Handling case when a class typed property receives a null value

Author: emulgeator

src/Mapper.php

@@ -66,7 +66,15 @@ public function map(array $input, string $className)
                             $property->setValue($object, $value);
                         }
                     } else {
-                        $property->setValue($object, $this->castCustom($value, $type->getName()));
+                        if (
+                            $value === null
+                            && empty($this->getCustomMapper($type->getName()))
+                        ) {
+                            $property->setValue($object, null);
+                        }
+                        else {
+                            $property->setValue($object, $this->castCustom($value, $type->getName()));
+                        }
                     }
                 } else {
                     if (empty($docBlockType)) {

test/Unit/MapperTest.php

@@ -8,6 +8,7 @@
 use Emul\ArrayToClassMapper\DocBlock\DocBlockParser;
 use Emul\ArrayToClassMapper\DocBlock\Entity\DocBlockType;
 use Emul\ArrayToClassMapper\Test\Unit\Stub\ClassDocBlockTypedArrayStub;
+use Emul\ArrayToClassMapper\Test\Unit\Stub\ClassTypedStub;
 use Emul\ArrayToClassMapper\Test\Unit\Stub\CustomDocBlockTypedArrayStub;
 use Emul\ArrayToClassMapper\Test\Unit\Stub\CustomDocBlockTypedStub;
 use Emul\ArrayToClassMapper\Test\Unit\Stub\CustomStub;
@@ -29,6 +30,20 @@ protected function setUp(): void
         $this->docBlockParser = \Mockery::mock(DocBlockParser::class);
     }
 
+    public function testMapWhenNullGiven_shouldSet()
+    {
+        $mapper = $this->getMapper();
+
+        $this->expectTypeRetrievedFromDocBlock('', null);
+
+        $input = ['int' => null];
+
+        /** @var ScalarTypedStub $result */
+        $result = $mapper->map($input, ScalarTypedStub::class);
+
+        $this->assertNull($result->getInt());
+    }
+
     public function testMapWhenBuiltInTypedPropertyGiven_shouldCast()
     {
         $mapper = $this->getMapper();
@@ -101,6 +116,34 @@ public function testMapWhenArrayTypedPropertyGivenWithCustomDockBlockType_should
         $this->assertSame(2, $mappedArray[1]->getInt());
     }
 
+    public function testMapWhenClassTypedPropertyGivenWithNullValue_shouldSetToNull()
+    {
+        $mapper = $this->getMapper();
+
+        $this->expectTypeRetrievedFromDocBlock('', null);
+
+        $input = ['object' => null];
+
+        /** @var ClassTypedStub $result */
+        $result = $mapper->map($input, ClassTypedStub::class);
+
+        $this->assertNull($result->getObject());
+    }
+
+    public function testMapWhenClassTypedPropertyGiven_shouldMap()
+    {
+        $mapper = $this->getMapper();
+
+        $this->expectTypeRetrievedFromDocBlock('', null);
+
+        $input = ['object' => ['int' => 1]];
+
+        /** @var ClassTypedStub $result */
+        $result = $mapper->map($input, ClassTypedStub::class);
+
+        $this->assertSame(1, $result->getObject()->getInt());
+    }
+
     public function testMapWhenArrayTypedPropertyGivenWithCustomDockBlockTypeAndCustomMapperProvided_shouldMapElementsWithGivenMapper()
     {
         $currentTime = '2020-01-01 01:01:01';

test/Unit/Stub/ClassTypedStub.php

@@ -0,0 +1,14 @@
+<?php
+declare(strict_types=1);
+
+namespace Emul\ArrayToClassMapper\Test\Unit\Stub;
+
+class ClassTypedStub
+{
+    private ?ScalarTypedStub $object;
+
+    public function getObject(): ?ScalarTypedStub
+    {
+        return $this->object;
+    }
+}

test/Unit/Stub/CustomTypedStub.php

@@ -7,9 +7,9 @@
 
 class CustomTypedStub
 {
-    private Carbon $currentTime;
+    private ?Carbon $currentTime;
 
-    public function getCurrentTime(): Carbon
+    public function getCurrentTime(): ?Carbon
     {
         return $this->currentTime;
     }

test/Unit/Stub/ScalarTypedStub.php

@@ -12,7 +12,7 @@ public function __construct()
         throw new \Exception('Constructor called');
     }
 
-    public function getInt(): int
+    public function getInt(): ?int
     {
         return $this->int;
     }