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

Inherits:
Cop
  • Object
show all
Includes:
AutocorrectAlignment, CheckAssignment, EndKeywordAlignment
Defined in:
lib/rubocop/cop/layout/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.

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 `%s` with `%s`.'.freeze

Constants included from AutocorrectAlignment

AutocorrectAlignment::SPACE

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from CheckAssignment

extract_rhs, #on_send

Methods included from AutocorrectAlignment

#autocorrect, #configured_indentation_width, #display_column, #indentation, #offset

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_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

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, comment_line?, compatible_external_encoding_for?, directions, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, scrub_string, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path, smart_path

Constructor Details

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

Instance Method Details

#on_case(node) ⇒ Object



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

def on_case(node)
  return unless node.else?

  check_alignment(node.when_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(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
55
56
57
58
59
60
61
# File 'lib/rubocop/cop/layout/else_alignment.rb', line 50

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

  parent = node.parent
  parent = parent.parent if parent.ensure_type?
  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