forked from rubocop/rubocop
/
corrector.rb
196 lines (177 loc) · 6.85 KB
/
corrector.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
# frozen_string_literal: true
module RuboCop
module Cop
# This class takes a source buffer and rewrite its source
# based on the different correction rules supplied.
#
# Important!
# The nodes modified by the corrections should be part of the
# AST of the source_buffer.
class Corrector
#
# @param source_buffer [Parser::Source::Buffer]
# @param corrections [Array(#call)]
# Array of Objects that respond to #call. They will receive the
# corrector itself and should use its method to modify the source.
#
# @example
#
# class AndOrCorrector
# def initialize(node)
# @node = node
# end
#
# def call(corrector)
# replacement = (@node.type == :and ? '&&' : '||')
# corrector.replace(@node.loc.operator, replacement)
# end
# end
#
# corrections = [AndOrCorrector.new(node)]
# corrector = Corrector.new(source_buffer, corrections)
def initialize(source_buffer, corrections = [])
@source_buffer = source_buffer
raise 'source_buffer should be a Parser::Source::Buffer' unless \
source_buffer.is_a? Parser::Source::Buffer
@corrections = corrections
@source_rewriter = Parser::Source::TreeRewriter.new(
source_buffer,
different_replacements: :raise,
swallowed_insertions: :raise,
crossing_deletions: :accept
)
@diagnostics = []
# Don't print warnings to stderr if corrections conflict with each other
@source_rewriter.diagnostics.consumer = lambda do |diagnostic|
@diagnostics << diagnostic
end
end
attr_reader :corrections, :diagnostics
# Does the actual rewrite and returns string corresponding to
# the rewritten source.
#
# @return [String]
def rewrite
@corrections.each do |correction|
begin
@source_rewriter.transaction do
correction.call(self)
end
rescue ErrorWithAnalyzedFileLocation => e
raise e unless e.cause.is_a?(::Parser::ClobberingError)
end
end
@source_rewriter.process
end
# Removes the source range.
#
# @param [Parser::Source::Range, Rubocop::AST::Node] range or node
def remove(node_or_range)
range = to_range(node_or_range)
@source_rewriter.remove(range)
end
# Inserts new code before the given source range.
#
# @param [Parser::Source::Range, Rubocop::AST::Node] range or node
# @param [String] content
def insert_before(node_or_range, content)
range = to_range(node_or_range)
# TODO: Fix Cops using bad ranges instead
if range.end_pos > @source_buffer.source.size
range = range.with(end_pos: @source_buffer.source.size)
end
@source_rewriter.insert_before(range, content)
end
# Inserts new code after the given source range.
#
# @param [Parser::Source::Range, Rubocop::AST::Node] range or node
# @param [String] content
def insert_after(node_or_range, content)
range = to_range(node_or_range)
@source_rewriter.insert_after(range, content)
end
# Wraps the given source range with the given before and after texts
#
# @param [Parser::Source::Range, Rubocop::AST::Node] range or node
# @param [String] before
# @param [String] after
def wrap(node_or_range, before, after)
range = to_range(node_or_range)
@source_rewriter.wrap(range, before, after)
end
# Replaces the code of the source range `range` with `content`.
#
# @param [Parser::Source::Range, Rubocop::AST::Node] range or node
# @param [String] content
def replace(node_or_range, content)
range = to_range(node_or_range)
@source_rewriter.replace(range, content)
end
# Removes `size` characters prior to the source range.
#
# @param [Parser::Source::Range, Rubocop::AST::Node] range or node
# @param [Integer] size
def remove_preceding(node_or_range, size)
range = to_range(node_or_range)
to_remove = Parser::Source::Range.new(range.source_buffer,
range.begin_pos - size,
range.begin_pos)
@source_rewriter.remove(to_remove)
end
# Removes `size` characters from the beginning of the given range.
# If `size` is greater than the size of `range`, the removed region can
# overrun the end of `range`.
#
# @param [Parser::Source::Range, Rubocop::AST::Node] range or node
# @param [Integer] size
def remove_leading(node_or_range, size)
range = to_range(node_or_range)
to_remove = Parser::Source::Range.new(range.source_buffer,
range.begin_pos,
range.begin_pos + size)
@source_rewriter.remove(to_remove)
end
# Removes `size` characters from the end of the given range.
# If `size` is greater than the size of `range`, the removed region can
# overrun the beginning of `range`.
#
# @param [Parser::Source::Range, Rubocop::AST::Node] range or node
# @param [Integer] size
def remove_trailing(node_or_range, size)
range = to_range(node_or_range)
to_remove = Parser::Source::Range.new(range.source_buffer,
range.end_pos - size,
range.end_pos)
@source_rewriter.remove(to_remove)
end
private
# :nodoc:
def to_range(node_or_range)
range = case node_or_range
when ::RuboCop::AST::Node, ::Parser::Source::Comment
node_or_range.loc.expression
when ::Parser::Source::Range
node_or_range
else
raise TypeError,
'Expected a Parser::Source::Range, Comment or ' \
"Rubocop::AST::Node, got #{node_or_range.class}"
end
validate_buffer(range.source_buffer)
range
end
def validate_buffer(buffer)
return if buffer == @source_buffer
unless buffer.is_a?(::Parser::Source::Buffer)
# actually this should be enforced by parser gem
raise 'Corrector expected range source buffer to be a ' \
"Parser::Source::Buffer, but got #{buffer.class}"
end
raise "Correction target buffer #{buffer.object_id} " \
"name:#{buffer.name.inspect}" \
" is not current #{@source_buffer.object_id} " \
"name:#{@source_buffer.name.inspect} under investigation"
end
end
end
end