feat(mapper): add MapFrom and MapTo attributes (#929)

Co-authored-by: brendt <[email protected]>

Author: gturpin-dev

src/Tempest/Mapper/src/Attributes/MapFrom.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Mapper\Attributes;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_PROPERTY)]
+final readonly class MapFrom
+{
+    public function __construct(
+        public string $name,
+    ) {
+    }
+}

src/Tempest/Mapper/src/Attributes/MapTo.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Mapper\Attributes;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_PROPERTY)]
+final readonly class MapTo
+{
+    public function __construct(
+        public string $name,
+    ) {
+    }
+}

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

@@ -4,6 +4,7 @@
 
 namespace Tempest\Mapper\Mappers;
 
+use Tempest\Mapper\Attributes\MapFrom;
 use Tempest\Mapper\Casters\ArrayCaster;
 use Tempest\Mapper\Casters\CasterFactory;
 use Tempest\Mapper\Exceptions\MissingValuesException;
@@ -57,7 +58,7 @@ public function map(mixed $from, mixed $to): object
                 continue;
             }
 
-            $propertyName = $property->getName();
+            $propertyName = $this->resolvePropertyName($property);
 
             if (! array_key_exists($propertyName, $from)) {
                 $isStrictProperty = $isStrictClass || $property->hasAttribute(Strict::class);
@@ -117,6 +118,17 @@ public function map(mixed $from, mixed $to): object
         return $object;
     }
 
+    private function resolvePropertyName(PropertyReflector $property): string
+    {
+        $mapFrom = $property->getAttribute(MapFrom::class);
+
+        if ($mapFrom !== null) {
+            return $mapFrom->name;
+        }
+
+        return $property->getName();
+    }
+
     private function resolveObject(mixed $objectOrClass): object
     {
         if (is_object($objectOrClass)) {

src/Tempest/Mapper/src/Mappers/ObjectToArrayMapper.php

@@ -5,8 +5,13 @@
 namespace Tempest\Mapper\Mappers;
 
 use JsonSerializable;
+use ReflectionException;
+use Tempest\Mapper\Attributes\MapTo as MapToAttribute;
 use Tempest\Mapper\Mapper;
 use Tempest\Mapper\MapTo;
+use Tempest\Reflection\ClassReflector;
+use Tempest\Reflection\PropertyReflector;
+use function Tempest\Support\arr;
 
 final readonly class ObjectToArrayMapper implements Mapper
 {
@@ -16,11 +21,54 @@ public function canMap(mixed $from, mixed $to): bool
     }
 
     public function map(mixed $from, mixed $to): array
+    {
+        $properties = $this->resolveProperties($from);
+        $mappedProperties = [];
+
+        foreach ($properties as $propertyName => $propertyValue) {
+            try {
+                $property = PropertyReflector::fromParts(class: $from, name: $propertyName);
+
+                $propertyName = $this->resolvePropertyName($property);
+
+                $mappedProperties[$propertyName] = $propertyValue;
+            } catch (ReflectionException) {
+                continue;
+            }
+        }
+
+        return $mappedProperties;
+    }
+
+    /**
+     * @return array<string, mixed> The properties name and value
+     */
+    private function resolveProperties(object $from): array
     {
         if ($from instanceof JsonSerializable) {
             return $from->jsonSerialize();
         }
 
-        return (array) $from;
+        try {
+            $class = new ClassReflector($from);
+            $properties = $class->getPublicProperties();
+
+            return arr(iterator_to_array($properties))
+                ->mapWithKeys(fn (PropertyReflector $property) => yield $property->getName() => $property->getValue($from))
+                ->toArray();
+        } catch (ReflectionException) {
+            return [];
+        }
+    }
+
+    private function resolvePropertyName(PropertyReflector $property): string
+    {
+        $mapTo = $property->getAttribute(MapToAttribute::class);
+
+        if ($mapTo !== null) {
+            return $mapTo->name;
+        }
+
+        return $property->getName();
     }
 }

src/Tempest/Reflection/src/PropertyReflector.php

@@ -71,6 +71,21 @@ public function isNullable(): bool
         return $this->getType()->isNullable();
     }
 
+    public function isPrivate(): bool
+    {
+        return $this->reflectionProperty->isPrivate();
+    }
+
+    public function isProtected(): bool
+    {
+        return $this->reflectionProperty->isProtected();
+    }
+
+    public function isPublic(): bool
+    {
+        return $this->reflectionProperty->isPublic();
+    }
+
     public function getIterableType(): ?TypeReflector
     {
         $doc = $this->reflectionProperty->getDocComment();

tests/Integration/Mapper/Fixtures/ObjectWithMapFromAttribute.php

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

tests/Integration/Mapper/Fixtures/ObjectWithMapToAttribute.php

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

tests/Integration/Mapper/Fixtures/ObjectWithMapToCollisions.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Integration\Mapper\Fixtures;
+
+use Tempest\Mapper\Attributes\MapTo;
+
+final class ObjectWithMapToCollisions
+{
+    public function __construct(
+        #[MapTo('name')]
+        public readonly string $first_name,
+        #[MapTo('full_name')]
+        public readonly string $name,
+        public readonly string $last_name,
+    ) {
+    }
+}

tests/Integration/Mapper/Fixtures/ObjectWithMapToCollisionsJsonSerializable.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Integration\Mapper\Fixtures;
+
+use JsonSerializable;
+use Tempest\Mapper\Attributes\MapTo;
+
+final class ObjectWithMapToCollisionsJsonSerializable implements JsonSerializable
+{
+    public function __construct(
+        #[MapTo('name')]
+        public readonly string $first_name,
+        #[MapTo('full_name')]
+        public readonly string $name,
+        public readonly string $last_name,
+    ) {
+    }
+
+    public function jsonSerialize(): mixed
+    {
+        return [
+            'first_name' => $this->first_name,
+            'name' => $this->name,
+        ];
+    }
+}

tests/Integration/Mapper/Fixtures/ObjectWithMappedVariousPropertyScope.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Integration\Mapper\Fixtures;
+
+use Tempest\Mapper\Attributes\MapTo;
+
+final class ObjectWithMappedVariousPropertyScope
+{
+    public function __construct(
+        #[MapTo('private')] // @phpstan-ignore-line property.onlyWritten
+        private string $privateProp,
+        #[MapTo('protected')]
+        protected string $protectedProp,
+        #[MapTo('public')]
+        public string $publicProp,
+    ) {
+    }
+}