Improve autocorrect for Capybara/CurrentPathExpectation

`expect(page.current_path).to eq(EXPECTED_VALUE)` is not directly equivalent to `expect(page).to have_current_path(EXPECTED_VALUE)`
In particular, `have_current_path` with no options will include the querystring on the path, while `page.current_path` does not.

This fix ensures the option `ignore_query: true` is set on `have_current_path` expect when `EXPECTED_VALUE` is a string or regexp.
In those cases, it should be safe to not use this param.

Author: Nuno Silva

CHANGELOG.md

@@ -7,6 +7,7 @@
 * Add `RSpec/ContextMethod` cop, to detect method names in `context`. ([@geniou][])
 * Update RuboCop dependency to 0.68.1 with support for children matching node pattern syntax. ([@pirj][])
 * Add `RSpec/EmptyLineAfterExample` cop to check that there is an empty line after example blocks. ([@pirj][])
+* Fix `Capybara/CurrentPathExpectation` auto-corrector, to include option `ignore_query: true`. ([@onumis][])
 
 ## 1.35.0 (2019-08-02)
 
@@ -446,3 +447,4 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@schmijos]: https://github.com/schmijos
 [@foton]: https://github.com/foton
 [@nc-holodakg]: https://github.com/nc-holodakg
+[@onumis]: https://github.com/onumis

lib/rubocop/cop/rspec/capybara/current_path_expectation.rb

@@ -78,13 +78,29 @@ def rewrite_expectation(corrector, node, to_symbol, matcher_node)
                                'have_no_current_path'
                              end
             corrector.replace(matcher_node.loc.selector, matcher_method)
+            add_ignore_query_options(corrector, node)
           end
 
           def convert_regexp_str_to_literal(corrector, matcher_node, regexp_str)
             str_node = matcher_node.first_argument
             regexp_expr = Regexp.new(regexp_str).inspect
             corrector.replace(str_node.loc.expression, regexp_expr)
           end
+
+          # `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)
+            expectation_node = node.parent.last_argument
+            expectation_last_child = expectation_node.children.last
+            return if %i[regexp str].include?(expectation_last_child.type)
+
+            corrector.insert_after(
+              expectation_last_child.loc.expression,
+              ', ignore_query: true'
+            )
+          end
         end
       end
     end

spec/rubocop/cop/rspec/capybara/current_path_expectation_spec.rb

@@ -31,19 +31,38 @@
 
   include_examples 'autocorrect',
                    'expect(current_path).to eq expected_path',
-                   'expect(page).to have_current_path expected_path'
+                   'expect(page).to have_current_path expected_path, '\
+                   'ignore_query: true'
+
+  include_examples 'autocorrect',
+                   'expect(current_path).to eq(expected_path)',
+                   'expect(page).to have_current_path(expected_path, '\
+                   'ignore_query: true)'
+
+  include_examples 'autocorrect',
+                   'expect(current_path).to(eq(expected_path))',
+                   'expect(page).to(have_current_path(expected_path, '\
+                   'ignore_query: true))'
+
+  include_examples 'autocorrect',
+                   'expect(current_path).to eq(expected_path(f: :b))',
+                   'expect(page).to have_current_path(expected_path(f: :b), '\
+                   'ignore_query: true)'
 
   include_examples 'autocorrect',
                    'expect(page.current_path).to eq(foo(bar).path)',
-                   'expect(page).to have_current_path(foo(bar).path)'
+                   'expect(page).to have_current_path(foo(bar).path, '\
+                   'ignore_query: true)'
 
   include_examples 'autocorrect',
                    'expect(current_path).not_to eq expected_path',
-                   'expect(page).to have_no_current_path expected_path'
+                   'expect(page).to have_no_current_path expected_path, '\
+                   'ignore_query: true'
 
   include_examples 'autocorrect',
                    'expect(current_path).to_not eq expected_path',
-                   'expect(page).to have_no_current_path expected_path'
+                   'expect(page).to have_no_current_path expected_path, '\
+                   'ignore_query: true'
 
   include_examples 'autocorrect',
                    'expect(page.current_path).to match(/regexp/i)',