Merge pull request #66 from rubocop/fix/50

Fix an incorrect autocorrect for `Capybara/CurrentPathExpectation`

CHANGELOG.md

@@ -7,6 +7,7 @@
 - Fix a false positive for `Capybara/SpecificFinders` when `find` with kind option. ([@ydah])
 - Add new `Capybara/RSpec/HaveSelector` cop. ([@ydah])
 - Add new `Capybara/ClickLinkOrButtonStyle` cop. ([@ydah])
+- Fix an incorrect autocorrect for `Capybara/CurrentPathExpectation`. ([@ydah])
 
 ## 2.18.0 (2023-04-21)
 

docs/modules/ROOT/pages/cops_capybara.adoc

@@ -86,15 +86,13 @@ This cop does not support autocorrection in some cases.
 ----
 # bad
 expect(current_path).to eq('/callback')
+expect(page.current_path).to eq('/callback')
 
 # good
-expect(page).to have_current_path('/callback')
+expect(page).to have_current_path('/callback', ignore_query: true)
 
-# bad (does not support autocorrection)
-expect(page.current_path).to match(variable)
-
-# good
-expect(page).to have_current_path('/callback')
+# bad (does not support autocorrection when `match` with a variable)
+expect(page).to match(variable)
 ----
 
 === References

lib/rubocop/cop/capybara/current_path_expectation.rb

@@ -18,15 +18,13 @@ module Capybara
       # @example
       #   # bad
       #   expect(current_path).to eq('/callback')
+      #   expect(page.current_path).to eq('/callback')
       #
       #   # good
-      #   expect(page).to have_current_path('/callback')
+      #   expect(page).to have_current_path('/callback', ignore_query: true)
       #
-      #   # bad (does not support autocorrection)
-      #   expect(page.current_path).to match(variable)
-      #
-      #   # good
-      #   expect(page).to have_current_path('/callback')
+      #   # bad (does not support autocorrection when `match` with a variable)
+      #   expect(page).to match(variable)
       #
       class CurrentPathExpectation < ::RuboCop::Cop::Base
         extend AutoCorrector
@@ -95,7 +93,7 @@ def rewrite_expectation(corrector, node, to_symbol, matcher_node)
                            end
           corrector.replace(matcher_node.loc.selector, matcher_method)
           add_argument_parentheses(corrector, matcher_node.first_argument)
-          add_ignore_query_options(corrector, node)
+          add_ignore_query_options(corrector, node, matcher_node)
         end
 
         def convert_regexp_node_to_literal(corrector, matcher_node, regexp_node)
@@ -129,18 +127,13 @@ def method_call_with_no_parentheses?(arg_node)
         # `have_current_path` with no options will include the querystring
         # while `page.current_path` does not.
         # This ensures the option `ignore_query: true` is added
-        # except when the expectation is a regexp or string
-        def add_ignore_query_options(corrector, node)
+        # except when `match` matcher.
+        def add_ignore_query_options(corrector, node, matcher_node)
+          return if matcher_node.method?(:match)
+
           expectation_node = node.parent.last_argument
           expectation_last_child = expectation_node.children.last
-          return if %i[
-            regexp str dstr xstr
-          ].include?(expectation_last_child.type)
-
-          corrector.insert_after(
-            expectation_last_child,
-            ', ignore_query: true'
-          )
+          corrector.insert_after(expectation_last_child, ', ignore_query: true')
         end
       end
     end

spec/rubocop/cop/capybara/current_path_expectation_spec.rb

@@ -8,7 +8,7 @@
     RUBY
 
     expect_correction(<<~RUBY)
-      expect(page).to have_current_path "/callback"
+      expect(page).to have_current_path "/callback", ignore_query: true
     RUBY
   end
 
@@ -22,7 +22,7 @@
 
     expect_correction(<<~'RUBY')
       expect(page).to have_current_path "/callback" \
-                                  "/foo"
+                                  "/foo", ignore_query: true
     RUBY
   end
 
@@ -33,7 +33,7 @@
     RUBY
 
     expect_correction(<<~RUBY)
-      expect(page).to have_current_path `pwd`
+      expect(page).to have_current_path `pwd`, ignore_query: true
     RUBY
   end
 
@@ -42,6 +42,10 @@
       expect(page.current_path).to eq("/callback")
       ^^^^^^ Do not set an RSpec expectation on `current_path` in Capybara feature specs - instead, use the `have_current_path` matcher on `page`
     RUBY
+
+    expect_correction(<<-RUBY)
+      expect(page).to have_current_path("/callback", ignore_query: true)
+    RUBY
   end
 
   it 'registers an offense when a variable is used' do