feat(mapper): allow multiple fields in #[MapFrom] (#944)

Author: gturpin-dev

src/Tempest/Mapper/src/MapFrom.php

@@ -9,8 +9,12 @@
 #[Attribute(Attribute::TARGET_PROPERTY)]
 final readonly class MapFrom
 {
+    /** @var array<string> */
+    public array $names;
+
     public function __construct(
-        public string $name,
+        string ...$names,
     ) {
+        $this->names = $names;
     }
 }

src/Tempest/Mapper/src/Mappers/ArrayToObjectMapper.php

@@ -58,7 +58,7 @@ public function map(mixed $from, mixed $to): object
                 continue;
             }
 
-            $propertyName = $this->resolvePropertyName($property);
+            $propertyName = $this->resolvePropertyName($property, $from);
 
             if (! array_key_exists($propertyName, $from)) {
                 $isStrictProperty = $isStrictClass || $property->hasAttribute(Strict::class);
@@ -118,12 +118,15 @@ public function map(mixed $from, mixed $to): object
         return $object;
     }
 
-    private function resolvePropertyName(PropertyReflector $property): string
+    /**
+     * @param array<mixed> $from
+     */
+    private function resolvePropertyName(PropertyReflector $property, array $from): string
     {
         $mapFrom = $property->getAttribute(MapFrom::class);
 
         if ($mapFrom !== null) {
-            return $mapFrom->name;
+            return arr($from)->keys()->intersect($mapFrom->names)->first() ?? $property->getName();
         }
 
         return $property->getName();

src/Tempest/Mapper/src/ObjectFactory.php

@@ -28,7 +28,8 @@ final class ObjectFactory
     public function __construct(
         private readonly MapperConfig $config,
         private readonly Container $container,
-    ) {}
+    ) {
+    }
 
     /**
      * @template T of object

src/Tempest/Reflection/src/PropertyReflector.php

@@ -86,6 +86,11 @@ public function isPublic(): bool
         return $this->reflectionProperty->isPublic();
     }
 
+    public function isReadonly(): bool
+    {
+        return $this->reflectionProperty->isReadOnly();
+    }
+
     public function getIterableType(): ?TypeReflector
     {
         $doc = $this->reflectionProperty->getDocComment();

src/Tempest/Support/src/ArrayHelper.php

@@ -489,7 +489,7 @@ public function equals(array|self $other): bool
      *
      * @param null|Closure(TValue $value, TKey $key): bool $filter
      *
-     * @return TValue
+     * @return TValue|null
      */
     public function first(?Closure $filter = null): mixed
     {

tests/Integration/Mapper/Fixtures/ObjectWithMultipleMapFrom.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Integration\Mapper\Fixtures;
+
+use Tempest\Mapper\MapFrom;
+
+final class ObjectWithMultipleMapFrom
+{
+    public function __construct(
+        #[MapFrom('name', 'first_name')]
+        public readonly string $fullName,
+    ) {
+    }
+}

tests/Integration/Mapper/MapperTest.php

@@ -21,6 +21,7 @@
 use Tests\Tempest\Integration\Mapper\Fixtures\ObjectWithMapToAttribute;
 use Tests\Tempest\Integration\Mapper\Fixtures\ObjectWithMapToCollisions;
 use Tests\Tempest\Integration\Mapper\Fixtures\ObjectWithMapToCollisionsJsonSerializable;
+use Tests\Tempest\Integration\Mapper\Fixtures\ObjectWithMultipleMapFrom;
 use Tests\Tempest\Integration\Mapper\Fixtures\ObjectWithStrictOnClass;
 use Tests\Tempest\Integration\Mapper\Fixtures\ObjectWithStrictProperty;
 use Tests\Tempest\Integration\Mapper\Fixtures\Person;
@@ -258,4 +259,33 @@ enum: EnumToCast::FOO,
             ],
         );
     }
+
+    public function test_multiple_map_from_source(): void
+    {
+        $object = map(['name' => 'Guillaume'])->to(ObjectWithMultipleMapFrom::class);
+        $this->assertSame('Guillaume', $object->fullName);
+
+        $object = map(['first_name' => 'Guillaume'])->to(ObjectWithMultipleMapFrom::class);
+        $this->assertSame('Guillaume', $object->fullName);
+    }
+
+    public function test_multiple_map_from_take_first_occurence(): void
+    {
+        $data = [
+            'name' => 'Guillaume',
+            'first_name' => 'John',
+        ];
+
+        $object = map($data)->to(ObjectWithMultipleMapFrom::class);
+        $this->assertSame('Guillaume', $object->fullName);
+    }
+
+    public function test_multiple_map_from_fallback_to_property_name(): void
+    {
+        $object = map([
+            'fullName' => 'Guillaume',
+        ])->to(ObjectWithMapFromAttribute::class);
+
+        $this->assertSame('Guillaume', $object->fullName);
+    }
 }