Support itblock

CHANGELOG.md

@@ -8,6 +8,7 @@
 - Change `RSpec/ScatteredSetup` to allow `around` hooks to be scattered. ([@ydah])
 - Fix an error `RSpec/ChangeByZero` cop when without expect block. ([@lee266])
 - Fix a false positive for `RSpec/DescribedClass` when `SkipBlocks` is true and numblocks are used. ([@earlopain])
+- Add support for `itblock` from Ruby 3.4. ([@earlopain])
 
 ## 3.5.0 (2025-02-16)
 

lib/rubocop/cop/rspec/around_block.rb

@@ -41,6 +41,11 @@ class AroundBlock < Base
           (numblock (send nil? :around sym ?) ...)
         PATTERN
 
+        # @!method hook_itblock(node)
+        def_node_matcher :hook_itblock, <<~PATTERN
+          (itblock (send nil? :around sym ?) ...)
+        PATTERN
+
         # @!method find_arg_usage(node)
         def_node_search :find_arg_usage, <<~PATTERN
           {(send $... {:call :run}) (send _ _ $...) (yield $...) (block-pass $...)}
@@ -51,14 +56,20 @@ def on_block(node)
             if example_proxy.nil?
               add_no_arg_offense(node)
             else
-              check_for_unused_proxy(node, example_proxy)
+              check_for_unused_proxy(node, example_proxy, example_proxy.name)
             end
           end
         end
 
         def on_numblock(node)
           hook_numblock(node) do
-            check_for_numblock(node)
+            check_for_unused_proxy(node, node.children.last, :_1)
+          end
+        end
+
+        def on_itblock(node)
+          hook_itblock(node) do
+            check_for_unused_proxy(node, node.children.last, :it)
           end
         end
 
@@ -68,25 +79,14 @@ def add_no_arg_offense(node)
           add_offense(node, message: MSG_NO_ARG)
         end
 
-        def check_for_unused_proxy(block, proxy)
-          find_arg_usage(block) do |usage|
-            return if usage.include?(s(:lvar, proxy.name))
-          end
-
-          add_offense(
-            proxy,
-            message: format(MSG_UNUSED_ARG, arg: proxy.name)
-          )
-        end
-
-        def check_for_numblock(block)
+        def check_for_unused_proxy(block, range, name)
           find_arg_usage(block) do |usage|
-            return if usage.include?(s(:lvar, :_1))
+            return if usage.include?(s(:lvar, name))
           end
 
           add_offense(
-            block.children.last,
-            message: format(MSG_UNUSED_ARG, arg: :_1)
+            range,
+            message: format(MSG_UNUSED_ARG, arg: name)
           )
         end
       end

lib/rubocop/cop/rspec/empty_line_after_hook.rb

@@ -68,6 +68,7 @@ def on_block(node)
         end
 
         alias on_numblock on_block
+        alias on_itblock on_block
 
         private
 

lib/rubocop/cop/rspec/expect_in_hook.rb

@@ -38,6 +38,7 @@ def on_block(node)
         end
 
         alias on_numblock on_block
+        alias on_itblock on_block
 
         private
 

lib/rubocop/cop/rspec/hook_argument.rb

@@ -89,6 +89,7 @@ def on_block(node)
         end
 
         alias on_numblock on_block
+        alias on_itblock on_block
 
         private
 

lib/rubocop/cop/rspec/hooks_before_examples.rb

@@ -38,14 +38,12 @@ class HooksBeforeExamples < Base
           }
         PATTERN
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           return unless example_group_with_body?(node)
 
           check_hooks(node.body) if multiline_block?(node.body)
         end
 
-        alias on_numblock on_block
-
         private
 
         def multiline_block?(block)

lib/rubocop/cop/rspec/iterated_expectation.rb

@@ -36,29 +36,44 @@ class IteratedExpectation < Base
           )
         PATTERN
 
+        # @!method each_itblock?(node)
+        def_node_matcher :each_itblock?, <<~PATTERN
+          (itblock
+            (send ... :each) _ $(...)
+          )
+        PATTERN
+
         # @!method expectation?(node)
         def_node_matcher :expectation?, <<~PATTERN
           (send (send nil? :expect (lvar %)) :to ...)
         PATTERN
 
         def on_block(node)
           each?(node) do |arg, body|
-            if single_expectation?(body, arg) || only_expectations?(body, arg)
-              add_offense(node.send_node)
-            end
+            check_expectation(node, body, arg)
           end
         end
 
         def on_numblock(node)
           each_numblock?(node) do |body|
-            if single_expectation?(body, :_1) || only_expectations?(body, :_1)
-              add_offense(node.send_node)
-            end
+            check_expectation(node, body, :_1)
+          end
+        end
+
+        def on_itblock(node)
+          each_itblock?(node) do |body|
+            check_expectation(node, body, :it)
           end
         end
 
         private
 
+        def check_expectation(node, body, arg)
+          if single_expectation?(body, arg) || only_expectations?(body, arg)
+            add_offense(node.send_node)
+          end
+        end
+
         def single_expectation?(body, arg)
           expectation?(body, arg)
         end

