rubocop-rspec 1.33.0 → 1.34.0

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

@@ -28,6 +28,19 @@ RSpec.describe RuboCop::Cop::RSpec::ExampleWording, :config do
       RUBY
     end
 
+    it 'finds interpolated description with `should` at the beginning' do
+      expect_offense(<<-'RUBY')
+        it "should do #{:stuff}" do
+            ^^^^^^^^^^^^^^^^^^^ Do not use should when describing your tests.
+        end
+      RUBY
+
+      expect_correction(<<-'RUBY')
+        it "does #{:stuff}" do
+        end
+      RUBY
+    end
+
     it 'finds description with `Should` at the beginning' do
       expect_offense(<<-RUBY)
         it 'Should do something' do
@@ -106,6 +119,19 @@ RSpec.describe RuboCop::Cop::RSpec::ExampleWording, :config do
       RUBY
     end
 
+    it 'finds leading it in interpolated description' do
+      expect_offense(<<-'RUBY')
+        it "it does #{action}" do
+            ^^^^^^^^^^^^^^^^^ Do not repeat 'it' when describing your tests.
+        end
+      RUBY
+
+      expect_correction(<<-'RUBY')
+        it "does #{action}" do
+        end
+      RUBY
+    end
+
     it "skips words beginning with 'it'" do
       expect_no_offenses(<<-RUBY)
         it 'itemizes items' do
@@ -126,6 +152,13 @@ RSpec.describe RuboCop::Cop::RSpec::ExampleWording, :config do
         end
       RUBY
     end
+
+    it 'skips interpolated description without literal `should` at the start' do
+      expect_no_offenses(<<-'RUBY')
+        it "#{should} not be here" do
+        end
+      RUBY
+    end
   end
 
   context 'when configuration is empty' do

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::RSpec::LeakyConstantDeclaration do
+  subject(:cop) { described_class.new }
+
+  describe 'constant assignment' do
+    it 'flags inside an example group' do
+      expect_offense(<<-RUBY)
+        describe SomeClass do
+          CONSTANT = "Accessible as ::CONSTANT".freeze
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Stub constant instead of declaring explicitly.
+        end
+      RUBY
+    end
+
+    it 'flags inside shared example group' do
+      expect_offense(<<-RUBY)
+        RSpec.shared_examples 'shared example' do
+          CONSTANT = "Accessible as ::CONSTANT".freeze
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Stub constant instead of declaring explicitly.
+        end
+      RUBY
+    end
+
+    it 'flags inside an example' do
+      expect_offense(<<-RUBY)
+        describe SomeClass do
+          specify do
+            CONSTANT = "Accessible as ::CONSTANT".freeze
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Stub constant instead of declaring explicitly.
+          end
+        end
+      RUBY
+    end
+
+    it 'ignores outside of example/shared group' do
+      expect_no_offenses(<<-RUBY)
+        factory :some_class do
+          CONSTANT = "Accessible as ::CONSTANT".freeze
+        end
+      RUBY
+    end
+  end
+
+  describe 'class defined' do
+    it 'flags inside an example group' do
+      expect_offense(<<-RUBY)
+        describe SomeClass do
+          class DummyClass < described_class
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Stub class constant instead of declaring explicitly.
+          end
+        end
+      RUBY
+    end
+
+    it 'ignores anonymous classes' do
+      expect_no_offenses(<<-RUBY)
+        describe SomeClass do
+          let(:dummy_playbook) do
+            Class.new do
+              def method
+              end
+            end
+          end
+         end
+      RUBY
+    end
+
+    it 'flags namespaced class' do
+      expect_offense(<<-RUBY)
+        describe SomeClass do
+          class SomeModule::AnotherModule::DummyClass
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Stub class constant instead of declaring explicitly.
+          end
+        end
+      RUBY
+    end
+  end
+
+  describe 'module defined' do
+    it 'flags inside an example group' do
+      expect_offense(<<-RUBY)
+        describe SomeClass do
+          module DummyModule
+          ^^^^^^^^^^^^^^^^^^ Stub module constant instead of declaring explicitly.
+          end
+        end
+      RUBY
+    end
+  end
+end

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

@@ -7,7 +7,7 @@ RSpec.describe RuboCop::Cop::RSpec::LetSetup do
     expect_offense(<<-RUBY)
       describe Foo do
         let!(:foo) { bar }
-        ^^^^^^^^^^ Do not use `let!` for test setup.
+        ^^^^^^^^^^ Do not use `let!` to setup objects not referenced in tests.
 
         it 'does not use foo' do
           expect(baz).to eq(qux)
