class RuboCop::Cop::Lint::ShadowedException

This cop checks for a rescued exception that get shadowed by a less specific exception being rescued before a more specific exception is rescued.

@example

# bad

begin
  something
rescue Exception
  handle_exception
rescue StandardError
  handle_standard_error
end

# good

begin
  something
rescue StandardError
  handle_standard_error
rescue Exception
  handle_exception
end

# good, however depending on runtime environment.
#
# This is a special case for system call errors.
# System dependent error code depends on runtime environment.
# For example, whether `Errno::EAGAIN` and `Errno::EWOULDBLOCK` are
# the same error code or different error code depends on environment.
# This good case is for `Errno::EAGAIN` and `Errno::EWOULDBLOCK` with
# the same error code.
begin
  something
rescue Errno::EAGAIN, Errno::EWOULDBLOCK
  handle_standard_error
end

Constants

MSG

Public Instance Methods

on_rescue(node) click to toggle source
# File lib/rubocop/cop/lint/shadowed_exception.rb, line 51
def on_rescue(node)
  return if rescue_modifier?(node)
  _body, *rescues, _else = *node
  rescued_groups = rescues.each_with_object([]) do |group, exceptions|
    rescue_group, = *group

    exceptions << evaluate_exceptions(rescue_group)
  end

  rescue_group_rescues_multiple_levels = rescued_groups.any? do |group|
    contains_multiple_levels_of_exceptions?(group)
  end

  return if !rescue_group_rescues_multiple_levels &&
            sorted?(rescued_groups)

  add_offense(node, location: offense_range(rescues))
end

Private Instance Methods

compare_exceptions(exception, other_exception) click to toggle source
# File lib/rubocop/cop/lint/shadowed_exception.rb, line 98
def compare_exceptions(exception, other_exception)
  if system_call_err?(exception) && system_call_err?(other_exception)
    # This condition logic is for special case.
    # System dependent error code depends on runtime environment.
    # For example, whether `Errno::EAGAIN` and `Errno::EWOULDBLOCK` are
    # the same error code or different error code depends on runtime
    # environment. This checks the error code for that.
    exception.const_get(:Errno) != other_exception.const_get(:Errno) &&
      exception <=> other_exception
  else
    exception && other_exception && exception <=> other_exception
  end
end
contains_multiple_levels_of_exceptions?(group) click to toggle source
# File lib/rubocop/cop/lint/shadowed_exception.rb, line 86
def contains_multiple_levels_of_exceptions?(group)
  if group.size > 1 && group.include?(Exception)
    # Treat `Exception` as the highest level exception unless `nil` was
    # also rescued
    return !(group.size == 2 && group.include?(NilClass))
  end

  group.combination(2).any? do |a, b|
    compare_exceptions(a, b)
  end
end
evaluate_exceptions(rescue_group) click to toggle source
# File lib/rubocop/cop/lint/shadowed_exception.rb, line 116
def evaluate_exceptions(rescue_group)
  if rescue_group
    rescued_exceptions = rescued_exceptions(rescue_group)
    rescued_exceptions.each_with_object([]) do |exception, converted|
      begin
        converted << Kernel.const_get(exception)
      rescue NameError
        converted << nil
      end
    end
  else
    # treat an empty `rescue` as `rescue StandardError`
    [StandardError]
  end
end
offense_range(rescues) click to toggle source
# File lib/rubocop/cop/lint/shadowed_exception.rb, line 72
def offense_range(rescues)
  first_rescue = rescues.first
  last_rescue = rescues.last
  last_exceptions, = *last_rescue
  # last_rescue clause may not specify exception class
  end_pos = if last_exceptions
              last_exceptions.loc.expression.end_pos
            else
              last_rescue.loc.keyword.end_pos
            end

  range_between(first_rescue.loc.expression.begin_pos, end_pos)
end
rescued_exceptions(rescue_group) click to toggle source

@param [RuboCop::AST::Node] rescue_group is a node of array_type

# File lib/rubocop/cop/lint/shadowed_exception.rb, line 149
def rescued_exceptions(rescue_group)
  klasses = *rescue_group
  klasses.map do |klass|
    next unless klass.const_type?
    klass.source
  end.compact
end
sorted?(rescued_groups) click to toggle source
# File lib/rubocop/cop/lint/shadowed_exception.rb, line 132
def sorted?(rescued_groups)
  rescued_groups.each_cons(2).all? do |x, y|
    if x.include?(Exception)
      false
    elsif y.include?(Exception)
      true
    elsif x.none? || y.none?
      # consider sorted if a group is empty or only contains
      # `nil`s
      true
    else
      (x <=> y || 0) <= 0
    end
  end
end
system_call_err?(error) click to toggle source
# File lib/rubocop/cop/lint/shadowed_exception.rb, line 112
def system_call_err?(error)
  error && error.ancestors[1] == SystemCallError
end