Replace Iterator with iterable almost everywhere.

loophp · Jan 28, 2022 · d623bc4 · d623bc4
1 parent 19616a6
commit d623bc4
Show file tree

Hide file tree

Showing 122 changed files with 533 additions and 632 deletions.
diff --git a/src/Collection.php b/src/Collection.php
@@ -133,7 +133,7 @@
 use loophp\collection\Operation\Zip;
 use loophp\iterators\CachingIteratorAggregate;
 use loophp\iterators\ClosureIterator;
-use loophp\iterators\IterableIterator;
+use loophp\iterators\IterableIteratorAggregate;
 use loophp\iterators\ResourceIteratorAggregate;
 use loophp\iterators\StringIteratorAggregate;
 use NoRewindIterator;
@@ -503,7 +503,7 @@ public static function fromGenerator(Generator $generator): self
      */
     public static function fromIterable(iterable $iterable): self
     {
-        return new self(static fn (): Iterator => new IterableIterator($iterable));
+        return new self(static fn (): IteratorAggregate => new IterableIteratorAggregate($iterable));
     }
 
     /**

diff --git a/src/Contract/Operation/Applyable.php b/src/Contract/Operation/Applyable.php
@@ -9,7 +9,6 @@
 
 namespace loophp\collection\Contract\Operation;
 
-use Iterator;
 use loophp\collection\Contract\Collection;
 
 /**
@@ -25,7 +24,7 @@ interface Applyable
      *
      * @see https://loophp-collection.readthedocs.io/en/stable/pages/api.html#apply
      *
-     * @param callable(T=, TKey=, Iterator<TKey, T>=): bool ...$callbacks
+     * @param callable(T=, TKey=, iterable<TKey, T>=): bool ...$callbacks
      *
      * @return Collection<TKey, T>
      */

diff --git a/src/Contract/Operation/Associateable.php b/src/Contract/Operation/Associateable.php
@@ -9,7 +9,6 @@
 
 namespace loophp\collection\Contract\Operation;
 
-use Iterator;
 use loophp\collection\Contract\Collection;
 
 /**
@@ -23,13 +22,10 @@ interface Associateable
      *
      * @see https://loophp-collection.readthedocs.io/en/stable/pages/api.html#associate
      *
-     * @template NewT
-     * @template NewTKey
+     * @param callable(TKey=, T=, iterable<TKey, T>=): mixed $callbackForKeys
+     * @param callable(T=, TKey=, iterable<TKey, T>=): mixed $callbackForValues
      *
-     * @param callable(TKey=, T=, Iterator<TKey, T>=): NewTKey $callbackForKeys
-     * @param callable(T=, TKey=, Iterator<TKey, T>=): NewT $callbackForValues
-     *
-     * @return Collection<NewTKey, NewT>
+     * @return Collection<mixed, mixed>
      */
     public function associate(?callable $callbackForKeys = null, ?callable $callbackForValues = null): Collection;
 }
diff --git a/src/Contract/Operation/Duplicateable.php b/src/Contract/Operation/Duplicateable.php
@@ -32,10 +32,8 @@ interface Duplicateable
      *
      * @see https://loophp-collection.readthedocs.io/en/stable/pages/api.html#duplicate
      *
-     * @template U
-     *
-     * @param null|callable(U): (Closure(U): bool) $comparatorCallback
-     * @param null|callable(T, TKey): U $accessorCallback
+     * @param (callable(mixed): (Closure(mixed): bool)) $comparatorCallback
+     * @param callable(T, TKey): mixed $accessorCallback
      *
      * @return Collection<TKey, T>
      */

diff --git a/src/Contract/Operation/Everyable.php b/src/Contract/Operation/Everyable.php
@@ -9,8 +9,6 @@
 
 namespace loophp\collection\Contract\Operation;
 
-use Iterator;
-
 /**
  * @template TKey
  * @template T
@@ -22,7 +20,7 @@ interface Everyable
      *
      * @see https://loophp-collection.readthedocs.io/en/stable/pages/api.html#every
      *
-     * @param callable(T=, TKey=, Iterator<TKey, T>=): bool ...$callbacks
+     * @param callable(T=, TKey=, iterable<TKey, T>=): bool ...$callbacks
      */
     public function every(callable ...$callbacks): bool;
 }
