Class: RuboCop::Cop::VariableForce
- Inherits:
-
Force
- Object
- Force
- RuboCop::Cop::VariableForce
show all
- Defined in:
- lib/rubocop/cop/variable_force.rb,
lib/rubocop/cop/variable_force/scope.rb,
lib/rubocop/cop/variable_force/variable.rb,
lib/rubocop/cop/variable_force/locatable.rb,
lib/rubocop/cop/variable_force/reference.rb,
lib/rubocop/cop/variable_force/assignment.rb,
lib/rubocop/cop/variable_force/variable_table.rb
Overview
This force provides a way to track local variables and scopes of Ruby.
Cops interact with this force need to override some of the hook methods.
def before_entering_scope(scope, variable_table)
end
def after_entering_scope(scope, variable_table)
end
def before_leaving_scope(scope, variable_table)
end
def after_leaving_scope(scope, variable_table)
end
def before_declaring_variable(variable, variable_table)
end
def after_declaring_variable(variable, variable_table)
end
Defined Under Namespace
Modules: Locatable
Classes: Assignment, Reference, Scope, Variable, VariableTable
Constant Summary
collapse
- VARIABLE_ASSIGNMENT_TYPE =
rubocop:disable Metrics/ClassLength
:lvasgn
- REGEXP_NAMED_CAPTURE_TYPE =
:match_with_lvasgn
- VARIABLE_ASSIGNMENT_TYPES =
[VARIABLE_ASSIGNMENT_TYPE, REGEXP_NAMED_CAPTURE_TYPE].freeze
- ARGUMENT_DECLARATION_TYPES =
[
:arg, :optarg, :restarg,
:kwarg, :kwoptarg, :kwrestarg,
:blockarg, :shadowarg ].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
- SEND_TYPE =
:send
Instance Attribute Summary
Attributes inherited from Force
#cops
Class Method Summary
collapse
Instance Method Summary
collapse
Methods inherited from Force
all, force_name, inherited, #initialize, #name, #run_hook
Class Method Details
.wrap_with_top_level_scope_node(root_node) ⇒ Object
58
59
60
61
62
63
64
|
# File 'lib/rubocop/cop/variable_force.rb', line 58
def self.wrap_with_top_level_scope_node(root_node)
if root_node.begin_type?
root_node
else
Astrolabe::Node.new(:begin, [root_node])
end
end
|
Instance Method Details
#dispatch_node(node) ⇒ Object
rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
#find_variables_in_loop(loop_node) ⇒ Object
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
|
# File 'lib/rubocop/cop/variable_force.rb', line 319
def find_variables_in_loop(loop_node)
referenced_variable_names_in_loop = []
assignment_nodes_in_loop = []
loop_node.each_descendant do |node|
case node.type
when :lvar
referenced_variable_names_in_loop << node.children.first
when *OPERATOR_ASSIGNMENT_TYPES
asgn_node = node.children.first
if asgn_node.type == :lvasgn
referenced_variable_names_in_loop << asgn_node.children.first
end
when :lvasgn
assignment_nodes_in_loop << node
end
end
[referenced_variable_names_in_loop, assignment_nodes_in_loop]
end
|
#inspect_variables_in_scope(scope_node) ⇒ Object
This is called for each scope recursively.
82
83
84
85
86
|
# File 'lib/rubocop/cop/variable_force.rb', line 82
def inspect_variables_in_scope(scope_node)
variable_table.push_scope(scope_node)
process_children(scope_node)
variable_table.pop_scope
end
|
#investigate(processed_source) ⇒ Object
71
72
73
74
75
76
77
78
79
|
# File 'lib/rubocop/cop/variable_force.rb', line 71
def investigate(processed_source)
root_node = processed_source.ast
return unless root_node
root_node = self.class.wrap_with_top_level_scope_node(root_node)
inspect_variables_in_scope(root_node)
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.
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
# File 'lib/rubocop/cop/variable_force.rb', line 301
def mark_assignments_as_referenced_in_loop(node)
referenced_variable_names_in_loop, assignment_nodes_in_loop =
find_variables_in_loop(node)
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
88
89
90
91
92
93
|
# File 'lib/rubocop/cop/variable_force.rb', line 88
def process_children(origin_node)
origin_node.each_child_node do |child_node|
next if scanned_node?(child_node)
process_node(child_node)
end
end
|
#process_loop(node) ⇒ Object
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
# File 'lib/rubocop/cop/variable_force.rb', line 238
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
95
96
97
98
99
100
|
# File 'lib/rubocop/cop/variable_force.rb', line 95
def process_node(node)
catch(:skip_children) do
dispatch_node(node)
process_children(node)
end
end
|
#process_regexp_named_captures(node) ⇒ Object
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
# File 'lib/rubocop/cop/variable_force.rb', line 167
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|
next if variable_table.variable_exist?(name)
variable_table.declare_variable(name, node)
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
253
254
255
256
257
258
259
260
261
262
|
# File 'lib/rubocop/cop/variable_force.rb', line 253
def process_rescue(node)
resbody_nodes = node.each_child_node(:resbody)
contain_retry = resbody_nodes.any? do |resbody_node|
resbody_node.each_descendant.any?(&:retry_type?)
end
process_loop(node) if contain_retry
end
|
#process_scope(node) ⇒ Object
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
|
# File 'lib/rubocop/cop/variable_force.rb', line 271
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_send(node) ⇒ Object
288
289
290
291
292
293
294
295
296
|
# File 'lib/rubocop/cop/variable_force.rb', line 288
def process_send(node)
_receiver, method_name, args = *node
return unless method_name == :binding
return if args && !args.children.empty?
variable_table.accessible_variables.each do |variable|
variable.reference!(node)
end
end
|
#process_variable_assignment(node) ⇒ Object
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
# File 'lib/rubocop/cop/variable_force.rb', line 147
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
rubocop:enable Metrics/MethodLength, Metrics/CyclomaticComplexity
135
136
137
138
139
140
141
142
143
144
145
|
# File 'lib/rubocop/cop/variable_force.rb', line 135
def process_variable_declaration(node)
variable_name = node.children.first
return unless variable_name
variable_table.declare_variable(variable_name, node)
end
|
#process_variable_multiple_assignment(node) ⇒ Object
226
227
228
229
230
231
|
# File 'lib/rubocop/cop/variable_force.rb', line 226
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
# File 'lib/rubocop/cop/variable_force.rb', line 189
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
233
234
235
236
|
# File 'lib/rubocop/cop/variable_force.rb', line 233
def process_variable_referencing(node)
name = node.children.first
variable_table.reference_variable(name, node)
end
|
#process_zero_arity_super(node) ⇒ Object
264
265
266
267
268
269
|
# File 'lib/rubocop/cop/variable_force.rb', line 264
def process_zero_arity_super(node)
variable_table.accessible_variables.each do |variable|
next unless variable.method_argument?
variable.reference!(node)
end
end
|
#scanned_node?(node) ⇒ Boolean
Use Node#equal? for accurate check.
343
344
345
346
347
|
# File 'lib/rubocop/cop/variable_force.rb', line 343
def scanned_node?(node)
scanned_nodes.any? do |scanned_node|
scanned_node.equal?(node)
end
end
|
#scanned_nodes ⇒ Object
349
350
351
|
# File 'lib/rubocop/cop/variable_force.rb', line 349
def scanned_nodes
@scanned_nodes ||= []
end
|
#skip_children! ⇒ Object
102
103
104
|
# File 'lib/rubocop/cop/variable_force.rb', line 102
def skip_children!
throw :skip_children
end
|
#variable_table ⇒ Object
66
67
68
|
# File 'lib/rubocop/cop/variable_force.rb', line 66
def variable_table
@variable_table ||= VariableTable.new(self)
end
|