Class: RuboCop::Cop::Style::RedundantArgument

Inherits:
Base
  • Object
show all
Defined in:
lib/rubocop/cop/style/redundant_argument.rb

Overview

This cop checks for a redundant argument passed to certain methods.

Limitations:

  1. This cop matches for method names only and hence cannot tell apart methods with same name in different classes.

  2. This cop is limited to methods with single parameter.

  3. This cop is unsafe if certain special global variables (e.g. ‘$;`) are set. That depends on the nature of the target methods, of course.

Method names and their redundant arguments can be configured like this:

Methods:

join: ''
split: ' '
foo: 2

Examples:

# bad
array.join('')
[1, 2, 3].join("")
string.split(" ")
"first\nsecond".split(" ")
A.foo(2)

# good
array.join
[1, 2, 3].join
string.split
"first second".split
A.foo

Constant Summary collapse

MSG = 
'Argument %<arg>s is redundant because it is implied by default.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Constants included from Util

Util::LITERAL_REGEX

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

add_parentheses, args_begin, args_end, begins_its_line?, comment_line?, comment_lines?, double_quotes_required?, escape_string, first_part_of_call_chain, indent, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file?, hidden_file_in_not_hidden_dir?, match_path?, maybe_hidden_file?, relative_path, smart_path

Constructor Details

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

Instance Method Details

#on_send(node) ⇒ Object 



42
43
44
45
46
47
48
 
# File 'lib/rubocop/cop/style/redundant_argument.rb', line 42

def on_send(node)
  return if node.receiver.nil?
  return if node.arguments.count != 1
  return unless redundant_argument?(node)

  add_offense(node, message: format(MSG, arg: node.arguments.first.source))
end