Class: RuboCop::Cop::Style::MultilineMethodCallIndentation

Inherits:
Cop
  • Object
show all
Includes:
AutocorrectAlignment, ConfigurableEnforcedStyle, MultilineExpressionIndentation
Defined in:
lib/rubocop/cop/style/multiline_method_call_indentation.rb

Overview

This cop checks the indentation of the method name part in method calls that span more than one line.

Examples:

# bad
while a
.b
  something
end

# good, EnforcedStyle: aligned
while a
      .b
  something
end

# good, EnforcedStyle: aligned
Thing.a
     .b
     .c

# good, EnforcedStyle: indented
while a
    .b
  something
end

Constant Summary

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 MultilineExpressionIndentation

#argument_in_method_call, #assignment_call?, #assignment_rhs, #check, #correct_indentation, #grouped_expression?, #incorrect_style_detected, #indentation, #inside_arg_list_parentheses?, #kw_node_with_special_indentation, #left_hand_side, #not_for_this_cop?, #on_send, #operation_description, #part_of_assignment_rhs, #part_of_block_body?, #regular_method_right_hand_side, #right_hand_side, #valid_method_rhs_candidate?, #valid_rhs_candidate?

Methods included from AutocorrectAlignment

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

Methods included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

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

#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_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

#validate_config ⇒ Object

Raises:



37
38
39
40
41
42
43
44
45
 
# File 'lib/rubocop/cop/style/multiline_method_call_indentation.rb', line 37

def validate_config
  return unless style == :aligned && cop_config['IndentationWidth']

  raise ValidationError,
        'The `Style/MultilineMethodCallIndentation`' \
        ' cop only accepts an `IndentationWidth` ' \
        'configuration parameter when ' \
        '`EnforcedStyle` is `indented`.'
end