Update various typing information

docs/pages/api.rst

@@ -287,32 +287,8 @@ Interface: `Associateable`_
 
 Signature: ``Collection::associate(?callable $callbackForKeys = null, ?callable $callbackForValues = null): Collection;``
 
-.. code-block:: php
-
-    $input = range(1, 10);
-
-    Collection::fromIterable($input)
-        ->associate(
-            static function ($key, $value) {
-                return $key * 2;
-            },
-            static function ($key, $value) {
-                return $value * 2;
-            }
-        );
-
-    // [
-    //   0 => 2,
-    //   2 => 4,
-    //   4 => 6,
-    //   6 => 8,
-    //   8 => 10,
-    //   10 => 12,
-    //   12 => 14,
-    //   14 => 16,
-    //   16 => 18,
-    //   18 => 20,
-    // ]
+.. literalinclude:: code/operations/associate.php
+  :language: php
 
 asyncMap
 ~~~~~~~~

docs/pages/code/operations/associate.php

@@ -0,0 +1,72 @@
+<?php
+
+/**
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace App;
+
+use loophp\collection\Collection;
+
+include __DIR__ . '/../../../../vendor/autoload.php';
+
+// Example 1: Both callbacks are provided
+$input = range(1, 5);
+
+Collection::fromIterable($input)
+    ->associate(
+        static function ($key, $value) {
+            return $key * 2;
+        },
+        static function ($value, $key) {
+            return $value * 3;
+        }
+    );
+
+// [
+//   0 => 3,
+//   2 => 6,
+//   4 => 9,
+//   6 => 12,
+//   8 => 15,
+// ]
+
+// Example 2: Only the callback for keys is provided
+$input = range(1, 5);
+
+Collection::fromIterable($input)
+    ->associate(
+        static function ($key, $value) {
+            return $key * 2;
+        }
+    );
+
+// [
+//   0 => 1,
+//   2 => 2,
+//   4 => 3,
+//   6 => 4,
+//   8 => 5,
+// ]
+
+// Example 3: Only the callback for values is provided
+$input = range(1, 5);
+
+Collection::fromIterable($input)
+    ->associate(
+        null,
+        static function ($value, $key) {
+            return $value * 3;
+        }
+    );
+
+// [
+//   0 => 3,
+//   1 => 6,
+//   2 => 9,
+//   3 => 12,
+//   4 => 15,
+// ]

phpstan-unsupported-baseline.neon

@@ -6,7 +6,7 @@ parameters:
 			path: src/Collection.php
 
 		-
-			message: "#^Generic type loophp\\\\collection\\\\Contract\\\\Operation\\\\Unpackable\\<mixed, mixed\\> in PHPDoc tag @extends does not specify all template types of interface loophp\\\\collection\\\\Contract\\\\Operation\\\\Unpackable\\: TKey, T, NewTKey, NewT$#"
+			message: "#^Generic type loophp\\\\collection\\\\Contract\\\\Operation\\\\Unpackable\\<mixed, array\\<int, mixed\\>\\> in PHPDoc tag @extends does not specify all template types of interface loophp\\\\collection\\\\Contract\\\\Operation\\\\Unpackable\\: TKey, T, NewTKey, NewT$#"
 			count: 1
 			path: src/Contract/Collection.php
 
@@ -20,7 +20,18 @@ parameters:
 			count: 1
 			path: src/Contract/Operation/Unpackable.php
 
+		-
+			message: "#^Parameter \\#1 \\$callable of class loophp\\\\collection\\\\Iterator\\\\ClosureIterator constructor expects callable\\(\\.\\.\\.mixed\\)\\: iterable\\<int, string\\>, Closure\\(mixed, bool\\)\\: Generator\\<int, string, mixed, void\\> given\\.$#"
+			count: 1
+			path: src/Iterator/ResourceIterator.php
+
+		-
+			message: "#^Parameter \\#1 \\$callable of class loophp\\\\collection\\\\Iterator\\\\ClosureIterator constructor expects callable\\(\\.\\.\\.mixed\\)\\: iterable, Closure\\(Iterator, callable\\(\\)\\: mixed\\)\\: Generator\\<mixed, mixed, mixed, void\\> given\\.$#"
+			count: 1
+			path: src/Iterator/TypedIterator.php
+
 		-
 			message: "#^PHPDoc tag @template T for class loophp\\\\collection\\\\Operation\\\\Unpack with bound type array\\<int, NewT\\|NewTKey\\> is not supported\\.$#"
 			count: 1
 			path: src/Operation/Unpack.php
+

spec/loophp/collection/CollectionSpec.php

@@ -225,10 +225,10 @@ public function it_can_associate(): void
 
         $this::fromIterable($input)
             ->associate(
-                static function (int $carry, int $key, int $value): int {
+                static function (int $key, int $value): int {
                     return $key * 2;
                 },
-                static function (int $carry, int $key, int $value): int {
+                static function (int $value, int $key): int {
                     return $value * 2;
                 }
             )

src/Collection.php

@@ -154,7 +154,7 @@
 final class Collection implements CollectionInterface
 {
     /**
-     * @var iterable<mixed>
+     * @var iterable<int, mixed>
      */
     private iterable $parameters;
 
