Class: RuboCop::Cop::Layout::MultilineMethodArgumentLineBreaks

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
MultilineElementLineBreaks
Defined in:
lib/rubocop/cop/layout/multiline_method_argument_line_breaks.rb

Overview

Ensures that each argument in a multi-line method call starts on a separate line.

Note
 This cop does not move the first argument, if you want that to be on a separate line, see Layout/FirstMethodArgumentLineBreak.

Examples:


# bad
foo(a, b,
  c
)

# bad
foo(a, b, {
  foo: "bar",
})

# good
foo(
  a,
  b,
  c
)

# good
foo(a, b, c)

AllowMultilineFinalElement: false (default)


# good
foo(
  a,
  b,
  {
    foo: "bar",
  }
)

AllowMultilineFinalElement: true


# good
foo(
  a,
  b,
  {
    foo: "bar",
  }
)

Constant Summary collapse

MSG = 
'Each argument in a multi-line method call must start on a separate line.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #begin_investigation, 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, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

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

Instance Method Details

#on_send(node) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/rubocop/cop/layout/multiline_method_argument_line_breaks.rb', line 62

def on_send(node)
  return if node.method?(:[]=)

  args = node.arguments

  # If there is a trailing hash arg without explicit braces, like this:
  #
  #    method(1, 'key1' => value1, 'key2' => value2)
  #
  # ...then each key/value pair is treated as a method 'argument'
  # when determining where line breaks should appear.
  last_arg = args.last
  args = args[0...-1] + last_arg.children if last_arg&.hash_type? && !last_arg&.braces?

  check_line_breaks(node, args, ignore_last: ignore_last_element?)
end