Mark RSpec/Rails/TravelAround as Safe: false

rubocop · Dec 2, 2022 · fdb58d0 · fdb58d0
1 parent a8dadcd
commit fdb58d0
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 6 deletions.
diff --git a/config/default.yml b/config/default.yml
@@ -1049,6 +1049,6 @@ RSpec/Rails/HttpStatus:
 RSpec/Rails/TravelAround:
   Description: Prefer to travel in `before` rather than `around`.
   Enabled: pending
-  SafeAutoCorrect: false
+  Safe: false
   VersionAdded: "<<next>>"
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Rails/TravelAround
diff --git a/docs/modules/ROOT/pages/cops_rspec_rails.adoc b/docs/modules/ROOT/pages/cops_rspec_rails.adoc
@@ -211,7 +211,7 @@ end
 | Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
 
 | Pending
-| Yes
+| No
 | Yes (Unsafe)
 | <<next>>
 | -
@@ -221,8 +221,12 @@ Prefer to travel in `before` rather than `around`.
 
 === Safety
 
-This cop's autocorrection is unsafe because the order of execution
-will change if other steps exist before traveling in `around`.
+This cop is unsafe because the automatic `travel_back` is only run
+on test cases that are considered as Rails related.
+
+And also, this cop's autocorrection is unsafe because the order of
+execution will change if other steps exist before traveling in
+`around`.
 
 === Examples
 

diff --git a/lib/rubocop/cop/rspec/rails/travel_around.rb b/lib/rubocop/cop/rspec/rails/travel_around.rb
@@ -7,8 +7,12 @@ module Rails
         # Prefer to travel in `before` rather than `around`.
         #
         # @safety
-        #   This cop's autocorrection is unsafe because the order of execution
-        #   will change if other steps exist before traveling in `around`.
+        #   This cop is unsafe because the automatic `travel_back` is only run
+        #   on test cases that are considered as Rails related.
+        #
+        #   And also, this cop's autocorrection is unsafe because the order of
+        #   execution will change if other steps exist before traveling in
+        #   `around`.
         #
         # @example
         #   # bad