Handling case when a class docblok typed property receives a null value

Author: emulgeator

.phpunit.result.cache

@@ -0,0 +1 @@
+C:37:"PHPUnit\Runner\DefaultTestResultCache":1847:{a:2:{s:7:"defects";a:1:{s:117:"Emul\ArrayToClassMapper\Test\Unit\MapperTest::testMapWhenClassDocBlockTypedPropertyGivenWithNullValue_shouldSetToNull";i:4;}s:5:"times";a:13:{s:117:"Emul\ArrayToClassMapper\Test\Unit\MapperTest::testMapWhenClassDocBlockTypedPropertyGivenWithNullValue_shouldSetToNull";d:0.006;s:76:"Emul\ArrayToClassMapper\Test\Unit\MapperTest::testMapWhenNullGiven_shouldSet";d:0.028;s:93:"Emul\ArrayToClassMapper\Test\Unit\MapperTest::testMapWhenBuiltInTypedPropertyGiven_shouldCast";d:0.005;s:114:"Emul\ArrayToClassMapper\Test\Unit\MapperTest::testMapWhenArrayTypedPropertyGivenWithoutDocBlock_shouldCastElements";d:0.006;s:123:"Emul\ArrayToClassMapper\Test\Unit\MapperTest::testMapWhenArrayTypedPropertyGivenWithBuiltInDockBlockType_shouldCastElements";d:0.006;s:133:"Emul\ArrayToClassMapper\Test\Unit\MapperTest::testMapWhenArrayTypedPropertyGivenWithCustomDockBlockType_shouldMapElementsToCustomType";d:0.01;s:109:"Emul\ArrayToClassMapper\Test\Unit\MapperTest::testMapWhenClassTypedPropertyGivenWithNullValue_shouldSetToNull";d:0.006;s:90:"Emul\ArrayToClassMapper\Test\Unit\MapperTest::testMapWhenClassTypedPropertyGiven_shouldMap";d:0.006;s:159:"Emul\ArrayToClassMapper\Test\Unit\MapperTest::testMapWhenArrayTypedPropertyGivenWithCustomDockBlockTypeAndCustomMapperProvided_shouldMapElementsWithGivenMapper";d:0.022;s:94:"Emul\ArrayToClassMapper\Test\Unit\MapperTest::testMapWhenTypelessPropertyGiven_shouldJustStore";d:0.005;s:115:"Emul\ArrayToClassMapper\Test\Unit\MapperTest::testMapWhenScalarDocBlockTypePropertyGiven_shouldCastToDocumentedType";d:0.005;s:114:"Emul\ArrayToClassMapper\Test\Unit\MapperTest::testMapWhenCustomDocBlockTypedPropertyGiven_shouldMapWithGivenMapper";d:0.006;s:119:"Emul\ArrayToClassMapper\Test\Unit\MapperTest::testMapWhenCustomDocBlockTypedArrayPropertyGiven_shouldMapWithGivenMapper";d:0.008;}}}

src/Mapper.php

@@ -66,15 +66,7 @@ public function map(array $input, string $className)
                             $property->setValue($object, $value);
                         }
                     } else {
-                        if (
-                            $value === null
-                            && empty($this->getCustomMapper($type->getName()))
-                        ) {
-                            $property->setValue($object, null);
-                        }
-                        else {
-                            $property->setValue($object, $this->castCustom($value, $type->getName()));
-                        }
+                        $this->setCustomValue($object, $property, $type->getName(), $value);
                     }
                 } else {
                     if (empty($docBlockType)) {
@@ -88,7 +80,7 @@ public function map(array $input, string $className)
                                 $property->setValue($object, $value);
                             }
                         } else {
-                            $property->setValue($object, $this->castCustom($value, $docBlockType->getName()));
+                            $this->setCustomValue($object, $property, $docBlockType->getName(), $value);
                         }
                     }
                 }
@@ -98,6 +90,19 @@ public function map(array $input, string $className)
         return $object;
     }
 
+    private function setCustomValue($object, \ReflectionProperty $property, string $typeName, $value): void
+    {
+        if (
+            $value === null
+            && empty($this->getCustomMapper($typeName))
+        ) {
+            $property->setValue($object, null);
+        }
+        else {
+            $property->setValue($object, $this->castCustom($value, $typeName));
+        }
+    }
+
     private function castArray(array $array, DocBlockType $docblockType): array
     {
         $castedArray = [];

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\ClassDocBlockTypedStub;
 use Emul\ArrayToClassMapper\Test\Unit\Stub\ClassTypedStub;
 use Emul\ArrayToClassMapper\Test\Unit\Stub\CustomDocBlockTypedArrayStub;
 use Emul\ArrayToClassMapper\Test\Unit\Stub\CustomDocBlockTypedStub;
@@ -130,6 +131,20 @@ public function testMapWhenClassTypedPropertyGivenWithNullValue_shouldSetToNull(
         $this->assertNull($result->getObject());
     }
 
+    public function testMapWhenClassDocBlockTypedPropertyGivenWithNullValue_shouldSetToNull()
+    {
+        $mapper = $this->getMapper();
+
+        $this->expectTypeRetrievedFromDocBlock('/** @var ScalarTypedStub|null */', new DocBlockType('ScalarTypedStub', true, false, true));
+
+        $input = ['object' => null];
+
+        /** @var ClassDocBlockTypedStub $result */
+        $result = $mapper->map($input, ClassDocBlockTypedStub::class);
+
+        $this->assertNull($result->getObject());
+    }
+
     public function testMapWhenClassTypedPropertyGiven_shouldMap()
     {
         $mapper = $this->getMapper();

test/Unit/Stub/ClassDocBlockTypedStub.php

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