Class: RuboCop::Cop::Style::AlignParameters

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

Overview

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

Constant Summary

Constants included from AutocorrectAlignment

AutocorrectAlignment::SPACE

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from OnMethodDef

#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, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

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?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#message(node) ⇒ Object 



28
29
30
31
32
 
# File 'lib/rubocop/cop/style/align_parameters.rb', line 28

def message(node)
  type = node && node.parent.send_type? ? 'call' : 'definition'
  "Align the parameters of a method #{type} if they span " \
  'more than one line.'
end

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



22
23
24
25
26
 
# File 'lib/rubocop/cop/style/align_parameters.rb', line 22

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 



13
14
15
16
17
18
19
20
 
# File 'lib/rubocop/cop/style/align_parameters.rb', line 13

def on_send(node)
  _receiver, method, *args = *node

  return if method == :[]=
  return if args.size < 2

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