PHPLIB-1184: Improve CallbackIterator (#1126)

* Pass key to callback in CallbackIterator

* Add template params to CallbackIterator

* Add tests for CallbackIterator

* Accept any callable as callback in CallbackIterator

* Rename callback variable to convey purpose

* Rework CallbackIterator test to use data providers

Author: alcaeus

src/Model/CallbackIterator.php

@@ -17,44 +17,54 @@
 
 namespace MongoDB\Model;
 
-use Closure;
 use Iterator;
 use IteratorIterator;
 use ReturnTypeWillChange;
 use Traversable;
 
+use function call_user_func;
+
 /**
  * Iterator to apply a callback before returning an element
  *
  * @internal
+ *
+ * @template TKey
+ * @template TValue
+ * @template TCallbackValue
+ * @template-implements Iterator<TKey, TCallbackValue>
  */
 class CallbackIterator implements Iterator
 {
-    /** @var Closure */
+    /** @var callable(TValue, TKey): TCallbackValue */
     private $callback;
 
-    /** @var Iterator */
+    /** @var Iterator<TKey, TValue> */
     private $iterator;
 
-    public function __construct(Traversable $traversable, Closure $callback)
+    /**
+     * @param Traversable<TKey, TValue>              $traversable
+     * @param callable(TValue, TKey): TCallbackValue $callback
+     */
+    public function __construct(Traversable $traversable, callable $callback)
     {
         $this->iterator = $traversable instanceof Iterator ? $traversable : new IteratorIterator($traversable);
         $this->callback = $callback;
     }
 
     /**
      * @see https://php.net/iterator.current
-     * @return mixed
+     * @return TCallbackValue
      */
     #[ReturnTypeWillChange]
     public function current()
     {
-        return ($this->callback)($this->iterator->current());
+        return call_user_func($this->callback, $this->iterator->current(), $this->iterator->key());
     }
 
     /**
      * @see https://php.net/iterator.key
-     * @return mixed
+     * @return TKey
      */
     #[ReturnTypeWillChange]
     public function key()

tests/Model/CallbackIteratorTest.php

@@ -0,0 +1,85 @@
+<?php
+
+namespace MongoDB\Tests\Model;
+
+use ArrayIterator;
+use Generator;
+use Iterator;
+use IteratorAggregate;
+use MongoDB\Model\CallbackIterator;
+use MongoDB\Tests\TestCase;
+
+use function iterator_to_array;
+
+class CallbackIteratorTest extends TestCase
+{
+    /** @dataProvider provideTests */
+    public function testIteration($expected, $source, $callback): void
+    {
+        $callbackIterator = new CallbackIterator($source, $callback);
+
+        $this->assertEquals($expected, iterator_to_array($callbackIterator));
+    }
+
+    public static function provideTests(): Generator
+    {
+        $listIterator = new ArrayIterator([1, 2, 3]);
+        $hashIterator = new ArrayIterator(['a' => 1, 'b' => 2, 'c' => 3]);
+
+        $iteratorAggregate = new class ($listIterator) implements IteratorAggregate
+        {
+            private $iterator;
+
+            public function __construct(Iterator $iterator)
+            {
+                $this->iterator = $iterator;
+            }
+
+            public function getIterator(): Iterator
+            {
+                return $this->iterator;
+            }
+        };
+
+        yield 'List with closure' => [
+            'expected' => [2, 4, 6],
+            'source' => $listIterator,
+            'callback' => function ($value, $key) use ($listIterator) {
+                self::assertSame($listIterator->key(), $key);
+
+                return $value * 2;
+            },
+        ];
+
+        yield 'List with callable' => [
+            'expected' => [2, 4, 6],
+            'source' => $listIterator,
+            'callback' => [self::class, 'doubleValue'],
+        ];
+
+        yield 'Hash with closure' => [
+            'expected' => ['a' => 2, 'b' => 4, 'c' => 6],
+            'source' => $hashIterator,
+            'callback' => function ($value, $key) use ($hashIterator) {
+                self::assertSame($hashIterator->key(), $key);
+
+                return $value * 2;
+            },
+        ];
+
+        yield 'IteratorAggregate with closure' => [
+            'expected' => [2, 4, 6],
+            'source' => $iteratorAggregate,
+            'callback' => function ($value, $key) use ($listIterator) {
+                self::assertSame($listIterator->key(), $key);
+
+                return $value * 2;
+            },
+        ];
+    }
+
+    public static function doubleValue($value, $key)
+    {
+        return $value * 2;
+    }
+}