Add support for RSpec/HaveHttpStatus when using response.code.

Fixes #1609 This PR adds support for `RSpec/HaveHttpStatus` when using `response.code`.
rubocop · Apr 18, 2023 · cde8a69 · cde8a69
1 parent 80c7d96
commit cde8a69
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@
 - Add autocorrect support for `RSpec/ScatteredSetup`. ([@ydah])
 - Fix a false negative for `RSpec/RedundantAround` when redundant numblock `around`. ([@ydah])
 - Add support for shared example groups to `RSpec/EmptyLineAfterExampleGroup`. ([@pirj])
+- Add support for `RSpec/HaveHttpStatus` when using `response.code`. ([@ydah])
 
 ## 2.19.0 (2023-03-06)
 

diff --git a/docs/modules/ROOT/pages/cops_rspec_rails.adoc b/docs/modules/ROOT/pages/cops_rspec_rails.adoc
@@ -53,6 +53,7 @@ Checks that tests use `have_http_status` instead of equality matchers.
 ----
 # bad
 expect(response.status).to be(200)
+expect(response.code).to eq("200")
 
 # good
 expect(response).to have_http_status(200)

diff --git a/lib/rubocop/cop/rspec/rails/have_http_status.rb b/lib/rubocop/cop/rspec/rails/have_http_status.rb
@@ -9,6 +9,7 @@ module Rails
         # @example
         #   # bad
         #   expect(response.status).to be(200)
+        #   expect(response.code).to eq("200")
         #
         #   # good
         #   expect(response).to have_http_status(200)
@@ -18,7 +19,7 @@ class HaveHttpStatus < ::RuboCop::Cop::Base
 
           MSG =
             'Prefer `expect(response).%<to>s have_http_status(%<status>i)` ' \
-            'over `expect(response.status).%<to>s %<match>s`.'
+            'over `%<bad_code>s`.'
 
           RUNNERS = %i[to to_not not_to].to_set
           RESTRICT_ON_SEND = RUNNERS
@@ -27,19 +28,21 @@ class HaveHttpStatus < ::RuboCop::Cop::Base
           def_node_matcher :match_status, <<-PATTERN
             (send
               (send nil? :expect
-                $(send (send nil? :response) :status)
+                $(send (send nil? :response) {:status :code})
               )
               $RUNNERS
-              $(send nil? {:be :eq :eql :equal} (int $_))
+              $(send nil? {:be :eq :eql :equal} ({int str} $_))
             )
           PATTERN
 
           def on_send(node)
             match_status(node) do |response_status, to, match, status|
-              message = format(MSG, to: to, match: match.source, status: status)
+              message = format(MSG, to: to, status: status,
+                                    bad_code: node.source)
               add_offense(node, message: message) do |corrector|
                 corrector.replace(response_status, 'response')
                 corrector.replace(match.loc.selector, 'have_http_status')
+                corrector.replace(match.first_argument, status.to_i.to_s)
               end
             end
           end

diff --git a/spec/rubocop/cop/rspec/rails/have_http_status_spec.rb b/spec/rubocop/cop/rspec/rails/have_http_status_spec.rb
@@ -23,6 +23,17 @@
     RUBY
   end
 
+  it 'registers an offense for `expect(response.code).to eq("200")`' do
+    expect_offense(<<~RUBY)
+      it { expect(response.code).to eq("200") }
+           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer `expect(response).to have_http_status(200)` over `expect(response.code).to eq("200")`.
+    RUBY
+
+    expect_correction(<<~RUBY)
+      it { expect(response).to have_http_status(200) }
+    RUBY
+  end
+
   it 'does not register an offense for `is_expected.to be(200)`' do
     expect_no_offenses(<<~RUBY)
       it { is_expected.to be(200) }