rubocop-rspec 1.30.1 → 1.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89853728f31f151cfe129bc754317563747529c95f5298be06478247b0a91bf0
-  data.tar.gz: 18a0909fe1352450cd69e289323e3c06f69a38cfb15fb54b3bc79b4f22c089d0
+  metadata.gz: 7dc31ff59557e82627745015742087123734c2d1abda96cc277ac243c8bee1f2
+  data.tar.gz: 819b5fea22acb7db40512b8291ce8cddec7c9580fb62ccb38bad146bdeaa27e1
 SHA512:
-  metadata.gz: d75b3a00d3da18979fd4a9effd3a8b231b54267695998cb8f61a57c0cae64121dc3d5d740422a8283abf425adee11ea4f6aff9d5247d9e8785971a52d949f6c0
-  data.tar.gz: feedb0ccb5ddc363c7c71fdaf4647316be0a9dc3063079621188fb2fa81b6e3165a1bc0b7ce7850342a10e216bf355ec5df682bcce7a957c40f2ee794394a64e
+  metadata.gz: 1998ae7af3934178c41e2c8c965d33af83d1eb30e1becf04ef69b9b6eda8b023d7f2f8e63e2d4a5b2edc74d254d3beb93b34d48d1edbfa318c32d8f389cded80
+  data.tar.gz: 59cdfdb2dd906222e08e4839f3c9b8ee8d0dcb81d28ad65de6e7fd6055849d7eac4393d21197b8de621934e71ae4405345f6be71f6fe9eb0d1b09562060a388a

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Master (Unreleased)
 
+## 1.31.0 (2019-01-02)
+
+* Add `IgnoreSharedExamples` option for `RSpec/NamedSubject`. ([@RST-J][])
+* Add autocorrect support for `Capybara/CurrentPathExpectation` cop. ([@ypresto][])
+* Add support for built-in `exists` matcher for `RSpec/PredicateMatcher` cop. ([@mkenyon][])
+* `SingleArgumentMessageChain` no longer reports an array as it's only argument as an offense. ([@Darhazer][])
+
 ## 1.30.1 (2018-11-01)
 
 * `FactoryBot/CreateList` now ignores `times` blocks with an argument. ([@Darhazer][])
@@ -389,3 +396,6 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@vzvu3k6k]: https://github.com/vzvu3k6k
 [@BrentWheeldon]: https://github.com/BrentWheeldon
 [@daveworth]: https://github.com/daveworth
+[@RST-J]: https://github.com/RST-J
+[@ypresto]: https://github.com/ypresto
+[@mkenyon]: https://github.com/mkenyon

data/config/default.yml

@@ -303,6 +303,7 @@ RSpec/MultipleSubjects:
 RSpec/NamedSubject:
   Description: Checks for explicitly referenced test subjects.
   Enabled: true
+  IgnoreSharedExamples: true
   StyleGuide: http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/NamedSubject
 
 RSpec/NestedGroups:

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

@@ -30,11 +30,59 @@ module RuboCop
             (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

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

@@ -12,6 +12,10 @@ module RuboCop
       # the most important object in your tests so they deserve a descriptive
       # name.
       #
+      # This cop can be configured in your configuration using the
+      # `IgnoreSharedExamples` which will not report offenses for implicit
+      # subjects in shared example groups.
+      #
       # @example
       #   # bad
       #   RSpec.describe User do
@@ -48,15 +52,24 @@ module RuboCop
           }
         PATTERN
 
+        def_node_matcher :shared_example?, <<-PATTERN
+          #{SharedGroups::EXAMPLES.block_pattern}
+        PATTERN
+
         def_node_search :subject_usage, '$(send nil? :subject)'
 
         def on_block(node)
-          return unless rspec_block?(node)
+          return if !rspec_block?(node) || ignored_shared_example?(node)
 
           subject_usage(node) do |subject_node|
             add_offense(subject_node, location: :selector)
           end
         end
+
+        def ignored_shared_example?(node)
+          cop_config['IgnoreSharedExamples'] &&
+            node.each_ancestor(:block).any?(&method(:shared_example?))
+        end
       end
     end
   end

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

