Class: RuboCop::Cop::Layout::FirstMethodArgumentLineBreak

Inherits:
Cop
  • Object
show all
Includes:
FirstElementLineBreak
Defined in:
lib/rubocop/cop/layout/first_method_argument_line_break.rb

Overview

This cop checks for a line break before the first argument in a multi-line method call.

Examples:


# bad
method(foo, bar,
  baz)

# good
method(
  foo, bar,
  baz)

# ignored
method foo, bar,
  baz

Constant Summary collapse

MSG = 
'Add a line break before the first argument of a ' \
'multi-line method argument list.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

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?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



49
50
51
 
# File 'lib/rubocop/cop/layout/first_method_argument_line_break.rb', line 49

def autocorrect(node)
  EmptyLineCorrector.insert_before(node)
end

#on_send(node) ⇒ Object Also known as: on_csend, on_super 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/rubocop/cop/layout/first_method_argument_line_break.rb', line 29

def on_send(node)
  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.
  if (last_arg = args.last)
    if last_arg.hash_type? && !last_arg.braces?
      args = args.concat(args.pop.children)
    end
  end

  check_method_line_break(node, args)
end