diff --git a/src/Contract/Operation/Filterable.php b/src/Contract/Operation/Filterable.php
@@ -9,7 +9,6 @@
 
 namespace loophp\collection\Contract\Operation;
 
-use Iterator;
 use loophp\collection\Contract\Collection;
 
 /**
@@ -23,7 +22,7 @@ interface Filterable
      *
      * @see https://loophp-collection.readthedocs.io/en/stable/pages/api.html#filter
      *
-     * @param callable(T=, TKey=, Iterator<TKey, T>=): bool ...$callbacks
+     * @param callable(T=, TKey=, iterable<TKey, T>=): bool ...$callbacks
      *
      * @return Collection<TKey, T>
      */

diff --git a/src/Contract/Operation/Findable.php b/src/Contract/Operation/Findable.php
@@ -9,8 +9,6 @@
 
 namespace loophp\collection\Contract\Operation;
 
-use Iterator;
-
 /**
  * @template TKey
  * @template T
@@ -26,7 +24,7 @@ interface Findable
      * @template V
      *
      * @param V $default
-     * @param (callable(T=, TKey=, Iterator<TKey, T>=): bool) ...$callbacks
+     * @param (callable(T=, TKey=, iterable<TKey, T>=): bool) ...$callbacks
      *
      * @return T|V
      */

diff --git a/src/Contract/Operation/FlatMapable.php b/src/Contract/Operation/FlatMapable.php
@@ -9,7 +9,6 @@
 
 namespace loophp\collection\Contract\Operation;
 
-use Iterator;
 use loophp\collection\Contract\Collection;
 
 /**
@@ -27,7 +26,7 @@ interface FlatMapable
      * @template IKey
      * @template IValue
      *
-     * @param callable(T=, TKey=, Iterator<TKey, T>=): iterable<IKey, IValue> $callback
+     * @param callable(T=, TKey=, iterable<TKey, T>=): iterable<IKey, IValue> $callback
      *
      * @return Collection<IKey, IValue>
      */

diff --git a/src/Contract/Operation/FoldLeftable.php b/src/Contract/Operation/FoldLeftable.php
@@ -9,7 +9,6 @@
 
 namespace loophp\collection\Contract\Operation;
 
-use Iterator;
 use loophp\collection\Contract\Collection;
 
 /**
@@ -24,7 +23,7 @@ interface FoldLeftable
      *
      * @see https://loophp-collection.readthedocs.io/en/stable/pages/api.html#foldleft
      *
-     * @param callable(T, T, TKey, Iterator<TKey, T>): T $callback
+     * @param callable(T, T, TKey, iterable<TKey, T>): T $callback
      * @param T|null $initial
      *
      * @return Collection<TKey, T|null>

diff --git a/src/Contract/Operation/FoldRightable.php b/src/Contract/Operation/FoldRightable.php
@@ -9,7 +9,6 @@
 
 namespace loophp\collection\Contract\Operation;
 
-use Iterator;
 use loophp\collection\Contract\Collection;
 
 /**
@@ -24,7 +23,7 @@ interface FoldRightable
      *
      * @see https://loophp-collection.readthedocs.io/en/stable/pages/api.html#foldright
      *
-     * @param callable(T, T, TKey, Iterator<TKey, T>): T $callback
+     * @param callable(T, T, TKey, iterable<TKey, T>): T $callback
      * @param T|null $initial
      *
      * @return Collection<TKey, T|null>

diff --git a/src/Contract/Operation/Hasable.php b/src/Contract/Operation/Hasable.php
@@ -9,8 +9,6 @@
 
 namespace loophp\collection\Contract\Operation;
 
-use Iterator;
-
 /**
  * @template TKey
  * @template T
@@ -22,7 +20,7 @@ interface Hasable
      *
      * @see https://loophp-collection.readthedocs.io/en/stable/pages/api.html#has
      *
-     * @param callable(T=, TKey=, Iterator<TKey, T>=): T ...$callbacks
+     * @param callable(T=, TKey=, iterable<TKey, T>=): T ...$callbacks
      */
     public function has(callable ...$callbacks): bool;
 }
