From 614fc78a4666decf2e8852793893f60da3f96bf5 Mon Sep 17 00:00:00 2001
From: Robertbaelde <robert_baelde@hotmail.com>
Date: Fri, 1 Mar 2024 15:21:47 +0100
Subject: [PATCH] Allow casters to provide null values

---
 .../ClassWithDefaultValueProvidingCaster.php     | 14 ++++++++++++++
 src/Fixtures/DefaultValueProvidingCaster.php     | 16 ++++++++++++++++
 src/ObjectHydrationTestCase.php                  | 12 ++++++++++++
 src/ObjectMapperCodeGenerator.php                | 14 +++++++-------
 src/ObjectMapperUsingReflection.php              | 13 -------------
 src/PropertyCasters/CastToDateTimeImmutable.php  |  4 ++++
 6 files changed, 53 insertions(+), 20 deletions(-)
 create mode 100644 src/Fixtures/ClassWithDefaultValueProvidingCaster.php
 create mode 100644 src/Fixtures/DefaultValueProvidingCaster.php

diff --git a/src/Fixtures/ClassWithDefaultValueProvidingCaster.php b/src/Fixtures/ClassWithDefaultValueProvidingCaster.php
new file mode 100644
index 0000000..e3e4cc5
--- /dev/null
+++ b/src/Fixtures/ClassWithDefaultValueProvidingCaster.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace EventSauce\ObjectHydrator\Fixtures;
+
+class ClassWithDefaultValueProvidingCaster
+{
+    public function __construct(
+        #[DefaultValueProvidingCaster]
+        public string $valueProvidedFromCaster,
+    ) {
+    }
+}
diff --git a/src/Fixtures/DefaultValueProvidingCaster.php b/src/Fixtures/DefaultValueProvidingCaster.php
new file mode 100644
index 0000000..a1d5eb8
--- /dev/null
+++ b/src/Fixtures/DefaultValueProvidingCaster.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace EventSauce\ObjectHydrator\Fixtures;
+
+use Attribute;
+use EventSauce\ObjectHydrator\ObjectMapper;
+use EventSauce\ObjectHydrator\PropertyCaster;
+
+#[Attribute(Attribute::TARGET_PARAMETER)]
+final class DefaultValueProvidingCaster implements PropertyCaster
+{
+    public function cast(mixed $value, ObjectMapper $hydrator): mixed
+    {
+        return 'some_default_value';
+    }
+}
diff --git a/src/ObjectHydrationTestCase.php b/src/ObjectHydrationTestCase.php
index d8ba916..5be2c49 100644
--- a/src/ObjectHydrationTestCase.php
+++ b/src/ObjectHydrationTestCase.php
@@ -15,6 +15,7 @@
 use EventSauce\ObjectHydrator\Fixtures\ClassThatUsesMutipleCastersWithoutOptions;
 use EventSauce\ObjectHydrator\Fixtures\ClassWithCamelCaseProperty;
 use EventSauce\ObjectHydrator\Fixtures\ClassWithComplexTypeThatIsMapped;
+use EventSauce\ObjectHydrator\Fixtures\ClassWithDefaultValueProvidingCaster;
 use EventSauce\ObjectHydrator\Fixtures\ClassWithDocblockAndArrayFollowingScalar;
 use EventSauce\ObjectHydrator\Fixtures\ClassWithDefaultValue;
 use EventSauce\ObjectHydrator\Fixtures\ClassWithDocblockArrayVariants;
@@ -466,6 +467,17 @@ public function hydrating_a_class_with_a_nullable_property_defaults_to_null(): v
         self::assertNull($object->defaultsToNull);
     }
 
+    /** @test */
+    public function hydrating_a_class_with_a_default_value_providing_caster(): void
+    {
+        $hydrator = $this->createObjectHydrator();
+
+        $object = $hydrator->hydrateObject(ClassWithDefaultValueProvidingCaster::class, []);
+
+        self::assertInstanceOf(ClassWithDefaultValueProvidingCaster::class, $object);
+        self::assertEquals('some_default_value', $object->valueProvidedFromCaster);
+    }
+
     /**
      * @test
      */
diff --git a/src/ObjectMapperCodeGenerator.php b/src/ObjectMapperCodeGenerator.php
index cab9471..3824222 100644
--- a/src/ObjectMapperCodeGenerator.php
+++ b/src/ObjectMapperCodeGenerator.php
@@ -245,11 +245,6 @@ private function dumpClassHydrator(string $className, ClassHydrationDefinition $
                 $body .= <<<CODE
 
             \$value = \$payload['$from'] ?? null;
-
-            if (\$value === null) {
-$isNullBody
-            }
-
 CODE;
             } else {
                 $collectKeys = '';
@@ -295,15 +290,20 @@ private function dumpClassHydrator(string $className, ClassHydrationDefinition $
             }
 
             \$value = \${$casterName}->cast(\$value, \$this);
+CODE;
+                }
+            }
 
+            if(isset($isNullBody)){
+                $body .= <<<CODE
             if (\$value === null) {
                 $isNullBody
             }
-
 CODE;
-                }
             }
 
+
+
             if ($definition->isBackedEnum()) {
                 $body .= <<<CODE
 
diff --git a/src/ObjectMapperUsingReflection.php b/src/ObjectMapperUsingReflection.php
index a9d09fd..dfa32af 100644
--- a/src/ObjectMapperUsingReflection.php
+++ b/src/ObjectMapperUsingReflection.php
@@ -98,18 +98,6 @@ public function hydrateObject(string $className, array $payload): object
                 $property = $definition->accessorName;
                 $value = $this->extractPayloadViaMap($payload, $keys);
 
-                // same code as two sections below
-                if ($value === null) {
-                    if ($definition->hasDefaultValue) {
-                        continue;
-                    } elseif ($definition->nullable) {
-                        $properties[$property] = null;
-                    } else {
-                        $missingFields[] = implode('.', end($keys));
-                    }
-                    continue;
-                }
-
                 foreach ($definition->casters as [$caster, $options]) {
                     $key = $className . '-' . $caster . '-' . json_encode($options);
                     /** @var PropertyCaster $propertyCaster */
@@ -117,7 +105,6 @@ public function hydrateObject(string $className, array $payload): object
                     $value = $propertyCaster->cast($value, $this);
                 }
 
-                // same code as two sections above
                 if ($value === null) {
                     if ($definition->hasDefaultValue) {
                         continue;
diff --git a/src/PropertyCasters/CastToDateTimeImmutable.php b/src/PropertyCasters/CastToDateTimeImmutable.php
index ce508e5..dcb6db1 100644
--- a/src/PropertyCasters/CastToDateTimeImmutable.php
+++ b/src/PropertyCasters/CastToDateTimeImmutable.php
@@ -23,6 +23,10 @@ public function __construct(private ?string $format = null, private ?string $tim
 
     public function cast(mixed $value, ObjectMapper $hydrator): mixed
     {
+        if($value === null){
+            return null;
+        }
+
         $timeZone = $this->timeZone ? new DateTimeZone($this->timeZone) : $this->timeZone;
 
         if ($this->format !== null) {