Class: RuboCop::Cop::Style::OptionalArguments

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/style/optional_arguments.rb

Overview

This cop checks for optional arguments to methods that do not come at the end of the argument list

Examples:

# bad
def foo(a = 1, b, c)
end

# good
def baz(a, b, c = 1)
end

def foobar(a = 1, b = 2, c = 3)
end

Constant Summary collapse

MSG = 
'Optional arguments should appear at the end of the argument list.'

Constants included from Util

Util::ASGN_NODES, Util::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, 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?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

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_def(node) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/rubocop/cop/style/optional_arguments.rb', line 24

def on_def(node)
  _method, arguments, = *node
  arguments = *arguments
  optarg_positions = []
  arg_positions = []

  arguments.each_with_index do |argument, index|
    optarg_positions << index if argument.optarg_type?
    arg_positions << index if argument.arg_type?
  end

  return if optarg_positions.empty? || arg_positions.empty?

  optarg_positions.each do |optarg_position|
    # there can only be one group of optional arguments
    break if optarg_position > arg_positions.max
    argument = arguments[optarg_position]
    arg, = *argument

    add_offense(argument, :expression, format(MSG, arg))
  end
end