Merge branch 'develop'

* develop:
  specify next release
  discard psalm errors
  add Set::unsorted()
  CS

Author: Baptouuuu

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 5.4.0 - 2024-05-29
+
+### Added
+
+- `Innmind\Immutable\Set::unsorted()`
+
 ## 5.3.0 - 2023-11-06
 
 ### Added

docs/SET.md

@@ -267,6 +267,16 @@ $sequence = Set::ints(1, 4, 2, 3)->sort(fn($a, $b) => $a <=> $b);
 $sequence->equals(Sequence::ints(1, 2, 3, 4));
 ```
 
+## `->unsorted()`
+
+It will transform the set into an unordered sequence.
+
+```php
+$sequence = Set::ints(1, 4, 2, 3)->unsorted();
+// is the same as
+$sequence = Sequence::of(...Set::of(1, 4, 2, 3)->toList());
+```
+
 ## `->merge()`
 
 Create a new set with all the elements from both sets.

proofs/predicate.php

@@ -7,21 +7,21 @@
     yield test(
         'Or predicate',
         static function($assert) {
-            $array = new \SplFixedArray;
+            $array = new SplFixedArray;
 
             $assert->true(
-                Instance::of(\Countable::class)
-                    ->or(Instance::of(\stdClass::class))
+                Instance::of(Countable::class)
+                    ->or(Instance::of(stdClass::class))
                     ($array),
             );
             $assert->true(
-                Instance::of(\stdClass::class)
-                    ->or(Instance::of(\Countable::class))
+                Instance::of(stdClass::class)
+                    ->or(Instance::of(Countable::class))
                     ($array),
             );
             $assert->false(
-                Instance::of(\Throwable::class)
-                    ->or(Instance::of(\Unknown::class))
+                Instance::of(Throwable::class)
+                    ->or(Instance::of(Unknown::class))
                     ($array),
             );
         },
@@ -30,21 +30,21 @@ static function($assert) {
     yield test(
         'And predicate',
         static function($assert) {
-            $array = new \SplFixedArray;
+            $array = new SplFixedArray;
 
             $assert->true(
-                Instance::of(\Countable::class)
-                    ->and(Instance::of(\Traversable::class))
+                Instance::of(Countable::class)
+                    ->and(Instance::of(Traversable::class))
                     ($array),
             );
             $assert->false(
-                Instance::of(\Throwable::class)
-                    ->and(Instance::of(\Countable::class))
+                Instance::of(Throwable::class)
+                    ->and(Instance::of(Countable::class))
                     ($array),
             );
             $assert->false(
-                Instance::of(\Countable::class)
-                    ->and(Instance::of(\Throwable::class))
+                Instance::of(Countable::class)
+                    ->and(Instance::of(Throwable::class))
                     ($array),
             );
         },

proofs/set.php

@@ -34,4 +34,22 @@ static function($assert, $first, $rest) {
             $assert->same($rest, $packed[1]->toList());
         },
     );
+
+    yield proof(
+        'Set::unsorted()',
+        given(
+            DataSet\Sequence::of(DataSet\Type::any()),
+        ),
+        static function($assert, $values) {
+            $set = Set::of(...$values);
+            $sequence = $set->unsorted();
+
+            $assert->true(
+                $sequence->matches($set->contains(...)),
+            );
+            $assert->true(
+                $set->matches($sequence->contains(...)),
+            );
+        },
+    );
 };

src/Accumulate.php

@@ -54,7 +54,9 @@ public function key(): mixed
 
     public function next(): void
     {
+        /** @psalm-suppress InaccessibleProperty */
         \next($this->keys);
+        /** @psalm-suppress InaccessibleProperty */
         \next($this->values);
 
         if ($this->reachedCacheEnd()) {
@@ -65,7 +67,9 @@ public function next(): void
 
     public function rewind(): void
     {
+        /** @psalm-suppress InaccessibleProperty */
         \reset($this->keys);
+        /** @psalm-suppress InaccessibleProperty */
         \reset($this->values);
     }
 

src/Map/DoubleIndex.php

@@ -5,7 +5,6 @@
 
 use Innmind\Immutable\{
     Map,
-    Str,
     Sequence,
     Set,
     Pair,

src/Map/Implementation.php

@@ -5,7 +5,6 @@
 
 use Innmind\Immutable\{
     Map,
-    Str,
     Set,
     Sequence,
     Pair,

src/Map/ObjectKeys.php

@@ -5,7 +5,6 @@
 
 use Innmind\Immutable\{
     Map,
-    Str,
     Sequence,
     Set,
     Pair,

src/Map/Primitive.php

@@ -5,7 +5,6 @@
 
 use Innmind\Immutable\{
     Map,
-    Str,
     Sequence,
     Set,
     Pair,
@@ -328,7 +327,10 @@ public function reduce($carry, callable $reducer)
 
     public function empty(): bool
     {
-        /** @psalm-suppress MixedArgumentTypeCoercion */
+        /**
+         * @psalm-suppress InaccessibleProperty
+         * @psalm-suppress MixedArgumentTypeCoercion
+         */
         \reset($this->values);
 
         /** @psalm-suppress MixedArgumentTypeCoercion */

src/Sequence/Defer.php

@@ -6,7 +6,6 @@
 use Innmind\Immutable\{
     Map,
     Sequence,
-    Str,
     Set,
     Maybe,
     Accumulate,

src/Sequence/Implementation.php

@@ -6,7 +6,6 @@
 use Innmind\Immutable\{
     Map,
     Sequence,
-    Str,
     Set,
     Maybe,
     SideEffect,

src/Sequence/Lazy.php

@@ -6,7 +6,6 @@
 use Innmind\Immutable\{
     Map,
     Sequence,
-    Str,
     Set,
     Maybe,
     SideEffect,
@@ -273,6 +272,7 @@ public function contains($element): bool
         /** @psalm-suppress ImpureFunctionCall */
         $generator = ($this->values)($register);
 
+        /** @psalm-suppress ImpureMethodCall */
         foreach ($generator as $value) {
             if ($value === $element) {
                 /** @psalm-suppress ImpureMethodCall */

src/Sequence/Primitive.php

@@ -6,7 +6,6 @@
 use Innmind\Immutable\{
     Map,
     Sequence,
-    Str,
     Set,
     Maybe,
     SideEffect,
@@ -385,7 +384,10 @@ public function intersect(Implementation $sequence): self
     public function sort(callable $function): self
     {
         $self = clone $this;
-        /** @psalm-suppress ImpureFunctionCall */
+        /**
+         * @psalm-suppress InaccessibleProperty
+         * @psalm-suppress ImpureFunctionCall
+         */
         \usort($self->values, $function);
 
         return $self;
@@ -528,6 +530,7 @@ public function aggregate(callable $map, callable $exfiltrate): self
         $values = $aggregate(static fn($a, $b) => $exfiltrate($map($a, $b))->iterator());
         $aggregated = [];
 
+        /** @psalm-suppress ImpureMethodCall */
         foreach ($values as $value) {
             $aggregated[] = $value;
         }

src/Set.php

@@ -362,6 +362,19 @@ public function sort(callable $function): Sequence
         return $this->implementation->sort($function);
     }
 
+    /**
+     * Return an unsorted sequence
+     *
+     * @return Sequence<T>
+     */
+    public function unsorted(): Sequence
+    {
+        return $this
+            ->implementation
+            ->sequence()
+            ->toSequence();
+    }
+
     /**
      * Create a new set with elements of both sets
      *

src/Set/Defer.php

@@ -7,7 +7,6 @@
     Map,
     Sequence,
     Set,
-    Str,
     Maybe,
     SideEffect,
 };

src/Set/Implementation.php

@@ -7,7 +7,6 @@
     Map,
     Sequence,
     Set,
-    Str,
     Maybe,
     SideEffect,
 };

src/Set/Lazy.php

@@ -7,7 +7,6 @@
     Map,
     Sequence,
     Set,
-    Str,
     Maybe,
     SideEffect,
     RegisterCleanup,

src/Set/Primitive.php

@@ -7,7 +7,6 @@
     Map,
     Sequence,
     Set,
-    Str,
     Maybe,
     SideEffect,
 };

tests/Map/DoubleIndexTest.php

@@ -7,8 +7,6 @@
     Map\DoubleIndex,
     Map\Implementation,
     Map,
-    Pair,
-    Str,
     Set,
     Sequence,
 };
@@ -20,7 +18,7 @@ public function testInterface()
     {
         $m = new DoubleIndex;
 
-        $this->assertInstanceOf(Map\Implementation::class, $m);
+        $this->assertInstanceOf(Implementation::class, $m);
         $this->assertInstanceOf(\Countable::class, $m);
     }
 

tests/Map/ObjectKeysTest.php

@@ -8,8 +8,6 @@
     Map\DoubleIndex,
     Map\Implementation,
     Map,
-    Pair,
-    Str,
     Set,
     Sequence,
 };
@@ -21,7 +19,7 @@ public function testInterface()
     {
         $m = new ObjectKeys;
 
-        $this->assertInstanceOf(Map\Implementation::class, $m);
+        $this->assertInstanceOf(Implementation::class, $m);
         $this->assertInstanceOf(\Countable::class, $m);
     }
 

tests/Map/PrimitiveTest.php

@@ -7,8 +7,6 @@
     Map\Primitive,
     Map\Implementation,
     Map,
-    Pair,
-    Str,
     Set,
     Sequence,
 };
@@ -20,7 +18,7 @@ public function testInterface()
     {
         $m = new Primitive;
 
-        $this->assertInstanceOf(Map\Implementation::class, $m);
+        $this->assertInstanceOf(Implementation::class, $m);
         $this->assertInstanceOf(\Countable::class, $m);
     }
 

tests/MapTest.php

@@ -5,8 +5,6 @@
 
 use Innmind\Immutable\{
     Map,
-    Pair,
-    Str,
     Set,
     Sequence,
 };

tests/Sequence/DeferTest.php

@@ -7,9 +7,6 @@
     Sequence\Defer,
     Sequence\Implementation,
     Map,
-    Sequence,
-    Str,
-    Set,
     SideEffect,
 };
 use Innmind\BlackBox\PHPUnit\Framework\TestCase;

tests/Sequence/LazyTest.php

@@ -7,9 +7,6 @@
     Sequence\Lazy,
     Sequence\Implementation,
     Map,
-    Sequence,
-    Str,
-    Set,
     SideEffect,
 };
 use Innmind\BlackBox\PHPUnit\Framework\TestCase;

tests/Sequence/PrimitiveTest.php

@@ -7,9 +7,6 @@
     Sequence\Primitive,
     Sequence\Implementation,
     Map,
-    Sequence,
-    Str,
-    Set,
     SideEffect,
 };
 use Innmind\BlackBox\PHPUnit\Framework\TestCase;

tests/Set/DeferTest.php

@@ -6,9 +6,7 @@
 use Innmind\Immutable\{
     Set\Defer,
     Set\Implementation,
-    Set,
     Map,
-    Str,
     Sequence,
     SideEffect,
 };

tests/Set/LazyTest.php

@@ -6,9 +6,7 @@
 use Innmind\Immutable\{
     Set\Lazy,
     Set\Implementation,
-    Set,
     Map,
-    Str,
     Sequence,
     SideEffect,
 };