@@ -50,7 +50,7 @@ RSpec.describe RuboCop::Cop::RSpec::LetSetup do
       describe Foo do
         context 'when something special happens' do
           let!(:foo) { bar }
-          ^^^^^^^^^^ Do not use `let!` for test setup.
+          ^^^^^^^^^^ Do not use `let!` to setup objects not referenced in tests.
 
           it 'does not use foo' do
             expect(baz).to eq(qux)

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

@@ -96,11 +96,11 @@ RSpec.describe RuboCop::Cop::RSpec::MultipleExpectations, :config do
     end
   end
 
-  context 'with meta data' do
+  context 'with metadata' do
     it 'ignores examples with `:aggregate_failures`' do
       expect_no_offenses(<<-RUBY)
         describe Foo do
-          it 'uses expect twice', :aggregate_failures do
+          it 'uses expect twice', :foo, :aggregate_failures do
             expect(foo).to eq(bar)
             expect(baz).to eq(bar)
           end
@@ -108,10 +108,10 @@ RSpec.describe RuboCop::Cop::RSpec::MultipleExpectations, :config do
       RUBY
     end
 
-    it 'ignores examples with `aggregate_failures: true`' do
+    it 'ignores example groups with `:aggregate_failures`' do
       expect_no_offenses(<<-RUBY)
-        describe Foo do
-          it 'uses expect twice', aggregate_failures: true do
+        describe Foo, :foo, :aggregate_failures do
+          it 'uses expect twice' do
             expect(foo).to eq(bar)
             expect(baz).to eq(bar)
           end
@@ -119,27 +119,20 @@ RSpec.describe RuboCop::Cop::RSpec::MultipleExpectations, :config do
       RUBY
     end
 
-    it 'checks examples with `aggregate_failures: false`' do
-      expect_offense(<<-RUBY)
+    it 'ignores examples with `aggregate_failures: true`' do
+      expect_no_offenses(<<-RUBY)
         describe Foo do
-          it 'uses expect twice', aggregate_failures: false do
-          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Example has too many expectations [2/1].
+          it 'uses expect twice', :foo, bar: 1, aggregate_failures: true do
             expect(foo).to eq(bar)
             expect(baz).to eq(bar)
           end
         end
       RUBY
     end
-  end
 
-  context 'with Max configuration' do
-    let(:cop_config) do
-      { 'Max' => '2' }
-    end
-
-    it 'permits two expectations' do
+    it 'ignores example groups with `aggregate_failures: true`' do
       expect_no_offenses(<<-RUBY)
-        describe Foo do
+        describe Foo, :foo, bar: 1, aggregate_failures: true do
           it 'uses expect twice' do
             expect(foo).to eq(bar)
             expect(baz).to eq(bar)
@@ -148,29 +141,35 @@ RSpec.describe RuboCop::Cop::RSpec::MultipleExpectations, :config do
       RUBY
     end
 
-    it 'flags three expectations' do
+    it 'prefers example metadata over example group metadata' do
       expect_offense(<<-RUBY)
-        describe Foo do
-          it 'uses expect three times' do
-          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Example has too many expectations [3/2].
+        describe Foo, aggregate_failures: true do
+          it 'uses expect twice', aggregate_failures: false do
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Example has too many expectations [2/1].
             expect(foo).to eq(bar)
             expect(baz).to eq(bar)
-            expect(qux).to eq(bar)
           end
         end
       RUBY
     end
-  end
 
-  context 'with AggregateFailuresByDefault configuration' do
-    let(:cop_config) do
-      { 'AggregateFailuresByDefault' => true }
+    it 'checks examples with `aggregate_failures: false`' do
+      expect_offense(<<-RUBY)
+        describe Foo do
+          it 'uses expect twice', aggregate_failures: false do
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Example has too many expectations [2/1].
+            expect(foo).to eq(bar)
+            expect(baz).to eq(bar)
+          end
+        end
+      RUBY
     end
 
-    it 'ignores examples without metadata' do
-      expect_no_offenses(<<-RUBY)
-        describe Foo do
+    it 'checks example groups with `aggregate_failures: false`' do
+      expect_offense(<<-RUBY)
+        describe Foo, aggregate_failures: false do
           it 'uses expect twice' do
+          ^^^^^^^^^^^^^^^^^^^^^^ Example has too many expectations [2/1].
             expect(foo).to eq(bar)
             expect(baz).to eq(bar)
           end
