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

Inherits:
Cop
  • Object
show all
Includes:
RescueNode
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 included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from RescueNode

#investigate

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, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

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 AST::Sexp

#s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object


62
63
64
65
66
67
68
69
70
71
# File 'lib/rubocop/cop/lint/rescue_type.rb', line 62

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

  lambda do |corrector|
    corrector.replace(range, correction(*rescued))
  end
end

#on_resbody(node) ⇒ Object


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# 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,
    location: node.loc.keyword.join(rescued.loc.expression),
    message: format(
      MSG, invalid_exceptions: invalid_exceptions.map(&:source)
                                                 .join(', ')
    )
  )
end