@@ -64,6 +64,8 @@ module RuboCop
             'be_an_instance_of'
           when 'include?', 'respond_to?'
             name[0..-2]
+          when 'exist?', 'exists?'
+            'exist'
           when /^has_/
             name.sub('has_', 'have_')[0..-2]
           else
@@ -174,9 +176,10 @@ module RuboCop
 
         def predicate_matcher_name?(name)
           name = name.to_s
-          name.start_with?('be_', 'have_') &&
-            !BUILT_IN_MATCHERS.include?(name) &&
-            !name.end_with?('?')
+
+          return false if BUILT_IN_MATCHERS.include?(name)
+
+          name.start_with?('be_', 'have_') && !name.end_with?('?')
         end
 
         def message_explicit(matcher)

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

@@ -26,9 +26,7 @@ module RuboCop
 
         def on_send(node)
           message_chain(node) do |arg|
-            return if arg.to_s.include?('.')
-
-            return if arg.hash_type? && !single_key_hash?(arg)
+            return if valid_usage?(arg)
 
             add_offense(node, location: :selector)
           end
@@ -39,12 +37,27 @@ module RuboCop
             corrector.replace(node.loc.selector, replacement(node.method_name))
             message_chain(node) do |arg|
               autocorrect_hash_arg(corrector, arg) if single_key_hash?(arg)
+              autocorrect_array_arg(corrector, arg) if arg.array_type?
             end
           end
         end
 
         private
 
+        def valid_usage?(node)
+          return true unless node.literal? || node.array_type?
+
+          case node.type
+          when :hash then !single_key_hash?(node)
+          when :array then !single_element_array?(node)
+          else node.to_s.include?('.')
+          end
+        end
+
+        def single_element_array?(node)
+          node.child_nodes.one?
+        end
+
         def autocorrect_hash_arg(corrector, arg)
           key, value = *arg.children.first
 
@@ -53,6 +66,12 @@ module RuboCop
                                  ".and_return(#{value.source})")
         end
 
+        def autocorrect_array_arg(corrector, arg)
+          value = arg.children.first
+
+          corrector.replace(arg.loc.expression, value.source)
+        end
+
         def key_to_arg(node)
           key, = *node
           node.sym_type? ? ":#{key}" : node.source

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.30.1'.freeze
+      STRING = '1.31.0'.freeze
     end
   end
 end

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

@@ -26,4 +26,38 @@ RSpec.describe RuboCop::Cop::RSpec::Capybara::CurrentPathExpectation do
       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

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

@@ -1,62 +1,123 @@
 # frozen_string_literal: true
 
-RSpec.describe RuboCop::Cop::RSpec::NamedSubject do
-  subject(:cop) { described_class.new }
+RSpec.describe RuboCop::Cop::RSpec::NamedSubject, :config do
+  subject(:cop) { described_class.new(config) }
 
-  it 'checks `it` and `specify` for explicit subject usage' do
-    expect_offense(<<-RUBY)
-      RSpec.describe User do
-        subject { described_class.new }
+  shared_examples_for 'checking subject outside of shared examples' do
+    it 'checks `it` and `specify` for explicit subject usage' do
+      expect_offense(<<-RUBY)
+        RSpec.describe User do
+          subject { described_class.new }
 
-        it "is valid" do
-          expect(subject.valid?).to be(true)
-                 ^^^^^^^ Name your test subject if you need to reference it explicitly.
+          it "is valid" do
+            expect(subject.valid?).to be(true)
+                   ^^^^^^^ Name your test subject if you need to reference it explicitly.
+          end
+
+          specify do
+            expect(subject.valid?).to be(true)
+                   ^^^^^^^ Name your test subject if you need to reference it explicitly.
+          end
         end
+      RUBY
+    end
+
+    it 'checks before and after for explicit subject usage' do
+      expect_offense(<<-RUBY)
+        RSpec.describe User do
+          subject { described_class.new }
 
