Class: RuboCop::Cop::Lint::UnusedMethodArgument

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
UnusedArgument
Defined in:
lib/rubocop/cop/lint/unused_method_argument.rb

Overview

Checks for unused method arguments.

Examples:

# bad
def some_method(used, unused, _unused_but_allowed)
  puts used
end

# good
def some_method(used, _unused, _unused_but_allowed)
  puts used
end

AllowUnusedKeywordArguments: false (default)

# bad
def do_something(used, unused: 42)
  used
end

AllowUnusedKeywordArguments: true

# good
def do_something(used, unused: 42)
  used
end

IgnoreEmptyMethods: true (default)

# good
def do_something(unused)
end

IgnoreEmptyMethods: false

# bad
def do_something(unused)
end

IgnoreNotImplementedMethods: true (default)

# with default value of `NotImplementedExceptions: ['NotImplementedError']`

# good
def do_something(unused)
  raise NotImplementedError
end

def do_something_else(unused)
  fail "TODO"
end

IgnoreNotImplementedMethods: true

# with `NotImplementedExceptions: ['AbstractMethodError']`

# good
def do_something(unused)
  raise AbstractMethodError
end

IgnoreNotImplementedMethods: false

# bad
def do_something(unused)
  raise NotImplementedError
end

def do_something_else(unused)
  fail "TODO"
end

Constant Summary

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source, #project_index

Class Method Summary collapse

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods included from UnusedArgument

#after_leaving_scope

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, lint?, match?, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_gem_version, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

cop_dir_for, #exclude_limit, read_limits

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #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

Class Method Details

.autocorrect_incompatible_with ⇒ Object 



80
81
82
 
# File 'lib/rubocop/cop/lint/unused_method_argument.rb', line 80

def self.autocorrect_incompatible_with
  [Style::ExplicitBlockArgument]
end

.joining_forces ⇒ Object 



84
85
86
 
# File 'lib/rubocop/cop/lint/unused_method_argument.rb', line 84

def self.joining_forces
  VariableForce
end

Instance Method Details

#not_implemented?(node) ⇒ Object 



75
76
77
78
 
# File 'lib/rubocop/cop/lint/unused_method_argument.rb', line 75

def_node_matcher :not_implemented?, <<~PATTERN
  {(send nil? :raise #allowed_exception_class? ...)
   (send nil? :fail ...)}
PATTERN