Class: RuboCop::Cop::Lint::InheritException

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

Overview

This cop looks for error classes inheriting from `Exception` and its standard library subclasses, excluding subclasses of `StandardError`. It is configurable to suggest using either `RuntimeError` (default) or `StandardError` instead.

Examples:

EnforcedStyle: runtime_error (default)

# bad

class C < Exception; end

C = Class.new(Exception)

# good

class C < RuntimeError; end

C = Class.new(RuntimeError)

EnforcedStyle: standard_error

# bad

class C < Exception; end

C = Class.new(Exception)

# good

class C < StandardError; end

C = Class.new(StandardError)

Constant Summary collapse

MSG =
'Inherit from `%<prefer>s` instead of `%<current>s`.'
PREFERRED_BASE_CLASS =
{
  runtime_error: 'RuntimeError',
  standard_error: 'StandardError'
}.freeze
ILLEGAL_CLASSES =
%w[
  Exception
  SystemStackError
  NoMemoryError
  SecurityError
  NotImplementedError
  LoadError
  SyntaxError
  ScriptError
  Interrupt
  SignalException
  SystemExit
].freeze
RESTRICT_ON_SEND =
%i[new].freeze

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

#class_new_call?(node) ⇒ Object


62
63
64
65
66
# File 'lib/rubocop/cop/lint/inherit_exception.rb', line 62

def_node_matcher :class_new_call?, <<~PATTERN
  (send
    (const {cbase nil?} :Class) :new
    $(const {cbase nil?} _))
PATTERN

#on_class(node) ⇒ Object


68
69
70
71
72
73
74
75
76
# File 'lib/rubocop/cop/lint/inherit_exception.rb', line 68

def on_class(node)
  return unless node.parent_class && illegal_class_name?(node.parent_class)

  message = message(node.parent_class)

  add_offense(node.parent_class, message: message) do |corrector|
    corrector.replace(node.parent_class, preferred_base_class)
  end
end

#on_send(node) ⇒ Object


78
79
80
81
82
83
84
85
86
87
# File 'lib/rubocop/cop/lint/inherit_exception.rb', line 78

def on_send(node)
  constant = class_new_call?(node)
  return unless constant && illegal_class_name?(constant)

  message = message(constant)

  add_offense(constant, message: message) do |corrector|
    corrector.replace(constant, preferred_base_class)
  end
end