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`.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, 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, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #duplicate_location?, #excluded_file?, #extra_details?, #find_location, #highlights, inherited, #initialize, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, comment_line?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, 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