Merge pull request #2073 from rubocop/1943

Change `RSpec/ScatteredSetup` to allow `around` hooks to be scattered

Author: ydah

CHANGELOG.md

@@ -5,6 +5,7 @@
 - Fix false positive in `RSpec/Pending`, where it would mark the default block `it` as an offense. ([@bquorning])
 - Fix issue when `Style/ContextWording` is configured with a Prefix being interpreted as a boolean, like `on`. ([@sakuro])
 - Add new `RSpec/IncludeExamples` cop to enforce using `it_behaves_like` over `include_examples`. ([@dvandersluis])
+- Change `RSpec/ScatteredSetup` to allow `around` hooks to be scattered. ([@ydah])
 
 ## 3.5.0 (2025-02-16)
 

docs/modules/ROOT/pages/cops_rspec.adoc

@@ -5524,7 +5524,9 @@ end
 
 Checks for setup scattered across multiple hooks in an example group.
 
-Unify `before`, `after`, and `around` hooks when possible.
+Unify `before` and `after` hooks when possible.
+However, `around` hooks are allowed to be defined multiple times,
+as unifying them would typically make the code harder to read.
 
 [#examples-rspecscatteredsetup]
 === Examples
@@ -5544,6 +5546,12 @@ describe Foo do
     setup2
   end
 end
+
+# good
+describe Foo do
+  around { |example| before1; example.call; after1 }
+  around { |example| before2; example.call; after2 }
+end
 ----
 
 [#references-rspecscatteredsetup]

lib/rubocop/cop/rspec/scattered_setup.rb

@@ -5,7 +5,9 @@ module Cop
     module RSpec
       # Checks for setup scattered across multiple hooks in an example group.
       #
-      # Unify `before`, `after`, and `around` hooks when possible.
+      # Unify `before` and `after` hooks when possible.
+      # However, `around` hooks are allowed to be defined multiple times,
+      # as unifying them would typically make the code harder to read.
       #
       # @example
       #   # bad
@@ -22,6 +24,12 @@ module RSpec
       #     end
       #   end
       #
+      #   # good
+      #   describe Foo do
+      #     around { |example| before1; example.call; after1 }
+      #     around { |example| before2; example.call; after2 }
+      #   end
+      #
       class ScatteredSetup < Base
         include FinalEndLocation
         include RangeHelp
@@ -48,7 +56,7 @@ def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
         def repeated_hooks(node)
           hooks = RuboCop::RSpec::ExampleGroup.new(node)
             .hooks
-            .select(&:knowable_scope?)
+            .select { |hook| hook.knowable_scope? && hook.name != :around }
             .group_by { |hook| [hook.name, hook.scope, hook.metadata] }
             .values
             .reject(&:one?)

spec/rubocop/cop/rspec/scattered_setup_spec.rb

@@ -58,6 +58,15 @@
     RUBY
   end
 
+  it 'ignores around hooks' do
+    expect_no_offenses(<<~RUBY)
+      describe Foo do
+        around { bar }
+        around { baz }
+      end
+    RUBY
+  end
+
   it 'ignores different hooks' do
     expect_no_offenses(<<~RUBY)
       describe Foo do