Add configuration option AllowNested to RSpec/MultipleExpectations

Fix: #379

CHANGELOG.md

@@ -15,6 +15,7 @@
 - Fix a false positive for `RSpec/ExpectActual` when used with rspec-rails routing matchers. ([@naveg])
 - Add new `RSpec/RepeatedSubjectCall` cop. ([@drcapulet])
 - Add configuration option `ResponseMethods` to `RSpec/Rails/HaveHttpStatus`. ([@ydah])
+- Add configuration option `AllowNested` to `RSpec/MultipleExpectations`. ([@ydah])
 
 ## 2.26.1 (2024-01-05)
 

config/default.yml

@@ -651,8 +651,9 @@ RSpec/MultipleExpectations:
   Description: Checks if examples contain too many `expect` calls.
   Enabled: true
   Max: 1
+  AllowNested: false
   VersionAdded: '1.7'
-  VersionChanged: '1.21'
+  VersionChanged: "<<next>>"
   StyleGuide: https://rspec.rubystyle.guide/#expectation-per-example
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/MultipleExpectations
 

docs/modules/ROOT/pages/cops_rspec.adoc

@@ -3415,7 +3415,7 @@ end
 | Yes
 | No
 | 1.7
-| 1.21
+| <<next>>
 |===
 
 Checks if examples contain too many `expect` calls.
@@ -3490,6 +3490,34 @@ describe UserCreator do
 end
 ----
 
+==== `AllowNested: false` (default)
+
+[source,ruby]
+----
+# bad
+describe UserCreator do
+  it 'raises an error' do
+    expect { my_code }.to raise_error(MyErrorType) do |error|
+      expect(error.message).to match /something went wrong/
+    end
+  end
+end
+----
+
+==== `AllowNested: true`
+
+[source,ruby]
+----
+# good
+describe UserCreator do
+  it 'raises an error' do
+    expect { my_code }.to raise_error(MyErrorType) do |error|
+      expect(error.message).to match /something went wrong/
+    end
+  end
+end
+----
+
 === Configurable attributes
 
 |===
@@ -3498,6 +3526,10 @@ end
 | Max
 | `1`
 | Integer
+
+| AllowNested
+| `false`
+| Boolean
 |===
 
 === References

lib/rubocop/cop/rspec/multiple_expectations.rb

@@ -61,6 +61,26 @@ module RSpec
       #     end
       #   end
       #
+      # @example `AllowNested: false` (default)
+      #   # bad
+      #   describe UserCreator do
+      #     it 'raises an error' do
+      #       expect { my_code }.to raise_error(MyErrorType) do |error|
+      #         expect(error.record.persisted?).to be(true)
+      #       end
+      #     end
+      #   end
+      #
+      # @example `AllowNested: true`
+      #   # good
+      #   describe UserCreator do
+      #     it 'raises an error' do
+      #       expect { my_code }.to raise_error(MyErrorType) do |error|
+      #         expect(error.record.persisted?).to be(true)
+      #       end
+      #     end
+      #   end
+      #
       class MultipleExpectations < Base
         include ConfigurableMax
 
@@ -119,6 +139,8 @@ def find_expectation(node, &block)
           # do not search inside of aggregate_failures block
           return if aggregate_failures_block?(node)
 
+          return if node.block_type? && allow_nested?
+
           node.each_child_node do |child|
             find_expectation(child, &block)
           end
@@ -138,6 +160,10 @@ def flag_example(node, expectation_count:)
         def max_expectations
           Integer(cop_config.fetch('Max', 1))
         end
+
+        def allow_nested?
+          cop_config.fetch('AllowNested', false)
+        end
       end
     end
   end

spec/rubocop/cop/rspec/multiple_expectations_spec.rb

@@ -238,6 +238,39 @@
     end
   end
 
+  context 'with `AllowNested: false`' do
+    let(:cop_config) { { 'AllowNested' => false } }
+
+    it 'flags nested expects' do
+      expect_offense(<<~RUBY)
+        describe Foo do
+          it 'uses expect with block twice' do
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Example has too many expectations [2/1].
+            expect { my_code }.to raise_error(MyErrorType) do |error|
+              expect(error.record.persisted?).to be(true)
+            end
+          end
+        end
+      RUBY
+    end
+  end
+
+  context 'with `AllowNested: true`' do
+    let(:cop_config) { { 'AllowNested' => true } }
+
+    it 'ignores nested expects' do
+      expect_no_offenses(<<~RUBY)
+        describe Foo do
+          it 'uses expect with block twice' do
+            expect { my_code }.to raise_error(MyErrorType) do |error|
+              expect(error.record.persisted?).to be(true)
+            end
+          end
+        end
+      RUBY
+    end
+  end
+
   it 'generates a todo based on the worst offense' do
     inspect_source(<<~RUBY, 'spec/foo_spec.rb')
       describe Foo do