Merge pull request #1697 from marocchino/fix-receive-messages-autocor…

…rect

Fix autocorrect in `RSpec/ReceiveMessages`

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Master (Unreleased)
 
 - Fix an infinite loop error when `RSpec/ExcessiveDocstringSpacing` finds a description with non-ASCII leading/trailing whitespace. ([@bcgraham])
+- Fix an incorrect autocorrect for `RSpec/ReceiveMessages` when return values declared between stubs. ([@marocchino])
 
 ## 2.23.2 (2023-08-09)
 

lib/rubocop/cop/rspec/receive_messages.rb

@@ -124,7 +124,7 @@ def normalize_return_arg(return_arg)
 
         def register_offense(item, repeated_lines, args)
           add_offense(item, message: message(repeated_lines)) do |corrector|
-            if item.loc.line < repeated_lines.min
+            if item.loc.line > repeated_lines.max
               replace_to_receive_messages(corrector, item, args)
             else
               corrector.remove(item_range_by_whole_lines(item))

spec/rubocop/cop/rspec/receive_messages_spec.rb

@@ -181,9 +181,31 @@
 
     expect_correction(<<~RUBY)
       before do
-        allow(Service).to receive_messages(foo: 1, bar: 2)
         calling_some_method
         calling_another_method
+        allow(Service).to receive_messages(foo: 1, bar: 2)
+      end
+    RUBY
+  end
+
+  it 'registers an offense when multiple messeages stubbed on the ' \
+     'same object and initialize return value between stubs' do
+    expect_offense(<<~RUBY)
+      before do
+        foo = Service.new
+        allow(Service).to receive(:foo).and_return(foo)
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `receive_messages` instead of multiple stubs on lines [5].
+        bar = Service.new
+        allow(Service).to receive(:bar).and_return(bar)
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `receive_messages` instead of multiple stubs on lines [3].
+      end
+    RUBY
+
+    expect_correction(<<~RUBY)
+      before do
+        foo = Service.new
+        bar = Service.new
+        allow(Service).to receive_messages(foo: foo, bar: bar)
       end
     RUBY
   end
@@ -267,8 +289,8 @@
     expect_correction(<<~RUBY)
       before do
         allow(Service).to receive(:foo).and_return(bar)
-        allow(Service).to receive_messages(bar: qux, baz: qux)
         allow(Service).to receive(:foo).and_return(qux)
+        allow(Service).to receive_messages(bar: qux, baz: qux)
       end
     RUBY
   end