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

Inherits:
Cop
  • Object
show all
Includes:
AutocorrectAlignment, CheckAssignment
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 Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, 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, #start_of_line?

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_name_with_namespace, cop_type, #debug?, #display_cop_names?, inherited, #initialize, #join_force?, lint?, #message, non_rails, qualified_cop_name, rails?, #relevant_file?, #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, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

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


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

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


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

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)

  base_range = if base
                 base.loc.expression
               else
                 base = node
                 until %w(if unless).include?(base.loc.keyword.source)
                   base = base.parent
                 end
                 base.loc.keyword
               end

  check_alignment(base_range, else_range)
end

#on_rescue(node) ⇒ Object


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

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

  grandparent = node.parent.parent
  base = case node.parent.type
         when :def, :defs
           if grandparent && grandparent.type == :send
             grandparent.loc.selector
           else
             node.parent.loc.keyword
           end
         when :ensure
           grandparent.loc.begin
         else
           node.loc.keyword
         end
  check_alignment(base, node.loc.else)
end