Merge pull request #2097 from lovro-bikic/rspec-dialect-error-matchers

Author: bquorning

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - Mark `RSpec/IncludeExamples` as `SafeAutoCorrect: false`. ([@yujideveloper])
 - Fix a false positive for `RSpec/LeakyConstantDeclaration` when defining constants in explicit namespaces. ([@naveg])
+- Add support for error matchers (`raise_exception` and `raise_error`) to `RSpec/Dialect`. ([@lovro-bikic])
 
 ## 3.6.0 (2025-04-18)
 

config/default.yml

@@ -79,6 +79,9 @@ RSpec:
       - prepend_after
       - after
       - append_after
+    ErrorMatchers:
+      - raise_error
+      - raise_exception
     Includes:
       inherit_mode:
         merge:

docs/modules/ROOT/pages/cops_rspec.adoc

@@ -1160,6 +1160,7 @@ A dialect can be based on the following RSpec methods:
 - let, let!
 - subject, subject!
 - expect, is_expected, expect_any_instance_of
+- raise_error, raise_exception
 
 By default all of the RSpec methods and aliases are allowed. By setting
 a config like:

lib/rubocop/cop/rspec/dialect.rb

@@ -21,6 +21,7 @@ module RSpec
       # - let, let!
       # - subject, subject!
       # - expect, is_expected, expect_any_instance_of
+      # - raise_error, raise_exception
       #
       # By default all of the RSpec methods and aliases are allowed. By setting
       # a config like:

lib/rubocop/rspec/language.rb

@@ -72,6 +72,12 @@ class << self
       # @!method subject?(node)
       def_node_matcher :subject?, '(block (send nil? #Subjects.all ...) ...)'
 
+      module ErrorMatchers # :nodoc:
+        def self.all(element)
+          Language.config['ErrorMatchers'].include?(element.to_s)
+        end
+      end
+
       module ExampleGroups # :nodoc:
         class << self
           def all(element)
@@ -200,14 +206,14 @@ def self.all(element)
       # This is used in Dialect and DescribeClass cops to detect RSpec blocks.
       module ALL # :nodoc:
         def self.all(element)
-          [ExampleGroups, Examples, Expectations, Helpers, Hooks, Includes,
-           Runners, SharedGroups, Subjects]
+          [ErrorMatchers, ExampleGroups, Examples, Expectations, Helpers, Hooks,
+           Includes, Runners, SharedGroups, Subjects]
             .find { |concept| concept.all(element) }
         end
       end
 
-      private_constant :ExampleGroups, :Examples, :Expectations, :Hooks,
-                       :Includes, :Runners, :SharedGroups, :ALL
+      private_constant :ErrorMatchers, :ExampleGroups, :Examples, :Expectations,
+                       :Hooks, :Includes, :Runners, :SharedGroups, :ALL
     end
   end
 end

spec/rubocop/cop/rspec/dialect_spec.rb

@@ -73,4 +73,29 @@
       RUBY
     end
   end
+
+  context 'with error matchers config' do
+    let(:cop_config) do
+      {
+        'PreferredMethods' => {
+          'raise_exception' => 'raise_error'
+        }
+      }
+    end
+
+    it 'registers an offense for `raise_exception`' do
+      expect_offense(<<~RUBY)
+        it 'raises an error' do
+          expect { subject }.to raise_exception(StandardError)
+                                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer `raise_error` over `raise_exception`.
+        end
+      RUBY
+
+      expect_correction(<<~RUBY)
+        it 'raises an error' do
+          expect { subject }.to raise_error(StandardError)
+        end
+      RUBY
+    end
+  end
 end