# frozen_string_literal: true module RuboCop module Cop module Lint # 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. # # @example EnforcedStyle: runtime_error (default) # # bad # # class C < Exception; end # # # good # # class C < RuntimeError; end # # @example EnforcedStyle: standard_error # # bad # # class C < Exception; end # # # good # # class C < StandardError; end class InheritException < Cop include ConfigurableEnforcedStyle MSG = 'Inherit from `%s` instead of `%s`.'.freeze 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 def on_class(node) _class, base_class, _body = *node return unless base_class && illegal_class_name?(base_class) add_offense(base_class) end def autocorrect(node) lambda do |corrector| corrector.replace(node.loc.expression, preferred_base_class) end end private def message(node) format(MSG, prefer: preferred_base_class, current: node.const_name) end def illegal_class_name?(class_node) ILLEGAL_CLASSES.include?(class_node.const_name) end def preferred_base_class PREFERRED_BASE_CLASS[style] end end end end end