@@ -178,10 +177,15 @@ RSpec.describe RuboCop::Cop::RSpec::MultipleExpectations, :config do
       RUBY
     end
 
-    it 'ignores examples with `:aggregate_failures`' do
-      expect_no_offenses(<<-RUBY)
+    it 'checks examples with siblings with `aggregate_failures: true`' do
+      expect_offense(<<-RUBY)
         describe Foo do
-          it 'uses expect twice', :aggregate_failures do
+          it 'uses expect twice' do
+          ^^^^^^^^^^^^^^^^^^^^^^ Example has too many expectations [2/1].
+            expect(foo).to eq(bar)
+            expect(baz).to eq(bar)
+          end
+          it 'with aggregate_failures', aggregate_failures: true do
             expect(foo).to eq(bar)
             expect(baz).to eq(bar)
           end
@@ -189,10 +193,32 @@ RSpec.describe RuboCop::Cop::RSpec::MultipleExpectations, :config do
       RUBY
     end
 
-    it 'ignores examples with `aggregate_failures: true`' do
+    it 'ignores examples with `aggregate_failures: true` defined deeply' do
+      expect_no_offenses(<<-RUBY)
+        describe Bar, aggregate_failures: true do
+          describe Foo do
+            it 'uses expect twice' do
+              expect(foo).to eq(bar)
+              expect(baz).to eq(bar)
+            end
+            it 'with aggregate_failures', aggregate_failures: false do
+              expect(foo).to eq(bar)
+            end
+          end
+        end
+      RUBY
+    end
+  end
+
+  context 'with Max configuration' do
+    let(:cop_config) do
+      { 'Max' => '2' }
+    end
+
+    it 'permits two expectations' do
       expect_no_offenses(<<-RUBY)
         describe Foo do
-          it 'uses expect twice', aggregate_failures: true do
+          it 'uses expect twice' do
             expect(foo).to eq(bar)
             expect(baz).to eq(bar)
           end
@@ -200,13 +226,14 @@ RSpec.describe RuboCop::Cop::RSpec::MultipleExpectations, :config do
       RUBY
     end
 
-    it 'checks examples with `aggregate_failures: false`' do
+    it 'flags three expectations' do
       expect_offense(<<-RUBY)
         describe Foo do
-          it 'uses expect twice', aggregate_failures: false do
-          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Example has too many expectations [2/1].
+          it 'uses expect three times' do
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Example has too many expectations [3/2].
             expect(foo).to eq(bar)
             expect(baz).to eq(bar)
+            expect(qux).to eq(bar)
           end
         end
       RUBY

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

@@ -3,14 +3,14 @@
 RSpec.describe RuboCop::Cop::RSpec::SubjectStub do
   subject(:cop) { described_class.new }
 
-  it 'complains when subject is stubbed' do
+  it 'flags when subject is stubbed' do
     expect_offense(<<-RUBY)
       describe Foo do
         subject(:foo) { described_class.new }
 
         before do
           allow(foo).to receive(:bar).and_return(baz)
-          ^^^^^^^^^^ Do not stub your test subject.
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub methods of the object under test.
         end
 
         it 'uses expect twice' do
@@ -20,20 +20,20 @@ RSpec.describe RuboCop::Cop::RSpec::SubjectStub do
     RUBY
   end
 
-  it 'complains when subject is mocked' do
+  it 'flags when subject is mocked' do
     expect_offense(<<-RUBY)
       describe Foo do
         subject(:foo) { described_class.new }
 
         before do
           expect(foo).to receive(:bar).and_return(baz)
-          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub your test subject.
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub methods of the object under test.
           expect(foo).to receive(:bar)
-          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub your test subject.
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub methods of the object under test.
           expect(foo).to receive(:bar).with(1)
-          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub your test subject.
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub methods of the object under test.
           expect(foo).to receive(:bar).with(1).and_return(2)
-          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub your test subject.
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub methods of the object under test.
         end
 
         it 'uses expect twice' do
@@ -43,6 +43,45 @@ RSpec.describe RuboCop::Cop::RSpec::SubjectStub do
     RUBY
   end
 
