Merge pull request #1725 from rubocop/fix-incorrect-autocorrect-https…

…tatus

Add support single quoted string and percent string and heredoc for `RSpec/Rails/HttpStatus`

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Master (Unreleased)
 
+- Add support single quoted string and percent string and heredoc for `RSpec/Rails/HttpStatus`. ([@ydah])
+
 ## 2.24.1 (2023-09-23)
 
 - Fix an error when using `RSpec/FilePath` and revert to enabled by default. If you have already moved to `RSpec/SpecFilePathSuffix` and `RSpec/SpecFilePathFormat`, disable `RSpec/FilePath` explicitly as `Enabled: false`. The `RSpec/FilePath` before migration and the `RSpec/SpecFilePathSuffix` and `RSpec/SpecFilePathFormat` as the target are available respectively. ([@ydah])

lib/rubocop/cop/rspec/rails/http_status.rb

@@ -66,6 +66,8 @@ class HttpStatus < Base
 
           def on_send(node)
             http_status(node) do |arg|
+              return if arg.str_type? && arg.heredoc?
+
               checker = checker_class.new(arg)
               return unless checker.offensive?
 
@@ -105,6 +107,10 @@ def message
               format(MSG, prefer: prefer, current: current)
             end
 
+            def current
+              offense_range.source
+            end
+
             def offense_range
               node
             end
@@ -129,18 +135,14 @@ def prefer
               symbol.inspect
             end
 
-            def current
-              node.value.inspect
-            end
-
             private
 
             def symbol
               ::Rack::Utils::SYMBOL_TO_STATUS_CODE.key(number)
             end
 
             def number
-              node.source.delete('"').to_i
+              node.value.to_i
             end
           end
 
@@ -154,10 +156,6 @@ def prefer
               number.to_s
             end
 
-            def current
-              symbol.inspect
-            end
-
             private
 
             def symbol
@@ -190,26 +188,22 @@ def prefer
               end
             end
 
-            def current
-              offense_range.source
-            end
-
             private
 
             def symbol
               ::Rack::Utils::SYMBOL_TO_STATUS_CODE.key(number)
             end
 
             def number
-              node.source.to_i
+              node.value.to_i
             end
 
             def normalize_str
-              normalized = node.source.delete('"')
-              if normalized.match?(/\A\d+\z/)
-                ::Rack::Utils::SYMBOL_TO_STATUS_CODE.key(normalized.to_i)
+              str = node.value.to_s
+              if str.match?(/\A\d+\z/)
+                ::Rack::Utils::SYMBOL_TO_STATUS_CODE.key(str.to_i)
               else
-                normalized
+                str
               end
             end
           end

spec/rubocop/cop/rspec/rails/http_status_spec.rb

@@ -15,7 +15,7 @@
       RUBY
     end
 
-    it 'registers an offense when using string value' do
+    it 'registers an offense when using double quoted string value' do
       expect_offense(<<-RUBY)
         it { is_expected.to have_http_status "200" }
                                              ^^^^^ Prefer `:ok` over `"200"` to describe HTTP status code.
@@ -26,6 +26,36 @@
       RUBY
     end
 
+    it 'registers an offense when using single quoted string value' do
+      expect_offense(<<-RUBY)
+        it { is_expected.to have_http_status '200' }
+                                             ^^^^^ Prefer `:ok` over `'200'` to describe HTTP status code.
+      RUBY
+
+      expect_correction(<<-RUBY)
+        it { is_expected.to have_http_status :ok }
+      RUBY
+    end
+
+    it 'registers an offense when using percent string value' do
+      expect_offense(<<-RUBY)
+        it { is_expected.to have_http_status %[200] }
+                                             ^^^^^^ Prefer `:ok` over `%[200]` to describe HTTP status code.
+      RUBY
+
+      expect_correction(<<-RUBY)
+        it { is_expected.to have_http_status :ok }
+      RUBY
+    end
+
+    it 'does not register an offense when using here document' do
+      expect_no_offenses(<<-RUBY)
+        it { is_expected.to have_http_status <<~HTTP }
+          200
+        HTTP
+      RUBY
+    end
+
     it 'does not register an offense when using symbolic value' do
       expect_no_offenses(<<-RUBY)
         it { is_expected.to have_http_status :ok }
@@ -66,7 +96,7 @@
       RUBY
     end
 
-    it 'registers an offense when using string value' do
+    it 'registers an offense when using double quoted string value' do
       expect_offense(<<-RUBY)
         it { is_expected.to have_http_status "ok" }
                                              ^^^^ Prefer `200` over `"ok"` to describe HTTP status code.
@@ -77,6 +107,17 @@
       RUBY
     end
 
+    it 'registers an offense when using single quoted string value' do
+      expect_offense(<<-RUBY)
+        it { is_expected.to have_http_status 'ok' }
+                                             ^^^^ Prefer `200` over `'ok'` to describe HTTP status code.
+      RUBY
+
+      expect_correction(<<-RUBY)
+        it { is_expected.to have_http_status 200 }
+      RUBY
+    end
+
     it 'does not register an offense when using numeric value' do
       expect_no_offenses(<<-RUBY)
         it { is_expected.to have_http_status 200 }
@@ -131,7 +172,7 @@
       RUBY
     end
 
-    it 'registers an offense when using string value' do
+    it 'registers an offense when using double quoted string value' do
       expect_offense(<<-RUBY)
         it { is_expected.to have_http_status "200" }
                             ^^^^^^^^^^^^^^^^^^^^^^ Prefer `be_ok` over `have_http_status "200"` to describe HTTP status code.
@@ -145,6 +186,42 @@
       RUBY
     end
 
+    it 'registers an offense when using single quoted string value' do
+      expect_offense(<<-RUBY)
+        it { is_expected.to have_http_status '200' }
+                            ^^^^^^^^^^^^^^^^^^^^^^ Prefer `be_ok` over `have_http_status '200'` to describe HTTP status code.
+        it { is_expected.to have_http_status 'ok' }
+                            ^^^^^^^^^^^^^^^^^^^^^ Prefer `be_ok` over `have_http_status 'ok'` to describe HTTP status code.
+      RUBY
+
+      expect_correction(<<-RUBY)
+        it { is_expected.to be_ok }
+        it { is_expected.to be_ok }
+      RUBY
+    end
+
+    it 'registers an offense when using percent string value' do
+      expect_offense(<<-RUBY)
+        it { is_expected.to have_http_status %[200] }
+                            ^^^^^^^^^^^^^^^^^^^^^^^ Prefer `be_ok` over `have_http_status %[200]` to describe HTTP status code.
+        it { is_expected.to have_http_status %[ok] }
+                            ^^^^^^^^^^^^^^^^^^^^^^ Prefer `be_ok` over `have_http_status %[ok]` to describe HTTP status code.
+      RUBY
+
+      expect_correction(<<-RUBY)
+        it { is_expected.to be_ok }
+        it { is_expected.to be_ok }
+      RUBY
+    end
+
+    it 'does not register an offense when using here document' do
+      expect_no_offenses(<<-RUBY)
+        it { is_expected.to have_http_status <<~HTTP }
+          200
+        HTTP
+      RUBY
+    end
+
     it 'does not register an offense when using numeric value' do
       expect_no_offenses(<<-RUBY)
         it { is_expected.to be_ok }