feat(mapper): support unions

Author: aazsamir

packages/mapper/src/CasterFactory.php

@@ -7,6 +7,7 @@
 use Closure;
 use Tempest\Mapper\Casters\DtoCaster;
 use Tempest\Reflection\PropertyReflector;
+use Tempest\Reflection\TypeReflector;
 
 use function Tempest\get;
 
@@ -64,4 +65,15 @@ public function forProperty(PropertyReflector $property): ?Caster
 
         return null;
     }
+
+    public function forType(TypeReflector $type): ?Caster
+    {
+        foreach ($this->casters as [$for, $casterClass]) {
+            if (is_string($for) && $type->matches($for) && ! \is_callable($for)) {
+                return get($casterClass);
+            }
+        }
+
+        return null;
+    }
 }

packages/mapper/src/CasterFactoryInitializer.php

@@ -21,6 +21,8 @@
 use Tempest\Mapper\Casters\JsonToArrayCaster;
 use Tempest\Mapper\Casters\NativeDateTimeCaster;
 use Tempest\Mapper\Casters\ObjectCaster;
+use Tempest\Mapper\Casters\StringCaster;
+use Tempest\Mapper\Casters\UnionCaster;
 use Tempest\Reflection\PropertyReflector;
 use UnitEnum;
 
@@ -29,21 +31,30 @@ final class CasterFactoryInitializer implements Initializer
     #[Singleton]
     public function initialize(Container $container): CasterFactory
     {
-        return new CasterFactory()
+        $casterFactory = new CasterFactory();
+
+        $casterFactory
             ->addCaster('array', JsonToArrayCaster::class)
             ->addCaster('bool', BooleanCaster::class)
             ->addCaster('boolean', BooleanCaster::class)
             ->addCaster('int', IntegerCaster::class)
             ->addCaster('integer', IntegerCaster::class)
             ->addCaster('float', FloatCaster::class)
             ->addCaster('double', FloatCaster::class)
-            ->addCaster(fn (PropertyReflector $property) => $property->getIterableType() !== null, fn (PropertyReflector $property) => new ArrayToObjectCollectionCaster($property))
+            ->addCaster('string', StringCaster::class)
+            ->addCaster(
+                fn (PropertyReflector $property) => $property->getIterableType() !== null,
+                fn (PropertyReflector $property) => new ArrayToObjectCollectionCaster($property, $casterFactory),
+            )
             ->addCaster(fn (PropertyReflector $property) => $property->getType()->isClass(), fn (PropertyReflector $property) => new ObjectCaster($property->getType()))
+            ->addCaster(fn (PropertyReflector $property) => $property->getType()->isUnion(), fn (PropertyReflector $property) => new UnionCaster($property))
             ->addCaster(UnitEnum::class, fn (PropertyReflector $property) => new EnumCaster($property->getType()->getName()))
             ->addCaster(DateTimeInterface::class, DateTimeCaster::fromProperty(...))
             ->addCaster(NativeDateTimeImmutable::class, NativeDateTimeCaster::fromProperty(...))
             ->addCaster(NativeDateTime::class, NativeDateTimeCaster::fromProperty(...))
             ->addCaster(NativeDateTimeInterface::class, NativeDateTimeCaster::fromProperty(...))
             ->addCaster(DateTime::class, DateTimeCaster::fromProperty(...));
+
+        return $casterFactory;
     }
 }

packages/mapper/src/Casters/ArrayToObjectCollectionCaster.php

@@ -5,23 +5,27 @@
 namespace Tempest\Mapper\Casters;
 
 use Tempest\Mapper\Caster;
