Update annotations.

loophp · Sep 7, 2020 · 1bb45f2 · 1bb45f2
1 parent 1b9ca3c
commit 1bb45f2
Show file tree

Hide file tree

Showing 13 changed files with 59 additions and 36 deletions.
diff --git a/src/Contract/Operation/Cycleable.php b/src/Contract/Operation/Cycleable.php
@@ -14,7 +14,7 @@
 interface Cycleable
 {
     /**
-     * @psalm-return static<TKey, T>
+     * @psalm-return \loophp\collection\Contract\Collection<TKey, T>
      */
     public function cycle(): Collection;
 }
diff --git a/src/Contract/Operation/Initable.php b/src/Contract/Operation/Initable.php
@@ -14,7 +14,7 @@
 interface Initable
 {
     /**
-     * @psalm-return static<TKey, T>
+     * @psalm-return \loophp\collection\Contract\Collection<TKey, T>
      */
     public function init(): Collection;
 }
diff --git a/src/Contract/Operation/Unfoldable.php b/src/Contract/Operation/Unfoldable.php
@@ -13,12 +13,11 @@ interface Unfoldable
      * @psalm-template TKey of array-key
      * @psalm-template T
      *
+     * @param mixed $init
      * @psalm-param T $init
      * @psalm-param callable(T): T $callback
      *
-     * @psalm-return static<T, T>
-     *
-     * @param mixed $init
+     * @psalm-return \loophp\collection\Contract\Collection<T, T>
      */
     public static function unfold($init, callable $callback): Collection;
 }
diff --git a/src/Iterator/ProxyIterator.php b/src/Iterator/ProxyIterator.php
@@ -15,7 +15,7 @@
 abstract class ProxyIterator
 {
     /**
-     * @var Generator<TKey, T>|Iterator<TKey, T>
+     * @psalm-var Generator<TKey, T>|Iterator<TKey, T>
      */
     protected $iterator;
 
@@ -37,7 +37,6 @@ public function getInnerIterator(): Iterator
     }
 
     /**
-     * @return mixed
      * @psalm-return TKey
      */
     public function key()

