Class: RuboCop::Cop::Layout::AlignParameters

Inherits:
Cop
  • Object
show all
Includes:
AutocorrectAlignment, OnMethodDef
Defined in:
lib/rubocop/cop/layout/align_parameters.rb

Overview

Here we check if the parameters on a multi-line method call or definition are aligned.

Examples:


# EnforcedStyle: with_first_parameter

# good

foo :bar,
    :baz

# bad

foo :bar,
  :baz

# EnforcedStyle: with_fixed_indentation

# good

foo :bar,
  :baz

# bad

foo :bar,
    :baz

Constant Summary collapse

ALIGN_PARAMS_MSG = 
'Align the parameters of a method %s if they span ' \
'more than one line.'.freeze
FIXED_INDENT_MSG = 
'Use one level of indentation for parameters ' \
'following the first line of a multi-line method %s.'.freeze

Constants included from AutocorrectAlignment

AutocorrectAlignment::SPACE

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from OnMethodDef

#method_def_node_parts, #on_def, #on_defs

Methods included from AutocorrectAlignment

#autocorrect, #check_alignment, #configured_indentation_width, #display_column, #indentation, #offset

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?, #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?, block_length, comment_line?, compatible_external_encoding_for?, directions, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path, smart_path

Constructor Details

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

Instance Method Details

#message(node) ⇒ Object 



60
61
62
63
64
65
 
# File 'lib/rubocop/cop/layout/align_parameters.rb', line 60

def message(node)
  type = node && node.parent.send_type? ? 'call' : 'definition'
  msg = fixed_indentation? ? FIXED_INDENT_MSG : ALIGN_PARAMS_MSG

  format(msg, type)
end

#on_method_def(node, _method_name, args, _body) ⇒ Object 



52
53
54
55
56
57
58
 
# File 'lib/rubocop/cop/layout/align_parameters.rb', line 52

def on_method_def(node, _method_name, args, _body)
  args = args.children

  return if args.size < 2

  check_alignment(args, base_column(node, args))
end

#on_send(node) ⇒ Object 



46
47
48
49
50
 
# File 'lib/rubocop/cop/layout/align_parameters.rb', line 46

def on_send(node)
  return if node.arguments.size < 2 || node.method?(:[]=)

  check_alignment(node.arguments, base_column(node, node.arguments))
end