refactor: Update Fold* operations.

BREAKING CHANGE: yes
loophp · Oct 7, 2020 · f6828f0 · f6828f0
1 parent ce14a0d
commit f6828f0
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 24 deletions.
diff --git a/spec/loophp/collection/CollectionSpec.php b/spec/loophp/collection/CollectionSpec.php
@@ -802,7 +802,7 @@ static function (string $carry, string $item): string {
                 },
                 ''
             )
-            ->shouldReturn('ABC');
+            ->shouldIterateAs([2 => 'ABC']);
     }
 
     public function it_can_fold_from_the_right(): void
@@ -816,7 +816,7 @@ static function (string $carry, string $item): string {
                 },
                 ''
             )
-            ->shouldReturn('CBA');
+            ->shouldIterateAs([0 => 'CBA']);
     }
 
     public function it_can_foldleft1(): void
@@ -827,11 +827,11 @@ public function it_can_foldleft1(): void
 
         $this::fromIterable([64, 4, 2, 8])
             ->foldLeft1($callback)
-            ->shouldReturn(1);
+            ->shouldIterateAs([3 => 1]);
 
         $this::fromIterable([12])
             ->foldLeft1($callback)
-            ->shouldReturn(12);
+            ->shouldIterateAs([0 => 12]);
     }
 
     public function it_can_foldright1(): void
@@ -842,11 +842,11 @@ public function it_can_foldright1(): void
 
         $this::fromIterable([8, 12, 24, 4])
             ->foldRight1($callback)
-            ->shouldReturn(4);
+            ->shouldIterateAs([0 => 4]);
 
         $this::fromIterable([12])
             ->foldRight1($callback)
-            ->shouldReturn(12);
+            ->shouldIterateAs([0 => 12]);
     }
 
     public function it_can_forget(): void
@@ -1744,7 +1744,7 @@ public function __invoke(): Closure
             }
         };
 
-        $map = new class() extends AbstractOperation implements Operation {
+        $castToInt = new class() extends AbstractOperation implements Operation {
             public function __invoke(): Closure
             {
                 return static function ($collection) {
@@ -1756,7 +1756,7 @@ public function __invoke(): Closure
         };
 
         $this::fromIterable(range(1, 5))
-            ->run($square(), $sqrt(), $map())
+            ->run($square(), $sqrt(), $castToInt())
             ->shouldIterateAs(range(1, 5));
     }
 

diff --git a/src/Collection.php b/src/Collection.php
@@ -409,24 +409,24 @@ public function flip(): CollectionInterface
         return $this->run(Flip::of());
     }
 
-    public function foldLeft(callable $callback, $initial = null)
+    public function foldLeft(callable $callback, $initial = null): CollectionInterface
     {
-        return $this->run(FoldLeft::of()($callback)($initial))->getIterator()->current();
+        return $this->run(FoldLeft::of()($callback)($initial));
     }
 
-    public function foldLeft1(callable $callback)
+    public function foldLeft1(callable $callback): CollectionInterface
     {
-        return $this->run(FoldLeft1::of()($callback))->getIterator()->current();
+        return $this->run(FoldLeft1::of()($callback));
     }
 
-    public function foldRight(callable $callback, $initial = null)
+    public function foldRight(callable $callback, $initial = null): CollectionInterface
     {
-        return $this->run(Foldright::of()($callback)($initial))->getIterator()->current();
+        return $this->run(Foldright::of()($callback)($initial));
     }
 
-    public function foldRight1(callable $callback)
+    public function foldRight1(callable $callback): CollectionInterface
     {
-        return $this->run(FoldRight1::of()($callback))->getIterator()->current();
+        return $this->run(FoldRight1::of()($callback));
     }
 
     public function forget(...$keys): CollectionInterface

diff --git a/src/Contract/Operation/FoldLeft1able.php b/src/Contract/Operation/FoldLeft1able.php
@@ -4,6 +4,9 @@
 
 namespace loophp\collection\Contract\Operation;
 
+use Iterator;
+use loophp\collection\Contract\Collection;
+
 /**
  * @psalm-template TKey
  * @psalm-template TKey of array-key
@@ -12,8 +15,10 @@
 interface FoldLeft1able
 {
     /**
+     * @psalm-param callable(T, T, TKey, Iterator<TKey, T>): T $callback
+     *
      * @return mixed
-     * @psalm-return T|null
+     * @psalm-return \loophp\collection\Contract\Collection<TKey, T|null>
      */
-    public function foldLeft1(callable $callback);
+    public function foldLeft1(callable $callback): Collection;
 }
diff --git a/src/Contract/Operation/FoldLeftable.php b/src/Contract/Operation/FoldLeftable.php
@@ -4,6 +4,9 @@
 
 namespace loophp\collection\Contract\Operation;
 
+use Iterator;
+use loophp\collection\Contract\Collection;
+
 /**
  * @psalm-template TKey
  * @psalm-template TKey of array-key
@@ -14,11 +17,13 @@ interface FoldLeftable
     /**
      * Fold the collection from the left to the right.
      *
+     * @psalm-param callable(T, T, TKey, Iterator<TKey, T>): T $callback
+     *
      * @param mixed $initial
      * @psalm-param T|null $initial
      *
      * @return mixed
-     * @psalm-return T|null
+     * @psalm-return \loophp\collection\Contract\Collection<TKey, T|null>
      */
-    public function foldLeft(callable $callback, $initial = null);
+    public function foldLeft(callable $callback, $initial = null): Collection;
 }
diff --git a/src/Contract/Operation/FoldRight1able.php b/src/Contract/Operation/FoldRight1able.php
@@ -4,6 +4,9 @@
 
 namespace loophp\collection\Contract\Operation;
 
+use Iterator;
+use loophp\collection\Contract\Collection;
+
 /**
  * @psalm-template TKey
  * @psalm-template TKey of array-key
@@ -12,8 +15,10 @@
 interface FoldRight1able
 {
     /**
+     * @psalm-param callable(T, T, TKey, Iterator<TKey, T>): T $callback
+     *
      * @return mixed
-     * @psalm-return T|null
+     * @psalm-return \loophp\collection\Contract\Collection<TKey, T|null>
      */
-    public function foldRight1(callable $callback);
+    public function foldRight1(callable $callback): Collection;
 }
diff --git a/src/Contract/Operation/FoldRightable.php b/src/Contract/Operation/FoldRightable.php
@@ -4,6 +4,9 @@
 
 namespace loophp\collection\Contract\Operation;
 
+use Iterator;
+use loophp\collection\Contract\Collection;
+
 /**
  * @psalm-template TKey
  * @psalm-template TKey of array-key
@@ -14,11 +17,13 @@ interface FoldRightable
     /**
      * Fold the collection from the right to the left.
      *
+     * @psalm-param callable(T, T, TKey, Iterator<TKey, T>): T $callback
+     *
      * @param mixed $initial
      * @psalm-param T|null $initial
      *
      * @return mixed
-     * @psalm-return T|null
+     * @psalm-return \loophp\collection\Contract\Collection<TKey, T|null>
      */
-    public function foldRight(callable $callback, $initial = null);
+    public function foldRight(callable $callback, $initial = null): Collection;
 }