rubocop-rspec 1.33.0 → 1.34.0

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

@@ -101,7 +101,6 @@ module RuboCop
         def add_shared_item_offense(node, message)
           add_offense(
             node,
-            location: :expression,
             message: message
           )
         end

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

@@ -75,7 +75,7 @@ module RuboCop
         end
 
         def key_to_arg(node)
-          key, = *node
+          key, = *node # rubocop:disable InternalAffairs/NodeDestructuring
           node.sym_type? ? ":#{key}" : node.source
         end
 

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

@@ -6,6 +6,8 @@ module RuboCop
       # Checks for stubbed test subjects.
       #
       # @see https://robots.thoughtbot.com/don-t-stub-the-system-under-test
+      # @see https://samphippen.com/introducing-rspec-smells-and-where-to-find-them#smell-1-stubject
+      # @see https://github.com/rubocop-hq/rspec-style-guide#dont-stub-subject
       #
       # @example
       #   # bad
@@ -18,9 +20,7 @@ module RuboCop
       #   end
       #
       class SubjectStub < Cop
-        include RuboCop::RSpec::TopLevelDescribe
-
-        MSG = 'Do not stub your test subject.'
+        MSG = 'Do not stub methods of the object under test.'
 
         # @!method subject(node)
         #   Find a named or unnamed subject definition
@@ -56,31 +56,28 @@ module RuboCop
         #     expect(foo).to receive(:bar).with(1)
         #     expect(foo).to receive(:bar).with(1).and_return(2)
         #
-        #   @example source that not matches
-        #     expect(foo).to all(receive(:bar))
-        #
         def_node_matcher :message_expectation?, <<-PATTERN
