Class: RuboCop::Cop::Style::RedundantException

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

Overview

This cop checks for RuntimeError as the argument of raise/fail.

It checks for code like this:

Examples:

# Bad
raise RuntimeError, 'message'

# Bad
raise RuntimeError.new('message')

# Good
raise 'message'

Constant Summary collapse

MSG_1 =
'Redundant `RuntimeError` argument can be removed.'
MSG_2 =
'Redundant `RuntimeError.new` call can be replaced with just the message.'
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

#compact?(node) ⇒ Object


59
60
61
# File 'lib/rubocop/cop/style/redundant_exception.rb', line 59

def_node_matcher :compact?, <<~PATTERN
  (send nil? {:raise :fail} $(send (const {nil? cbase} :RuntimeError) :new $_))
PATTERN

#exploded?(node) ⇒ Object


54
55
56
# File 'lib/rubocop/cop/style/redundant_exception.rb', line 54

def_node_matcher :exploded?, <<~PATTERN
  (send nil? ${:raise :fail} (const {nil? cbase} :RuntimeError) $_)
PATTERN

#fix_compact(node) ⇒ Object


45
46
47
48
49
50
51
# File 'lib/rubocop/cop/style/redundant_exception.rb', line 45

def fix_compact(node)
  compact?(node) do |new_call, message|
    add_offense(node, message: MSG_2) do |corrector|
      corrector.replace(new_call, message.source)
    end
  end
end

#fix_exploded(node) ⇒ Object


33
34
35
36
37
38
39
40
41
42
43
# File 'lib/rubocop/cop/style/redundant_exception.rb', line 33

def fix_exploded(node)
  exploded?(node) do |command, message|
    add_offense(node, message: MSG_1) do |corrector|
      if node.parenthesized?
        corrector.replace(node, "#{command}(#{message.source})")
      else
        corrector.replace(node, "#{command} #{message.source}")
      end
    end
  end
end

#on_send(node) ⇒ Object

Switch `raise RuntimeError, 'message'` to `raise 'message'`, and `raise RuntimeError.new('message')` to `raise 'message'`.


29
30
31
# File 'lib/rubocop/cop/style/redundant_exception.rb', line 29

def on_send(node)
  fix_exploded(node) || fix_compact(node)
end