Class: RuboCop::Cop::Lint::ShadowingOuterLocalVariable

Inherits:
Cop
  • Object
show all
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 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 inherited from Cop

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

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

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

Methods included from PathUtil

issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#before_declaring_variable(variable, variable_table) ⇒ Object 



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

def before_declaring_variable(variable, variable_table)
  return if variable.should_be_unused?

  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

#join_force?(force_class) ⇒ Boolean

Returns:

  • (Boolean) 


13
14
15
 
# File 'lib/rubocop/cop/lint/shadowing_outer_local_variable.rb', line 13

def join_force?(force_class)
  force_class == VariableForce
end