diff --git a/src/Operation/Column.php b/src/Operation/Column.php
@@ -16,7 +16,7 @@
 final class Column extends AbstractOperation
 {
     /**
-     * @psalm-return Closure(Iterator<TKey, T>, array-key):(Generator<int, iterable<TKey, T>>)
+     * @psalm-return Closure(array-key): Closure(Iterator<TKey, T>): Generator<int, iterable<TKey, T>>
      */
     public function __invoke(): Closure
     {
@@ -25,6 +25,8 @@ public function __invoke(): Closure
              * @param int|string $column
              *
              * @psalm-param array-key $column
+             *
+             * @psalm-return Closure(Iterator<TKey, T>): Generator<int, iterable<TKey, T>>
              */
             static function ($column): Closure {
                 return

diff --git a/src/Operation/FoldLeft.php b/src/Operation/FoldLeft.php
@@ -24,7 +24,7 @@ public function __invoke(): Closure
     {
         return
             /**
-             * @psalm-param callable(T|null, T, TKey, Iterator<TKey, T>): T
+             * @psalm-param callable(T|null, T, TKey, Iterator<TKey, T>): T $callback
              */
             static function (callable $callback): Closure {
                 return

diff --git a/src/Operation/FoldRight.php b/src/Operation/FoldRight.php
@@ -24,7 +24,7 @@ public function __invoke(): Closure
     {
         return
             /**
-             * @psalm-param callable(T|null, T, TKey, Iterator<TKey, T>): T
+             * @psalm-param callable(T|null, T, TKey, Iterator<TKey, T>): T $callback
              */
             static function (callable $callback): Closure {
                 return

diff --git a/src/Operation/Has.php b/src/Operation/Has.php
@@ -16,18 +16,21 @@
 final class Has extends AbstractOperation
 {
     /**
-     * @psalm-return Closure(callable(TKey, T):(bool)): Closure(Iterator<TKey, T>): bool
+     * @psalm-return Closure(callable(TKey, T): T): Closure(Iterator<TKey, T>): Generator<int, bool>
      */
     public function __invoke(): Closure
     {
         return
             /**
-             * @psalm-param callable(TKey, T):(bool) $callback
+             * @psalm-param callable(TKey, T): T $callback
+             *
+             * @psalm-return Closure(Iterator<TKey, T>): Generator<int, bool>
              */
             static function (callable $callback): Closure {
                 return
                     /**
                      * @psalm-param Iterator<TKey, T> $iterator
+                     *
                      * @psalm-return Generator<int, bool>
                      */
                     static function (Iterator $iterator) use ($callback): Generator {

diff --git a/src/Operation/IfThenElse.php b/src/Operation/IfThenElse.php
@@ -12,29 +12,35 @@
  * @psalm-template TKey
  * @psalm-template TKey of array-key
  * @psalm-template T
+ *
+ * phpcs:disable Generic.Files.LineLength.TooLong
  */
 final class IfThenElse extends AbstractOperation
 {
-    // phpcs:disable
     /**
-     * @psalm-return Closure(callable(T, TKey): bool): Closure(callable(T, TKey): (T)): Closure(callable(T, TKey): (T)): Generator<TKey, T>
+     * @psalm-return Closure(callable(T, TKey): bool): Closure(callable(T, TKey): (T)): Closure(callable(T, TKey): (T)): Closure(Iterator<TKey, T>): Generator<TKey, T>
      */
-    // phpcs:enable
     public function __invoke(): Closure
     {
         return
             /**
              * @psalm-param callable(T, TKey): bool $condition
+             *
+             * @psalm-return Closure(callable(T, TKey): (T)): Closure(callable(T, TKey): (T)): Closure(Iterator<TKey, T>): Generator<TKey, T>
              */
             static function (callable $condition): Closure {
                 return
                     /**
                      * @psalm-param callable(T, TKey): (T) $then
+                     *
+                     * @psalm-return Closure(callable(T, TKey): (T)): Closure(Iterator<TKey, T>): Generator<TKey, T>
                      */
                     static function (callable $then) use ($condition): Closure {
                         return
                             /**
                              * @psalm-param callable(T, TKey): (T) $else
+                             *
+                             * @psalm-return Closure(Iterator<TKey, T>): Generator<TKey, T>
                              */
                             static function (callable $else) use ($condition, $then): Closure {
                                 return

diff --git a/src/Operation/Reduction.php b/src/Operation/Reduction.php
@@ -17,14 +17,14 @@ final class Reduction extends AbstractOperation
 {
     // phpcs:disable
     /**
-     * @psalm-return Closure(callable(T|null, T, TKey):(T|null)): Closure(T|null): Closure(Iterator<TKey, T>): Generator<TKey, T>
+     * @psalm-return Closure(callable(T|null, T, TKey, Iterator<TKey, T>):(T|null)): Closure(T|null): Closure(Iterator<TKey, T>): Generator<TKey, T>
      */
     // phpcs:enable
     public function __invoke(): Closure
     {
         return
             /**
-             * @psalm-param callable(T|null, T, TKey):(T|null) $callback
+             * @psalm-param callable(T|null, T, TKey, Iterator<TKey, T>):(T|null) $callback
              *
              * @psalm-return Closure(T|null): Closure(Iterator<TKey, T>): Generator<TKey, T>
              */

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

diff --git a/src/Operation/Wrap.php b/src/Operation/Wrap.php
@@ -15,6 +15,9 @@
  */
 final class Wrap extends AbstractOperation
 {
+    /**
+     * @psalm-return Closure(Iterator<TKey, T>): Generator<int, array<TKey, T>>
+     */
     public function __invoke(): Closure
     {
         return

diff --git a/src/Operation/Zip.php b/src/Operation/Zip.php
@@ -17,28 +17,36 @@
  */
 final class Zip extends AbstractOperation
 {
+    /**
+     * @psalm-return Closure(iterable<TKey, T>...): Closure(Iterator<TKey, T>): Generator<int, list<T>>
+     */
     public function __invoke(): Closure
     {
-        return static function (iterable ...$iterables): Closure {
-            return
-                /**
-                 * @psalm-param Iterator<TKey, T> $iterator
-                 * @psalm-param list<iterable<TKey, T>> $iterables
-                 *
-                 * @psalm-return Generator<int, list<T>>
-                 */
-                static function (Iterator $iterator) use ($iterables): Generator {
-                    $mit = new MultipleIterator(MultipleIterator::MIT_NEED_ANY);
-                    $mit->attachIterator($iterator);
+        return
+            /**
+             * @psalm-param iterable<TKey, T> ...$iterables
+             *
+             * @psalm-return Closure(Iterator<TKey, T>): Generator<int, list<T>>
+             */
+            static function (iterable ...$iterables): Closure {
+                return
+                    /**
+                     * @psalm-param Iterator<TKey, T> $iterator
+                     *
+                     * @psalm-return Generator<int, list<T>>
+                     */
+                    static function (Iterator $iterator) use ($iterables): Generator {
+                        $mit = new MultipleIterator(MultipleIterator::MIT_NEED_ANY);
+                        $mit->attachIterator($iterator);
 
-                    foreach ($iterables as $iterableIterator) {
-                        $mit->attachIterator(new IterableIterator($iterableIterator));
-                    }
+                        foreach ($iterables as $iterableIterator) {
+                            $mit->attachIterator(new IterableIterator($iterableIterator));
+                        }
 
-                    foreach ($mit as $values) {
-                        yield $values;
-                    }
-                };
-        };
+                        foreach ($mit as $values) {
+                            yield $values;
+                        }
+                    };
+            };
     }
 }