Class: RuboCop::Cop::Lint::CircularArgumentReference

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

Overview

This cop checks for circular argument references in keyword arguments.

This cop mirrors a warning produced by MRI since 2.2.

Examples:

def bake(pie: pie)
  pie.heat_up
end

Constant Summary collapse

MSG =
'Circular argument reference - `%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, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #display_cop_names?, #display_style_guide?, #excluded_file?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

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, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_kwoptarg(node) ⇒ Object



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# File 'lib/rubocop/cop/lint/circular_argument_reference.rb', line 17

def on_kwoptarg(node)
  arg_name, arg_value = *node
  case arg_value.type
  when :send
    # Ruby 2.0 will have type send every time, and "send nil" if it is
    # calling itself with a specified "self" receiver
    receiver, name = *arg_value
    return unless name == arg_name && receiver.nil?
  when :lvar
    # Ruby 2.2.2 will have type lvar if it is calling its own method
    # without a specified "self"
    return unless arg_value.to_a == [arg_name]
  else
    return
  end

  add_offense(arg_value, :expression, format(MSG, arg_name))
end