-        specify do
-          expect(subject.valid?).to be(true)
-                 ^^^^^^^ Name your test subject if you need to reference it explicitly.
+          before(:each) do
+            do_something_with(subject)
+                              ^^^^^^^ Name your test subject if you need to reference it explicitly.
+          end
+
+          after do
+            do_something_with(subject)
+                              ^^^^^^^ Name your test subject if you need to reference it explicitly.
+          end
         end
-      end
-    RUBY
-  end
+      RUBY
+    end
 
-  it 'checks before and after for explicit subject usage' do
-    expect_offense(<<-RUBY)
-      RSpec.describe User do
-        subject { described_class.new }
+    it 'checks around(:each) for explicit subject usage' do
+      expect_offense(<<-RUBY)
+        RSpec.describe User do
+          subject { described_class.new }
 
-        before(:each) do
-          do_something_with(subject)
-                            ^^^^^^^ Name your test subject if you need to reference it explicitly.
+          around(:each) do |test|
+            do_something_with(subject)
+                              ^^^^^^^ Name your test subject if you need to reference it explicitly.
+          end
         end
+      RUBY
+    end
 
-        after do
-          do_something_with(subject)
-                            ^^^^^^^ Name your test subject if you need to reference it explicitly.
+    it 'ignores subject when not wrapped inside a test' do
+      expect_no_offenses(<<-RUBY)
+        def foo
+          it(subject)
         end
-      end
-    RUBY
+      RUBY
+    end
   end
 
-  it 'checks around(:each) for explicit subject usage' do
-    expect_offense(<<-RUBY)
-      RSpec.describe User do
-        subject { described_class.new }
+  context 'when IgnoreSharedExamples is false' do
+    let(:cop_config) { { 'IgnoreSharedExamples' => false } }
+
+    it_behaves_like 'checking subject outside of shared examples'
+
+    it 'checks shared_examples for explicit subject usage' do
+      expect_offense(<<-RUBY)
+        RSpec.describe User do
+          subject(:new_user) { described_class.new }
+
+          shared_examples_for 'a valid new user' do
+            it "is a User" do
+              expect(subject).to be_a(User)
+                     ^^^^^^^ Name your test subject if you need to reference it explicitly.
+            end
 
-        around(:each) do |test|
-          do_something_with(subject)
-                            ^^^^^^^ Name your test subject if you need to reference it explicitly.
+            it "is valid" do
+              expect(subject.valid?).to be(true)
+                     ^^^^^^^ Name your test subject if you need to reference it explicitly.
+            end
+
+            it "is new" do
+              expect(subject).to be_new_record
+                     ^^^^^^^ Name your test subject if you need to reference it explicitly.
+            end
+          end
         end
-      end
-    RUBY
+      RUBY
+    end
   end
 
-  it 'ignores subject when not wrapped inside a test' do
-    expect_no_offenses(<<-RUBY)
-      def foo
-        it(subject)
-      end
-    RUBY
+  context 'when IgnoreSharedExamples is true' do
+    let(:cop_config) { { 'IgnoreSharedExamples' => true } }
+
+    it_behaves_like 'checking subject outside of shared examples'
+
+    it 'ignores explicit subject in shared_examples' do
+      expect_no_offenses(<<-RUBY)
+        RSpec.describe User do
+          subject(:new_user) { described_class.new }
+
+          shared_examples_for 'a valid new user' do
+            it "is a User" do
+              expect(subject).to be_a(User)
+            end
+
+            it "is valid" do
+              expect(subject.valid?).to be(true)
+            end
+
+            it "is new" do
+              expect(subject).to be_new_record
+            end
+          end
+        end
+      RUBY
+    end
   end
 end

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

@@ -20,6 +20,15 @@ RSpec.describe RuboCop::Cop::RSpec::PredicateMatcher, :config do
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer using `be_empty` matcher over `empty?`.
           expect(foo.empty?).to be_falsey
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer using `be_empty` matcher over `empty?`.
+        RUBY
+      end
+
+      it 'registers an offense for a predicate method with built-in equiv' do
+        expect_offense(<<-RUBY)
+          expect(foo.exist?).to be_truthy
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer using `exist` matcher over `exist?`.
+          expect(foo.exists?).to be_truthy
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer using `exist` matcher over `exists?`.
           expect(foo.has_something?).to be_truthy
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer using `have_something` matcher over `has_something?`.
           expect(foo.include?(something)).to be_truthy
