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 `%s` will raise a `TypeError` instead of ' \
'catching the actual exception.'.freeze
INVALID_TYPES = 
%i[array dstr float hash nil int str sym].freeze

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 RescueNode

#investigate, #rescue_modifier?

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?, 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

#autocorrect(node) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/rubocop/cop/lint/rescue_type.rb', line 56

def autocorrect(node)
  rescued, _, _body = *node
  exceptions = *rescued
  valid_exceptions = exceptions - invalid_exceptions(exceptions)
  correction = valid_exceptions.map(&:source).join(', ')
  correction = " #{correction}" unless correction.empty?
  range = Parser::Source::Range.new(node.loc.expression,
                                    node.loc.keyword.end_pos,
                                    rescued.loc.expression.end_pos)

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

#on_resbody(node) ⇒ Object 



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