Merge pull request #25 from Innmind/map-to-sequence

Add `Map::toSequence()`

Author: Baptouuuu

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [Unreleased]
+
+### Added
+
+- `Innmind\Immutable\Map::toSequence()`
+
+### Fixed
+
+- Using `string`s or `int`s as a `Map` key type and then adding keys of different types was throwing an error.
+
 ## 5.9.0 - 2024-07-05
 
 ### Added

docs/structures/map.md

@@ -349,3 +349,17 @@ Return an empty new map of the same type. Useful to avoid to respecify the templ
 $map = Map::of([1, 2], [3, 4]);
 $map->clear()->size(); // 0
 ```
+
+### `->toSequence()`
+
+Returns an unsorted `Sequence` with all value pairs.
+
+```php
+$map = Map::of([1, 2], [3, 4]);
+$map
+    ->toSequence()
+    ->equals(Sequence::of(
+        new Pair(1, 2),
+        new Pair(3, 4),
+    )); // true
+```

proofs/map.php

@@ -0,0 +1,31 @@
+<?php
+declare(strict_types = 1);
+
+use Innmind\Immutable\Map;
+use Innmind\BlackBox\Set;
+
+return static function() {
+    yield proof(
+        'Map::toSequence()',
+        given(
+            Set\Sequence::of(Set\Type::any()),
+            Set\Sequence::of(Set\Type::any()),
+        ),
+        static function($assert, $keys, $values) {
+            $map = Map::of();
+
+            foreach ($keys as $index => $key) {
+                $map = ($map)($key, $values[$index] ?? null);
+            }
+
+            $assert->true(
+                $map->equals(Map::of(
+                    ...$map
+                        ->toSequence()
+                        ->map(static fn($pair) => [$pair->key(), $pair->value()])
+                        ->toList(),
+                )),
+            );
+        },
+    );
+};

src/Map.php

@@ -328,4 +328,12 @@ public function any(callable $predicate): bool
             static fn() => false,
         );
     }
+
+    /**
+     * @return Sequence<Pair<T, S>>
+     */
+    public function toSequence(): Sequence
+    {
+        return $this->implementation->toSequence();
+    }
 }

src/Map/DoubleIndex.php

@@ -302,6 +302,11 @@ public function find(callable $predicate): Maybe
         return $this->pairs->find(static fn($pair) => $predicate($pair->key(), $pair->value()));
     }
 
+    public function toSequence(): Sequence
+    {
+        return $this->pairs->toSequence();
+    }
+
     /**
      * @return Map<T, S>
      */

src/Map/Implementation.php

@@ -166,4 +166,9 @@ public function empty(): bool;
      * @return Maybe<Pair<T, S>>
      */
     public function find(callable $predicate): Maybe;
+
+    /**
+     * @return Sequence<Pair<T, S>>
+     */
+    public function toSequence(): Sequence;
 }

src/Map/ObjectKeys.php

@@ -430,6 +430,15 @@ public function find(callable $predicate): Maybe
         return Maybe::nothing();
     }
 
+    public function toSequence(): Sequence
+    {
+        /** @var Sequence<Pair<T, S>> */
+        return $this->reduce(
+            Sequence::of(),
+            static fn(Sequence $pairs, $key, $value) => ($pairs)(new Pair($key, $value)),
+        );
+    }
+
     /**
      * @return Map<T, S>
      */

src/Map/Primitive.php

@@ -47,6 +47,10 @@ public function __invoke($key, $value): Implementation
             return (new DoubleIndex)->merge($this)($key, $value);
         }
 
+        if (!\is_string($key) && !\is_int($key)) {
+            return (new DoubleIndex)->merge($this)($key, $value);
+        }
+
         $values = $this->values;
         $values[$key] = $value;
 
@@ -350,6 +354,15 @@ public function find(callable $predicate): Maybe
         return Maybe::nothing();
     }
 
+    public function toSequence(): Sequence
+    {
+        /** @var Sequence<Pair<T, S>> */
+        return $this->reduce(
+            Sequence::of(),
+            static fn(Sequence $pairs, $key, $value) => ($pairs)(new Pair($key, $value)),
+        );
+    }
+
     /**
      * @return Map<T, S>
      */

src/Map/Uninitialized.php

@@ -214,6 +214,11 @@ public function find(callable $predicate): Maybe
         return Maybe::nothing();
     }
 
+    public function toSequence(): Sequence
+    {
+        return Sequence::of();
+    }
+
     /**
      * @return Map<T, S>
      */