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

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::AutoCorrector, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/lint/raise_exception.rb


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.


# 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`.

Cop Safety Information:

  • This cop is unsafe because it will change the exception class being raised, which is a change in behavior.

Constant Summary

::RuboCop::Cop::Base - Inherited


Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,

Returns if class supports autocorrect.


Override if your cop should be called repeatedly for multiple investigations Between calls to on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::RuboCop::Cop::Base - Inherited


List of cops that should not try to autocorrect at the same time as this cop.



.callbacks_needed, .cop_name, .department,

Returns an url to view this cops documentation online.


Call for abstract Cop classes.


Override and return the Force class(es) you need to join.


Returns true if the cop name or the cop namespace matches any of the given names.


Register a version requirement for the given gem name.


::RuboCop::ExcludeLimit - Extended


Sets up a configuration option to have an exclude limit tracked.


Instance Attribute Summary

Instance Method Summary

::RuboCop::Cop::Base - Inherited


Adds an offense that has no particular location.


Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.


Called before any investigation.


Configuration Helpers.

#cop_name, #excluded_file?,

This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:


Gets called if no message is specified when calling add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.


Alias for Base#cop_name.


Called after all on_…​


Called before all on_…​


Called instead of all on_…​


There should be very limited reasons for a Cop to do it’s own parsing.


Called between investigations.

#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,

Reserved for Cop::Cop.


Called to complete an investigation.

#correct, #current_corrector,

Reserved for Commissioner:

#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,

Actually private methods.


::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

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

Instance Method Details

#allow_implicit_namespaces (private)

[ GitHub ]

# File 'lib/rubocop/cop/lint/raise_exception.rb', line 85

def allow_implicit_namespaces
  cop_config['AllowedImplicitNamespaces'] || []

#check(node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/lint/raise_exception.rb', line 57

def check(node)
  lambda do |exception_class, cbase|
    return if cbase.nil? && implicit_namespace?(node)

    add_offense(exception_class) do |corrector|
      prefer_exception = if exception_class.children.first&.cbase_type?

      corrector.replace(exception_class, prefer_exception)


[ GitHub ]

# File 'lib/rubocop/cop/lint/raise_exception.rb', line 41

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


[ GitHub ]

# File 'lib/rubocop/cop/lint/raise_exception.rb', line 46

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

#implicit_namespace?(node) ⇒ Boolean (private)

[ GitHub ]

# File 'lib/rubocop/cop/lint/raise_exception.rb', line 73

def implicit_namespace?(node)
  return false unless (parent = node.parent)

  if parent.module_type?
    namespace = parent.identifier.source

    return allow_implicit_namespaces.include?(namespace)



[ GitHub ]

# File 'lib/rubocop/cop/lint/raise_exception.rb', line 51

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