rubocop-rspec 1.17.1 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 173b96ec8e65798ba9231c7d57413056381b680a
-  data.tar.gz: 5b8b0010efd6c40c21d9febaf0017de0b46da612
+  metadata.gz: fef3eb92e763b31bdcf1b4a1adc0557e603b63d6
+  data.tar.gz: 48a039a782f517efb9cd9b7ff84f30acce3b9644
 SHA512:
-  metadata.gz: d2c56f9cb57a365fb7dabcd9fd5d1f59d0f687947bc9a79ac85eae78beaff37d649e4bdcb980ef3771b21c083ebef7192de09510a8c5cf5f24f60f1288a8fcca
-  data.tar.gz: 0e0b35c09f62bf77e0d9777a9ae87ab15b43c7c380b34956ae799fb4a91169352c0a932c8f548bb7f15064238fd9c562ad1b41ecd9d995b33f17d205562451f3
+  metadata.gz: 98638e435ef551ee81ee340767d6adf1de37bf36f3b848514cd244fbb6b7d8a43c2a30c049eb6454376e35d98f86f17e3bd2afbcc985ef424a73499c3b182ba6
+  data.tar.gz: a4024e740e9a5fc79189dfae61b2ba62e5b2ea649f78be9c3aa1b733c47b7bb9bed4a73744e4773f2cd402f8d99caae2e6c1d5e509d07cda2d789730d8783a18

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Master (Unreleased)
 
+## 1.18.0 (2017-09-29)
+
+* Fix false positive in `Capybara/FeatureMethods`. ([@Darhazer][])
+* Add `RSpec/Capybara/CurrentPathExpectation` cop for feature specs, disallowing setting expectations on `current_path`. ([@timrogers][])
+* Fix false positive in `RSpec/LetBeforeExamples` cop when example group contains single let. ([@Darhazer][])
+
 ## 1.17.1 (2017-09-20)
 
 * Improved `RSpec/ReturnFromStub` to handle string interpolation, hashes and do..end blocks. ([@Darhazer][])
@@ -248,3 +254,4 @@
 [@pocke]: https://github.com/pocke
 [@bmorrall]: https:/github.com/bmorrall
 [@zverok]: https:/github.com/zverok
+[@timrogers]: https://github.com/timrogers

data/config/default.yml

@@ -325,6 +325,11 @@ RSpec/VoidExpect:
   Enabled: true
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/VoidExpect
 
+Capybara/CurrentPathExpectation:
+  Description: Checks that no expectations are set on Capybara's `current_path`.
+  Enabled: true
+  StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/Capybara/CurrentPathExpectation
+
 Capybara/FeatureMethods:
   Description: Checks for consistent method usage in feature specs.
   Enabled: true

data/lib/rubocop-rspec.rb

@@ -29,6 +29,7 @@ require 'rubocop/cop/rspec/any_instance'
 require 'rubocop/cop/rspec/around_block'
 require 'rubocop/cop/rspec/be_eql'
 require 'rubocop/cop/rspec/before_after_all'
+require 'rubocop/cop/rspec/capybara/current_path_expectation'
 require 'rubocop/cop/rspec/capybara/feature_methods'
 require 'rubocop/cop/rspec/describe_class'
 require 'rubocop/cop/rspec/describe_method'

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

@@ -0,0 +1,42 @@
+module RuboCop
+  module Cop
+    module RSpec
+      module Capybara
+        # Checks that no expectations are set on Capybara's `current_path`.
+        #
+        # The `have_current_path` matcher (http://www.rubydoc.info/github/
+        # teamcapybara/capybara/master/Capybara/RSpecMatchers#have_current_path-
+        # instance_method) should be used on `page` to set expectations on
+        # Capybara's current path, since it uses Capybara's waiting
+        # functionality (https://github.com/teamcapybara/capybara/blob/master/
+        # README.md#asynchronous-javascript-ajax-and-friends) which ensures that
+        # preceding actions (like `click_link`) have completed.
+        #
+        # @example
+        #   # bad
+        #   expect(current_path).to eq('/callback')
+        #   expect(page.current_path).to match(/widgets/)
+        #
+        #   # good
+        #   expect(page).to have_current_path("/callback")
+        #   expect(page).to have_current_path(/widgets/)
+        #
+        class CurrentPathExpectation < Cop
+          MSG = 'Do not set an RSpec expectation on `current_path` in ' \
+                'Capybara feature specs - instead, use the ' \
+                '`have_current_path` matcher on `page`'.freeze
+
+          def_node_matcher :expectation_set_on_current_path, <<-PATTERN
+            (send nil :expect (send {(send nil :page) nil} :current_path))
+          PATTERN
+
+          def on_send(node)
+            expectation_set_on_current_path(node) do
+              add_offense(node, :selector)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec/capybara/feature_methods.rb

@@ -45,13 +45,15 @@ module RuboCop
             feature:    :describe
           }.freeze
 
