Merge branch 'develop'

* develop: specify next release ban the use of "yield from" and iterator_to_array() simplify lazy Sequence::slice() implementation remove dead code mention the callable passed to reduce may not be called fix psalm errors prevent loading the whole Set/Sequence/Map when matches find an invalid value fix psalm error fix loading the whole the Generator when lazy slicing a Sequence
Innmind · May 18, 2023 · 5b85b79 · 5b85b79
2 parents a15d1e4 + 7418a58
commit 5b85b79
Show file tree

Hide file tree

Showing 21 changed files with 242 additions and 133 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,17 @@
 # Changelog
 
+## 4.14.1 - 2023-05-18
+
+### Changed
+
+- All `reduce` methods now explicit the fact that the callable may not be called when the structure is empty
+
+### Fixed
+
+- A lazy `Sequence::slice()` no longer loads the whole underlying `Generator`
+- `Innmind\Immutable\Set::matches()`, `Innmind\Immutable\Sequence::matches()` and `Innmind\Immutable\Map::matches()` no longer iterates over all elements when one value doesn't match the predicate
+- When using `yield from` in the `Generator` passed to `Sequence::lazy()` values may be lost on certain operations
+
 ## 4.14.0 - 2023-04-29
 
 ### Added

diff --git a/src/Map.php b/src/Map.php
@@ -224,12 +224,15 @@ public function map(callable $function): self
      */
     public function flatMap(callable $map): self
     {
+        /** @var self<A, B> */
+        $all = self::of();
+
         /**
          * @psalm-suppress InvalidArgument
          * @psalm-suppress MixedArgument
          */
         return $this->reduce(
-            self::of(),
+            $all,
             static fn(self $carry, $key, $value) => $carry->merge($map($key, $value)),
         );
     }
