[Fix #9304] Do not register offense for Style/ExplicitBlockArgument when the yield arguments are not an exact match with the block arguments.

changelog/fix_do_not_register_offense_for.md

@@ -0,0 +1 @@
+* [#9304](https://github.com/rubocop-hq/rubocop/issues/9304): Do not register an offense for `Style/ExplicitBlockArgument` when the `yield` arguments are not an exact match with the block arguments. ([@dvandersluis][])

config/default.yml

@@ -3271,9 +3271,8 @@ Style/ExplicitBlockArgument:
                   that just passes its arguments to another block.
   StyleGuide: '#block-argument'
   Enabled: true
-  # May change the yielding arity.
-  Safe: false
   VersionAdded: '0.89'
+  VersionChanged: <<next>>
 
 Style/ExponentialNotation:
   Description: 'When using exponential notation, favor a mantissa between 1 (inclusive) and 10 (exclusive).'

lib/rubocop/cop/style/explicit_block_argument.rb

@@ -6,6 +6,9 @@ module Style
       # This cop enforces the use of explicit block argument to avoid writing
       # block literal that just passes its arguments to another block.
       #
+      # NOTE: This cop only registers an offense if the block args match the
+      # yield args exactly.
+      #
       # @example
       #   # bad
       #   def with_tmp_dir
@@ -75,7 +78,14 @@ def on_yield(node)
         private
 
         def yielding_arguments?(block_args, yield_args)
+          yield_args = yield_args.dup.fill(
+            nil,
+            yield_args.length, block_args.length - yield_args.length
+          )
+
           yield_args.zip(block_args).all? do |yield_arg, block_arg|
+            next false unless yield_arg && block_arg
+
             block_arg && yield_arg.children.first == block_arg.children.first
           end
         end

spec/rubocop/cop/style/explicit_block_argument_spec.rb

@@ -18,17 +18,25 @@ def m(&block)
     RUBY
   end
 
-  it 'registers an offense and corrects when block yields several first its arguments' do
+  it 'registers an offense and corrects when multiple arguments are yielded' do
     expect_offense(<<~RUBY)
       def m
-        items.something { |i, j| yield i }
-        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Consider using explicit block argument in the surrounding method's signature over `yield`.
+        items.something(first_arg) { |i, j| yield i, j }
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Consider using explicit block argument in the surrounding method's signature over `yield`.
       end
     RUBY
 
     expect_correction(<<~RUBY)
       def m(&block)
-        items.something(&block)
+        items.something(first_arg, &block)
+      end
+    RUBY
+  end
+
+  it 'does not register an offense when arguments are yielded in a different order' do
+    expect_no_offenses(<<~RUBY)
+      def m
+        items.something(first_arg) { |i, j| yield j, i }
       end
     RUBY
   end
@@ -92,8 +100,8 @@ def m
           3.times { yield }
           ^^^^^^^^^^^^^^^^^ Consider using explicit block argument in the surrounding method's signature over `yield`.
         else
-          other_items.something { |i, j| yield i }
-          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Consider using explicit block argument in the surrounding method's signature over `yield`.
+          other_items.something { |i, j| yield i, j }
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Consider using explicit block argument in the surrounding method's signature over `yield`.
         end
       end
     RUBY
@@ -155,6 +163,14 @@ def m
     RUBY
   end
 
+  it 'does not register an offense when there is more than one block argument and not all are yielded' do
+    expect_no_offenses(<<~RUBY)
+      def m
+        items.something { |i, j| yield i }
+      end
+    RUBY
+  end
+
   it 'does not register an offense when code is called outside of a method' do
     expect_no_offenses(<<~RUBY)
       render("partial") do