Implement autocorrect for Capybara/CurrentPathExpectation

ypresto · ypresto · commit 63a09e381495 · 2018-11-06T22:46:21.000+09:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## Master (Unreleased)
 
 * Add `IgnoreSharedExamples` option for `RSpec/NamedSubject`. ([@RST-J][])
+* Add autocorrect support for `Capybara/CurrentPathExpectation` cop. ([@ypresto][])
 
 ## 1.30.1 (2018-11-01)
 
@@ -392,3 +393,4 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@BrentWheeldon]: https://github.com/BrentWheeldon
 [@daveworth]: https://github.com/daveworth
 [@RST-J]: https://github.com/RST-J
+[@ypresto]: https://github.com/ypresto
diff --git a/lib/rubocop/cop/rspec/capybara/current_path_expectation.rb b/lib/rubocop/cop/rspec/capybara/current_path_expectation.rb
@@ -30,11 +30,59 @@ class CurrentPathExpectation < Cop
             (send nil? :expect (send {(send nil? :page) nil?} :current_path))
           PATTERN
 
+          # Supported matchers: eq(...) / match(/regexp/) / match('regexp')
+          def_node_matcher :as_is_matcher, <<-PATTERN
+            (send
+              #expectation_set_on_current_path ${:to :not_to :to_not}
+              ${(send nil? :eq ...) (send nil? :match (regexp ...))})
+          PATTERN
+
+          def_node_matcher :regexp_str_matcher, <<-PATTERN
+            (send
+              #expectation_set_on_current_path ${:to :not_to :to_not}
+              $(send nil? :match (str $_)))
+          PATTERN
+
           def on_send(node)
             expectation_set_on_current_path(node) do
               add_offense(node, location: :selector)
             end
           end
+
+          def autocorrect(node)
+            lambda do |corrector|
+              return unless node.chained?
+
+              as_is_matcher(node.parent) do |to_sym, matcher_node|
+                rewrite_expectation(corrector, node, to_sym, matcher_node)
+              end
+
+              regexp_str_matcher(node.parent) do |to_sym, matcher_node, regexp|
+                rewrite_expectation(corrector, node, to_sym, matcher_node)
+                convert_regexp_str_to_literal(corrector, matcher_node, regexp)
+              end
+            end
+          end
+
+          private
+
+          def rewrite_expectation(corrector, node, to_symbol, matcher_node)
+            current_path_node = node.first_argument
+            corrector.replace(current_path_node.loc.expression, 'page')
+            corrector.replace(node.parent.loc.selector, 'to')
+            matcher_method = if to_symbol == :to
+                               'have_current_path'
+                             else
+                               'have_no_current_path'
+                             end
+            corrector.replace(matcher_node.loc.selector, matcher_method)
+          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
         end
       end
     end
diff --git a/manual/cops_capybara.md b/manual/cops_capybara.md
@@ -4,7 +4,7 @@
 
 Enabled by default | Supports autocorrection
 --- | ---
-Enabled | No
+Enabled | Yes
 
 Checks that no expectations are set on Capybara's `current_path`.
 
diff --git a/spec/rubocop/cop/rspec/capybara/current_path_expectation_spec.rb b/spec/rubocop/cop/rspec/capybara/current_path_expectation_spec.rb
@@ -26,4 +26,38 @@
       current_path = WalkingRoute.last.path
     RUBY
   end
+
+  include_examples 'autocorrect',
+                   'expect(current_path).to eq expected_path',
+                   'expect(page).to have_current_path expected_path'
+
+  include_examples 'autocorrect',
+                   'expect(page.current_path).to eq(foo(bar).path)',
+                   'expect(page).to have_current_path(foo(bar).path)'
+
+  include_examples 'autocorrect',
+                   'expect(current_path).not_to eq expected_path',
+                   'expect(page).to have_no_current_path expected_path'
+
+  include_examples 'autocorrect',
+                   'expect(current_path).to_not eq expected_path',
+                   'expect(page).to have_no_current_path expected_path'
+
+  include_examples 'autocorrect',
+                   'expect(page.current_path).to match(/regexp/i)',
+                   'expect(page).to have_current_path(/regexp/i)'
+
+  include_examples 'autocorrect',
+                   'expect(page.current_path).to match("string/")',
+                   'expect(page).to have_current_path(/string\//)'
+
+  # Unsupported, no change.
+  include_examples 'autocorrect',
+                   'expect(page.current_path).to match(variable)',
+                   'expect(page.current_path).to match(variable)'
+
+  # Unsupported, no change.
+  include_examples 'autocorrect',
+                   'expect(page.current_path)',
+                   'expect(page.current_path)'
 end