@@ -273,11 +276,13 @@ public function partition(callable $predicate): self
     /**
      * Reduce the map to a single value
      *
+     * @template I
      * @template R
-     * @param R $carry
-     * @param callable(R, T, S): R $reducer
      *
-     * @return R
+     * @param I $carry
+     * @param callable(I|R, T, S): R $reducer
+     *
+     * @return I|R
      */
     public function reduce($carry, callable $reducer)
     {
@@ -304,11 +309,13 @@ public function find(callable $predicate): Maybe
      */
     public function matches(callable $predicate): bool
     {
-        /** @psalm-suppress MixedArgument */
-        return $this->reduce(
-            true,
-            static fn(bool $matches, $key, $value): bool => $matches && $predicate($key, $value),
-        );
+        /** @psalm-suppress MixedArgument For some reason Psalm no longer recognize the type in `find` */
+        return $this
+            ->find(static fn($key, $value) => !$predicate($key, $value))
+            ->match(
+                static fn() => false,
+                static fn() => true,
+            );
     }
 
     /**

diff --git a/src/Map/DoubleIndex.php b/src/Map/DoubleIndex.php
@@ -241,7 +241,6 @@ public function remove($key): self
      */
     public function merge(Implementation $map): self
     {
-        /** @psalm-suppress MixedArgument For some reason it no longer recognize templates for $key and $value */
         return $map->reduce(
             $this,
             static fn(self $carry, $key, $value): self => ($carry)($key, $value),
@@ -276,11 +275,13 @@ public function partition(callable $predicate): Map
     }
 
     /**
+     * @template I
      * @template R
-     * @param R $carry
-     * @param callable(R, T, S): R $reducer
      *
-     * @return R
+     * @param I $carry
+     * @param callable(I|R, T, S): R $reducer
+     *
+     * @return I|R
      */
     public function reduce($carry, callable $reducer)
     {

diff --git a/src/Map/Implementation.php b/src/Map/Implementation.php
@@ -149,11 +149,13 @@ public function partition(callable $predicate): Map;
     /**
      * Reduce the map to a single value
      *
+     * @template I
      * @template R
-     * @param R $carry
-     * @param callable(R, T, S): R $reducer
      *
-     * @return R
+     * @param I $carry
+     * @param callable(I|R, T, S): R $reducer
+     *
+     * @return I|R
      */
     public function reduce($carry, callable $reducer);
 

diff --git a/src/Map/ObjectKeys.php b/src/Map/ObjectKeys.php
@@ -250,8 +250,11 @@ public function groupBy(callable $discriminator): Map
      */
     public function keys(): Set
     {
+        /** @var Set<T> */
+        $keys = Set::of();
+
         return $this->reduce(
-            Set::of(),
+            $keys,
             static fn(Set $keys, $key): Set => ($keys)($key),
         );
     }
@@ -261,8 +264,11 @@ public function keys(): Set
      */
     public function values(): Sequence
     {
+        /** @var Sequence<S> */
+        $values = Sequence::of();
+
         return $this->reduce(
-            Sequence::of(),
+            $values,
             static fn(Sequence $values, $_, $value): Sequence => ($values)($value),
         );
     }
@@ -367,11 +373,13 @@ public function partition(callable $predicate): Map
     }
 
     /**
+     * @template I
      * @template R
-     * @param R $carry
-     * @param callable(R, T, S): R $reducer
      *
-     * @return R
+     * @param I $carry
+     * @param callable(I|R, T, S): R $reducer
+     *
+     * @return I|R
      */
     public function reduce($carry, callable $reducer)
     {

diff --git a/src/Map/Primitive.php b/src/Map/Primitive.php
@@ -308,11 +308,13 @@ public function partition(callable $predicate): Map
     }
 
     /**
+     * @template I
      * @template R
-     * @param R $carry
-     * @param callable(R, T, S): R $reducer
      *
-     * @return R
+     * @param I $carry
+     * @param callable(I|R, T, S): R $reducer
+     *
+     * @return I|R
      */
     public function reduce($carry, callable $reducer)
     {

diff --git a/src/Map/Uninitialized.php b/src/Map/Uninitialized.php
@@ -190,11 +190,13 @@ public function partition(callable $predicate): Map
     }
 
     /**
+     * @template I
      * @template R
-     * @param R $carry
-     * @param callable(R, T, S): R $reducer
      *
-     * @return R
+     * @param I $carry
+     * @param callable(I|R, T, S): R $reducer
+     *
+     * @return I|R
      */
     public function reduce($carry, callable $reducer)
     {

diff --git a/src/Maybe/Defer.php b/src/Maybe/Defer.php
@@ -72,7 +72,9 @@ public function toSequence(): Sequence
     {
         /** @psalm-suppress ImpureFunctionCall */
         return Sequence::defer((function() {
-            yield from $this->unwrap()->toSequence()->toList();
+            foreach ($this->unwrap()->toSequence()->toList() as $value) {
+                yield $value;
+            }
         })());
     }
 

diff --git a/src/Sequence.php b/src/Sequence.php
@@ -536,10 +536,7 @@ public function sort(callable $function): self
      */
     public function fold(Monoid $monoid)
     {
-        /**
-         * @psalm-suppress MissingClosureParamType
-         * @psalm-suppress MixedArgument
-         */
+        /** @psalm-suppress MixedArgument */
         return $this->reduce(
             $monoid->identity(),
             static fn($a, $b) => $monoid->combine($a, $b),
@@ -549,12 +546,13 @@ public function fold(Monoid $monoid)
     /**
      * Reduce the sequence to a single value
      *
+     * @template I
      * @template R
      *
-     * @param R $carry
-     * @param callable(R, T): R $reducer
+     * @param I $carry
+     * @param callable(I|R, T): R $reducer
      *
-     * @return R
+     * @return I|R
      */
     public function reduce($carry, callable $reducer)
     {
@@ -599,13 +597,14 @@ public function toSet(): Set
      */
     public function toList(): array
     {
-        /**
-         * @psalm-suppress MixedAssignment
-         * @var list<T>
-         */
+        /** @var list<T> */
+        $all = [];
+
+        /** @var list<T> */
         return $this->reduce(
-            [],
+            $all,
             static function(array $carry, $value): array {
+                /** @var T $value */
                 $carry[] = $value;
 
                 return $carry;
@@ -645,11 +644,13 @@ public function match(callable $match, callable $empty)
      */
     public function matches(callable $predicate): bool
     {
-        /** @psalm-suppress MixedArgument */
-        return $this->reduce(
-            true,
-            static fn(bool $matches, $value): bool => $matches && $predicate($value),
-        );
+        /** @psalm-suppress MixedArgument For some reason Psalm no longer recognize the type in `find` */
+        return $this
+            ->find(static fn($value) => !$predicate($value))
+            ->match(
+                static fn() => false,
+                static fn() => true,
+            );
     }
 
     /**

diff --git a/src/Sequence/Defer.php b/src/Sequence/Defer.php
@@ -507,24 +507,30 @@ public function sort(callable $function): Implementation
             (static function(\Iterator $values, callable $function): \Generator {
                 /** @var callable(T, T): int $sorter */
                 $sorter = $function;
+                $loaded = [];
 
-                /** @var list<T> */
-                $values = \iterator_to_array($values);
-                \usort($values, $sorter);
-
+                /** @var T $value */
                 foreach ($values as $value) {
+                    $loaded[] = $value;
+                }
+
+                \usort($loaded, $sorter);
+
+                foreach ($loaded as $value) {
                     yield $value;
                 }
             })($this->values, $function),
         );
     }
 
     /**
+     * @template I
      * @template R
-     * @param R $carry
-     * @param callable(R, T): R $reducer
      *
-     * @return R
+     * @param I $carry
+     * @param callable(I|R, T): R $reducer
+     *
+     * @return I|R
      */
     public function reduce($carry, callable $reducer)
     {
@@ -552,9 +558,16 @@ public function reverse(): Implementation
         /** @psalm-suppress ImpureFunctionCall */
         return new self(
             (static function(\Iterator $values): \Generator {
-                $values = \iterator_to_array($values);
+                $reversed = [];
 
-                yield from \array_reverse($values);
+                /** @var T $value */
+                foreach ($values as $value) {
+                    \array_unshift($reversed, $value);
+                }
+
+                foreach ($reversed as $value) {
+                    yield $value;
+                }
             })($this->values),
         );
     }
@@ -766,7 +779,12 @@ public function takeWhile(callable $condition): self
      */
     private function load(): Implementation
     {
-        /** @psalm-suppress ImpureFunctionCall */
-        return new Primitive(\array_values(\iterator_to_array($this->values)));
+        $values = [];
+
+        foreach ($this->values as $value) {
+            $values[] = $value;
+        }
+
+        return new Primitive($values);
     }
 }
diff --git a/src/Sequence/Implementation.php b/src/Sequence/Implementation.php
@@ -251,11 +251,13 @@ public function sort(callable $function): self;
     /**
      * Reduce the sequence to a single value
      *
+     * @template I
      * @template R
-     * @param R $carry
-     * @param callable(R, T): R $reducer
      *
-     * @return R
+     * @param I $carry
+     * @param callable(I|R, T): R $reducer
+     *
+     * @return I|R
      */
     public function reduce($carry, callable $reducer);