Class: RuboCop::Cop::Lint::RescueType

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Defined in:
lib/rubocop/cop/lint/rescue_type.rb

Overview

Check for arguments to `rescue` that will result in a `TypeError` if an exception is raised.

Examples:

# bad
begin
  bar
rescue nil
  baz
end

# bad
def foo
  bar
rescue 1, 'a', "#{b}", 0.0, [], {}
  baz
end

# good
begin
  bar
rescue
  baz
end

# good
def foo
  bar
rescue NameError
  baz
end

Constant Summary collapse

MSG =
'Rescuing from `%<invalid_exceptions>s` will raise a ' \
'`TypeError` instead of catching the actual exception.'
INVALID_TYPES =
%i[array dstr float hash nil int str sym].freeze

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#autocorrect(corrector, node) ⇒ Object


60
61
62
63
64
65
66
67
# File 'lib/rubocop/cop/lint/rescue_type.rb', line 60

def autocorrect(corrector, node)
  rescued, _, _body = *node
  range = Parser::Source::Range.new(node.loc.expression.source_buffer,
                                    node.loc.keyword.end_pos,
                                    rescued.loc.expression.end_pos)

  corrector.replace(range, correction(*rescued))
end

#on_resbody(node) ⇒ Object


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# File 'lib/rubocop/cop/lint/rescue_type.rb', line 44

def on_resbody(node)
  rescued, _, _body = *node
  return if rescued.nil?

  exceptions = *rescued
  invalid_exceptions = invalid_exceptions(exceptions)
  return if invalid_exceptions.empty?

  add_offense(
    node.loc.keyword.join(rescued.loc.expression),
    message: format(MSG, invalid_exceptions: invalid_exceptions.map(&:source).join(', '))
  ) do |corrector|
    autocorrect(corrector, node)
  end
end