Class: RuboCop::Cop::Layout::ElseAlignment

Inherits:
Cop
  • Object
show all
Includes:
Alignment, CheckAssignment, EndKeywordAlignment
Defined in:
lib/rubocop/cop/layout/else_alignment.rb

Overview

This cop checks the alignment of else keywords. Normally they should be aligned with an if/unless/while/until/begin/def/rescue keyword, but there are special cases when they should follow the same rules as the alignment of end.

Examples:

# bad
if something
  code
 else
  code
end

# bad
if something
  code
 elsif something
  code
end

# good
if something
  code
else
  code
end

Constant Summary collapse

MSG =
'Align `%<else_range>s` with `%<base_range>s`.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Cop

#offenses

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from CheckAssignment

extract_rhs, #on_lvasgn, #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?, #message, #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

silence_warnings

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object


70
71
72
# File 'lib/rubocop/cop/layout/else_alignment.rb', line 70

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

#on_case(node) ⇒ Object


56
57
58
59
60
# File 'lib/rubocop/cop/layout/else_alignment.rb', line 56

def on_case(node)
  return unless node.else?

  check_alignment(node.when_branches.last.loc.keyword, node.loc.else)
end

#on_case_match(node) ⇒ Object


62
63
64
65
66
67
68
# File 'lib/rubocop/cop/layout/else_alignment.rb', line 62

def on_case_match(node)
  return unless node.else?

  check_alignment(
    node.in_pattern_branches.last.loc.keyword, node.loc.else
  )
end

#on_if(node, base = nil) ⇒ Object


39
40
41
42
43
44
45
46
47
48
# File 'lib/rubocop/cop/layout/else_alignment.rb', line 39

def on_if(node, base = nil)
  return if ignored_node?(node)
  return unless node.else? && begins_its_line?(node.loc.else)

  check_alignment(base_range_of_if(node, base), node.loc.else)

  return unless node.elsif_conditional?

  check_nested(node.else_branch, base)
end

#on_rescue(node) ⇒ Object


50
51
52
53
54
# File 'lib/rubocop/cop/layout/else_alignment.rb', line 50

def on_rescue(node)
  return unless node.loc.respond_to?(:else) && node.loc.else

  check_alignment(base_range_of_rescue(node), node.loc.else)
end