Cast using expected type

README.md

@@ -401,7 +401,7 @@ class CastToMoney implements PropertyCaster
         private string $currency
     ) {}
 
-    public function cast(mixed $value, ObjectMapper $mapper) : mixed
+    public function cast(mixed $value, ObjectMapper $mapper, ?string $expectedTypeName) : mixed
     {
         return new Money($value, Currency::fromString($this->currency));
     }
@@ -416,7 +416,7 @@ class CastUnionToType implements PropertyCaster
         private array $typeToClassMap
     ) {}
 
-    public function cast(mixed $value, ObjectMapper $mapper) : mixed
+    public function cast(mixed $value, ObjectMapper $mapper, ?string $expectedTypeName) : mixed
     {
         assert(is_array($value));
 

src/Fixtures/CastEmptyStringToNull.php

@@ -9,7 +9,7 @@
 #[Attribute(Attribute::TARGET_PROPERTY)]
 final class CastEmptyStringToNull implements PropertyCaster
 {
-    public function cast(mixed $value, ObjectMapper $hydrator): mixed
+    public function cast(mixed $value, ObjectMapper $hydrator, ?string $expectedTypeName): mixed
     {
         if ($value === '') {
             return null;

src/Fixtures/CastToClassWithStaticConstructor.php

@@ -11,7 +11,7 @@
 #[Attribute(Attribute::TARGET_PARAMETER)]
 final class CastToClassWithStaticConstructor implements PropertyCaster
 {
-    public function cast(mixed $value, ObjectMapper $hydrator): mixed
+    public function cast(mixed $value, ObjectMapper $hydrator, ?string $expectedTypeName): mixed
     {
         return $hydrator->hydrateObject(ClassWithStaticConstructor::class, ['name' => $value]);
     }

src/Fixtures/CastToExpectedType/AuthorId.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace EventSauce\ObjectHydrator\Fixtures\CastToExpectedType;
+
+final class AuthorId
+{
+    public function __construct(
+        private string $id
+    ) {}
+    public static function fromString(string $id): static
+    {
+        return new static($id);
+    }
+
+    public function toString(): string
+    {
+        return $this->id;
+    }
+}

src/Fixtures/CastToExpectedType/BlogId.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace EventSauce\ObjectHydrator\Fixtures\CastToExpectedType;
+
+final class BlogId
+{
+    public function __construct(
+        private string $id
+    ) {}
+    public static function fromString(string $id): static
+    {
+        return new static($id);
+    }
+
+    public function toString(): string
+    {
+        return $this->id;
+    }
+}

src/Fixtures/CastToExpectedType/ClassWithIds.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace EventSauce\ObjectHydrator\Fixtures\CastToExpectedType;
+
+final class ClassWithIds
+{
+    public function __construct(
+        #[IdCaster]
+        public AuthorId $authorId,
+        #[IdCaster]
+        public BlogId $blogId,
+    )
+    {
+    }
+}

src/Fixtures/CastToExpectedType/IdCaster.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace EventSauce\ObjectHydrator\Fixtures\CastToExpectedType;
+
+use Attribute;
+use EventSauce\ObjectHydrator\ObjectMapper;
+use EventSauce\ObjectHydrator\PropertyCaster;
+
+#[Attribute(Attribute::TARGET_PROPERTY)]
+final class IdCaster implements PropertyCaster
+{
+    public function cast(mixed $value, ObjectMapper $hydrator, ?string $expectedTypeName): mixed
+    {
+        if ($expectedTypeName === null) {
+            throw new \RuntimeException('Expected type name is required');
+        }
+        return $expectedTypeName::fromString($value);
+    }
+}

src/Fixtures/CastToLowerCase.php

@@ -12,7 +12,7 @@
 #[Attribute(Attribute::TARGET_PARAMETER)]
 final class CastToLowerCase implements PropertyCaster
 {
-    public function cast(mixed $value, ObjectMapper $hydrator): mixed
+    public function cast(mixed $value, ObjectMapper $hydrator, ?string $expectedTypeName): mixed
     {
         return strtolower((string) $value);
     }

src/ObjectHydrationTestCase.php

@@ -6,6 +6,9 @@
 
 use EventSauce\ObjectHydrator\Fixtures\CastersOnClasses\ClassWithClassLevelMapFrom;
 use EventSauce\ObjectHydrator\Fixtures\CastersOnClasses\ClassWithClassLevelMapFromMultiple;
+use EventSauce\ObjectHydrator\Fixtures\CastToExpectedType\AuthorId;
+use EventSauce\ObjectHydrator\Fixtures\CastToExpectedType\BlogId;
+use EventSauce\ObjectHydrator\Fixtures\CastToExpectedType\ClassWithIds;
 use EventSauce\ObjectHydrator\Fixtures\ClassThatCastsListsToDifferentTypes;
 use EventSauce\ObjectHydrator\Fixtures\ClassThatContainsAnotherClass;
 use EventSauce\ObjectHydrator\Fixtures\ClassThatHasMultipleCastersOnSingleProperty;
@@ -623,6 +626,23 @@ public function hydrating_a_class_with_valid_docblock_array_following_scalar():
         self::assertInstanceOf(ClassWithDocblockAndArrayFollowingScalar::class, $object);
     }
 
+    /**
+     * @test
+     */
+    public function hydrating_a_class_casting_expected_types(): void {
+        $hydrator = $this->createObjectHydrator();
+        $payload = [
+            'authorId' => 'a',
+            'blogId' => 'b',
+        ];
+
+        $object = $hydrator->hydrateObject(ClassWithIds::class, $payload);
+
+        self::assertInstanceOf(ClassWithIds::class, $object);
+        self::assertInstanceOf(AuthorId::class, $object->authorId);
+        self::assertInstanceOf(BlogId::class, $object->blogId);
+    }
+
     /**
      * @test
      * @see https://github.com/EventSaucePHP/ObjectHydrator/issues/56

src/ObjectMapperCodeGenerator.php

@@ -294,7 +294,7 @@ private function dumpClassHydrator(string $className, ClassHydrationDefinition $
                 \$$casterName = new \\$caster(...$casterOptions);
             }
 
-            \$value = \${$casterName}->cast(\$value, \$this);
+            \$value = \${$casterName}->cast(\$value, \$this, '$definition->firstTypeName');
 
             if (\$value === null) {
                 $isNullBody

src/ObjectMapperUsingReflection.php

@@ -110,11 +110,13 @@ public function hydrateObject(string $className, array $payload): object
                     continue;
                 }
 
+                $typeName = $definition->firstTypeName;
+
                 foreach ($definition->casters as [$caster, $options]) {
                     $key = $className . '-' . $caster . '-' . json_encode($options);
                     /** @var PropertyCaster $propertyCaster */
                     $propertyCaster = $this->casterInstances[$key] ??= new $caster(...$options);
-                    $value = $propertyCaster->cast($value, $this);
+                    $value = $propertyCaster->cast($value, $this, $typeName);
                 }
 
                 // same code as two sections above
@@ -133,7 +135,7 @@ public function hydrateObject(string $className, array $payload): object
                     $value = $this->hydrateViaTypeMap($definition, $value);
                 }
 
-                $typeName = $definition->firstTypeName;
+
 
                 if ($definition->isBackedEnum()) {
                     $value = $typeName::from($value);

src/ObjectSerializationTestCase.php

@@ -8,6 +8,7 @@
 use DateTimeImmutable;
 use EventSauce\ObjectHydrator\Fixtures\CastersOnClasses\ClassWithClassLevelMapFrom;
 use EventSauce\ObjectHydrator\Fixtures\CastersOnClasses\ClassWithClassLevelMapFromMultiple;
+use EventSauce\ObjectHydrator\Fixtures\CastToExpectedType\ClassWithIds;
 use EventSauce\ObjectHydrator\Fixtures\ClassReferencedByUnionOne;
 use EventSauce\ObjectHydrator\Fixtures\ClassReferencedByUnionTwo;
 use EventSauce\ObjectHydrator\Fixtures\ClassThatOmitsPublicMethods;

src/PropertyCaster.php

@@ -6,5 +6,5 @@
 
 interface PropertyCaster
 {
-    public function cast(mixed $value, ObjectMapper $hydrator): mixed;
+    public function cast(mixed $value, ObjectMapper $hydrator, ?string $expectedTypeName): mixed;
 }

src/PropertyCasters/CastListToType.php

@@ -31,7 +31,7 @@ public function __construct(
         $this->isEnum = enum_exists($this->propertyType);
     }
 
-    public function cast(mixed $value, ObjectMapper $hydrator): mixed
+    public function cast(mixed $value, ObjectMapper $hydrator, ?string $expectedTypeName): mixed
     {
         assert(is_array($value), 'value is expected to be an array');
 

src/PropertyCasters/CastToArrayWithKey.php

@@ -17,7 +17,7 @@ public function __construct(private string $key)
     {
     }
 
-    public function cast(mixed $value, ObjectMapper $hydrator): mixed
+    public function cast(mixed $value, ObjectMapper $hydrator, ?string $expectedTypeName): mixed
     {
         return [$this->key => $value];
     }

src/PropertyCasters/CastToDateTimeImmutable.php

@@ -21,7 +21,7 @@ public function __construct(private ?string $format = null, private ?string $tim
     {
     }
 
-    public function cast(mixed $value, ObjectMapper $hydrator): mixed
+    public function cast(mixed $value, ObjectMapper $hydrator, ?string $expectedTypeName): mixed
     {
         $timeZone = $this->timeZone ? new DateTimeZone($this->timeZone) : $this->timeZone;
 

src/PropertyCasters/CastToType.php

@@ -19,7 +19,7 @@ public function __construct(
     ) {
     }
 
-    public function cast(mixed $value, ObjectMapper $hydrator): mixed
+    public function cast(mixed $value, ObjectMapper $hydrator, ?string $expectedTypeName): mixed
     {
         settype($value, $this->propertyType);
 

src/PropertyCasters/CastToUuid.php

@@ -20,7 +20,7 @@ public function __construct(private string $type = 'string')
     {
     }
 
-    public function cast(mixed $value, ObjectMapper $hydrator): UuidInterface
+    public function cast(mixed $value, ObjectMapper $hydrator, ?string $expectedTypeName): UuidInterface
     {
         $value = (string) $value;