Merge pull request #2052 from Earlopain/always-expect-correction

Always use `expect_correction` or `expect_no_corrections` when autocorrect is supported

Author: pirj

spec/rubocop/cop/rspec/described_class_spec.rb

@@ -23,6 +23,22 @@
           end
         end
       RUBY
+
+      expect_correction(<<~RUBY)
+        describe MyClass do
+          controller(ApplicationController) do
+            bar = MyClass
+          end
+
+          before do
+            described_class
+
+            Foo.custom_block do
+              MyClass
+            end
+          end
+        end
+      RUBY
     end
   end
 
@@ -46,6 +62,22 @@
           end
         end
       RUBY
+
+      expect_correction(<<~RUBY)
+        describe MyClass do
+          controller(ApplicationController) do
+            bar = described_class
+          end
+
+          before do
+            described_class
+
+            Foo.custom_block do
+              described_class
+            end
+          end
+        end
+      RUBY
     end
   end
 
@@ -95,6 +127,12 @@ module Foo
                     ^^^^^^^ Use `described_class` instead of `MyClass`.
         end
       RUBY
+
+      expect_correction(<<~RUBY)
+        describe MyClass, some: :metadata do
+          subject { described_class }
+        end
+      RUBY
     end
 
     it 'ignores described class as string' do
@@ -146,6 +184,16 @@ module MyModule
           end
         end
       RUBY
+
+      expect_correction(<<~RUBY)
+        describe MyClass do
+          describe MyClass::Foo do
+            subject { described_class }
+
+            let(:foo) { MyClass }
+          end
+        end
+      RUBY
     end
 
     it 'ignores non-matching namespace defined on `describe` level' do
@@ -174,6 +222,12 @@ module MyNamespace
                     ^^^^^^^^^^^^^^^^^^^^ Use `described_class` instead of `MyNamespace::MyClass`.
         end
       RUBY
+
+      expect_correction(<<~RUBY)
+        describe MyNamespace::MyClass do
+          subject { described_class }
+        end
+      RUBY
     end
 
     it 'ignores non-matching namespace in usages' do
@@ -248,6 +302,22 @@ module D
           end
         end
       RUBY
+
+      expect_correction(<<~RUBY)
+        module A
+          class B::C
+            module D
+              describe E do
+                subject { described_class }
+                let(:one) { described_class }
+                let(:two) { described_class }
+                let(:six) { described_class }
+                let(:ten) { described_class }
+              end
+            end
+          end
+        end
+      RUBY
     end
 
     it 'accepts an empty block' do

spec/rubocop/cop/rspec/empty_example_group_spec.rb

@@ -67,6 +67,8 @@
         end
       end
     RUBY
+
+    expect_correction("\n\n")
   end
 
   it 'ignores example group with examples defined in `if` branches' do
@@ -123,6 +125,8 @@
         end
       end
     RUBY
+
+    expect_correction("\n\n")
   end
 
   it 'ignores example group with examples defined in `case` branches' do
@@ -186,6 +190,8 @@
         end
       end
     RUBY
+
+    expect_correction("\n\n")
   end
 
   it 'ignores example group with examples defined in iterator' do
@@ -222,6 +228,8 @@
         more_surroundings
       end
     RUBY
+
+    expect_correction('')
   end
 
   it 'ignores example group with examples defined in `if` branch ' \
@@ -407,6 +415,8 @@
         end
       end
     RUBY
+
+    expect_correction('')
   end
 
   context 'when a custom include method is specified' do

spec/rubocop/cop/rspec/empty_line_after_example_spec.rb

@@ -99,6 +99,19 @@
         it { }
       end
     RUBY
+
+    expect_correction(<<~RUBY)
+      RSpec.context 'foo' do
+        it { }
+        it { }
+
+        it 'does this' do
+        end
+
+        it { }
+        it { }
+      end
+    RUBY
   end
 
   it 'does not register an offense for a comment followed by an empty line' do
@@ -258,6 +271,14 @@
           it { two }
         end
       RUBY
+
+      expect_correction(<<~RUBY)
+        RSpec.describe Foo do
+          it { one }
+
+          it { two }
+        end
+      RUBY
     end
   end
 end

spec/rubocop/cop/rspec/example_wording_spec.rb

@@ -329,6 +329,8 @@
       DESC
       end
     RUBY
+
+    expect_no_corrections
   end
 
   it 'flags an unclear description' do
@@ -337,6 +339,8 @@
           ^^^^^ Your example description is insufficient.
       end
     RUBY
+
+    expect_no_corrections
   end
 
   it 'flags an unclear description despite extra spaces' do
