Class: RuboCop::Cop::RSpec::UnspecifiedException

Inherits:
Base
  • Object
show all
Defined in:
lib/rubocop/cop/rspec/unspecified_exception.rb

Overview

Checks for a specified error in checking raised errors.

Enforces one of an Exception type, a string, or a regular expression to match against the exception message as a parameter to ‘raise_error`

Examples:

# bad
expect {
  raise StandardError.new('error')
}.to raise_error

# good
expect {
  raise StandardError.new('error')
}.to raise_error(StandardError)

expect {
  raise StandardError.new('error')
}.to raise_error('error')

expect {
  raise StandardError.new('error')
}.to raise_error(/err/)

expect { do_something }.not_to raise_error

Constant Summary collapse

MSG =
'Specify the exception being captured'
RESTRICT_ON_SEND =
%i[
  raise_exception
  raise_error
].freeze

Instance Method Summary collapse

Methods inherited from Base

inherited, #on_new_investigation

Methods included from RSpec::Language

#example?, #example_group?, #example_group_with_body?, #explicit_rspec?, #hook?, #include?, #let?, #rspec?, #shared_group?, #spec_group?, #subject?

Instance Method Details

#expect_to?(node) ⇒ Object



42
43
44
# File 'lib/rubocop/cop/rspec/unspecified_exception.rb', line 42

def_node_matcher :expect_to?, <<~PATTERN
  (send (block (send nil? :expect) ...) :to ...)
PATTERN

#on_send(node) ⇒ Object



46
47
48
49
50
# File 'lib/rubocop/cop/rspec/unspecified_exception.rb', line 46

def on_send(node)
  return unless empty_exception_matcher?(node)

  add_offense(node)
end