-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
corrector.rb
121 lines (106 loc) · 4.13 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
# 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 < ::Parser::Source::TreeRewriter
NOOP_CONSUMER = ->(diagnostic) {} # noop
# @param source [Parser::Source::Buffer, or anything
# leading to one via `(processed_source.)buffer`]
#
# corrector = Corrector.new(cop)
def initialize(source)
source = self.class.source_buffer(source)
super(
source,
different_replacements: :raise,
swallowed_insertions: :raise,
crossing_deletions: :accept
)
# Don't print warnings to stderr if corrections conflict with each other
diagnostics.consumer = NOOP_CONSUMER
end
alias rewrite process # Legacy
# 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 = range.with(
begin_pos: range.begin_pos - size,
end_pos: range.begin_pos
)
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 = range.with(end_pos: range.begin_pos + size)
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 = range.with(begin_pos: range.end_pos - size)
remove(to_remove)
end
# Duck typing for get to a ::Parser::Source::Buffer
def self.source_buffer(source)
source = source.processed_source if source.respond_to?(:processed_source)
source = source.buffer if source.respond_to?(:buffer)
source = source.source_buffer if source.respond_to?(:source_buffer)
unless source.is_a? ::Parser::Source::Buffer
raise TypeError, 'Expected argument to lead to a Parser::Source::Buffer ' \
"but got #{source.inspect}"
end
source
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 check_range_validity(node_or_range)
super(to_range(node_or_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