refactor: Update various operations.

loophp · Dec 15, 2020 · b5da182 · b5da182
1 parent 0127f40
commit b5da182
Show file tree

Hide file tree

Showing 23 changed files with 139 additions and 110 deletions.
diff --git a/src/Collection.php b/src/Collection.php
@@ -136,13 +136,13 @@ final class Collection implements CollectionInterface
     private array $parameters;
 
     /**
-     * @psalm-var callable(...mixed): Generator<TKey, T>
+     * @psalm-var callable(...mixed): (Generator<TKey, T>|Iterator<TKey, T>)
      */
     private Closure $source;
 
     /**
      * @param callable|Closure $callable
-     * @psalm-param callable(...mixed): Generator<TKey, T> $callable
+     * @psalm-param callable(...mixed): Iterator<TKey, T> $callable
      *
      * @param mixed ...$parameters
      * @psalm-param mixed ...$parameters
@@ -240,7 +240,7 @@ public function contains(...$value): CollectionInterface
 
     public function count(): int
     {
-        return iterator_count($this);
+        return iterator_count($this->getIterator());
     }
 
     public function current(int $index = 0)
@@ -360,7 +360,7 @@ public static function fromCallable(callable $callable, ...$parameters): self
              * @psalm-param callable(T...) $callable
              * @psalm-param list<T> $parameters
              *
-             * @psalm-return Generator<TKey, T>
+             * @psalm-return Iterator<TKey, T>
              */
             static fn (callable $callable, array $parameters): Iterator => new IteratorIterator($callable(...$parameters)),
             $callable,