@@ -167,7 +167,7 @@ final class Collection implements CollectionInterface
      * @psalm-external-mutation-free
      *
      * @param callable(mixed ...$parameters): iterable<TKey, T> $callable
-     * @param iterable<array-key, mixed> $parameters
+     * @param iterable<int, mixed> $parameters
      */
     private function __construct(callable $callable, iterable $parameters = [])
     {
@@ -196,9 +196,9 @@ public function associate(
     ): CollectionInterface {
         $defaultCallback =
             /**
-             * @param T|TKey $carry
+             * @param mixed $carry
              *
-             * @return T|TKey
+             * @return mixed
              */
             static fn ($carry) => $carry;
 
@@ -449,7 +449,7 @@ public function frequency(): CollectionInterface
      * @template NewT
      *
      * @param callable(mixed ...$parameters): iterable<NewTKey, NewT> $callable
-     * @param iterable<mixed> $parameters
+     * @param iterable<int, mixed> $parameters
      *
      * @return self<NewTKey, NewT>
      */

src/Contract/Collection.php

@@ -235,7 +235,7 @@
  * @template-extends Transposeable<TKey, T>
  * @template-extends Truthyable<TKey, T>
  * @template-extends Unlinesable<TKey, T>
- * @template-extends Unpackable<TKey, T>
+ * @template-extends Unpackable<mixed, array{0: TKey, 1: T}>
  * @template-extends Unpairable<TKey, T>
  * @template-extends Untilable<TKey, T>
  * @template-extends Unwindowable<TKey, T>

src/Contract/Operation/Associateable.php

@@ -23,10 +23,13 @@ interface Associateable
      *
      * @see https://loophp-collection.readthedocs.io/en/stable/pages/api.html#associate
      *
-     * @param null|callable(TKey, TKey, T, Iterator<TKey, T>):(T|TKey) $callbackForKeys
-     * @param null|callable(T, TKey, T, Iterator<TKey, T>):(T|TKey) $callbackForValues
+     * @template NewT
+     * @template NewTKey
      *
-     * @return Collection<T|TKey, T|TKey>
+     * @param callable(TKey=, T=, Iterator<TKey, T>=): NewTKey $callbackForKeys
+     * @param callable(T=, TKey=, Iterator<TKey, T>=): NewT $callbackForValues
+     *
+     * @return Collection<NewTKey, NewT>
      */
     public function associate(?callable $callbackForKeys = null, ?callable $callbackForValues = null): Collection;
 }

src/Contract/Operation/Zipable.php

@@ -22,9 +22,12 @@ interface Zipable
      *
      * @see https://loophp-collection.readthedocs.io/en/stable/pages/api.html#zip
      *
-     * @param iterable<mixed, mixed> ...$iterables
+     * @template U
+     * @template UKey
      *
-     * @return Collection<list<mixed>, list<mixed>>
+     * @param iterable<UKey, U> ...$iterables
+     *
+     * @return Collection<list<TKey|UKey>, list<T|U>>
      */
     public function zip(iterable ...$iterables): Collection;
 }

src/Iterator/ClosureIterator.php

@@ -33,7 +33,7 @@ final class ClosureIterator extends ProxyIterator
 
     /**
      * @param callable(mixed ...$parameters): iterable<TKey, T> $callable
-     * @param iterable<mixed> $parameters
+     * @param iterable<int, mixed> $parameters
      */
     public function __construct(callable $callable, iterable $parameters)
     {
@@ -48,10 +48,10 @@ public function rewind(): void
     }
 
     /**
-     * @return Generator<TKey, T>
+     * @return Generator<TKey, T, mixed, void>
      */
     private function getGenerator(): Generator
     {
-        return yield from ($this->callable)(...$this->parameters);
+        yield from ($this->callable)(...$this->parameters);
     }
 }

src/Iterator/ResourceIterator.php

@@ -11,7 +11,6 @@
 
 use Generator;
 use InvalidArgumentException;
-use IteratorIterator;
 
 use function is_resource;
 
@@ -38,9 +37,9 @@ public function __construct($resource, bool $closeResource = false)
             /**
              * @param resource $resource
              *
-             * @return Generator<int, string>
+             * @return Generator<int, string, mixed, void>
              */
