Class: RuboCop::Cop::Style::ImplicitRuntimeError

Inherits:
Base
  • Object
show all
Defined in:
lib/rubocop/cop/style/implicit_runtime_error.rb

Overview

Checks for ‘raise` or `fail` statements which do not specify an explicit exception class. (This raises a `RuntimeError`. Some projects might prefer to use exception classes which more precisely identify the nature of the error.)

Examples:

# bad
raise 'Error message here'

# good
raise ArgumentError, 'Error message here'

Constant Summary collapse

MSG = 
'Use `%<method>s` with an explicit exception class and message, ' \
'rather than just a message.'
RESTRICT_ON_SEND = 
%i[raise fail].freeze

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #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, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, 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

#implicit_runtime_error_raise_or_fail(node) ⇒ Object 



23
24
 
# File 'lib/rubocop/cop/style/implicit_runtime_error.rb', line 23

def_node_matcher :implicit_runtime_error_raise_or_fail,
'(send nil? ${:raise :fail} {str dstr})'

#on_send(node) ⇒ Object 



26
27
28
29
30
 
# File 'lib/rubocop/cop/style/implicit_runtime_error.rb', line 26

def on_send(node)
  implicit_runtime_error_raise_or_fail(node) do |method|
    add_offense(node, message: format(MSG, method: method))
  end
end