Merge pull request #1316 from r7kamura/feature/empty-example-group

Add autocorrect support for `RSpec/EmptyExampleGroup`

Author: pirj

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Master (Unreleased)
 
 * Add new `AllowConsecutiveOneLiners` (default true) option for `Rspec/EmptyLineAfterHook` cop. ([@ngouy][])
+* Add autocorrect support for `RSpec/EmptyExampleGroup`. ([@r7kamura][])
 
 ## 2.12.1 (2022-07-03)
 

config/default.yml

@@ -279,8 +279,9 @@ RSpec/Dialect:
 RSpec/EmptyExampleGroup:
   Description: Checks if an example group does not include any tests.
   Enabled: true
+  SafeAutoCorrect: false
   VersionAdded: '1.7'
-  VersionChanged: '2.0'
+  VersionChanged: '2.13'
   Reference: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/EmptyExampleGroup
 
 RSpec/EmptyHook:

docs/modules/ROOT/pages/cops_rspec.adoc

@@ -879,9 +879,9 @@ end
 
 | Enabled
 | Yes
-| No
+| Yes (Unsafe)
 | 1.7
-| 2.0
+| 2.13
 |===
 
 Checks if an example group does not include any tests.

lib/rubocop/cop/rspec/empty_example_group.rb

@@ -36,6 +36,10 @@ module RSpec
       #     pending 'will add tests later'
       #   end
       class EmptyExampleGroup < Base
+        extend AutoCorrector
+
+        include RangeHelp
+
         MSG = 'Empty example group detected.'
 
         # @!method example_group_body(node)
@@ -135,7 +139,11 @@ def on_block(node)
           return if node.each_ancestor(:block).any? { |block| example?(block) }
 
           example_group_body(node) do |body|
-            add_offense(node.send_node) if offensive?(body)
+            next unless offensive?(body)
+
+            add_offense(node.send_node) do |corrector|
+              corrector.remove(removed_range(node))
+            end
           end
         end
 
@@ -163,6 +171,13 @@ def conditionals_with_examples?(body)
         def examples_in_branches?(condition_node)
           condition_node.branches.any? { |branch| examples?(branch) }
         end
+
+        def removed_range(node)
+          range_by_whole_lines(
+            node.location.expression,
+            include_final_newline: true
+          )
+        end
       end
     end
   end

spec/rubocop/cop/rspec/empty_example_group_spec.rb

@@ -19,6 +19,19 @@
         it { should be_true }
       end
     RUBY
+
+    expect_correction(<<~RUBY)
+      describe Foo do
+
+        describe '#thingy?' do
+          specify do
+            expect(whatever.thingy?).to be(true)
+          end
+        end
+
+        it { should be_true }
+      end
+    RUBY
   end
 
   it 'flags an empty top level describe' do
@@ -27,6 +40,9 @@
       ^^^^^^^^^^^^ Empty example group detected.
       end
     RUBY
+
+    expect_correction(<<~RUBY)
+    RUBY
   end
 
   it 'flags example group with examples defined in hooks' do