@@ -106,6 +115,9 @@ RSpec.describe RuboCop::Cop::RSpec::PredicateMatcher, :config do
       include_examples 'autocorrect',
                        'expect(foo.respond_to?(:bar)).to be_truthy',
                        'expect(foo).to respond_to(:bar)'
+      include_examples 'autocorrect',
+                       'expect(foo.exists?).to be_truthy',
+                       'expect(foo).to exist'
 
       include_examples 'autocorrect',
                        'expect(foo.something?()).to be_truthy',
@@ -252,6 +264,7 @@ RSpec.describe RuboCop::Cop::RSpec::PredicateMatcher, :config do
           expect(foo).to have_received(:foo)
           expect(foo).to be_between(1, 10)
           expect(foo).to be_within(0.1).of(10.0)
+          expect(foo).to exist
         RUBY
       end
 

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

@@ -48,8 +48,52 @@ RSpec.describe RuboCop::Cop::RSpec::SingleArgumentMessageChain do
       RUBY
     end
 
+    it 'accepts single-argument calls with variable' do
+      expect_no_offenses(<<-RUBY)
+        before do
+          foo = %i[:one :two]
+          allow(foo).to receive_message_chain(foo) { :many }
+        end
+      RUBY
+    end
+
+    it 'accepts single-argument calls with send node' do
+      expect_no_offenses(<<-RUBY)
+        before do
+          allow(foo).to receive_message_chain(foo) { :many }
+        end
+      RUBY
+    end
+
+    context 'with single-element array argument' do
+      it 'reports an offense' do
+        expect_offense(<<-RUBY)
+          before do
+            allow(foo).to receive_message_chain([:one]) { :two }
+                          ^^^^^^^^^^^^^^^^^^^^^ Use `receive` instead of calling `receive_message_chain` with a single argument.
+          end
+        RUBY
+      end
+
+      include_examples(
+        'autocorrect',
+        'before { allow(foo).to receive_message_chain([:one]) { :two } }',
+        'before { allow(foo).to receive(:one) { :two } }'
+      )
+    end
+
+    context 'with multiple-element array argument' do
+      it "doesn't report an offense" do
+        expect_no_offenses(<<-RUBY)
+          before do
+            allow(foo).to receive_message_chain([:one, :two]) { :many }
+          end
+        RUBY
+      end
+    end
+
     context 'with single-key hash argument' do
-      it 'reports an offence' do
+      it 'reports an offense' do
         expect_offense(<<-RUBY)
           before do
             allow(foo).to receive_message_chain(bar: 42)
@@ -78,7 +122,7 @@ RSpec.describe RuboCop::Cop::RSpec::SingleArgumentMessageChain do
     end
 
     context 'with multiple keys hash argument' do
-      it "doesn't report an offence" do
+      it "doesn't report an offense" do
         expect_no_offenses(<<-RUBY)
           before do
             allow(foo).to receive_message_chain(bar: 42, baz: 42)

data/spec/spec_helper.rb

@@ -21,14 +21,6 @@ RSpec.configure do |config|
 
   config.order = :random
 
-  config.expect_with :rspec do |expectations|
-    expectations.syntax = :expect # Disable `should`
-  end
-
-  config.mock_with :rspec do |mocks|
-    mocks.syntax = :expect # Disable `should_receive` and `stub`
-  end
-
   # Forbid RSpec from monkey patching any of our objects
   config.disable_monkey_patching!
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rspec
 version: !ruby/object:Gem::Version
-  version: 1.30.1
+  version: 1.31.0
 platform: ruby
 authors:
 - John Backus
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-01 00:00:00.000000000 Z
+date: 2019-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -319,8 +319,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Code style checking for RSpec files