Merge pull request #11 from emulgeator/empty-string-cast

Casting empty string to null in case of nullable `int` or `float`

Author: emulgeator

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.1.0] - 2024-04-08
+
+### Added
+- Casting empty string to null in case of nullable `int` or `float`
+
+
 ## [1.0.0] - 2024-03-26
 
 ### Added

src/Caster.php

@@ -10,4 +10,18 @@ public static function castToBool($input): ?bool
     {
         return is_null($input) ? null : filter_var($input, FILTER_VALIDATE_BOOLEAN);
     }
+
+    public static function castToInt($input): ?int
+    {
+        $result = (is_null($input) || $input === '') ? null : filter_var($input, FILTER_VALIDATE_INT);
+
+        return $result === false ? null : $result;
+    }
+
+    public static function castToFloat($input): ?float
+    {
+        $result = (is_null($input) || $input === '') ? null : filter_var($input, FILTER_VALIDATE_FLOAT);
+
+        return $result === false ? null : $result;
+    }
 }

src/Mapper.php

@@ -136,8 +136,18 @@ private function setValueByPhpType(\ReflectionNamedType $type, ?DocBlockType $do
                     $property->setValue($object, $valueCasted);
                 }
             } else {
-                if ($type->getName() === 'bool') {
-                    $value = Caster::castToBool($value);
+                switch ($type->getName()) {
+                    case 'bool':
+                        $value = Caster::castToBool($value);
+                        break;
+
+                    case 'int':
+                        $value = Caster::castToInt($value);
+                        break;
+
+                    case 'float':
+                        $value = Caster::castToInt($value);
+                        break;
                 }
                 $property->setValue($object, $value);
             }

test/Unit/CasterTest.php

@@ -30,4 +30,48 @@ public function testCastToBool($input, ?bool $mappedValue)
 
         $this->assertSame($mappedValue, $result);
     }
+
+    public static function intProvider(): array
+    {
+        return [
+            'integer'        => [1, 1],
+            'string integer' => ['11', 11],
+            'null'           => [null, null],
+            'empty string'   => ['', null],
+            'zero'           => [0, 0],
+            'invalid'        => [false, null],
+        ];
+    }
+
+    /**
+     * @dataProvider intProvider
+     */
+    public function testCastToInt($input, ?int $mappedValue)
+    {
+        $result = Caster::castToInt($input);
+
+        $this->assertSame($mappedValue, $result);
+    }
+
+    public static function floatProvider(): array
+    {
+        return [
+            'float'            => [1.1, 1.1],
+            'string floateger' => ['2.2', 2.2],
+            'null'             => [null, null],
+            'empty string'     => ['', null],
+            'zero'             => [0, 0],
+            'invalid'          => [false, null],
+        ];
+    }
+
+    /**
+     * @dataProvider floatProvider
+     */
+    public function testCastToFloat($input, ?float $mappedValue)
+    {
+        $result = Caster::castToFloat($input);
+
+        $this->assertSame($mappedValue, $result);
+    }
 }

test/Unit/MapperTest.php

@@ -35,6 +35,28 @@ public function testMapWhenNullGiven_shouldSet()
         $this->assertNull($result->getInt());
     }
 
+    public function testMapWhenEmptyStringGivenForNullableInt_shouldSetToNull()
+    {
+        $mapper = $this->getMapper();
+        $input  = ['int' => ''];
+
+        /** @var ScalarTypedStub $result */
+        $result = $mapper->map($input, ScalarTypedStub::class);
+
+        $this->assertNull($result->getInt());
+    }
+
+    public function testMapWhenEmptyStringGivenForNullableFloat_shouldSetToNull()
+    {
+        $mapper = $this->getMapper();
+        $input  = ['float' => ''];
+
+        /** @var ScalarTypedStub $result */
+        $result = $mapper->map($input, ScalarTypedStub::class);
+
+        $this->assertNull($result->getFloat());
+    }
+
     public function testMapWhenKeyContainsSpecialCharacter_shouldSetByRemovingSpecialChars()
     {
         $mapper = $this->getMapper();

test/Unit/Stub/ScalarTypedStub.php

@@ -1,11 +1,13 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Emul\ArrayToClassMapper\Test\Unit\Stub;
 
 class ScalarTypedStub
 {
-    private ?int $int = null;
+    private ?int   $int;
+    private ?float $float;
 
     public function __construct()
     {
@@ -16,4 +18,9 @@ public function getInt(): ?int
     {
         return $this->int;
     }
+
+    public function getFloat(): ?float
+    {
+        return $this->float;
+    }
 }