+  it 'flags when an unnamed subject is mocked' do
+    expect_offense(<<-RUBY)
+      describe Foo do
+        subject { described_class.new }
+
+        it 'uses unnamed subject' do
+          expect(subject).to receive(:bar)
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub methods of the object under test.
+        end
+      end
+    RUBY
+  end
+
+  it 'flags an expectation made on an unnamed subject' do
+    expect_offense(<<-RUBY)
+      describe Foo do
+        subject(:foo) { described_class.new }
+
+        it 'uses unnamed subject' do
+          expect(subject).to receive(:bar)
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub methods of the object under test.
+        end
+      end
+    RUBY
+  end
+
+  it 'flags one-line expectcation syntax' do
+    expect_offense(<<-RUBY)
+      describe Foo do
+        subject(:foo) { described_class.new }
+
+        it 'uses one-line expectation syntax' do
+          is_expected.to receive(:bar)
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub methods of the object under test.
+        end
+      end
+    RUBY
+  end
+
   it 'ignores stub within context where subject name changed' do
     expect_no_offenses(<<-RUBY)
       describe Foo do
@@ -59,12 +98,13 @@ RSpec.describe RuboCop::Cop::RSpec::SubjectStub do
     RUBY
   end
 
-  it 'ignores stub when inside all matcher' do
-    expect_no_offenses(<<-RUBY)
+  it 'flags stub inside all matcher' do
+    expect_offense(<<-RUBY)
       describe Foo do
         subject(:foo) { [Object.new] }
         it 'tries to trick rubocop-rspec' do
           expect(foo).to all(receive(:baz))
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub methods of the object under test.
         end
       end
     RUBY
@@ -80,7 +120,7 @@ RSpec.describe RuboCop::Cop::RSpec::SubjectStub do
 
           before do
             allow(foo).to receive(:wow)
-            ^^^^^^^^^^ Do not stub your test subject.
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub methods of the object under test.
           end
 
           it 'tries to trick rubocop-rspec' do
@@ -119,7 +159,7 @@ RSpec.describe RuboCop::Cop::RSpec::SubjectStub do
         context 'when I shake things up' do
           before do
             allow(foo).to receive(:wow)
-            ^^^^^^^^^^ Do not stub your test subject.
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub methods of the object under test.
           end
 
           it 'tries to trick rubocop-rspec' do
@@ -141,7 +181,7 @@ RSpec.describe RuboCop::Cop::RSpec::SubjectStub do
           before do
             allow(foo).to receive(:wow)
             allow(bar).to receive(:wow)
-            ^^^^^^^^^^ Do not stub your test subject.
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub methods of the object under test.
           end
 
           it 'tries to trick rubocop-rspec' do
@@ -163,7 +203,7 @@ RSpec.describe RuboCop::Cop::RSpec::SubjectStub do
 
         it 'still flags this test' do
           allow(foo).to receive(:blah)
-          ^^^^^^^^^^ Do not stub your test subject.
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub methods of the object under test.
         end
       end
     RUBY
@@ -184,11 +224,70 @@ RSpec.describe RuboCop::Cop::RSpec::SubjectStub do
               allow(foo).to receive(:wow)
               allow(bar).to receive(:wow)
               allow(baz).to receive(:wow)
-              ^^^^^^^^^^ Do not stub your test subject.
+              ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub methods of the object under test.
             end
           end
         end
       end
     RUBY
   end
+
+  it 'flags negated runners' do
+    expect_offense(<<-RUBY)
+      describe Foo do
+        subject(:foo) { described_class.new }
+
+        specify do
+          expect(foo).not_to receive(:bar)
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub methods of the object under test.
+          expect(foo).to_not receive(:bar)
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub methods of the object under test.
+          expect(foo.bar).to eq(baz)
+        end
+      end
+    RUBY
+  end
+
+  it 'flags multiple-method stubs' do
+    expect_offense(<<-RUBY)
+      describe Foo do
+        subject(:foo) { described_class.new }
+
+        specify do
+          expect(foo).to receive_messages(bar: :baz, baz: :baz)
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub methods of the object under test.
+          expect(foo.bar).to eq(baz)
+        end
+      end
+    RUBY
+  end
+
+  it 'flags chain stubs' do
+    expect_offense(<<-RUBY)
+      describe Foo do
+        subject(:foo) { described_class.new }
+
+        specify do
+          expect(foo).to receive_message_chain(:bar, baz: :baz)
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub methods of the object under test.
+          expect(foo.bar.baz).to eq(baz)
+        end
+      end
+    RUBY
+  end
+
+  it 'flags spy subject stubs' do
+    expect_offense(<<-RUBY)
+      describe Foo do
+        subject(:foo) { described_class.new }
+
+        specify do
+          allow(foo).to some_matcher_that_allows_a_bar_message
+          expect(foo.bar).to eq(baz)
+          expect(foo).to have_received(:bar)
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Do not stub methods of the object under test.
+        end
+      end
+    RUBY
+  end
 end