Update annotations.

loophp · Sep 8, 2020 · 3830e38 · 3830e38
1 parent 47b2f55
commit 3830e38
Show file tree

Hide file tree

Showing 42 changed files with 345 additions and 200 deletions.
diff --git a/composer.json b/composer.json
@@ -27,7 +27,7 @@
         "psr/cache": "^1.0",
         "symfony/cache": "^4.4 || ^5.1",
         "symfony/polyfill-mbstring": "^1.18",
-        "vimeo/psalm": "^3.14.2"
+        "vimeo/psalm": "dev-master"
     },
     "suggest": {
         "symfony/polyfill-mbstring": "Use it if you do not have the PHP mbstring extension."

diff --git a/src/Collection.php b/src/Collection.php
@@ -244,13 +244,31 @@ public function associate(
         ?callable $callbackForKeys = null,
         ?callable $callbackForValues = null
     ): CollectionInterface {
-        $callbackForKeys = $callbackForKeys ?? static function ($key, $value) {
-            return $key;
-        };
+        $callbackForKeys = $callbackForKeys ??
+            /**
+             * @psalm-param TKey $key
+             * @psalm-param T $value
+             * @psalm-return TKey
+             *
+             * @param mixed $key
+             * @param mixed $value
+             */
+            static function ($key, $value) {
+                return $key;
+            };
 
-        $callbackForValues = $callbackForValues ?? static function ($key, $value) {
-            return $value;
-        };
+        $callbackForValues = $callbackForValues ??
+            /**
+             * @psalm-param TKey $key
+             * @psalm-param T $value
+             * @psalm-return T
+             *
+             * @param mixed $key
+             * @param mixed $value
+             */
+            static function ($key, $value) {
+                return $value;
+            };
 
         return $this->run(Associate::of()($callbackForKeys)($callbackForValues));
     }

diff --git a/src/Operation/Append.php b/src/Operation/Append.php
@@ -23,11 +23,15 @@ public function __invoke(): Closure
         return
             /**
              * @psalm-param T ...$items
+             *
+             * @psalm-return Closure(Iterator<TKey, T>): Generator<int|TKey, T>
              */
             static function (...$items): Closure {
                 return
                     /**
                      * @psalm-param Iterator<TKey, T> $iterator
+                     *
+                     * @psalm-return Generator<int|TKey, T>
                      */
                     static function (Iterator $iterator) use ($items): Generator {
                         foreach ($iterator as $key => $value) {

diff --git a/src/Operation/Apply.php b/src/Operation/Apply.php
@@ -23,6 +23,8 @@ public function __invoke(): Closure
         return
             /**
              * @psalm-param callable(T, TKey):(bool) ...$callbacks
+             *
+             * @psalm-return Closure(Iterator<TKey, T>): Generator<TKey, T>
              */
             static function (callable ...$callbacks): Closure {
                 return

diff --git a/src/Operation/Cache.php b/src/Operation/Cache.php
@@ -22,16 +22,20 @@ final class Cache extends AbstractOperation
      */
     public function __invoke(): Closure
     {
-        return static function (CacheItemPoolInterface $cache): Closure {
-            return
-                /**
-                 * @psalm-param Iterator<TKey, T> $iterator
-                 *
-                 * @psalm-return Generator<TKey, T>
-                 */
-                static function (Iterator $iterator) use ($cache): Generator {
-                    return yield from new CacheIterator($iterator, $cache);
-                };
-        };
+        return
+            /**
+             * @psalm-return Closure(Iterator<TKey, T>): Generator<TKey, T>
+             */
+            static function (CacheItemPoolInterface $cache): Closure {
+                return
+                    /**
+                     * @psalm-param Iterator<TKey, T> $iterator
+                     *
+                     * @psalm-return Generator<TKey, T>
+                     */
+                    static function (Iterator $iterator) use ($cache): Generator {
+                        return yield from new CacheIterator($iterator, $cache);
+                    };
+            };
     }
 }
diff --git a/src/Operation/Chunk.php b/src/Operation/Chunk.php
@@ -25,7 +25,7 @@ public function __invoke(): Closure
     {
         return
             /**
-             * @psalm-param int ...$sizes
+             * @psalm-return Closure(Iterator<TKey, T>): Generator<int, list<T>>
              */
             static function (int ...$sizes): Closure {
                 return

diff --git a/src/Operation/Collapse.php b/src/Operation/Collapse.php
@@ -16,7 +16,7 @@
 final class Collapse extends AbstractOperation
 {
     /**
-     * @psalm-return Closure(Iterator<TKey, T>): Generator<TKey, T>
+     * @psalm-return Closure(Iterator<array-key, T|iterable<TKey, T>>): Generator<TKey, T>
      */
     public function __invoke(): Closure
     {

diff --git a/src/Operation/Combine.php b/src/Operation/Combine.php
@@ -19,7 +19,7 @@
 final class Combine extends AbstractOperation
 {
     /**
-     * @return Closure(T...): Closure(Iterator<TKey, T>): Generator<T, T>
+     * @psalm-return Closure(T...): Closure(Iterator<TKey, T>): Generator<T, T>
      */
     public function __invoke(): Closure
     {

diff --git a/src/Operation/Compact.php b/src/Operation/Compact.php
@@ -25,11 +25,14 @@ public function __invoke(): Closure
         return
             /**
              * @psalm-param T ...$values
+             *
+             * @psalm-return Closure(Iterator<TKey, T>): Generator<TKey, T>
              */
             static function (...$values): Closure {
                 return
                     /**
                      * @psalm-param Iterator<TKey, T> $iterator
+                     *
                      * @psalm-return Generator<TKey, T>
                      */
                     static function (Iterator $iterator) use ($values): Generator {

diff --git a/src/Operation/Compose.php b/src/Operation/Compose.php
@@ -25,11 +25,14 @@ public function __invoke(): Closure
         return
             /**
              * @psalm-param callable(Iterator<TKey, T>): Generator<TKey, T> ...$operations
+             *
+             * @psalm-return Closure(Iterator<TKey, T>): Generator<TKey, T>
              */
             static function (callable ...$operations): Closure {
                 return
                     /**
                      * @psalm-param Iterator<TKey, T> $iterator
+                     *
                      * @psalm-return Generator<TKey, T>
                      */
                     static function (Iterator $iterator) use ($operations): Generator {

diff --git a/src/Operation/Contains.php b/src/Operation/Contains.php
@@ -15,11 +15,16 @@
  */
 final class Contains extends AbstractOperation
 {
+    /**
+     * @psalm-return Closure(T...): Closure(Iterator<TKey, T>): Generator<int, bool>
+     */
     public function __invoke(): Closure
     {
         return
             /**
              * @psalm-param T ...$values
+             *
+             * @psalm-return Closure(Iterator<TKey, T>): Generator<int, bool>
              */
             static function (...$values): Closure {
                 return

diff --git a/src/Operation/Diff.php b/src/Operation/Diff.php
@@ -25,6 +25,8 @@ public function __invoke(): Closure
         return
             /**
              * @psalm-param T ...$values
+             *
+             * @psalm-return Closure(Iterator<TKey, T>): Generator<TKey, T>
              */
             static function (...$values): Closure {
                 return

diff --git a/src/Operation/DiffKeys.php b/src/Operation/DiffKeys.php
@@ -25,11 +25,15 @@ public function __invoke(): Closure
         return
             /**
              * @psalm-param T ...$values
+             *
+             * @psalm-return Closure(Iterator<TKey, T>): Generator<TKey, T>
              */
             static function (...$values): Closure {
                 return
                     /**
                      * @psalm-param Iterator<TKey, T> $iterator
+                     *
+                     * @psalm-return Generator<TKey, T>
                      */
                     static function (Iterator $iterator) use ($values): Generator {
                         $filterCallbackFactory = static function (array $values): Closure {

diff --git a/src/Operation/Drop.php b/src/Operation/Drop.php
@@ -21,16 +21,20 @@ final class Drop extends AbstractOperation
      */
     public function __invoke(): Closure
     {
-        return static function (int ...$offsets): Closure {
-            return
-                /**
-                 * @psalm-param Iterator<TKey, T> $iterator
-                 *
-                 * @psalm-return Generator<TKey, T>
-                 */
-                static function (Iterator $iterator) use ($offsets): Generator {
-                    return yield from new LimitIterator($iterator, (int) array_sum($offsets));
-                };
-        };
+        return
+            /**
+             * @psalm-return Closure(Iterator<TKey, T>): Generator<TKey, T>
+             */
+            static function (int ...$offsets): Closure {
+                return
+                    /**
+                     * @psalm-param Iterator<TKey, T> $iterator
+                     *
+                     * @psalm-return Generator<TKey, T>
+                     */
+                    static function (Iterator $iterator) use ($offsets): Generator {
+                        return yield from new LimitIterator($iterator, (int) array_sum($offsets));
+                    };
+            };
     }
 }
diff --git a/src/Operation/Explode.php b/src/Operation/Explode.php
@@ -15,11 +15,16 @@
  */
 final class Explode extends AbstractOperation
 {
+    /**
+     * @psalm-return Closure(T...): Closure(Iterator<TKey, T>): Generator<int, list<T>>
+     */
     public function __invoke(): Closure
     {
         return
             /**
              * @psalm-param T ...$explodes
+             *
+             * @psalm-return Closure(Iterator<TKey, T>): Generator<int, list<T>>
              */
             static function (...$explodes): Closure {
                 return

diff --git a/src/Operation/Falsy.php b/src/Operation/Falsy.php
@@ -23,6 +23,7 @@ public function __invoke(): Closure
         return
             /**
              * @psalm-param Iterator<TKey, T> $iterator
+             *
              * @psalm-return Generator<int, bool> $iterator
              */
             static function (Iterator $iterator): Generator {

diff --git a/src/Operation/Filter.php b/src/Operation/Filter.php
@@ -26,11 +26,14 @@ public function __invoke(): Closure
         return
             /**
              * @psalm-param callable(T, TKey, Iterator<TKey, T>): bool ...$callbacks
+             *
+             * @psalm-return Closure(Iterator<TKey, T>): Generator<TKey, T>
              */
             static function (callable ...$callbacks): Closure {
                 return
                     /**
                      * @psalm-param Iterator<TKey, T> $iterator
+                     *
                      * @psalm-return Generator<TKey, T>
                      */
                     static function (Iterator $iterator) use ($callbacks): Generator {

diff --git a/src/Operation/First.php b/src/Operation/First.php
@@ -15,14 +15,23 @@
  */
 final class First extends AbstractOperation
 {
+    /**
+     * @psalm-return Closure(Iterator<TKey, T>): Generator<TKey, T>
+     */
     public function __invoke(): Closure
     {
-        return static function (Iterator $iterator): Generator {
-            if (!$iterator->valid()) {
-                return yield from [];
-            }
+        return
+            /**
+             * @psalm-param Iterator<TKey, T> $iterator
+             *
+             * @psalm-return Generator<TKey, T>
+             */
+            static function (Iterator $iterator): Generator {
+                if (!$iterator->valid()) {
+                    return yield from [];
+                }
 
-            return yield $iterator->key() => $iterator->current();
-        };
+                return yield $iterator->key() => $iterator->current();
+            };
     }
 }
diff --git a/src/Operation/Flatten.php b/src/Operation/Flatten.php
@@ -21,37 +21,41 @@ final class Flatten extends AbstractOperation
      */
     public function __invoke(): Closure
     {
-        return static function (int $depth): Closure {
-            return
-                /**
-                 * @psalm-param Iterator<TKey, T> $iterator
-                 *
-                 * @psalm-return Generator<int, T>
-                 */
-                static function (Iterator $iterator) use ($depth): Generator {
-                    foreach ($iterator as $key => $value) {
-                        if (false === is_iterable($value)) {
-                            yield $key => $value;
-                        } elseif (1 === $depth) {
-                            /** @psalm-var TKey $subKey */
-                            /** @psalm-var T $subValue */
-                            foreach ($value as $subKey => $subValue) {
-                                yield $subKey => $subValue;
-                            }
-                        } else {
-                            /** @psalm-var callable(Iterator<TKey, T>): Generator<TKey, T> $flatten */
-                            $flatten = Flatten::of()($depth - 1);
+        return
+            /**
+             * @psalm-return Closure(Iterator<TKey, T>): Generator<int, T>
+             */
+            static function (int $depth): Closure {
+                return
+                    /**
+                     * @psalm-param Iterator<TKey, T> $iterator
+                     *
+                     * @psalm-return Generator<int, T>
+                     */
+                    static function (Iterator $iterator) use ($depth): Generator {
+                        foreach ($iterator as $key => $value) {
+                            if (false === is_iterable($value)) {
+                                yield $key => $value;
+                            } elseif (1 === $depth) {
+                                /** @psalm-var TKey $subKey */
+                                /** @psalm-var T $subValue */
+                                foreach ($value as $subKey => $subValue) {
+                                    yield $subKey => $subValue;
+                                }
+                            } else {
+                                /** @psalm-var callable(Iterator<TKey, T>): Generator<TKey, T> $flatten */
+                                $flatten = Flatten::of()($depth - 1);
 
-                            /**
-                             * @psalm-var TKey $subKey
-                             * @psalm-var T $subValue
-                             */
-                            foreach ($flatten(new IterableIterator($value)) as $subKey => $subValue) {
-                                yield $subKey => $subValue;
+                                /**
+                                 * @psalm-var TKey $subKey
+                                 * @psalm-var T $subValue
+                                 */
+                                foreach ($flatten(new IterableIterator($value)) as $subKey => $subValue) {
+                                    yield $subKey => $subValue;
+                                }
                             }
                         }
-                    }
-                };
-        };
+                    };
+            };
     }
 }
diff --git a/src/Operation/Flip.php b/src/Operation/Flip.php
@@ -16,7 +16,7 @@
 final class Flip extends AbstractOperation
 {
     /**
-     * @return Closure(Iterator<TKey, T>): Generator<T, TKey>
+     * @psalm-return Closure(Iterator<TKey, T>): Generator<T, TKey>
      */
     public function __invoke(): Closure
     {