Module: Rubocop::Cop::VariableInspector
- Included in:
- Lint::ShadowingOuterLocalVariable, Lint::UselessAssignment
- Defined in:
- lib/rubocop/cop/variable_inspector.rb,
lib/rubocop/cop/variable_inspector/scope.rb,
lib/rubocop/cop/variable_inspector/variable.rb,
lib/rubocop/cop/variable_inspector/locatable.rb,
lib/rubocop/cop/variable_inspector/reference.rb,
lib/rubocop/cop/variable_inspector/assignment.rb,
lib/rubocop/cop/variable_inspector/variable_table.rb
Overview
This module provides a way to track local variables and scopes of Ruby.
This is intended to be used as mix-in, and the user class may override
some of hook methods.
Defined Under Namespace
Modules: Locatable
Classes: Assignment, Reference, Scope, Variable, VariableTable
Constant Summary
collapse
- VARIABLE_ASSIGNMENT_TYPE =
:lvasgn
- REGEXP_NAMED_CAPTURE_TYPE =
:match_with_lvasgn
- VARIABLE_ASSIGNMENT_TYPES =
[VARIABLE_ASSIGNMENT_TYPE, REGEXP_NAMED_CAPTURE_TYPE].freeze
- METHOD_ARGUMENT_DECLARATION_TYPES =
[
:arg, :optarg, :restarg,
:kwarg, :kwoptarg, :kwrestarg
].freeze
- BLOCK_ARGUMENT_DECLARATION_TYPE =
:blockarg
- ARGUMENT_DECLARATION_TYPES =
(
METHOD_ARGUMENT_DECLARATION_TYPES + [BLOCK_ARGUMENT_DECLARATION_TYPE]
).freeze
- BLOCK_LOCAL_VARIABLE_DECLARATION_TYPE =
:shadowarg
- DECLARATION_TYPES =
(
ARGUMENT_DECLARATION_TYPES + [BLOCK_LOCAL_VARIABLE_DECLARATION_TYPE]
).freeze
- LOGICAL_OPERATOR_ASSIGNMENT_TYPES =
[:or_asgn, :and_asgn].freeze
- OPERATOR_ASSIGNMENT_TYPES =
(LOGICAL_OPERATOR_ASSIGNMENT_TYPES + [:op_asgn]).freeze
- MULTIPLE_ASSIGNMENT_TYPE =
:masgn
- VARIABLE_REFERENCE_TYPE =
:lvar
- POST_CONDITION_LOOP_TYPES =
[:while_post, :until_post].freeze
- LOOP_TYPES =
(POST_CONDITION_LOOP_TYPES + [:while, :until, :for]).freeze
- RESCUE_TYPE =
:rescue
- ZERO_ARITY_SUPER_TYPE =
:zsuper
- TWISTED_SCOPE_TYPES =
[:block, :class, :sclass, :defs].freeze
- SCOPE_TYPES =
(TWISTED_SCOPE_TYPES + [:module, :def]).freeze
Instance Method Summary
collapse
Instance Method Details
#after_declaring_variable(variable_variable) ⇒ Object
340
341
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 340
def after_declaring_variable(variable_variable)
end
|
#after_entering_scope(scope) ⇒ Object
328
329
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 328
def after_entering_scope(scope)
end
|
#after_leaving_scope(scope) ⇒ Object
334
335
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 334
def after_leaving_scope(scope)
end
|
#before_declaring_variable(variable_variable) ⇒ Object
337
338
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 337
def before_declaring_variable(variable_variable)
end
|
#before_entering_scope(scope) ⇒ Object
325
326
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 325
def before_entering_scope(scope)
end
|
#before_leaving_scope(scope) ⇒ Object
331
332
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 331
def before_leaving_scope(scope)
end
|
#dispatch_node(node) ⇒ Object
#inspect_variables(root_node) ⇒ Object
50
51
52
53
54
55
56
57
58
59
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 50
def inspect_variables(root_node)
return unless root_node
unless root_node.type == :begin
root_node = Parser::AST::Node.new(:begin, [root_node])
end
inspect_variables_in_scope(root_node)
end
|
#inspect_variables_in_scope(scope_node) ⇒ Object
This is called for each scope recursively.
62
63
64
65
66
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 62
def inspect_variables_in_scope(scope_node)
variable_table.push_scope(scope_node)
process_children(scope_node)
variable_table.pop_scope
end
|
#mark_assignments_as_referenced_in_loop(node) ⇒ Object
Mark all assignments which are referenced in the same loop
as referenced by ignoring AST order since they would be referenced
in next iteration.
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 273
def mark_assignments_as_referenced_in_loop(node)
referenced_variable_names_in_loop = []
assignment_nodes_in_loop = []
scan(node) do |scanning_node|
case scanning_node.type
when :lvar
referenced_variable_names_in_loop << scanning_node.children.first
when :lvasgn
assignment_nodes_in_loop << scanning_node
end
end
referenced_variable_names_in_loop.each do |name|
variable = variable_table.find_variable(name)
next unless variable
variable.assignments.each do |assignment|
next if assignment_nodes_in_loop.none? do |assignment_node|
assignment_node.equal?(assignment.node)
end
assignment.reference!
end
end
end
|
#process_children(origin_node) ⇒ Object
68
69
70
71
72
73
74
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 68
def process_children(origin_node)
origin_node.children.each do |child|
next unless child.is_a?(Parser::AST::Node)
next if scanned_node?(child)
process_node(child)
end
end
|
#process_loop(node) ⇒ Object
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 215
def process_loop(node)
if POST_CONDITION_LOOP_TYPES.include?(node.type)
condition_node, body_node = *node
process_node(body_node)
process_node(condition_node)
else
process_children(node)
end
mark_assignments_as_referenced_in_loop(node)
skip_children!
end
|
#process_node(node) ⇒ Object
76
77
78
79
80
81
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 76
def process_node(node)
catch(:skip_children) do
dispatch_node(node)
process_children(node)
end
end
|
#process_regexp_named_captures(node) ⇒ Object
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 143
def process_regexp_named_captures(node)
regexp_node, rhs_node = *node
regexp_string = regexp_node.children[0].children[0]
regexp = Regexp.new(regexp_string)
variable_names = regexp.named_captures.keys
variable_names.each do |name|
unless variable_table.variable_exist?(name)
variable_table.declare_variable(name, node)
end
end
process_node(rhs_node)
process_node(regexp_node)
variable_names.each do |name|
variable_table.assign_to_variable(name, node)
end
skip_children!
end
|
#process_rescue(node) ⇒ Object
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 230
def process_rescue(node)
resbody_nodes = node.children.select do |child|
next false unless child.is_a?(Parser::AST::Node)
child.type == :resbody
end
contain_retry = resbody_nodes.any? do |resbody_node|
scan(resbody_node) do |node_in_resbody|
break true if node_in_resbody.type == :retry
end
end
process_loop(node) if contain_retry
end
|
#process_scope(node) ⇒ Object
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 253
def process_scope(node)
if TWISTED_SCOPE_TYPES.include?(node.type)
twisted_nodes = [node.children[0]]
twisted_nodes << node.children[1] if node.type == :class
twisted_nodes.compact!
twisted_nodes.each do |twisted_node|
process_node(twisted_node)
scanned_nodes << twisted_node
end
end
inspect_variables_in_scope(node)
skip_children!
end
|
#process_variable_assignment(node) ⇒ Object
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 123
def process_variable_assignment(node)
name = node.children.first
unless variable_table.variable_exist?(name)
variable_table.declare_variable(name, node)
end
process_children(node)
variable_table.assign_to_variable(name, node)
skip_children!
end
|
#process_variable_declaration(node) ⇒ Object
112
113
114
115
116
117
118
119
120
121
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 112
def process_variable_declaration(node)
return if node.type == :restarg && node.children.empty?
variable_name = node.children.first
variable_table.declare_variable(variable_name, node)
end
|
#process_variable_multiple_assignment(node) ⇒ Object
203
204
205
206
207
208
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 203
def process_variable_multiple_assignment(node)
lhs_node, rhs_node = *node
process_node(rhs_node)
process_node(lhs_node)
skip_children!
end
|
#process_variable_operator_assignment(node) ⇒ Object
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
197
198
199
200
201
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 166
def process_variable_operator_assignment(node)
if LOGICAL_OPERATOR_ASSIGNMENT_TYPES.include?(node.type)
asgn_node, rhs_node = *node
else
asgn_node, _operator, rhs_node = *node
end
return unless asgn_node.type == :lvasgn
name = asgn_node.children.first
unless variable_table.variable_exist?(name)
variable_table.declare_variable(name, asgn_node)
end
variable_table.reference_variable(name, node)
process_node(rhs_node)
variable_table.assign_to_variable(name, asgn_node)
skip_children!
end
|
#process_variable_referencing(node) ⇒ Object
210
211
212
213
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 210
def process_variable_referencing(node)
name = node.children.first
variable_table.reference_variable(name, node)
end
|
#process_zero_arity_super(node) ⇒ Object
246
247
248
249
250
251
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 246
def process_zero_arity_super(node)
variable_table.accessible_variables.each do |variable|
next unless variable.method_argument?
variable.reference!(node)
end
end
|
#scan(node, &block) ⇒ Object
303
304
305
306
307
308
309
310
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 303
def scan(node, &block)
node.children.each do |child|
next unless child.is_a?(Parser::AST::Node)
yield child
scan(child, &block)
end
nil
end
|
#scanned_node?(node) ⇒ Boolean
Use Node#equal? for accurate check.
313
314
315
316
317
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 313
def scanned_node?(node)
scanned_nodes.any? do |scanned_node|
scanned_node.equal?(node)
end
end
|
#scanned_nodes ⇒ Object
319
320
321
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 319
def scanned_nodes
@scanned_nodes ||= []
end
|
#skip_children! ⇒ Object
83
84
85
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 83
def skip_children!
throw :skip_children
end
|
#variable_table ⇒ Object
45
46
47
|
# File 'lib/rubocop/cop/variable_inspector.rb', line 45
def variable_table
@variable_table ||= VariableTable.new(self)
end
|