Class: RuboCop::Cop::Style::ElseAlignment

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

Overview

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

Constant Summary collapse

MSG =
'Align `%s` with `%s`.'

Constants included from CheckAssignment

CheckAssignment::TYPES

Constants included from AutocorrectAlignment

AutocorrectAlignment::SPACE

Constants included from Util

Util::ASGN_NODES, Util::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from CheckAssignment

#on_casgn, #on_op_asgn, #on_send

Methods included from AutocorrectAlignment

#autocorrect, #configured_indentation_width, #indentation, #offset, #start_of_line?

Methods included from ConfigurableEnforcedStyle

#alternative_style, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #parameter_name, #style, #style_detected, #unexpected_style_detected

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

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, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_case(node) ⇒ Object


52
53
54
55
56
# File 'lib/rubocop/cop/style/else_alignment.rb', line 52

def on_case(node)
  _cond, *whens, _else = *node
  return unless node.loc.else
  check_alignment(whens.last.loc.keyword, node.loc.else)
end

#on_if(node, base = nil) ⇒ Object


17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# File 'lib/rubocop/cop/style/else_alignment.rb', line 17

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

  else_range = node.loc.else
  return unless begins_its_line?(else_range)

  check_alignment(base_range(node, base), else_range)

  return if else_range.source != 'elsif'

  # If the `else` part is actually an `elsif`, we check the `elsif`
  # node in case it contains an `else` within, because that `else`
  # should have the same alignment (base).
  _condition, _if_body, else_body = *node
  on_if(else_body, base)
  # The `elsif` node will get an `on_if` call from the framework later,
  # but we're done here, so we set it to ignored.
  ignore_node(else_body)
end

#on_rescue(node) ⇒ Object


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

def on_rescue(node)
  return unless node.loc.else

  parent = node.parent
  parent = parent.parent if parent.type == :ensure
  base = case parent.type
         when :def, :defs then base_for_method_definition(parent)
         when :kwbegin then parent.loc.begin
         else node.loc.keyword
         end
  check_alignment(base, node.loc.else)
end