diff --git a/src/Contract/Operation/MapNable.php b/src/Contract/Operation/MapNable.php
@@ -9,7 +9,6 @@
 
 namespace loophp\collection\Contract\Operation;
 
-use Iterator;
 use loophp\collection\Contract\Collection;
 
 /**
@@ -23,7 +22,7 @@ interface MapNable
      *
      * @see https://loophp-collection.readthedocs.io/en/stable/pages/api.html#mapn
      *
-     * @param callable(mixed, mixed, Iterator<TKey, T>): mixed ...$callbacks
+     * @param callable(mixed, mixed, iterable<TKey, T>): mixed ...$callbacks
      *
      * @return Collection<mixed, mixed>
      */

diff --git a/src/Contract/Operation/Mapable.php b/src/Contract/Operation/Mapable.php
@@ -9,7 +9,6 @@
 
 namespace loophp\collection\Contract\Operation;
 
-use Iterator;
 use loophp\collection\Contract\Collection;
 
 /**
@@ -25,7 +24,7 @@ interface Mapable
      *
      * @template V
      *
-     * @param callable(T=, TKey=, Iterator<TKey, T>=): V $callback
+     * @param callable(T=, TKey=, iterable<TKey, T>=): V $callback
      *
      * @return Collection<TKey, V>
      */

diff --git a/src/Contract/Operation/Matchable.php b/src/Contract/Operation/Matchable.php
@@ -30,8 +30,8 @@ interface Matchable
      *
      * @see https://loophp-collection.readthedocs.io/en/stable/pages/api.html#match
      *
-     * @param callable(T=, TKey=, Iterator<TKey, T>=): bool $callback
-     * @param null|callable(T=, TKey=, Iterator<TKey, T>=): bool $matcher
+     * @param callable(T=, TKey=, iterable<TKey, T>=): bool $callback
+     * @param null|callable(T=, TKey=, iterable<TKey, T>=): bool $matcher
      */
     public function match(callable $callback, ?callable $matcher = null): bool;
 }
diff --git a/src/Contract/Operation/Partitionable.php b/src/Contract/Operation/Partitionable.php
@@ -9,7 +9,6 @@
 
 namespace loophp\collection\Contract\Operation;
 
-use Iterator;
 use loophp\collection\Contract\Collection;
 
 /**
@@ -26,7 +25,7 @@ interface Partitionable
      *
      * @see https://loophp-collection.readthedocs.io/en/stable/pages/api.html#partition
      *
-     * @param callable(T=, TKey=, Iterator<TKey, T>=): bool ...$callbacks
+     * @param callable(T=, TKey=, iterable<TKey, T>=): bool ...$callbacks
      *
      * @return Collection<int, Collection<TKey, T>>
      */

diff --git a/src/Contract/Operation/Reduceable.php b/src/Contract/Operation/Reduceable.php
@@ -9,7 +9,6 @@
 
 namespace loophp\collection\Contract\Operation;
 
-use Iterator;
 use loophp\collection\Contract\Collection;
 
 /**
@@ -26,7 +25,7 @@ interface Reduceable
      * @template V
      * @template W
      *
-     * @param callable((V|W)=, T=, TKey=, Iterator<TKey, T>=): W $callback
+     * @param callable((V|W)=, T=, TKey=, iterable<TKey, T>=): W $callback
      * @param V $initial
      *
      * @return Collection<TKey, W>

diff --git a/src/Contract/Operation/Reductionable.php b/src/Contract/Operation/Reductionable.php
@@ -9,7 +9,6 @@
 
 namespace loophp\collection\Contract\Operation;
 
-use Iterator;
 use loophp\collection\Contract\Collection;
 
 /**
@@ -26,7 +25,7 @@ interface Reductionable
      * @template V
      * @template W
      *
-     * @param callable((V|W)=, T=, TKey=, Iterator<TKey, T>=): W $callback
+     * @param callable((V|W)=, T=, TKey=, iterable<TKey, T>=): W $callback
      * @param V $initial
      *
      * @return Collection<TKey, W>

diff --git a/src/Contract/Operation/Rejectable.php b/src/Contract/Operation/Rejectable.php
@@ -9,7 +9,6 @@
 
 namespace loophp\collection\Contract\Operation;
 
-use Iterator;
 use loophp\collection\Contract\Collection;
 
 /**
@@ -23,7 +22,7 @@ interface Rejectable
      *
      * @see https://loophp-collection.readthedocs.io/en/stable/pages/api.html#reject
      *
-     * @param callable(T=, TKey=, Iterator<TKey, T>=): bool ...$callbacks
+     * @param callable(T=, TKey=, iterable<TKey, T>=): bool ...$callbacks
      *
      * @return Collection<TKey, T>
      */

