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

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

Overview

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, an explicit return statement, etc. In other contexts, the second operand should be indented regardless of enforced style.

In both styles, operators should be aligned when an assignment begins on the next line.

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 included from Alignment

Alignment::SPACE

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

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 Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_gem_version, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

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

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_and(node) ⇒ Object 



51
52
53
 
# File 'lib/rubocop/cop/layout/multiline_operation_indentation.rb', line 51

def on_and(node)
  check_and_or(node)
end

#on_or(node) ⇒ Object 



55
56
57
 
# File 'lib/rubocop/cop/layout/multiline_operation_indentation.rb', line 55

def on_or(node)
  check_and_or(node)
end

#validate_config ⇒ Object

Raises:



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

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