lib/rubocop/cop/rspec/mixin/metadata.rb

@@ -27,7 +27,7 @@ module Metadata
           (send (lvar %) #Hooks.all _ $...)
         PATTERN
 
-        def on_block(node)
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
           rspec_configure(node) do |block_var|
             metadata_in_block(node, block_var) do |metadata_arguments|
               on_metadata_arguments(metadata_arguments)
@@ -38,7 +38,6 @@ def on_block(node)
             on_metadata_arguments(metadata_arguments)
           end
         end
-        alias on_numblock on_block
 
         def on_metadata(_symbols, _hash)
           raise ::NotImplementedError

lib/rubocop/cop/rspec/no_expectation_example.rb

@@ -96,6 +96,7 @@ def on_block(node)
         end
 
         alias on_numblock on_block
+        alias on_itblock on_block
       end
     end
   end

lib/rubocop/cop/rspec/redundant_around.rb

@@ -28,6 +28,7 @@ def on_block(node)
           end
         end
         alias on_numblock on_block
+        alias on_itblock on_block
 
         def on_send(node)
           return unless match_redundant_around_hook_send?(node)

lib/rubocop/cop/rspec/skip_block_inside_example.rb

@@ -34,6 +34,7 @@ def on_block(node)
         end
 
         alias on_numblock on_block
+        alias on_itblock on_block
 
         private
 

rubocop-rspec.gemspec

@@ -39,5 +39,5 @@ Gem::Specification.new do |spec|
   }
 
   spec.add_dependency 'lint_roller', '~> 1.1'
-  spec.add_dependency 'rubocop', '~> 1.72', '>= 1.72.1'
+  spec.add_dependency 'rubocop', '~> 1.75'
 end

spec/rubocop/cop/rspec/around_block_spec.rb

@@ -178,4 +178,66 @@
       end
     end
   end
+
+  context 'when Ruby 3.4', :ruby34, unsupported_on: :parser do
+    context 'when the yielded value is unused' do
+      it 'registers an offense' do
+        expect_offense(<<~RUBY)
+          around { it }
+                   ^^ You should call `it.call` or `it.run`.
+        RUBY
+      end
+    end
+
+    context 'when a method other than #run or #call is called' do
+      it 'registers an offense' do
+        expect_offense(<<~RUBY)
+          around do
+            it.inspect
+            ^^^^^^^^^^ You should call `it.call` or `it.run`.
+          end
+        RUBY
+      end
+    end
+
+    context 'when #run is called' do
+      it 'does not register an offense' do
+        expect_no_offenses(<<~RUBY)
+          around do
+            it.run
+          end
+        RUBY
+      end
+    end
+
+    context 'when #call is called' do
+      it 'does not register an offense' do
+        expect_no_offenses(<<~RUBY)
+          around do
+            it.call
+          end
+        RUBY
+      end
+    end
+
+    context 'when used as a block arg' do
+      it 'does not register an offense' do
+        expect_no_offenses(<<~RUBY)
+          around do
+            1.times(&it)
+          end
+        RUBY
+      end
+    end
+
+    context 'when passed to another method' do
+      it 'does not register an offense' do
+        expect_no_offenses(<<~RUBY)
+          around do
+            something_that_might_run_test(it, another_arg)
+          end
+        RUBY
+      end
+    end
+  end
 end

spec/rubocop/cop/rspec/empty_line_after_hook_spec.rb

@@ -483,5 +483,37 @@
         RUBY
       end
     end
+
+    context 'when Ruby 3.4', :ruby34 do
+      it 'registers an offense for empty line after `around` hook' do
+        expect_offense(<<~RUBY)
+          RSpec.describe User do
+            around { it.run }
+            ^^^^^^^^^^^^^^^^^ Add an empty line after `around`.
+            it { does_something }
+          end
+        RUBY
+
+        expect_correction(<<~RUBY)
+          RSpec.describe User do
+            around { it.run }
+
+            it { does_something }
+          end
+        RUBY
+      end
+
+      it 'does not register an offense for multiline `around` block' do
+        expect_no_offenses(<<~RUBY)
+          RSpec.describe User do
+            around do
+              it.run
+            end
+
+            it { does_something }
+          end
+        RUBY
+      end
+    end
   end
 end

spec/rubocop/cop/rspec/expect_in_hook_spec.rb

@@ -90,4 +90,20 @@
       RUBY
     end
   end
+
+  context 'when Ruby 3.4', :ruby34 do
+    it 'adds an offense for `expect` in `around` hook' do
+      expect_offense(<<~RUBY)
+        around do
+          expect(something).to eq('foo')
+          ^^^^^^ Do not use `expect` in `around` hook
+          is_expected(something).to eq('foo')
+          ^^^^^^^^^^^ Do not use `is_expected` in `around` hook
+          expect_any_instance_of(Something).to receive(:foo)
+          ^^^^^^^^^^^^^^^^^^^^^^ Do not use `expect_any_instance_of` in `around` hook
+          it.run
+        end
+      RUBY
+    end
+  end
 end