@@ -371,6 +371,9 @@ public static function fromCallable(callable $callable, ...$parameters): self
     public static function fromFile(string $filepath): self
     {
         return new self(
+            /**
+             * @psalm-return Iterator<int, string>
+             */
             static fn (string $filepath): Iterator => new ResourceIterator(fopen($filepath, 'rb')),
             $filepath
         );
@@ -382,7 +385,7 @@ public static function fromIterable(iterable $iterable): self
             /**
              * @psalm-param iterable<TKey, T> $iterable
              *
-             * @psalm-return Generator<TKey, T>
+             * @psalm-return Iterator<TKey, T>
              */
             static fn (iterable $iterable): Iterator => new IterableIterator($iterable),
             $iterable
@@ -396,7 +399,7 @@ public static function fromResource($resource): self
              * @param mixed $resource
              * @psalm-param resource $resource
              *
-             * @psalm-return Generator<int, string>
+             * @psalm-return Iterator<int, string>
              */
             static fn ($resource): Iterator => new ResourceIterator($resource),
             $resource
@@ -407,7 +410,7 @@ public static function fromString(string $string, string $delimiter = ''): self
     {
         return new self(
             /**
-             * @psalm-return Generator<int, string>
+             * @psalm-return Iterator<int, string>
              */
             static fn (string $string, string $delimiter): Iterator => new StringIterator($string, $delimiter),
             $string,

diff --git a/src/Iterator/CacheIterator.php b/src/Iterator/CacheIterator.php
@@ -5,7 +5,6 @@
 namespace loophp\collection\Iterator;
 
 use Iterator;
-use IteratorIterator;
 use Psr\Cache\CacheItemInterface;
 use Psr\Cache\CacheItemPoolInterface;
 
@@ -14,7 +13,7 @@
  * @psalm-template TKey of array-key
  * @psalm-template T
  *
- * @extends IteratorIterator<TKey, T>
+ * @extends ProxyIterator<TKey, T>
  */
 final class CacheIterator extends ProxyIterator
 {

diff --git a/src/Iterator/ProxyIterator.php b/src/Iterator/ProxyIterator.php
@@ -4,7 +4,6 @@
 
 namespace loophp\collection\Iterator;
 
-use Generator;
 use Iterator;
 use OuterIterator;
 
@@ -17,7 +16,7 @@
 abstract class ProxyIterator implements OuterIterator
 {
     /**
-     * @psalm-var Generator<TKey, T>|Iterator<TKey, T>
+     * @psalm-var Iterator<TKey, T>
      */
     protected Iterator $iterator;
 

diff --git a/src/Iterator/RandomIterator.php b/src/Iterator/RandomIterator.php
@@ -17,6 +17,8 @@
  * @psalm-template TKey
  * @psalm-template TKey of array-key
  * @psalm-template T of string
+ *
+ * @implements Iterator<TKey, T>
  */
 final class RandomIterator implements Iterator, OuterIterator
 {

diff --git a/src/Iterator/ResourceIterator.php b/src/Iterator/ResourceIterator.php
@@ -13,7 +13,7 @@
  * @psalm-template TKey of array-key
  * @psalm-template T
  *
- * @extends ProxyIterator<TKey, T>
+ * @extends ProxyIterator<int, string>
  */
 final class ResourceIterator extends ProxyIterator
 {

diff --git a/src/Iterator/StringIterator.php b/src/Iterator/StringIterator.php
@@ -12,28 +12,32 @@
  * @psalm-template TKey of array-key
  * @psalm-template T of string
  *
- * @extends ProxyIterator<TKey, T>
+ * @extends ProxyIterator<int, string>
  */
 final class StringIterator extends ProxyIterator
 {
     public function __construct(string $data, string $delimiter = '')
     {
-        $callback = static function (string $input, string $delimiter): Generator {
-            $offset = 0;
-
-            while (
-                mb_strlen($input) > $offset
-                && false !== $nextOffset = '' !== $delimiter ? mb_strpos($input, $delimiter, $offset) : 1 + $offset
-            ) {
-                yield (string) mb_substr($input, $offset, $nextOffset - $offset);
-
-                $offset = $nextOffset + mb_strlen($delimiter);
-            }
-
-            if ('' !== $delimiter) {
-                yield (string) mb_substr($input, $offset);
-            }
-        };
+        $callback =
+            /**
+             * @psalm-return Generator<int, string>
+             */
+            static function (string $input, string $delimiter): Generator {
+                $offset = 0;
+
+                while (
+                    mb_strlen($input) > $offset
+                    && false !== $nextOffset = '' !== $delimiter ? mb_strpos($input, $delimiter, $offset) : 1 + $offset
+                ) {
+                    yield (string) mb_substr($input, $offset, $nextOffset - $offset);
+
+                    $offset = $nextOffset + mb_strlen($delimiter);
+                }
+
+                if ('' !== $delimiter) {
+                    yield (string) mb_substr($input, $offset);
+                }
+            };
 
         $this->iterator = new IteratorIterator($callback($data, $delimiter));
 

diff --git a/src/Operation/Cache.php b/src/Operation/Cache.php
@@ -5,7 +5,6 @@
 namespace loophp\collection\Operation;
 
 use Closure;
-use Generator;
 use Iterator;
 use loophp\collection\Iterator\CacheIterator;
 use Psr\Cache\CacheItemPoolInterface;
@@ -20,19 +19,19 @@
 final class Cache extends AbstractOperation
 {
     /**
-     * @psalm-return Closure(CacheItemPoolInterface): Closure(Iterator<TKey, T>): Generator<TKey, T>
+     * @psalm-return Closure(CacheItemPoolInterface): Closure(Iterator<TKey, T>): Iterator<TKey, T>
      */
     public function __invoke(): Closure
     {
         return
             /**
-             * @psalm-return Closure(Iterator<TKey, T>): Generator<TKey, T>
+             * @psalm-return Closure(Iterator<TKey, T>): Iterator<TKey, T>
              */
             static fn (CacheItemPoolInterface $cache): Closure =>
                 /**
                  * @psalm-param Iterator<TKey, T> $iterator
                  *
-                 * @psalm-return Generator<TKey, T>
+                 * @psalm-return Iterator<TKey, T>
                  */
                 static fn (Iterator $iterator): Iterator => new CacheIterator($iterator, $cache);
     }

diff --git a/src/Operation/Combinate.php b/src/Operation/Combinate.php
@@ -56,7 +56,7 @@ static function (Iterator $iterator) use ($length, $getCombinations): Generator
                     $dataset = [...$iterator];
 
                     if (0 < $length) {
-                        return yield from $getCombinations($dataset, (int) $length);
+                        return yield from $getCombinations($dataset, $length);
                     }
 
                     $collectionSize = count($dataset);

diff --git a/src/Operation/Cycle.php b/src/Operation/Cycle.php
@@ -5,7 +5,6 @@
 namespace loophp\collection\Operation;
 
 use Closure;
-use Generator;
 use InfiniteIterator;
 use Iterator;
 
@@ -17,15 +16,15 @@
 final class Cycle extends AbstractOperation
 {
     /**
-     * @psalm-return Closure(Iterator<TKey, T>): Generator<TKey, T>
+     * @psalm-return Closure(Iterator<TKey, T>): Iterator<TKey, T>
      */
     public function __invoke(): Closure
     {
         return
             /**
              * @psalm-param Iterator<TKey, T> $iterator
              *
-             * @psalm-return Generator<TKey, T>
+             * @psalm-return Iterator<TKey, T>
              */
             static fn (Iterator $iterator): Iterator => new InfiniteIterator($iterator);
     }

diff --git a/src/Operation/Drop.php b/src/Operation/Drop.php
@@ -25,12 +25,18 @@ public function __invoke(): Closure
             /**
              * @psalm-return Closure(Iterator<TKey, T>): Generator<TKey, T>
              */
-            static fn (int ...$offsets): Closure => static function (Iterator $iterator) use ($offsets): Generator {
-                if (!$iterator->valid()) {
-                    return yield from [];
-                }
+            static fn (int ...$offsets): Closure =>
+                /**
+                 * @psalm-param Iterator<TKey, T> $iterator
+                 *
+                 * @psalm-return Generator<TKey, T>
+                 */
+                static function (Iterator $iterator) use ($offsets): Generator {
+                    if (!$iterator->valid()) {
+                        return yield from [];
+                    }
 
-                return yield from new LimitIterator($iterator, array_sum($offsets));
-            };
+                    return yield from new LimitIterator($iterator, array_sum($offsets));
+                };
     }
 }
diff --git a/src/Operation/Flip.php b/src/Operation/Flip.php
@@ -16,15 +16,32 @@
 final class Flip extends AbstractOperation
 {
     /**
-     * @psalm-return Closure(Iterator<TKey, T>): Generator<T, TKey>
+     * @psalm-return Closure(Iterator<TKey, T>): Closure(Iterator<T, TKey>): Generator<T, TKey>
      */
     public function __invoke(): Closure
     {
-        $callbackForKeys = static fn ($carry, $key, $value) => $value;
-        $callbackForValues = static fn ($carry, $key, $value) => $key;
+        $callbackForKeys =
+            /**
+             * @psalm-param mixed $carry
+             * @psalm-param TKey $key
+             * @psalm-param T $value
+             *
+             * @psalm-return T
+             */
+            static fn ($carry, $key, $value) => $value;
+
+        $callbackForValues =
+            /**
+             * @psalm-param mixed $carry
+             * @psalm-param TKey $key
+             * @psalm-param T $value
+             *
+             * @psalm-return TKey
+             */
+            static fn ($carry, $key, $value) => $key;
 
         /**
-         * @var Closure(Iterator<TKey, T>): Generator<T, TKey>
+         * @psalm-var Closure(Iterator<TKey, T>): Generator<T, TKey>
          */
         $associate = Associate::of()($callbackForKeys)($callbackForValues);
 

diff --git a/src/Operation/Group.php b/src/Operation/Group.php
@@ -43,15 +43,15 @@ static function (Iterator $iterator): Generator {
                          */
                         static fn ($value): bool => $value === $current;
 
-                for (; $iterator->valid(); $span->next(), $iterator = $span->current()) {
-                    $key = $iterator->key();
-                    $current = $iterator->current();
-
+                do {
                     /** @psalm-var Iterator<int, Iterator<TKey, T>> $span */
-                    $span = Span::of()($spanCallback($current))($iterator);
+                    $span = Span::of()($spanCallback($iterator->current()))($iterator);
+
+                    yield $iterator->key() => [...$span->current()];
 
-                    yield $key => [...$span->current()];
-                }
+                    $span->next();
+                    $iterator = $span->current();
+                } while ($iterator->valid());
             };
     }
 }
diff --git a/src/Operation/Inits.php b/src/Operation/Inits.php
@@ -32,7 +32,7 @@ public function __invoke(): Closure
              * @param mixed $value
              * @param mixed $key
              */
-            static function (array $carry, $value, $key, Iterator $iterator): array {
+            static function (array $carry, $value, $key): array {
                 $carry[$key] = $value;
 
                 return $carry;

diff --git a/src/Operation/Limit.php b/src/Operation/Limit.php
@@ -19,13 +19,13 @@
 final class Limit extends AbstractOperation
 {
     /**
-     * @psalm-return Closure(int  = default):Closure (int=): Closure(Iterator<TKey, T>): Generator<TKey, T>
+     * @psalm-return Closure(int): Closure(int): Closure(Iterator<TKey, T>): Generator<TKey, T>
      */
     public function __invoke(): Closure
     {
         return
             /**
-             * @psalm-return Closure(int=): Closure(Iterator<TKey, T>): Generator<TKey, T>
+             * @psalm-return Closure(int): Closure(Iterator<TKey, T>): Generator<TKey, T>
              */
             static fn (int $count = -1): Closure =>
                 /**

diff --git a/src/Operation/Lines.php b/src/Operation/Lines.php
@@ -24,7 +24,11 @@ final class Lines extends AbstractOperation
      */
     public function __invoke(): Closure
     {
-        $mapCallback = static fn (array $value): string => implode('', $value);
+        $mapCallback =
+            /**
+             * @psalm-param T $value
+             */
+            static fn (array $value): string => implode('', $value);
 
         /** @psalm-var Closure(Iterator<TKey, (T | string)>):Generator<int, string> $pipe */
         $pipe = Pipe::of()(

diff --git a/src/Operation/Nth.php b/src/Operation/Nth.php
@@ -28,22 +28,22 @@ public function __invoke(): Closure
                 /**
                  * @psalm-return Closure(Iterator<TKey, T>): Generator<TKey, T>
                  */
-                static fn (int $offset): Closure =>
-                    /**
-                     * @psalm-param Iterator<TKey, T> $iterator
-                     *
-                     * @psalm-return Generator<TKey, T>
-                     */
-                    static function (Iterator $iterator) use ($step, $offset): Generator {
-                        $position = 0;
+                static function (int $offset) use ($step): Closure {
+                    $filterCallback =
+                        /**
+                         * @psalm-param array{0: TKey, 1: T} $value
+                         */
+                        static fn ($value, int $key): bool => (($key % $step) === $offset);
 
-                        foreach ($iterator as $key => $value) {
-                            if ($position++ % $step !== $offset) {
-                                continue;
-                            }
+                    /** @psalm-var Closure(Iterator<TKey, T>): Generator<TKey, T> $pipe */
+                    $pipe = Pipe::of()(
+                        Pack::of(),
+                        Filter::of()($filterCallback),
+                        Unpack::of()
+                    );
 
-                            yield $key => $value;
-                        }
-                    };
+                    // Point free style.
+                    return $pipe;
+                };
     }
 }