Class: RuboCop::Cop::Lint::RaiseException

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

Overview

This cop checks for `raise` or `fail` statements which are raising `Exception` class.

You can specify a module name that will be an implicit namespace using `AllowedImplicitNamespaces` option. The cop cause a false positive for namespaced `Exception` when a namespace is omitted. This option can prevent the false positive by specifying a namespace to be omitted for `Exception`. Alternatively, make `Exception` a fully qualified class name with an explicit namespace.

Examples:

# bad
raise Exception, 'Error message here'

# good
raise StandardError, 'Error message here'

AllowedImplicitNamespaces: ['Gem']

# good
module Gem
  def self.foo
    raise Exception # This exception means `Gem::Exception`.
  end
end

Constant Summary collapse

MSG =
'Use `StandardError` over `Exception`.'
RESTRICT_ON_SEND =
%i[raise fail].freeze

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

#exception?(node) ⇒ Object


37
38
39
# File 'lib/rubocop/cop/lint/raise_exception.rb', line 37

def_node_matcher :exception?, <<~PATTERN
  (send nil? {:raise :fail} $(const ${cbase nil?} :Exception) ... )
PATTERN

#exception_new_with_message?(node) ⇒ Object


42
43
44
45
# File 'lib/rubocop/cop/lint/raise_exception.rb', line 42

def_node_matcher :exception_new_with_message?, <<~PATTERN
  (send nil? {:raise :fail}
    (send $(const ${cbase nil?} :Exception) :new ... ))
PATTERN

#on_send(node) ⇒ Object


47
48
49
# File 'lib/rubocop/cop/lint/raise_exception.rb', line 47

def on_send(node)
  exception?(node, &check(node)) || exception_new_with_message?(node, &check(node))
end