Class: RuboCop::Cop::Style::RescueStandardError

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
ConfigurableEnforcedStyle, RangeHelp, RescueNode
Defined in:
lib/rubocop/cop/style/rescue_standard_error.rb

Overview

Checks for rescuing StandardError. There are two supported styles implicit and explicit. This cop will not register an offense if any error other than StandardError is specified.

Examples:

EnforcedStyle: explicit (default)

# `explicit` will enforce using `rescue StandardError`
# instead of `rescue`.

# bad
begin
  foo
rescue
  bar
end

# good
begin
  foo
rescue StandardError
  bar
end

# good
begin
  foo
rescue OtherError
  bar
end

# good
begin
  foo
rescue StandardError, SecurityError
  bar
end

EnforcedStyle: implicit

# `implicit` will enforce using `rescue` instead of
# `rescue StandardError`.

# bad
begin
  foo
rescue StandardError
  bar
end

# good
begin
  foo
rescue
  bar
end

# good
begin
  foo
rescue OtherError
  bar
end

# good
begin
  foo
rescue StandardError, SecurityError
  bar
end

Constant Summary collapse

MSG_IMPLICIT = 
'Omit the error class when rescuing `StandardError` by itself.'
MSG_EXPLICIT = 
'Avoid rescuing without specifying an error class.'

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 included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_configured?, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods included from RescueNode

#modifier_locations

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #begin_investigation, 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, #inspect, 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?, #autocorrect_with_disable_uncorrectable?, #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

#on_resbody(node) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/rubocop/cop/style/rescue_standard_error.rb', line 92

def on_resbody(node)
  return if rescue_modifier?(node)

  case style
  when :implicit
    rescue_standard_error?(node) do |error|
      offense_for_implicit_enforced_style(node, error)
    end
  when :explicit
    rescue_without_error_class?(node) { offense_for_explicit_enforced_style(node) }
  end
end

#rescue_standard_error?(node) ⇒ Object 



88
89
90
 
# File 'lib/rubocop/cop/style/rescue_standard_error.rb', line 88

def_node_matcher :rescue_standard_error?, <<~PATTERN
  (resbody $(array (const {nil? cbase} :StandardError)) _ _)
PATTERN

#rescue_without_error_class?(node) ⇒ Object 



83
84
85
 
# File 'lib/rubocop/cop/style/rescue_standard_error.rb', line 83

def_node_matcher :rescue_without_error_class?, <<~PATTERN
  (resbody nil? _ _)
PATTERN