Merge pull request #58 from loophp/57-use-key-and-current-at-same-time

Use key and current operation at the same time
loophp · Dec 30, 2020 · 318c2ea · 318c2ea
2 parents 739e9c6 + a7b6a9c
commit 318c2ea
Show file tree

Hide file tree

Showing 33 changed files with 149 additions and 170 deletions.
diff --git a/docs/pages/api.rst b/docs/pages/api.rst
@@ -561,6 +561,15 @@ Signature: ``Collection::every(callable $callback);``
         ->every($callback)
         ->current(); // true
 
+    Collection::fromIterable(range(0, 10))
+        ->append(21)
+        ->every($callback)
+        ->current(); // false
+
+    Collection::fromIterable([])
+        ->every($callback)
+        ->current(); // true
+
 explode
 ~~~~~~~
 
@@ -1434,8 +1443,8 @@ Signature: ``Collection::scanLeft(callable $callback, $initial = null);``
         ->normalize(); // [64 ,16 ,8 ,2]
 
     Collection::empty()
-        ->scanLeft($callback, 3)
-        ->normalize(); // [3]
+        ->scanLeft($callback, 3); // [0 => 3]
+
 
 scanLeft1
 ~~~~~~~~~

diff --git a/spec/loophp/collection/CollectionSpec.php b/spec/loophp/collection/CollectionSpec.php
@@ -754,7 +754,7 @@ public function it_can_every(): void
 
         $this::empty()
             ->every($callback)
-            ->shouldIterateAs([]);
+            ->shouldIterateAs([true]);
 
         $this::fromIterable(range(0, 10))
             ->every(
@@ -2028,7 +2028,7 @@ public function it_can_scanleft(): void
 
         $this::fromIterable([])
             ->scanLeft($callback, 3)
-            ->shouldIterateAs([]);
+            ->shouldIterateAs([0 => 3]);
     }
 
     public function it_can_scanleft1(): void
@@ -3034,6 +3034,34 @@ public function it_can_zip(): void
             ->shouldIterateAs([[1, 'A'], [2, 'B'], [3, 'C'], [4, 'D'], [5, 'E']]);
     }
 