diff --git a/src/Contract/Operation/ScanLeftable.php b/src/Contract/Operation/ScanLeftable.php
@@ -9,7 +9,6 @@
 
 namespace loophp\collection\Contract\Operation;
 
-use Iterator;
 use loophp\collection\Contract\Collection;
 
 /**
@@ -28,7 +27,7 @@ interface ScanLeftable
      * @template V
      * @template W
      *
-     * @param callable((V|W)=, T=, TKey=, Iterator<TKey, T>=): W $callback
+     * @param callable((V|W)=, T=, TKey=, iterable<TKey, T>=): W $callback
      * @param V $initial
      *
      * @return Collection<int|TKey, V|W>

diff --git a/src/Contract/Operation/ScanRightable.php b/src/Contract/Operation/ScanRightable.php
@@ -9,7 +9,6 @@
 
 namespace loophp\collection\Contract\Operation;
 
-use Iterator;
 use loophp\collection\Contract\Collection;
 
 /**
@@ -28,7 +27,7 @@ interface ScanRightable
      * @template V
      * @template W
      *
-     * @param callable((V|W)=, T=, TKey=, Iterator<TKey, T>=): W $callback
+     * @param callable((V|W)=, T=, TKey=, iterable<TKey, T>=): W $callback
      * @param V $initial
      *
      * @return Collection<int|TKey, V|W>

diff --git a/src/Contract/Operation/Spanable.php b/src/Contract/Operation/Spanable.php
@@ -9,7 +9,6 @@
 
 namespace loophp\collection\Contract\Operation;
 
-use Iterator;
 use loophp\collection\Contract\Collection;
 
 /**
@@ -27,7 +26,7 @@ interface Spanable
      *
      * @see https://loophp-collection.readthedocs.io/en/stable/pages/api.html#span
      *
-     * @param callable(T=, TKey=, Iterator<TKey, T>=): bool ...$callbacks
+     * @param callable(T=, TKey=, iterable<TKey, T>=): bool ...$callbacks
      *
      * @return Collection<int, Collection<TKey, T>>
      */

diff --git a/src/Contract/Operation/TakeWhileable.php b/src/Contract/Operation/TakeWhileable.php
@@ -9,7 +9,6 @@
 
 namespace loophp\collection\Contract\Operation;
 
-use Iterator;
 use loophp\collection\Contract\Collection;
 
 /**
@@ -24,7 +23,7 @@ interface TakeWhileable
      *
      * @see https://loophp-collection.readthedocs.io/en/stable/pages/api.html#takewhile
      *
-     * @param callable(T=, TKey=, Iterator<TKey, T>=): bool ...$callbacks
+     * @param callable(T=, TKey=, iterable<TKey, T>=): bool ...$callbacks
      *
      * @return Collection<TKey, T>
      */

diff --git a/src/Contract/Operation/Whenable.php b/src/Contract/Operation/Whenable.php
@@ -9,7 +9,6 @@
 
 namespace loophp\collection\Contract\Operation;
 
-use Iterator;
 use loophp\collection\Contract\Collection;
 
 /**
@@ -27,9 +26,9 @@ interface Whenable
      *
      * @see https://loophp-collection.readthedocs.io/en/stable/pages/api.html#when
      *
-     * @param callable(Iterator<TKey, T>): bool $predicate
-     * @param callable(Iterator<TKey, T>): iterable<TKey, T> $whenTrue
-     * @param callable(Iterator<TKey, T>): iterable<TKey, T> $whenFalse
+     * @param callable(iterable<TKey, T>): bool $predicate
+     * @param callable(iterable<TKey, T>): iterable<TKey, T> $whenTrue
+     * @param callable(iterable<TKey, T>): iterable<TKey, T> $whenFalse
      *
      * @return Collection<TKey, T>
      */