fix: properly handle list type when input contains superfluous keys

Co-authored-by: Romain Canon <[email protected]>
CuyZ · Mar 12, 2024 · 1b8efa1 · 1b8efa1
1 parent 4b68835
commit 1b8efa1
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 3 deletions.
diff --git a/src/Mapper/Object/ArgumentsValues.php b/src/Mapper/Object/ArgumentsValues.php
@@ -6,6 +6,7 @@
 
 use CuyZ\Valinor\Mapper\Object\Exception\InvalidSource;
 use CuyZ\Valinor\Type\CompositeTraversableType;
+use CuyZ\Valinor\Type\Types\ArrayKeyType;
 use IteratorAggregate;
 use Traversable;
 
@@ -116,15 +117,17 @@ private function transformValueForSingleArgument(mixed $value): mixed
 
         $argument = $this->arguments->at(0);
         $name = $argument->name();
-        $isTraversable = $argument-> type() instanceof CompositeTraversableType;
+        $type = $argument->type();
+        $isTraversableAndAllowsStringKeys = $type instanceof CompositeTraversableType
+            && $type->keyType() !== ArrayKeyType::integer();
 
         if (is_array($value) && array_key_exists($name, $value)) {
-            if ($this->forInterface || ! $isTraversable || count($value) === 1) {
+            if ($this->forInterface || ! $isTraversableAndAllowsStringKeys || count($value) === 1) {
                 return $value;
             }
         }
 
-        if ($value === [] && ! $isTraversable) {
+        if ($value === [] && ! $isTraversableAndAllowsStringKeys) {
             return $value;
         }
 

diff --git a/tests/Integration/Mapping/Other/SuperfluousKeysMappingTest.php b/tests/Integration/Mapping/Other/SuperfluousKeysMappingTest.php
@@ -67,6 +67,44 @@ public function test_single_property_node_can_be_mapped_with_superfluous_key():
         }
         self::assertSame('foo', $result->foo);
     }
+
+    public function test_single_list_property_node_can_be_mapped_with_superfluous_key(): void
+    {
+        try {
+            $result = $this->mapper->map(ObjectWithSingleListProperty::class, [
+                'unrelated_key' => 'this-should-be-ignored-and-have-no-effect',
+                'values' => [7, 8, 9],
+            ]);
+        } catch (MappingError $error) {
+            $this->mappingFail($error);
+        }
+
+        self::assertSame([7, 8, 9], $result->values);
+    }
+
+    public function test_single_list_property_node_can_be_mapped_with_matching_key_and_without_superfluous_key(): void
+    {
+        try {
+            $result = $this->mapper->map(ObjectWithSingleListProperty::class, [
+                'values' => [7, 8, 9],
+            ]);
+        } catch (MappingError $error) {
+            $this->mappingFail($error);
+        }
+
+        self::assertSame([7, 8, 9], $result->values);
+    }
+
+    public function test_single_list_property_node_can_be_mapped_(): void
+    {
+        try {
+            $result = $this->mapper->map(ObjectWithSingleListProperty::class, [7, 8, 9]);
+        } catch (MappingError $error) {
+            $this->mappingFail($error);
+        }
+
+        self::assertSame([7, 8, 9], $result->values);
+    }
 }
 
 final class UnionOfBarAndFizAndFoo
@@ -86,3 +124,9 @@ final class SomeBarAndFizObject
 
     public string $fiz;
 }
+
+final class ObjectWithSingleListProperty
+{
+    /** @var list<int> */
+    public array $values;
+}