+    /**
+     * @see https://github.com/loophp/collection/issues/57
+     */
+    public function it_fix_bug_57()
+    {
+        $input = array_combine(range(1, 26), range('a', 'z'));
+
+        $collection = $this::fromIterable($input);
+
+        $collection
+            ->key()
+            ->shouldReturn(1);
+
+        $collection
+            ->current()
+            ->shouldReturn('a');
+
+        $last = $collection->last();
+
+        $last
+            ->key()
+            ->shouldReturn(26);
+
+        $last
+            ->current()
+            ->shouldReturn('z');
+    }
+
     public function it_is_initializable(): void
     {
         $this->shouldHaveType(Collection::class);

diff --git a/spec/loophp/collection/Operation/CurrentSpec.php b/spec/loophp/collection/Operation/CurrentSpec.php
@@ -18,8 +18,7 @@ public function it_can_get_current()
 
         $this
             ->__invoke()(0)($iterator)
-            ->current()
-            ->shouldReturn('a');
+            ->shouldIterateAs(['a']);
 
         $this
             ->__invoke()(0)($iterator)

diff --git a/spec/loophp/collection/Operation/LimitSpec.php b/spec/loophp/collection/Operation/LimitSpec.php
@@ -33,8 +33,7 @@ public function it_can_set_an_offset()
 
         $this
             ->__invoke()(1)(2)($iterator)
-            ->current()
-            ->shouldReturn('c');
+            ->shouldIterateAs([2 => 'c']);
 
         $this
             ->__invoke()(2)(2)($iterator)

diff --git a/src/Operation/Apply.php b/src/Operation/Apply.php
@@ -33,19 +33,16 @@ public function __invoke(): Closure
                  * @psalm-return Generator<TKey, T>
                  */
                 static function (Iterator $iterator) use ($callbacks): Generator {
-                    for (; $iterator->valid(); $iterator->next()) {
-                        $key = $iterator->key();
-                        $current = $iterator->current();
-
+                    foreach ($iterator as $key => $value) {
                         foreach ($callbacks as $callback) {
-                            if (true === $callback($current, $key)) {
+                            if (true === $callback($value, $key)) {
                                 continue;
                             }
 
                             break;
                         }
 
-                        yield $key => $current;
+                        yield $key => $value;
                     }
                 };
     }

diff --git a/src/Operation/Associate.php b/src/Operation/Associate.php
@@ -68,15 +68,12 @@ static function (Iterator $iterator) use ($callbackForKeys, $callbackForValues):
                                      */
                                     static fn ($initial, callable $callback, int $callbackId, Iterator $iterator) => $callback($initial, $key, $value, $iterator);
 
-                        for (; $iterator->valid(); $iterator->next()) {
-                            $key = $iterator->key();
-                            $current = $iterator->current();
-
+                        foreach ($iterator as $key => $value) {
                             /** @psalm-var Generator<int, TKey|T> $k */
-                            $k = FoldLeft::of()($callbackFactory($key)($current))($key)(new ArrayIterator($callbackForKeys));
+                            $k = FoldLeft::of()($callbackFactory($key)($value))($key)(new ArrayIterator($callbackForKeys));
 
                             /** @psalm-var Generator<int, T|TKey> $c */
-                            $c = FoldLeft::of()($callbackFactory($key)($current))($current)(new ArrayIterator($callbackForValues));
+                            $c = FoldLeft::of()($callbackFactory($key)($value))($value)(new ArrayIterator($callbackForValues));
 
                             yield $k->current() => $c->current();
                         }

diff --git a/src/Operation/Chunk.php b/src/Operation/Chunk.php
@@ -41,15 +41,13 @@ static function (Iterator $iterator) use ($sizes): Generator {
 
                     $values = [];
 
-                    for (; $iterator->valid(); $iterator->next()) {
-                        $current = $iterator->current();
-
+                    foreach ($iterator as $value) {
                         if (0 >= $sizesIterator->current()) {
                             return new EmptyIterator();
                         }
 
                         if (count($values) !== $sizesIterator->current()) {
-                            $values[] = $current;
+                            $values[] = $value;
 
                             continue;
                         }
@@ -58,7 +56,7 @@ static function (Iterator $iterator) use ($sizes): Generator {
 
                         yield $values;
 
-                        $values = [$current];
+                        $values = [$value];
                     }
 
                     return yield $values;

diff --git a/src/Operation/Collapse.php b/src/Operation/Collapse.php
@@ -27,14 +27,12 @@ public function __invoke(): Closure
              * @psalm-return Generator<TKey, T>
              */
             static function (Iterator $iterator): Generator {
-                for (; $iterator->valid(); $iterator->next()) {
-                    $current = $iterator->current();
-
-                    if (false === is_iterable($current)) {
+                foreach ($iterator as $value) {
+                    if (false === is_iterable($value)) {
                         continue;
                     }
 
-                    yield from $current;
+                    yield from $value;
                 }
             };
     }

diff --git a/src/Operation/Contains.php b/src/Operation/Contains.php
@@ -37,11 +37,9 @@ static function (Iterator $iterator) use ($values): Generator {
                     // yield count($values) === Intersect::of()(...$values)($iterator);
                     // But it would not be very optimal because it would have to traverse
                     // the whole iterator.
-                    for (; $iterator->valid(); $iterator->next()) {
-                        $current = $iterator->current();
-
+                    foreach ($iterator as $value) {
                         foreach ($values as $k => $v) {
-                            if ($v === $current) {
+                            if ($v === $value) {
                                 unset($values[$k]);
                             }
 

diff --git a/src/Operation/Drop.php b/src/Operation/Drop.php
@@ -6,7 +6,6 @@
 
 use Closure;
 use EmptyIterator;
-use Generator;
 use Iterator;
 use LimitIterator;
 
@@ -18,26 +17,26 @@
 final class Drop extends AbstractOperation
 {
     /**
-     * @psalm-return Closure(int...): Closure(Iterator<TKey, T>): Generator<TKey, T>
+     * @psalm-return Closure(int...): 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 (int ...$offsets): Closure =>
                 /**
                  * @psalm-param Iterator<TKey, T> $iterator
                  *
-                 * @psalm-return Generator<TKey, T>
+                 * @psalm-return Iterator<TKey, T>
                  */
-                static function (Iterator $iterator) use ($offsets): Generator {
-                    if (!$iterator->valid()) {
+                static function (Iterator $iterator) use ($offsets): Iterator {
+                    if (false === $iterator->valid()) {
                         return new EmptyIterator();
                     }
 
-                    return yield from new LimitIterator($iterator, array_sum($offsets));
+                    return new LimitIterator($iterator, array_sum($offsets));
                 };
     }
 }
diff --git a/src/Operation/DropWhile.php b/src/Operation/DropWhile.php
@@ -24,7 +24,7 @@ public function __invoke(): Closure
     {
         return
             /**
-             * @psalm-param callable(T, TKey, Iterator<TKey, T>): bool ...$callbacks
+             * @psalm-param callable(T, TKey, Iterator<TKey, T>):bool $callback
              *
              * @psalm-return Closure(Iterator<TKey, T>): Generator<TKey, T>
              */

diff --git a/src/Operation/Duplicate.php b/src/Operation/Duplicate.php
@@ -31,15 +31,12 @@ public function __invoke(): Closure
             static function (Iterator $iterator): Generator {
                 $stack = [];
 
-                for (; $iterator->valid(); $iterator->next()) {
-                    $key = $iterator->key();
-                    $current = $iterator->current();
-
-                    if (true === in_array($current, $stack, true)) {
-                        yield $key => $current;
+                foreach ($iterator as $key => $value) {
+                    if (true === in_array($value, $stack, true)) {
+                        yield $key => $value;
                     }
 
-                    $stack[] = $current;
+                    $stack[] = $value;
                 }
             };
     }

diff --git a/src/Operation/Filter.php b/src/Operation/Filter.php
@@ -6,7 +6,6 @@
 
 use CallbackFilterIterator;
 use Closure;
-use Generator;
 use Iterator;
 
 /**
@@ -19,23 +18,23 @@
 final class Filter extends AbstractOperation
 {
     /**
-     * @psalm-return Closure(callable(T , TKey , Iterator<TKey, T> ): bool ...):Closure (Iterator<TKey, T>): Generator<TKey, T>
+     * @psalm-return Closure(callable(T , TKey , Iterator<TKey, T> ): bool ...): Closure (Iterator<TKey, T>): Iterator<TKey, T>
      */
     public function __invoke(): Closure
     {
         return
             /**
              * @psalm-param callable(T, TKey, Iterator<TKey, T>): bool ...$callbacks
              *
-             * @psalm-return Closure(Iterator<TKey, T>): Generator<TKey, T>
+             * @psalm-return Closure(Iterator<TKey, T>): Iterator<TKey, T>
              */
             static fn (callable ...$callbacks): Closure =>
                 /**
                  * @psalm-param Iterator<TKey, T> $iterator
                  *
-                 * @psalm-return Generator<TKey, T>
+                 * @psalm-return Iterator<TKey, T>
                  */
-                static function (Iterator $iterator) use ($callbacks): Generator {
+                static function (Iterator $iterator) use ($callbacks): Iterator {
                     $defaultCallback =
                         /**
                          * @param mixed $value
@@ -52,7 +51,7 @@ static function (Iterator $iterator) use ($callbacks): Generator {
                         [$defaultCallback] :
                         $callbacks;
 
-                    return yield from array_reduce(
+                    return array_reduce(
                         $callbacks,
                         static fn (Iterator $carry, callable $callback): CallbackFilterIterator => new CallbackFilterIterator($carry, $callback),
                         $iterator

diff --git a/src/Operation/Flatten.php b/src/Operation/Flatten.php
@@ -30,12 +30,9 @@ public function __invoke(): Closure
                  * @psalm-param Iterator<TKey, T> $iterator
                  */
                 static function (Iterator $iterator) use ($depth): Generator {
-                    for (; $iterator->valid(); $iterator->next()) {
-                        $key = $iterator->key();
-                        $current = $iterator->current();
-
-                        if (false === is_iterable($current)) {
-                            yield $key => $current;
+                    foreach ($iterator as $key => $value) {
+                        if (false === is_iterable($value)) {
+                            yield $key => $value;
 
                             continue;
                         }
@@ -44,10 +41,10 @@ static function (Iterator $iterator) use ($depth): Generator {
                             /** @psalm-var callable(Iterator<TKey, T>): Generator<TKey, T> $flatten */
                             $flatten = Flatten::of()($depth - 1);
 
-                            $current = $flatten(new IterableIterator($current));
+                            $value = $flatten(new IterableIterator($value));
                         }
 
-                        yield from $current;
+                        yield from $value;
                     }
                 };
     }

diff --git a/src/Operation/Flip.php b/src/Operation/Flip.php
@@ -16,7 +16,7 @@
 final class Flip extends AbstractOperation
 {
     /**
-     * @psalm-return Closure(Iterator<T, TKey>): Generator<TKey, T>
+     * @psalm-return Closure(Iterator<TKey, T>): Closure(Iterator<T, TKey>): Generator<T, TKey>
      */
     public function __invoke(): Closure
     {
@@ -40,7 +40,7 @@ public function __invoke(): Closure
              */
             static fn ($carry, $key, $value) => $key;
 
-        /** @psalm-var Closure(Iterator<T, TKey>): Generator<TKey, T> $associate */
+        /** @psalm-var Closure(Iterator<TKey, T>): Generator<T, TKey> $associate */
         $associate = Associate::of()($callbackForKeys)($callbackForValues);
 
         // Point free style.
-Original file line number
+Diff line change
@@ Expand Up / @@ -24,7 +24,7 @@ public function __invoke(): Closure @@
         {
             return
                 /**
-                 * @psalm-param callable(T, TKey, Iterator<TKey, T>): bool ...$callbacks
+                 * @psalm-param callable(T, TKey, Iterator<TKey, T>):bool $callback
                  *
                  * @psalm-return Closure(Iterator<TKey, T>): Generator<TKey, T>
                  */
@@ Expand Down @@