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

Inherits:
Cop
  • Object
show all
Includes:
Alignment
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 (default)

# 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 %<type>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 %<type>s.'.freeze

Constants included from Util

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

Methods included from PathUtil

absolute?, 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 



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

def autocorrect(node)
  AlignmentCorrector.correct(processed_source, node, column_delta)
end

#on_send(node) ⇒ Object Also known as: on_def, on_defs 



39
40
41
42
43
44
 
# File 'lib/rubocop/cop/layout/align_parameters.rb', line 39

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

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