Class: RuboCop::Cop::Layout::MultilineOperationIndentation

Inherits:
Cop
  • Object
show all
Includes:
Alignment, ConfigurableEnforcedStyle, MultilineExpressionIndentation
Defined in:
lib/rubocop/cop/layout/multiline_operation_indentation.rb

Overview

This cop checks the indentation of the right hand side operand in binary operations that span more than one line.

The ‘aligned` style checks that operators are aligned if they are part of an `if` or `while` condition, a `return` statement, etc. In other contexts, the second operand should be indented regardless of enforced style.

Examples:

EnforcedStyle: aligned (default)

# bad
if a +
    b
  something &&
  something_else
end

# good
if a +
   b
  something &&
    something_else
end

EnforcedStyle: indented

# bad
if a +
   b
  something &&
  something_else
end

# good
if a +
    b
  something &&
    something_else
end

Constant Summary

Constants included from MultilineExpressionIndentation

MultilineExpressionIndentation::ASSIGNMENT_MESSAGE_TAIL, MultilineExpressionIndentation::DEFAULT_MESSAGE_TAIL, MultilineExpressionIndentation::KEYWORD_ANCESTOR_TYPES, MultilineExpressionIndentation::KEYWORD_MESSAGE_TAIL, MultilineExpressionIndentation::UNALIGNED_RHS_TYPES

Constants inherited from Base

Base::RESTRICT_ON_SEND

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#offenses

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from MultilineExpressionIndentation

#on_send

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_configured?, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Cop

#add_offense, all, #corrections, #find_location, #highlights, joining_forces, #messages, #on_investigation_end, #on_new_investigation, #parse, qualified_cop_name, registry, support_autocorrect?, #support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

add_parentheses, args_begin, args_end, begins_its_line?, comment_line?, comment_lines?, double_quotes_required?, escape_string, first_part_of_call_chain, indent, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file?, hidden_file_in_not_hidden_dir?, match_path?, maybe_hidden_file?, relative_path, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



66
67
68
 
# File 'lib/rubocop/cop/layout/multiline_operation_indentation.rb', line 66

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

#on_and(node) ⇒ Object 



49
50
51
 
# File 'lib/rubocop/cop/layout/multiline_operation_indentation.rb', line 49

def on_and(node)
  check_and_or(node)
end

#on_or(node) ⇒ Object 



53
54
55
 
# File 'lib/rubocop/cop/layout/multiline_operation_indentation.rb', line 53

def on_or(node)
  check_and_or(node)
end

#validate_config ⇒ Object

Raises:



57
58
59
60
61
62
63
64
 
# File 'lib/rubocop/cop/layout/multiline_operation_indentation.rb', line 57

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

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