Merge pull request #10086 from dvandersluis/expect-no-corrections

Guard against `expect_corrections` with no changes
rubocop · Sep 15, 2021 · 80c9feb · 80c9feb
2 parents 90cace7 + 92fcdaf
commit 80c9feb
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 40 deletions.
diff --git a/lib/rubocop/rspec/expect_offense.rb b/lib/rubocop/rspec/expect_offense.rb
@@ -126,7 +126,7 @@ def expect_offense(source, file = nil, severity: nil, chomp: false, **replacemen
         @offenses
       end
 
-      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity
       def expect_correction(correction, loop: true, source: nil)
         if source
           expected_annotations = parse_annotations(source, raise_error: false)
@@ -136,6 +136,8 @@ def expect_correction(correction, loop: true, source: nil)
 
         raise '`expect_correction` must follow `expect_offense`' unless @processed_source
 
+        source = @processed_source.raw_source
+
         iteration = 0
         new_source = loop do
           iteration += 1
@@ -155,9 +157,11 @@ def expect_correction(correction, loop: true, source: nil)
           _investigate(cop, @processed_source)
         end
 
+        raise 'Use `expect_no_corrections` if the code will not change' if new_source == source
+
         expect(new_source).to eq(correction)
       end
-      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity
 
       def expect_no_corrections
         raise '`expect_no_corrections` must follow `expect_offense`' unless @processed_source

diff --git a/spec/rubocop/cop/layout/line_length_spec.rb b/spec/rubocop/cop/layout/line_length_spec.rb
@@ -1094,9 +1094,7 @@ def baz(bar)
                                                     ^^^^^^^^^^^^^^^^^^^^^^^^^^ Line is too long. [66/40]
           RUBY
 
-          expect_correction(<<~RUBY)
-            "00000000000000000;0000000000000000000'000000;00000'0000;0000;000"
-          RUBY
+          expect_no_corrections
         end
       end
     end

diff --git a/spec/rubocop/cop/lint/heredoc_method_call_position_spec.rb b/spec/rubocop/cop/lint/heredoc_method_call_position_spec.rb
@@ -131,14 +131,7 @@
           3).foo
         RUBY
 
-        # Should not autocorrect -- cannot always be done safely.
-        expect_correction(<<~RUBY)
-          <<-SQL
-            foo
-          SQL
-          .abc(1, 2,
-          3).foo
-        RUBY
+        expect_no_corrections
       end
     end
 
@@ -153,14 +146,7 @@
           .foo
         RUBY
 
-        # Should not autocorrect -- cannot always be done safely.
-        expect_correction(<<~RUBY)
-          <<-SQL
-            foo
-          SQL
-          .abc
-          .foo
-        RUBY
+        expect_no_corrections
       end
     end
   end

diff --git a/spec/rubocop/cop/lint/script_permission_spec.rb b/spec/rubocop/cop/lint/script_permission_spec.rb
@@ -36,9 +36,7 @@
           ^^^^^^^^^^^^^^^ Script file #{filename} doesn't have execute permission.
         RUBY
 
-        expect_correction(<<~RUBY)
-          #!/usr/bin/ruby
-        RUBY
+        expect_no_corrections
         expect(file.stat.executable?).to be_truthy
       end
 

diff --git a/spec/rubocop/cop/style/empty_else_spec.rb b/spec/rubocop/cop/style/empty_else_spec.rb
@@ -117,23 +117,18 @@
       end
 
       context 'with an empty comment' do
-        let(:source) { <<~RUBY }
-          if cond
-            something
-          else
-          ^^^^ Redundant `else`-clause.
-            # TODO
-          end
-        RUBY
-        let(:corrected_source) { <<~RUBY }
-          if cond
-            something
-          else
-            # TODO
-          end
-        RUBY
+        it 'does not auto-correct' do
+          expect_offense(<<~RUBY)
+            if cond
+              something
+            else
+            ^^^^ Redundant `else`-clause.
+              # TODO
+            end
+          RUBY
 
-        it_behaves_like 'auto-correct', 'if'
+          expect_no_corrections
+        end
       end
     end