-            static function ($resource) use ($closeResource): Generator {
+            static function ($resource, bool $closeResource): Generator {
                 try {
                     while (false !== $chunk = fgetc($resource)) {
                         yield $chunk;
@@ -52,6 +51,6 @@ static function ($resource) use ($closeResource): Generator {
                 }
             };
 
-        $this->iterator = new IteratorIterator($callback($resource));
+        $this->iterator = new ClosureIterator($callback, [$resource, $closeResource]);
     }
 }

src/Iterator/TypedIterator.php

@@ -28,7 +28,7 @@ final class TypedIterator extends ProxyIterator
 {
     /**
      * @param Iterator<TKey, T> $iterator
-     * @param null|callable(mixed): string $getType
+     * @param callable(T): string $getType
      */
     public function __construct(Iterator $iterator, ?callable $getType = null)
     {
@@ -55,7 +55,13 @@ static function ($variable): string {
             };
 
         $this->iterator = new ClosureIterator(
-            static function (Iterator $iterator) use ($getType): Generator {
+            /**
+             * @param Iterator<TKey, T> $iterator
+             * @param callable(T): string $getType
+             *
+             * @return Generator<TKey, T|null>
+             */
+            static function (Iterator $iterator, callable $getType): Generator {
                 $previousType = null;
 
                 foreach ($iterator as $key => $value) {
@@ -81,7 +87,7 @@ static function (Iterator $iterator) use ($getType): Generator {
                     yield $key => $value;
                 }
             },
-            [$iterator]
+            [$iterator, $getType]
         );
     }
 }

src/Operation/Associate.php

@@ -9,7 +9,6 @@
 
 namespace loophp\collection\Operation;
 
-use ArrayIterator;
 use Closure;
 use Generator;
 use Iterator;
@@ -27,61 +26,34 @@ final class Associate extends AbstractOperation
     /**
      * @pure
      *
-     * @return Closure(callable(TKey, TKey, T, Iterator<TKey, T>): (T|TKey) ...): Closure((callable(T, TKey, T, Iterator<TKey, T>): (T|TKey))...): Closure(Iterator<TKey, T>): Generator<TKey|T, T|TKey>
+     * @template NewTKey
+     * @template NewT
+     *
+     * @return Closure(callable(TKey=, T=, Iterator<TKey, T>=): NewTKey): Closure(callable(T=, TKey=, Iterator<TKey, T>=): NewT): Closure(Iterator<TKey, T>): Generator<NewTKey, NewT>
      */
     public function __invoke(): Closure
     {
         return
             /**
-             * @param callable(TKey, TKey, T, Iterator<TKey, T>): (T|TKey) ...$callbackForKeys
+             * @param callable(TKey=, T=, Iterator<TKey, T>=): NewTKey $callbackForKeys
              *
-             * @return Closure((callable(T, TKey, T, Iterator<TKey, T>): (T|TKey))...): Closure(Iterator<TKey, T>): Generator<TKey|T, T|TKey>
+             * @return Closure((callable(T=, TKey=, Iterator<TKey, T>=): NewT)): Closure(Iterator<TKey, T>): Generator<NewTKey, NewT>
              */
-            static fn (callable ...$callbackForKeys): Closure =>
+            static fn (callable $callbackForKeys): Closure =>
                 /**
-                 * @param callable(T, TKey, T, Iterator<TKey, T>): (T|TKey) ...$callbackForValues
+                 * @param callable(T=, TKey=, Iterator<TKey, T>=): NewT $callbackForValues
                  *
-                 * @return Closure(Iterator<TKey, T>): Generator<TKey|T, T|TKey>
+                 * @return Closure(Iterator<TKey, T>): Generator<NewTKey, NewT>
                  */
-                static fn (callable ...$callbackForValues): Closure =>
+                static fn (callable $callbackForValues): Closure =>
                     /**
                      * @param Iterator<TKey, T> $iterator
                      *
-                     * @return Generator<T|TKey, T|TKey>
+                     * @return Generator<NewTKey, NewT>
                      */
                     static function (Iterator $iterator) use ($callbackForKeys, $callbackForValues): Generator {
-                        $callbackFactory =
-                            /**
-                             * @param TKey $key
-                             *
-                             * @return Closure(T): Closure(T|TKey, callable(T|TKey, TKey, T, Iterator<TKey, T>): (T|TKey), int, Iterator<TKey, T>): (T|TKey)
-                             */
-                            static fn ($key): Closure =>
-                                /**
-                                 * @param T $value
-                                 *
-                                 * @return Closure(T|TKey, callable(T|TKey, TKey, T, Iterator<TKey, T>): (T|TKey), int, Iterator<TKey, T>): (T|TKey)
-                                 */
-                                static fn ($value): Closure =>
-                                    /**
-                                     * @param T|TKey $accumulator
-                                     * @param callable(T|TKey, TKey, T, Iterator<TKey, T>): (T|TKey) $callback
-                                     * @param Iterator<TKey, T> $iterator
-                                     *
-                                     * @return T|TKey
-                                     */
-                                    static fn ($accumulator, callable $callback, int $callbackId, Iterator $iterator) => $callback($accumulator, $key, $value, $iterator);
-
                         foreach ($iterator as $key => $value) {
-                            $reduceCallback = $callbackFactory($key)($value);
-
-                            /** @var Generator<int, T|TKey> $k */
-                            $k = Reduce::of()($reduceCallback)($key)(new ArrayIterator($callbackForKeys));
-
-                            /** @var Generator<int, T|TKey> $c */
-                            $c = Reduce::of()($reduceCallback)($value)(new ArrayIterator($callbackForValues));
-
-                            yield $k->current() => $c->current();
+                            yield $callbackForKeys($key, $value, $iterator) => $callbackForValues($value, $key, $iterator);
                         }
                     };
     }