@@ -345,6 +349,8 @@
           ^^^^^^^^^^^ Your example description is insufficient.
       end
     RUBY
+
+    expect_no_corrections
   end
 
   it 'flags an unclear description despite uppercase and lowercase strings' do
@@ -353,6 +359,8 @@
           ^^^^^^ Your example description is insufficient.
       end
     RUBY
+
+    expect_no_corrections
   end
 
   context 'when `DisallowedExamples: Workz`' do
@@ -373,6 +381,8 @@
           " " do
         end
       RUBY
+
+      expect_no_corrections
     end
 
     it 'flags an unclear description' do
@@ -381,6 +391,8 @@
             ^^^^^ Your example description is insufficient.
         end
       RUBY
+
+      expect_no_corrections
     end
 
     it 'flags an unclear description despite uppercase and lowercase strings' do
@@ -389,6 +401,8 @@
             ^^^^^^ Your example description is insufficient.
         end
       RUBY
+
+      expect_no_corrections
     end
   end
 end

spec/rubocop/cop/rspec/expect_change_spec.rb

@@ -46,6 +46,12 @@
                          ^^^^^^^^^^^^^^^^^^^^^ Prefer `change(User, :count)`.
         end
       RUBY
+
+      expect_correction(<<~RUBY)
+        it do
+          expect(run).to change(User, :count).by(1)
+        end
+      RUBY
     end
 
     it 'ignores the usage that adheres to the enforced style' do
@@ -256,6 +262,12 @@
                          ^^^^^^^^^^^^^^^^^^^^ Prefer `change { User.count }`.
         end
       RUBY
+
+      expect_correction(<<~RUBY)
+        it do
+          expect(run).to change { User.count }.by(1)
+        end
+      RUBY
     end
   end
 end

spec/rubocop/cop/rspec/predicate_matcher_spec.rb

@@ -257,6 +257,13 @@
           expect(foo).to have_something
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer using `has_something?` over `have_something` matcher.
         RUBY
+
+        expect_correction(<<~RUBY)
+          expect(foo.empty?).to #{matcher_true}
+          expect(foo.empty?).to #{matcher_true}, 'fail'
+          expect(foo.empty?).to #{matcher_false}
+          expect(foo.has_something?).to #{matcher_true}
+        RUBY
       end
 
       it 'registers an offense for a predicate mather with argument' do
@@ -266,6 +273,11 @@
           expect(foo).to have_key(1)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer using `has_key?` over `have_key` matcher.
         RUBY
+
+        expect_correction(<<~RUBY)
+          expect(foo.something?(1, 2)).to #{matcher_true}
+          expect(foo.has_key?(1)).to #{matcher_true}
+        RUBY
       end
 
       it 'registers an offense for a predicate matcher with a block' do
@@ -279,6 +291,13 @@
           expect(foo).to be_something(x) { |y| y.present? }
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer using `something?` over `be_something` matcher.
         RUBY
+
+        expect_correction(<<~RUBY)
+          expect(foo.all?(&:present?)).to #{matcher_true}
+          expect(foo.all? { |x| x.present? }).to #{matcher_true}
+          expect(foo.all? { present }).to #{matcher_true}
+          expect(foo.something?(x) { |y| y.present? }).to #{matcher_true}
+        RUBY
       end
 
       it 'accepts built in matchers' do

spec/rubocop/cop/rspec/return_from_stub_spec.rb

@@ -218,6 +218,12 @@ def stub_foo
                                       ^^^^^^^^^^ Use block for static values.
         end
       RUBY
+
+      expect_correction(<<~RUBY)
+        it do
+          allow(Foo).to receive(:bar) { 42 }
+        end
+      RUBY
     end
 
     it 'registers an offense for static values returned from chained method' do
@@ -227,6 +233,12 @@ def stub_foo
                                               ^^^^^^^^^^ Use block for static values.
         end
       RUBY
+
+      expect_correction(<<~RUBY)
+        it do
+          allow(Foo).to receive(:bar).with(1) { 42 }
+        end
+      RUBY
     end
 
     it 'registers, but does not try to autocorrect, heredocs' do

spec/rubocop/cop/rspec/sort_metadata_spec.rb

@@ -269,6 +269,16 @@
           end
         end
       RUBY
+
+      expect_correction(<<~RUBY)
+        RSpec.describan "Algo", :a, :b do
+          contexto_compartido 'una situación complicada', baz: true, foo: 'bar' do
+          end
+
+          ejemplo "hablando español", baz: true, foo: 'bar' do
+          end
+        end
+      RUBY
     end
   end
 end