-          def_node_matcher :feature_method?, <<-PATTERN
-            (send {(const nil :RSpec) nil} ${:#{MAP.keys.join(' :')}} ...)
+          def_node_matcher :feature_method, <<-PATTERN
+            (block
+              $(send {(const nil :RSpec) nil} ${#{MAP.keys.map(&:inspect).join(' ')}} ...)
+            ...)
           PATTERN
 
-          def on_send(node)
-            feature_method?(node) do |match|
-              add_offense(node, :selector, format(MSG, MAP[match], match))
+          def on_block(node)
+            feature_method(node) do |send_node, match|
+              add_offense(send_node, :selector, format(MSG, MAP[match], match))
             end
           end
 

data/lib/rubocop/cop/rspec/let_before_examples.rb

@@ -44,9 +44,13 @@ module RuboCop
         def on_block(node)
           return unless example_group_with_body?(node)
 
-          _describe, _args, body = *node
+          check_let_declarations(node.body) if multiline_block?(node.body)
+        end
+
+        private
 
-          check_let_declarations(body)
+        def multiline_block?(block)
+          block.begin_type?
         end
 
         def check_let_declarations(node)

data/lib/rubocop/rspec/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module RSpec
     # Version information for the RSpec RuboCop plugin.
     module Version
-      STRING = '1.17.1'.freeze
+      STRING = '1.18.0'.freeze
     end
   end
 end

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

@@ -0,0 +1,29 @@
+RSpec.describe RuboCop::Cop::RSpec::Capybara::CurrentPathExpectation do
+  subject(:cop) { described_class.new }
+
+  it 'flags violations for `expect(current_path)`' do
+    expect_offense(<<-RUBY)
+      expect(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
+  end
+
+  it 'flags violations for `expect(page.current_path)`' do
+    expect_offense(<<-RUBY)
+      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
+  end
+
+  it "doesn't flag a violation for other expectations" do
+    expect_no_offenses(<<-RUBY)
+      expect(current_user).to eq(user)
+    RUBY
+  end
+
+  it "doesn't flag a violation for other references to `current_path`" do
+    expect_no_offenses(<<-RUBY)
+      current_path = WalkingRoute.last.path
+    RUBY
+  end
+end

data/spec/rubocop/cop/rspec/capybara/feature_methods_spec.rb

@@ -43,6 +43,16 @@ RSpec.describe RuboCop::Cop::RSpec::Capybara::FeatureMethods do
     RUBY
   end
 
+  it 'ignores variables inside examples' do
+    expect_no_offenses(<<-RUBY)
+      it 'is valid code' do
+        given(feature)
+        assign(background)
+        run scenario
+      end
+    RUBY
+  end
+
   include_examples 'autocorrect', 'background { }',    'before { }'
   include_examples 'autocorrect', 'scenario { }',      'it { }'
   include_examples 'autocorrect', 'xscenario { }',     'xit { }'

data/spec/rubocop/cop/rspec/let_before_examples_spec.rb

@@ -76,6 +76,16 @@ RSpec.describe RuboCop::Cop::RSpec::LetBeforeExamples do
     RUBY
   end
 
+  it 'ignores single-line example blocks' do
+    expect_no_offenses(<<-RUBY)
+      RSpec.describe User do
+        include_examples 'special user' do
+          let(:foo) { bar }
+        end
+      end
+    RUBY
+  end
+
   it 'does not encounter an error when handling an empty describe' do
     expect { inspect_source('RSpec.describe(User) do end', 'a_spec.rb') }
       .not_to raise_error

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 1.17.1
+  version: 1.18.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-20 00:00:00.000000000 Z
+date: 2017-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -108,6 +108,7 @@ files:
 - lib/rubocop/cop/rspec/around_block.rb
 - lib/rubocop/cop/rspec/be_eql.rb
 - lib/rubocop/cop/rspec/before_after_all.rb
+- lib/rubocop/cop/rspec/capybara/current_path_expectation.rb
 - lib/rubocop/cop/rspec/capybara/feature_methods.rb
 - lib/rubocop/cop/rspec/cop.rb
 - lib/rubocop/cop/rspec/describe_class.rb
@@ -183,6 +184,7 @@ files:
 - spec/rubocop/cop/rspec/around_block_spec.rb
 - spec/rubocop/cop/rspec/be_eql_spec.rb
 - spec/rubocop/cop/rspec/before_after_all_spec.rb
+- spec/rubocop/cop/rspec/capybara/current_path_expectation_spec.rb
 - spec/rubocop/cop/rspec/capybara/feature_methods_spec.rb
 - spec/rubocop/cop/rspec/cop_spec.rb
 - spec/rubocop/cop/rspec/describe_class_spec.rb
@@ -277,6 +279,7 @@ test_files:
 - spec/rubocop/cop/rspec/around_block_spec.rb
 - spec/rubocop/cop/rspec/be_eql_spec.rb
 - spec/rubocop/cop/rspec/before_after_all_spec.rb
+- spec/rubocop/cop/rspec/capybara/current_path_expectation_spec.rb
 - spec/rubocop/cop/rspec/capybara/feature_methods_spec.rb
 - spec/rubocop/cop/rspec/cop_spec.rb
 - spec/rubocop/cop/rspec/describe_class_spec.rb