Merge pull request #1918 from Earlopain/invalid-autocorrect-scattered-setup

[Fix #1913] Fix broken autocorrect for `RSpec/ScatteredSetup` when block contains heredoc

Author: Darhazer

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Master (Unreleased)
 
+- Fix wrong autocorrect for `RSpec/ScatteredSetup` when hook contains heredoc. ([@earlopain])
+
 ## 3.0.1 (2024-06-11)
 
 - Bump RuboCop requirement to +1.61. ([@ydah])

lib/rubocop/cop/rspec/scattered_setup.rb

@@ -23,6 +23,7 @@ module RSpec
       #   end
       #
       class ScatteredSetup < Base
+        include FinalEndLocation
         include RangeHelp
         extend AutoCorrector
 
@@ -75,8 +76,13 @@ def message(occurrences, occurrence)
         def autocorrect(corrector, first_occurrence, occurrence)
           return if first_occurrence == occurrence || !first_occurrence.body
 
+          # Take heredocs into account
+          body = occurrence.body&.source_range&.with(
+            end_pos: final_end_location(occurrence).begin_pos
+          )
+
           corrector.insert_after(first_occurrence.body,
-                                 "\n#{occurrence.body&.source}")
+                                 "\n#{body&.source}")
           corrector.remove(range_by_whole_lines(occurrence.source_range,
                                                 include_final_newline: true))
         end

spec/rubocop/cop/rspec/scattered_setup_spec.rb

@@ -14,7 +14,7 @@
     expect_correction(<<~RUBY)
       describe Foo do
         before { bar
-      baz }
+      baz  }
       end
     RUBY
   end
@@ -34,8 +34,8 @@
     expect_correction(<<~RUBY)
       describe Foo do
         after { bar
-      baz
-      baz }
+      baz#{' '}
+      baz  }
       end
     RUBY
   end
@@ -53,7 +53,7 @@
     expect_correction(<<~RUBY)
       describe Foo do
         before(:all) { bar
-      baz }
+      baz  }
       end
     RUBY
   end
@@ -143,9 +143,9 @@
     expect_correction(<<~RUBY)
       describe Foo do
         before(:each, :special_case) { foo
-      bar
-      bar
-      bar }
+      bar#{' '}
+      bar#{' '}
+      bar  }
         before(:example, special_case: false) { bar }
       end
     RUBY
@@ -168,4 +168,29 @@
       end
     RUBY
   end
+
+  it 'flags hooks that contain heredoc arguments and autocorrects correctly' do
+    expect_offense(<<~RUBY)
+      describe Foo do
+        before { foo }
+        ^^^^^^^^^^^^^^ Do not define multiple `before` hooks in the same example group (also defined on line 3).
+        before do
+        ^^^^^^^^^ Do not define multiple `before` hooks in the same example group (also defined on line 2).
+          bar(<<~'TEXT')
+            Hello World!
+          TEXT
+        end
+      end
+    RUBY
+
+    expect_correction(<<~RUBY)
+      describe Foo do
+        before { foo
+      bar(<<~'TEXT')
+            Hello World!
+          TEXT
+         }
+      end
+    RUBY
+  end
 end