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

Examples:


# bad

def some_method
  foo = 1

  2.times do |foo| # shadowing outer `foo`
    do_something(foo)
  end
end

# good

def some_method
  foo = 1

  2.times do |bar|
    do_something(bar)
  end
end

Constant Summary collapse

MSG = 
'Shadowing outer local variable - `%<variable>s`.'.freeze

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::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?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#before_declaring_variable(variable, variable_table) ⇒ Object 



41
42
43
44
45
46
47
48
49
 
# File 'lib/rubocop/cop/lint/shadowing_outer_local_variable.rb', line 41

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: variable.name)
  add_offense(variable.declaration_node, message: message)
end

#join_force?(force_class) ⇒ Boolean

Returns:

  • (Boolean) 


37
38
39
 
# File 'lib/rubocop/cop/lint/shadowing_outer_local_variable.rb', line 37

def join_force?(force_class)
  force_class == VariableForce
end