Merge pull request #1687 from rubocop/receive-messages-has-unsafe-aut…

…ocorrection Declare autocorrect as unsafe for `RSpec/ReceiveMessages`
rubocop · Aug 7, 2023 · 7e4e0d9 · 7e4e0d9
2 parents 4071f9b + 233faf2
commit 7e4e0d9
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## Master (Unreleased)
 
 - Mark to `Safe: false` for `RSpec/Rails/NegationBeValid`  cop. ([@ydah])
+- Declare autocorrect as unsafe for `RSpec/ReceiveMessages`. ([@bquorning])
 
 ## 2.23.0 (2023-07-30)
 

diff --git a/config/default.yml b/config/default.yml
@@ -733,7 +733,9 @@ RSpec/ReceiveCounts:
 RSpec/ReceiveMessages:
   Description: Checks for multiple messages stubbed on the same object.
   Enabled: pending
+  SafeAutoCorrect: false
   VersionAdded: '2.23'
+  VersionChanged: "<<next>>"
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ReceiveMessages
 
 RSpec/ReceiveNever:

diff --git a/docs/modules/ROOT/pages/cops_rspec.adoc b/docs/modules/ROOT/pages/cops_rspec.adoc
@@ -4271,13 +4271,19 @@ expect(foo).to receive(:bar).at_most(:twice).times
 
 | Pending
 | Yes
-| Yes
+| Yes (Unsafe)
 | 2.23
-| -
+| <<next>>
 |===
 
 Checks for multiple messages stubbed on the same object.
 
+=== Safety
+
+The autocorrection is marked as unsafe, because it may change the
+order of stubs. This in turn may cause e.g. variables to be called
+before they are defined.
+
 === Examples
 
 [source,ruby]

diff --git a/lib/rubocop/cop/rspec/receive_messages.rb b/lib/rubocop/cop/rspec/receive_messages.rb
@@ -5,6 +5,11 @@ module Cop
     module RSpec
       # Checks for multiple messages stubbed on the same object.
       #
+      # @safety
+      #   The autocorrection is marked as unsafe, because it may change the
+      #   order of stubs. This in turn may cause e.g. variables to be called
+      #   before they are defined.
+      #
       # @example
       #   # bad
       #   before do