-          {
-            (send nil? :allow (send nil? %))
-            (send (send nil? :expect (send nil? %)) :to #expectation?)
-          }
+          (send
+            {
+              (send nil? { :expect :allow } (send nil? {% :subject}))
+              (send nil? :is_expected)
+            }
+            #{Runners::ALL.node_pattern_union}
+            #message_expectation_matcher?
+          )
         PATTERN
 
-        def_node_matcher :all_matcher?, '(send nil? :all ...)'
-
-        def_node_search :receive_message?, '(send nil? :receive ...)'
-
-        def expectation?(node)
-          return if all_matcher?(node)
-
-          receive_message?(node)
-        end
+        def_node_search :message_expectation_matcher?, <<-PATTERN
+          (send nil? {
+            :receive :receive_messages :receive_message_chain :have_received
+            } ...)
+        PATTERN
 
         def on_block(node)
           return unless example_group?(node)
 
           find_subject_stub(node) do |stub|
-            add_offense(stub, location: :expression)
+            add_offense(stub)
           end
         end
 

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

@@ -45,10 +45,7 @@ module RuboCop
         def on_send(node)
           return unless empty_exception_matcher?(node)
 
-          add_offense(
-            node.children.last,
-            location: :expression
-          )
+          add_offense(node.children.last)
         end
 
         def empty_exception_matcher?(node)

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

@@ -34,7 +34,7 @@ module RuboCop
             return if name.nil? && cop_config['IgnoreNameless']
             return if symbol?(name) && cop_config['IgnoreSymbolicNames']
 
-            add_offense(node, location: :expression)
+            add_offense(node)
           end
         end
 

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

@@ -40,7 +40,7 @@ module RuboCop
         def check_expect(node)
           return unless void?(node)
 
-          add_offense(node, location: :expression)
+          add_offense(node)
         end
 
         def void?(expect)

data/lib/rubocop/cop/rspec_cops.rb

@@ -49,6 +49,7 @@ require_relative 'rspec/invalid_predicate_matcher'
 require_relative 'rspec/it_behaves_like'
 require_relative 'rspec/iterated_expectation'
 require_relative 'rspec/leading_subject'
+require_relative 'rspec/leaky_constant_declaration'
 require_relative 'rspec/let_before_examples'
 require_relative 'rspec/let_setup'
 require_relative 'rspec/message_chain'

data/lib/rubocop/rspec/language.rb

@@ -4,7 +4,7 @@ module RuboCop
   module RSpec
     # RSpec public API methods that are commonly used in cops
     module Language
-      RSPEC = '{(const nil? :RSpec) nil?}'
+      RSPEC = '{(const {nil? cbase} :RSpec) nil?}'
 
       # Set of method selectors
       class SelectorSet

data/lib/rubocop/rspec/top_level_describe.rb

@@ -6,10 +6,6 @@ module RuboCop
     module TopLevelDescribe
       extend NodePattern::Macros
 
-      def_node_matcher :described_constant, <<-PATTERN
-        (block $(send _ :describe $(const ...)) (args) $_)
-      PATTERN
-
       def on_send(node)
         return unless respond_to?(:on_top_level_describe)
         return unless top_level_describe?(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.33.0'
+      STRING = '1.34.0'
     end
   end
 end

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

@@ -21,13 +21,13 @@ RSpec.describe RuboCop::Cop::RSpec::Cop do
 
   let(:fake_cop) do
     stub_const('RuboCop::RSpec', Module.new)
-    # rubocop:disable ClassAndModuleChildren
+    # rubocop:disable ClassAndModuleChildren, RSpec/LeakyConstantDeclaration
     class RuboCop::RSpec::FakeCop < described_class
       def on_send(node)
-        add_offense(node, location: :expression, message: 'I flag everything')
+        add_offense(node, message: 'I flag everything')
       end
     end
-    # rubocop:enable ClassAndModuleChildren
+    # rubocop:enable ClassAndModuleChildren, RSpec/LeakyConstantDeclaration
     RuboCop::RSpec::FakeCop
   end
 

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

@@ -18,6 +18,13 @@ RSpec.describe RuboCop::Cop::RSpec::DescribeClass do
     RUBY
   end
 
+  it 'supports ::RSpec.describe' do
+    expect_no_offenses(<<-RUBY)
+      ::RSpec.describe Foo do
+      end
+    RUBY
+  end
+
   it 'checks describe statements after a require' do
     expect_offense(<<-RUBY)
       require 'spec_helper'

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

@@ -3,12 +3,12 @@
 RSpec.describe RuboCop::Cop::RSpec::DescribedClass, :config do
   subject(:cop) { described_class.new(config) }
 
-  let(:cop_config) do
-    { 'EnforcedStyle' => enforced_style }
-  end
+  let(:cop_config) { {} }
+
+  context 'when SkipBlocks is `true`' do
+    let(:cop_config) { { 'SkipBlocks' => true } }
 
-  shared_examples 'SkipBlocks enabled' do
-    it 'does not flag violations within non-rspec blocks' do
+    it 'ignores violations within non-rspec blocks' do
       expect_offense(<<-RUBY)
         describe MyClass do
           controller(ApplicationController) do
@@ -28,7 +28,7 @@ RSpec.describe RuboCop::Cop::RSpec::DescribedClass, :config do
     end
   end
 
-  shared_examples 'SkipBlocks disabled' do
+  context 'when SkipBlocks is `false`' do
     it 'flags violations within all blocks' do
       expect_offense(<<-RUBY)
         describe MyClass do
@@ -37,7 +37,7 @@ RSpec.describe RuboCop::Cop::RSpec::DescribedClass, :config do
                   ^^^^^^^ Use `described_class` instead of `MyClass`.
           end
 
-          before(:each) do
+          before do
             MyClass
             ^^^^^^^ Use `described_class` instead of `MyClass`.
 
@@ -51,34 +51,10 @@ RSpec.describe RuboCop::Cop::RSpec::DescribedClass, :config do
     end
   end
 
-  context 'when SkipBlocks is `true`' do
-    let(:cop_config) { { 'SkipBlocks' => true } }
-
-    include_examples 'SkipBlocks enabled'
-  end
-
-  context 'when SkipBlocks anything besides `true`' do
-    let(:cop_config) { { 'SkipBlocks' => 'yes' } }
-
-    include_examples 'SkipBlocks disabled'
-  end
-
-  context 'when SkipBlocks is not set' do
-    let(:cop_config) { {} }
-
-    include_examples 'SkipBlocks disabled'
-  end
-
-  context 'when SkipBlocks is `false`' do
-    let(:cop_config) { { 'SkipBlocks' => false } }
-
-    include_examples 'SkipBlocks disabled'
-  end
-
   context 'when EnforcedStyle is :described_class' do
-    let(:enforced_style) { :described_class }
+    let(:cop_config) { { 'EnforcedStyle' => :described_class } }
 
-    it 'checks for the use of the described class' do
+    it 'flags for the use of the described class' do
       expect_offense(<<-RUBY)
         describe MyClass do
           include MyClass
@@ -91,6 +67,25 @@ RSpec.describe RuboCop::Cop::RSpec::DescribedClass, :config do
                    ^^^^^^^ Use `described_class` instead of `MyClass`.
         end
       RUBY
+
+      expect_correction(<<-RUBY)
+        describe MyClass do
+          include described_class
+
+          subject { described_class.do_something }
+
+          before { described_class.do_something }
+        end
+      RUBY
+    end
+
+    it 'flags with metadata' do
+      expect_offense(<<-RUBY)
+        describe MyClass, some: :metadata do
+          subject { MyClass }
+                    ^^^^^^^ Use `described_class` instead of `MyClass`.
+        end
+      RUBY
     end
 
     it 'ignores described class as string' do
@@ -131,14 +126,14 @@ RSpec.describe RuboCop::Cop::RSpec::DescribedClass, :config do
       RUBY
     end
 
-    it 'only takes class from top level describes' do
+    it 'takes class from innermost describe' do
       expect_offense(<<-RUBY)
         describe MyClass do
           describe MyClass::Foo do
             subject { MyClass::Foo }
+                      ^^^^^^^^^^^^ Use `described_class` instead of `MyClass::Foo`.
 
             let(:foo) { MyClass }
-                        ^^^^^^^ Use `described_class` instead of `MyClass`.
           end
         end
       RUBY
@@ -152,7 +147,7 @@ RSpec.describe RuboCop::Cop::RSpec::DescribedClass, :config do
       RUBY
     end
 
-    it 'ignores if namespace is not matching' do
+    it 'ignores non-matching namespace defined on `describe` level' do
       expect_no_offenses(<<-RUBY)
         describe MyNamespace::MyClass do
           subject { ::MyClass }
@@ -161,7 +156,17 @@ RSpec.describe RuboCop::Cop::RSpec::DescribedClass, :config do
       RUBY
     end
 
-    it 'checks for the use of described class with namespace' do
+    it 'ignores non-matching namespace' do
+      expect_no_offenses(<<-RUBY)
+        module MyNamespace
+          describe MyClass do
+            subject { ::MyClass }
+          end
+        end
+      RUBY
+    end
+
+    it 'flags the use of described class with namespace' do
       expect_offense(<<-RUBY)
         describe MyNamespace::MyClass do
           subject { MyNamespace::MyClass }
@@ -170,7 +175,17 @@ RSpec.describe RuboCop::Cop::RSpec::DescribedClass, :config do
       RUBY
     end
 
-    it 'does not flag violations within a class scope change' do
+    it 'ignores non-matching namespace in usages' do
+      expect_no_offenses(<<-RUBY)
+        module UnrelatedNamespace
+          describe MyClass do
+            subject { MyNamespace::MyClass }
+          end
+        end
+      RUBY
+    end
+
+    it 'ignores violations within a class scope change' do
       expect_no_offenses(<<-RUBY)
         describe MyNamespace::MyClass do
           before do
@@ -182,7 +197,7 @@ RSpec.describe RuboCop::Cop::RSpec::DescribedClass, :config do
       RUBY
     end
 
-    it 'does not flag violations within a hook scope change' do
+    it 'ignores violations within a hook scope change' do
       expect_no_offenses(<<-RUBY)
         describe do
           before do
@@ -192,17 +207,46 @@ RSpec.describe RuboCop::Cop::RSpec::DescribedClass, :config do
       RUBY
     end
 
-    it 'checks for the use of described class with module' do
-      pending
-
+    it 'flags the use of described class with module' do
       expect_offense(<<-RUBY)
         module MyNamespace
           describe MyClass do
             subject { MyNamespace::MyClass }
-                      ^^^^^^^^^^^^^^^^^^^^ Use `described_class` instead of `MyNamespace::MyClass`
+                      ^^^^^^^^^^^^^^^^^^^^ Use `described_class` instead of `MyNamespace::MyClass`.
           end
         end
       RUBY
+
+      expect_correction(<<-RUBY)
+        module MyNamespace
+          describe MyClass do
+            subject { described_class }
+          end
+        end
+      RUBY
+    end
+
+    it 'flags the use of described class with nested namespace' do
+      expect_offense(<<-RUBY)
+          module A
+            class B::C
+              module D
+                describe E do
+                  subject { A::B::C::D::E }
+                            ^^^^^^^^^^^^^ Use `described_class` instead of `A::B::C::D::E`.
+                  let(:one) { B::C::D::E }
+                              ^^^^^^^^^^ Use `described_class` instead of `B::C::D::E`.
+                  let(:two) { C::D::E }
+                              ^^^^^^^ Use `described_class` instead of `C::D::E`.
+                  let(:six) { D::E }
+                              ^^^^ Use `described_class` instead of `D::E`.
+                  let(:ten) { E }
+                              ^ Use `described_class` instead of `E`.
+                end
+              end
+            end
+          end
+      RUBY
     end
 
     it 'accepts an empty block' do
@@ -211,24 +255,12 @@ RSpec.describe RuboCop::Cop::RSpec::DescribedClass, :config do
         end
       RUBY
     end
-
-    include_examples 'autocorrect',
-                     'describe(Foo) { include Foo }',
-                     'describe(Foo) { include described_class }'
-
-    include_examples 'autocorrect',
-                     'describe(Foo) { subject { Foo.do_action } }',
-                     'describe(Foo) { subject { described_class.do_action } }'
-
-    include_examples 'autocorrect',
-                     'describe(Foo) { before { Foo.do_action } }',
-                     'describe(Foo) { before { described_class.do_action } }'
   end
 
   context 'when EnforcedStyle is :explicit' do
-    let(:enforced_style) { :explicit }
+    let(:cop_config) { { 'EnforcedStyle' => :explicit } }
 
-    it 'checks for the use of the described_class' do
+    it 'flags the use of the described_class' do
       expect_offense(<<-RUBY)
         describe MyClass do
           include described_class
@@ -241,6 +273,16 @@ RSpec.describe RuboCop::Cop::RSpec::DescribedClass, :config do
                    ^^^^^^^^^^^^^^^ Use `MyClass` instead of `described_class`.
         end
       RUBY
+
+      expect_correction(<<-RUBY)
+        describe MyClass do
+          include MyClass
+
+          subject { MyClass.do_something }
+
+          before { MyClass.do_something }
+        end
+      RUBY
     end
 
     it 'ignores described_class as string' do
@@ -259,7 +301,7 @@ RSpec.describe RuboCop::Cop::RSpec::DescribedClass, :config do
       RUBY
     end
 
-    it 'does not flag violations within a class scope change' do
+    it 'ignores violations within a class scope change' do
       expect_no_offenses(<<-RUBY)
         describe MyNamespace::MyClass do
           before do
@@ -271,7 +313,7 @@ RSpec.describe RuboCop::Cop::RSpec::DescribedClass, :config do
       RUBY
     end
 
-    it 'does not flag violations within a hook scope change' do
+    it 'ignores violations within a hook scope change' do
       expect_no_offenses(<<-RUBY)
         describe do
           before do
@@ -281,27 +323,18 @@ RSpec.describe RuboCop::Cop::RSpec::DescribedClass, :config do
       RUBY
     end
 
-    include_examples 'autocorrect',
-                     'describe(Foo) { include described_class }',
-                     'describe(Foo) { include Foo }'
-
-    include_examples 'autocorrect',
-                     'describe(Foo) { subject { described_class.do_action } }',
-                     'describe(Foo) { subject { Foo.do_action } }'
-
-    include_examples 'autocorrect',
-                     'describe(Foo) { before { described_class.do_action } }',
-                     'describe(Foo) { before { Foo.do_action } }'
-
-    original = <<-RUBY
-      describe(Foo) { include described_class }
-      describe(Bar) { include described_class }
-    RUBY
-    corrected = <<-RUBY
-      describe(Foo) { include Foo }
-      describe(Bar) { include Bar }
-    RUBY
+    it 'autocorrects corresponding' do
+      expect_offense(<<-RUBY)
+        describe(Foo) { include described_class }
+                                ^^^^^^^^^^^^^^^ Use `Foo` instead of `described_class`.
+        describe(Bar) { include described_class }
+                                ^^^^^^^^^^^^^^^ Use `Bar` instead of `described_class`.
+      RUBY
 
-    include_examples 'autocorrect', original, corrected
+      expect_correction(<<-RUBY)
+        describe(Foo) { include Foo }
+        describe(Bar) { include Bar }
+      RUBY
+    end
   end
 end