Class: RuboCop::Cop::Style::AlignParameters
- 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 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
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
- #message(node) ⇒ Object
- #on_method_def(node, _method_name, args, _body) ⇒ Object
- #on_send(node) ⇒ Object
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, 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_ruby_version
Methods included from AST::Sexp
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_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_supported_styles, to_symbol_literal, within_node?
Methods included from PathUtil
absolute?, match_path?, relative_path
Constructor Details
This class inherits a constructor from RuboCop::Cop::Cop
Instance Method Details
#message(node) ⇒ Object
33 34 35 36 37 |
# File 'lib/rubocop/cop/style/align_parameters.rb', line 33 def (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
27 28 29 30 31 |
# File 'lib/rubocop/cop/style/align_parameters.rb', line 27 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
18 19 20 21 22 23 24 25 |
# File 'lib/rubocop/cop/style/align_parameters.rb', line 18 def on_send(node) _receiver, method, *args = *node return if method == :[]= return if args.size < 2 check_alignment(args, base_column(node, args)) end |