Class: RuboCop::Cop::Layout::ParameterAlignment

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

Overview

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

To set the alignment of the first argument, use the cop FirstParameterIndentation.

Examples:

EnforcedStyle: with_first_parameter (default)

# good

def foo(bar,
        baz)
  123
end

def foo(
  bar,
  baz
)
  123
end

# bad

def foo(bar,
     baz)
  123
end

# bad

def foo(
  bar,
     baz)
  123
end

EnforcedStyle: with_fixed_indentation

# good

def foo(bar,
  baz)
  123
end

def foo(
  bar,
  baz
)
  123
end

# bad

def foo(bar,
        baz)
  123
end

# bad

def foo(
  bar,
     baz)
  123
end

Constant Summary collapse

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

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, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #external_dependency_checksum, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

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 AST::Sexp

#s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #safe_autocorrect?, #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 


87
88
89
 
# File 'lib/rubocop/cop/layout/parameter_alignment.rb', line 87

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

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


80
81
82
83
84
 
# File 'lib/rubocop/cop/layout/parameter_alignment.rb', line 80

def on_def(node)
  return if node.arguments.size < 2

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