class RubbyCop::Cop::Layout::ElseAlignment

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.

Constants

MSG

Public Instance Methods

on_case(node) click to toggle source
# File lib/rubbycop/cop/layout/else_alignment.rb, line 50
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) click to toggle source
# File lib/rubbycop/cop/layout/else_alignment.rb, line 17
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)

  else_branch = node.else_branch

  return unless else_branch && else_branch.if_type? &&
                else_branch.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).
  on_if(else_branch, 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_branch)
end
on_rescue(node) click to toggle source
# File lib/rubbycop/cop/layout/else_alignment.rb, line 37
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

Private Instance Methods

base_for_method_definition(node) click to toggle source
# File lib/rubbycop/cop/layout/else_alignment.rb, line 67
def base_for_method_definition(node)
  parent = node.parent
  if parent && parent.send_type?
    parent.loc.selector # For example "private def ..."
  else
    node.loc.keyword
  end
end
base_range(node, base) click to toggle source
# File lib/rubbycop/cop/layout/else_alignment.rb, line 58
def base_range(node, base)
  if base
    base.source_range
  else
    lineage = [node, *node.each_ancestor(:if)]
    lineage.find { |parent| parent.if? || parent.unless? }.loc.keyword
  end
end
check_alignment(base_range, else_range) click to toggle source
# File lib/rubbycop/cop/layout/else_alignment.rb, line 93
def check_alignment(base_range, else_range)
  return unless begins_its_line?(else_range)

  @column_delta = effective_column(base_range) - else_range.column
  return if @column_delta.zero?

  add_offense(else_range, else_range,
              format(MSG, else_range.source, base_range.source[/^\S*/]))
end
check_assignment(node, rhs) click to toggle source
# File lib/rubbycop/cop/layout/else_alignment.rb, line 76
def check_assignment(node, rhs)
  # If there are method calls chained to the right hand side of the
  # assignment, we let rhs be the receiver of those method calls before
  # we check its indentation.
  rhs = first_part_of_call_chain(rhs)
  return unless rhs

  end_config = config.for_cop('Lint/EndAlignment')
  style = end_config['EnforcedStyleAlignWith'] || 'keyword'
  base = variable_alignment?(node.loc, rhs, style.to_sym) ? node : rhs

  return unless rhs.if_type?

  on_if(rhs, base)
  ignore_node(rhs)
end