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

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

Overview

This cop checks for circular argument references in optional keyword arguments and optional ordinal arguments.

This cop mirrors a warning produced by MRI since 2.2.

Examples:


# bad

def bake(pie: pie)
  pie.heat_up
end

# good

def bake(pie:)
  pie.refrigerate
end

# good

def bake(pie: self.pie)
  pie.feed_to(user)
end

# bad

def cook(dry_ingredients = dry_ingredients)
  dry_ingredients.reduce(&:+)
end

# good

def cook(dry_ingredients = self.dry_ingredients)
  dry_ingredients.combine
end

Constant Summary collapse

MSG =
'Circular argument reference - `%<arg_name>s`.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_kwoptarg(node) ⇒ Object


53
54
55
# File 'lib/rubocop/cop/lint/circular_argument_reference.rb', line 53

def on_kwoptarg(node)
  check_for_circular_argument_references(*node)
end

#on_optarg(node) ⇒ Object


57
58
59
# File 'lib/rubocop/cop/lint/circular_argument_reference.rb', line 57

def on_optarg(node)
  check_for_circular_argument_references(*node)
end