refactor(mapper): split caster and serializer into two (#1041)

Author: brendt

src/Tempest/Database/src/Builder/FieldName.php

@@ -6,9 +6,11 @@
 
 use Stringable;
 use Tempest\Database\DatabaseModel;
-use Tempest\Mapper\Casters\CasterFactory;
+use Tempest\Mapper\CasterFactory;
 use Tempest\Reflection\ClassReflector;
 
+use function Tempest\get;
+
 final class FieldName implements Stringable
 {
     public function __construct(
@@ -21,7 +23,7 @@ public function __construct(
     /** @return \Tempest\Database\Builder\FieldName[] */
     public static function make(ClassReflector $class, ?TableName $tableName = null): array
     {
-        $casterFactory = new CasterFactory();
+        $casterFactory = get(CasterFactory::class);
         $fieldNames = [];
         $tableName ??= $class->callStatic('table');
 

src/Tempest/Database/src/Mappers/ModelToQueryMapper.php

@@ -6,16 +6,16 @@
 
 use Tempest\Database\DatabaseModel;
 use Tempest\Database\Query;
-use Tempest\Mapper\Casters\CasterFactory;
 use Tempest\Mapper\Mapper;
+use Tempest\Mapper\SerializerFactory;
 use Tempest\Reflection\ClassReflector;
 
 use function Tempest\map;
 
 final readonly class ModelToQueryMapper implements Mapper
 {
     public function __construct(
-        private CasterFactory $casterFactory,
+        private SerializerFactory $serializerFactory,
     ) {
     }
 
@@ -138,9 +138,9 @@ private function fields(DatabaseModel $model): array
 
             $value = $property->getValue($model);
 
-            // Check if caster is available for value serialization
-            if ($value !== null && ($caster = $this->casterFactory->forProperty($property))) {
-                $value = $caster->serialize($value);
+            // Check if serializer is available for value serialization
+            if ($value !== null && ($serializer = $this->serializerFactory->forProperty($property))) {
+                $value = $serializer->serialize($value);
             }
 
             $fields[$property->getName()] = $value;

src/Tempest/Database/src/Mappers/QueryToModelMapper.php

@@ -6,7 +6,7 @@
 
 use Tempest\Database\DatabaseModel;
 use Tempest\Database\Query;
-use Tempest\Mapper\Casters\CasterFactory;
+use Tempest\Mapper\CasterFactory;
 use Tempest\Mapper\Mapper;
 use Tempest\Reflection\ClassReflector;
 use Tempest\Reflection\PropertyReflector;

src/Tempest/Mapper/src/Caster.php

@@ -7,6 +7,4 @@
 interface Caster
 {
     public function cast(mixed $input): mixed;
-
-    public function serialize(mixed $input): array|string;
 }

src/Tempest/Mapper/src/CasterFactory.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Mapper;
+
+use Closure;
+use Tempest\Reflection\PropertyReflector;
+
+use function Tempest\get;
+
+final class CasterFactory
+{
+    /**
+     * @var array{string|Closure, class-string<\Tempest\Mapper\Caster>|Closure}[]
+     */
+    private array $casters = [];
+
+    /**
+     * @param class-string<\Tempest\Mapper\Caster> $casterClass
+     */
+    public function addCaster(string|Closure $for, string|Closure $casterClass): self
+    {
+        $this->casters = [[$for, $casterClass], ...$this->casters];
+
+        return $this;
+    }
+
+    public function forProperty(PropertyReflector $property): ?Caster
+    {
+        $type = $property->getType();
+
+        // Get CastWith from the property
+        $castWith = $property->getAttribute(CastWith::class);
+
+        // Get CastWith from the property's type if there's no property-defined CastWith
+        if ($castWith === null && $type->isClass()) {
+            $castWith = $type->asClass()->getAttribute(CastWith::class, recursive: true);
+        }
+
+        // Return the caster if defined with CastWith
+        if ($castWith !== null) {
+            // Resolve the caster from the container
+            return get($castWith->className);
+        }
+
+        // Resolve caster from manual additions
+        foreach ($this->casters as [$for, $casterClass]) {
+            if (is_callable($for) && $for($property) || is_string($for) && $type->matches($for) || $type->getName() === $for) {
+                return is_callable($casterClass)
+                    ? $casterClass($property)
+                    : get($casterClass);
+            }
+        }
+
+        return null;
+    }
+}

src/Tempest/Mapper/src/CasterFactoryInitializer.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Tempest\Mapper;
+
+use BackedEnum;
+use DateTime;
+use DateTimeImmutable;
+use DateTimeInterface;
+use Tempest\Container\Container;
+use Tempest\Container\Initializer;
+use Tempest\Container\Singleton;
+use Tempest\Mapper\Casters\ArrayToObjectCollectionCaster;
+use Tempest\Mapper\Casters\DateTimeCaster;
+use Tempest\Mapper\Casters\EnumCaster;
+use Tempest\Mapper\Casters\JsonToArrayCaster;
+use Tempest\Mapper\Casters\ObjectCaster;
+use Tempest\Reflection\PropertyReflector;
+
+final class CasterFactoryInitializer implements Initializer
+{
+    #[Singleton]
+    public function initialize(Container $container): CasterFactory
+    {
+        return new CasterFactory()
+            ->addCaster('array', JsonToArrayCaster::class)
+            ->addCaster(fn (PropertyReflector $property) => $property->getIterableType() !== null, fn (PropertyReflector $property) => new ArrayToObjectCollectionCaster($property))
+            ->addCaster(fn (PropertyReflector $property) => $property->getType()->isClass(), fn (PropertyReflector $property) => new ObjectCaster($property->getType()))
+            ->addCaster(BackedEnum::class, fn (PropertyReflector $property) => new EnumCaster($property->getType()->getName()))
+            ->addCaster(DateTimeImmutable::class, DateTimeCaster::fromProperty(...))
+            ->addCaster(DateTime::class, DateTimeCaster::fromProperty(...))
+            ->addCaster(DateTimeInterface::class, DateTimeCaster::fromProperty(...));
+    }
+}

src/Tempest/Mapper/src/Casters/ArrayJsonCaster.php

@@ -10,7 +10,7 @@
 
 use function Tempest\map;
 
-final readonly class ArrayObjectCaster implements Caster
+final readonly class ArrayToObjectCollectionCaster implements Caster
 {
     public function __construct(
         private PropertyReflector $property,
@@ -29,15 +29,4 @@ public function cast(mixed $input): mixed
 
         return $values;
     }
-
-    public function serialize(mixed $input): array
-    {
-        $values = [];
-
-        foreach ($input as $key => $item) {
-            $values[$key] = map($item)->with(ObjectToArrayMapper::class)->do();
-        }
-
-        return $values;
-    }
 }

…Mapper/src/Casters/ArrayObjectCaster.php …asters/ArrayToObjectCollectionCaster.phpsrc/Tempest/Mapper/src/Casters/ArrayObjectCaster.php renamed to src/Tempest/Mapper/src/Casters/ArrayToObjectCollectionCaster.php src/Tempest/Mapper/src/Casters/ArrayObjectCaster.php renamed to src/Tempest/Mapper/src/Casters/ArrayToObjectCollectionCaster.php

@@ -5,21 +5,11 @@
 namespace Tempest\Mapper\Casters;
 
 use Tempest\Mapper\Caster;
-use Tempest\Mapper\Exceptions\CannotSerializeValue;
 
 final readonly class BooleanCaster implements Caster
 {
     public function cast(mixed $input): bool
     {
         return boolval($input);
     }
-
-    public function serialize(mixed $input): string
-    {
-        if (! is_bool($input)) {
-            throw new CannotSerializeValue('boolean');
-        }
-
-        return $input ? 'true' : 'false';
-    }
 }