Class: Rubocop::Cop::Lint::ShadowingOuterLocalVariable

Inherits:
Cop
  • Object
show all
Includes:
VariableInspector
Defined in:
lib/rubocop/cop/lint/shadowing_outer_local_variable.rb

Overview

This cop looks for use of the same name as outer local variables for block arguments or block local variables. This is a mimic of the warning "shadowing outer local variable - foo" from ruby -cw.

Constant Summary collapse

MSG = 
'Shadowing outer local variable - `%s`'

Constants included from VariableInspector

VariableInspector::ARGUMENT_DECLARATION_TYPES, VariableInspector::BLOCK_ARGUMENT_DECLARATION_TYPE, VariableInspector::BLOCK_LOCAL_VARIABLE_DECLARATION_TYPE, VariableInspector::DECLARATION_TYPES, VariableInspector::LOGICAL_OPERATOR_ASSIGNMENT_TYPES, VariableInspector::LOOP_TYPES, VariableInspector::METHOD_ARGUMENT_DECLARATION_TYPES, VariableInspector::MULTIPLE_ASSIGNMENT_TYPE, VariableInspector::OPERATOR_ASSIGNMENT_TYPES, VariableInspector::POST_CONDITION_LOOP_TYPES, VariableInspector::REGEXP_NAMED_CAPTURE_TYPE, VariableInspector::RESCUE_TYPE, VariableInspector::SCOPE_TYPES, VariableInspector::TWISTED_SCOPE_TYPES, VariableInspector::VARIABLE_ASSIGNMENT_TYPE, VariableInspector::VARIABLE_ASSIGNMENT_TYPES, VariableInspector::VARIABLE_REFERENCE_TYPE, VariableInspector::ZERO_ARITY_SUPER_TYPE

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from VariableInspector

#after_declaring_variable, #after_entering_scope, #after_leaving_scope, #before_entering_scope, #before_leaving_scope, #dispatch_node, #find_variables_in_loop, #inspect_variables, #inspect_variables_in_scope, #mark_assignments_as_referenced_in_loop, #process_children, #process_loop, #process_node, #process_regexp_named_captures, #process_rescue, #process_scope, #process_variable_assignment, #process_variable_declaration, #process_variable_multiple_assignment, #process_variable_operator_assignment, #process_variable_referencing, #process_zero_arity_super, #scan, #scanned_node?, #scanned_nodes, #skip_children!, #variable_table, wrap_with_top_level_node

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #debug?, #display_cop_names?, #exclude_file?, #include_file?, inherited, #initialize, lint?, #message, non_rails, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

block_length, command?, comment_line?, const_name, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes

Methods included from PathUtil

match_path?, relative_path

Constructor Details

This class inherits a constructor from Rubocop::Cop::Cop

Instance Method Details

#before_declaring_variable(variable) ⇒ Object 



19
20
21
22
23
24
25
26
27
 
# File 'lib/rubocop/cop/lint/shadowing_outer_local_variable.rb', line 19

def before_declaring_variable(variable)
  return if variable.name.to_s.start_with?('_')

  outer_local_variable = variable_table.find_variable(variable.name)
  return unless outer_local_variable

  message = format(MSG, variable.name)
  add_offense(variable.declaration_node, :expression, message)
end

#investigate(processed_source) ⇒ Object 



15
16
17
 
# File 'lib/rubocop/cop/lint/shadowing_outer_local_variable.rb', line 15

def investigate(processed_source)
  inspect_variables(processed_source.ast)
end