+use Tempest\Mapper\CasterFactory;
 use Tempest\Reflection\PropertyReflector;
 use Tempest\Support\Json;
 
 final readonly class ArrayToObjectCollectionCaster implements Caster
 {
     public function __construct(
         private PropertyReflector $property,
+        private CasterFactory $casterFactory,
     ) {}
 
     public function cast(mixed $input): mixed
     {
         $values = [];
         $iterableType = $this->property->getIterableType();
 
-        $caster = $iterableType->isEnum()
-            ? new EnumCaster($iterableType->getName())
-            : new ObjectCaster($iterableType);
+        $caster = match (true) {
+            $iterableType->isEnum() => new EnumCaster($iterableType->getName()),
+            $iterableType->isBuiltIn() => $this->casterFactory->forType($iterableType),
+            default => new ObjectCaster($iterableType),
+        };
 
         if (Json\is_valid($input)) {
             $input = Json\decode($input);

packages/mapper/src/Casters/StringCaster.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Mapper\Casters;
+
+use Tempest\Mapper\Caster;
+
+class StringCaster implements Caster
+{
+    public function cast(mixed $input): string
+    {
+        return (string) $input;
+    }
+}

packages/mapper/src/Casters/UnionCaster.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Mapper\Casters;
+
+use Tempest\Mapper\Caster;
+use Tempest\Reflection\PropertyReflector;
+
+use function Tempest\map;
+
+class UnionCaster implements Caster
+{
+    public function __construct(
+        private PropertyReflector $property,
+    ) {}
+
+    public function cast(mixed $input): mixed
+    {
+        $propertyType = $this->property->getDocType() ?? $this->property->getType();
+
+        // for native types that already match, return early
+        foreach ($propertyType->split() as $type) {
+            if ($type->accepts($input)) {
+                return $input;
+            }
+        }
+
+        $lastException = null;
+
+        // as last resort, try to map to any of the union types
+        foreach ($propertyType->split() as $type) {
+            try {
+                return map($input)->to($type->getName());
+            } catch (\Throwable $e) {
+                $lastException = $e;
+            }
+        }
+
+        throw $lastException;
+    }
+}

packages/reflection/src/PropertyReflector.php

@@ -107,6 +107,23 @@ public function getIterableType(): ?TypeReflector
         return new TypeReflector(ltrim($match[1], '\\'));
     }
 
+    public function getDocType(): ?TypeReflector
+    {
+        $doc = $this->reflectionProperty->getDocComment();
+
+        if (! $doc) {
+            return null;
+        }
+
+        preg_match('/@var ([^\s]+)/', $doc, $match);
+
+        if (! isset($match[1])) {
+            return null;
+        }
+
+        return new TypeReflector($match[1]);
+    }
+
     public function isUninitialized(object $object): bool
     {
         return ! $this->reflectionProperty->isInitialized($object);

packages/reflection/src/TypeReflector.php

@@ -110,19 +110,41 @@ public function accepts(mixed $input): bool
             return is_iterable($input);
         }
 
-        if (str_contains($this->definition, '|')) {
+        if ($this->isUnion()) {
             return array_any($this->split(), static fn ($type) => $type->accepts($input));
         }
 
         if (str_contains($this->definition, '&')) {
             return array_all($this->split(), static fn ($type) => $type->accepts($input));
         }
 
+        // non-native array types, e.g. string[] or Type[]
+        if (\str_contains($this->definition, '[]')) {
+            if (! \is_iterable($input)) {
+                return false;
+            }
+
+            $typeName = str_replace('[]', '', $this->definition);
+            $itemType = new self($typeName);
+
+            foreach ($input as $item) {
+                if (! $itemType->accepts($item)) {
+                    return false;
+                }
+            }
+
+            return true;
+        }
+
         return false;
     }
 
     public function matches(string $className): bool
     {
+        if ($this->isBuiltIn()) {
+            return $this->cleanDefinition === $className;
+        }
+
         return is_a($this->cleanDefinition, $className, true);
     }
 
@@ -168,6 +190,11 @@ public function isBackedEnum(): bool
         return $this->matches(BackedEnum::class);
     }
 
+    public function isUnion(): bool
+    {
+        return str_contains($this->definition, '|');
+    }
+
     // TODO: should be refactored outside of the reflector component
     public function isRelation(): bool
     {

packages/reflection/tests/Fixtures/ClassWithIterableProperty.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Reflection\Tests\Fixtures;
+
+class ClassWithIterableProperty
+{
+    /**
+     * @var string[]
+     */
+    public array $items;
+}

packages/reflection/tests/Fixtures/ClassWithUnionOfStringAndArray.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Reflection\Tests\Fixtures;
+
+class ClassWithUnionOfStringAndArray
+{
+    /**
+     * @var string|string[]|null
+     */
+    public string|array|null $items;
+}

packages/reflection/tests/PropertyReflectorTest.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Tempest\Reflection\Tests;
+
+use PHPUnit\Framework\TestCase;
+use Tempest\Reflection\ClassReflector;
+use Tempest\Reflection\Tests\Fixtures\ClassWithIterableProperty;
+use Tempest\Reflection\Tests\Fixtures\ClassWithUnionOfStringAndArray;
+
+final class PropertyReflectorTest extends TestCase
+{
+    public function test_get_iterable_type(): void
+    {
+        $reflector = new ClassReflector(ClassWithIterableProperty::class)->getProperty('items');
+
+        $iterableType = $reflector->getIterableType();
+
+        $this->assertEquals('string', $iterableType->getName());
+    }
+
+    public function test_get_union_of_string_and_array(): void
+    {
+        $reflector = new ClassReflector(ClassWithUnionOfStringAndArray::class)->getProperty('items');
+
+        $unionType = $reflector->getDocType();
+
+        $this->assertTrue($unionType->isUnion());
+        $this->assertCount(3, $unionType->split());
+        $this->assertTrue($unionType->accepts('a'));
+        $this->assertTrue($unionType->accepts(['a', 'b', 'c']));
+        $this->assertTrue($unionType->accepts([]));
+        $this->assertTrue($unionType->accepts(null));
+
+        $this->assertFalse($unionType->accepts(123));
+        $this->assertFalse($unionType->accepts([123]));
+        $this->assertFalse($unionType->accepts([null]));
+    }
+}