add emptyToNull support

chubbyphp · Mar 10, 2019 · 79dc4fc · 79dc4fc
1 parent d2771ac
commit 79dc4fc
Show file tree

Hide file tree

Showing 9 changed files with 155 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -30,7 +30,7 @@ A simple deserialization.
 Through [Composer](http://getcomposer.org) as [chubbyphp/chubbyphp-deserialization][1].
 
 ```sh
-composer require chubbyphp/chubbyphp-deserialization "~2.7"
+composer require chubbyphp/chubbyphp-deserialization "~2.8"
 ```
 
 ## Usage

diff --git a/composer.json b/composer.json
@@ -30,7 +30,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "2.7-dev"
+            "dev-master": "2.8-dev"
         }
     }
 }
diff --git a/src/Denormalizer/ConvertTypeFieldDenormalizer.php b/src/Denormalizer/ConvertTypeFieldDenormalizer.php
@@ -32,20 +32,27 @@ final class ConvertTypeFieldDenormalizer implements FieldDenormalizerInterface
         self::TYPE_STRING,
     ];
 
+    /**
+     * @var bool
+     */
+    private $emptyToNull;
+
     /**
      * @param AccessorInterface $accessor
      * @param string            $type
+     * @param bool              $emptyToNull
      *
      * @throws DeserializerLogicException
      */
-    public function __construct(AccessorInterface $accessor, string $type)
+    public function __construct(AccessorInterface $accessor, string $type, bool $emptyToNull = false)
     {
         if (!in_array($type, self::TYPES, true)) {
             throw DeserializerLogicException::createConvertTypeDoesNotExists($type);
         }
 
         $this->accessor = $accessor;
         $this->type = $type;
+        $this->emptyToNull = $emptyToNull;
     }
 
     /**
@@ -64,6 +71,12 @@ public function denormalizeField(
         DenormalizerContextInterface $context,
         DenormalizerInterface $denormalizer = null
     ) {
+        if ($this->emptyToNull && '' === $value) {
+            $this->accessor->setValue($object, null);
+
+            return;
+        }
+
         $this->accessor->setValue($object, $this->convertType($value));
     }
 

diff --git a/src/Denormalizer/DateTimeFieldDenormalizer.php b/src/Denormalizer/DateTimeFieldDenormalizer.php
@@ -21,11 +21,18 @@ final class DateTimeFieldDenormalizer implements FieldDenormalizerInterface
      */
     private $accessor;
 
+    /**
+     * @var bool
+     */
+    private $emptyToNull;
+
     /**
      * @param AccessorInterface|FieldDenormalizerInterface $accessor
      */
-    public function __construct($accessor)
+    public function __construct($accessor, bool $emptyToNull = false)
     {
+        $this->emptyToNull = $emptyToNull;
+
         if ($accessor instanceof AccessorInterface) {
             $this->accessor = $accessor;
 
@@ -74,6 +81,12 @@ public function denormalizeField(
         DenormalizerContextInterface $context,
         DenormalizerInterface $denormalizer = null
     ) {
+        if ($this->emptyToNull && '' === $value) {
+            $this->setValue($path, $object, null, $context, $denormalizer);
+
+            return;
+        }
+
         if (!is_string($value) || '' === $trimmedValue = trim($value)) {
             $this->setValue($path, $object, $value, $context, $denormalizer);
 

diff --git a/src/Denormalizer/FieldDenormalizer.php b/src/Denormalizer/FieldDenormalizer.php
@@ -14,12 +14,19 @@ final class FieldDenormalizer implements FieldDenormalizerInterface
      */
     private $accessor;
 
+    /**
+     * @var bool
+     */
+    private $emptyToNull;
+
     /**
      * @param AccessorInterface $accessor
+     * @param bool              $emptyToNull
      */
-    public function __construct(AccessorInterface $accessor)
+    public function __construct(AccessorInterface $accessor, bool $emptyToNull = false)
     {
         $this->accessor = $accessor;
+        $this->emptyToNull = $emptyToNull;
     }
 
     /**
@@ -38,6 +45,12 @@ public function denormalizeField(
         DenormalizerContextInterface $context,
         DenormalizerInterface $denormalizer = null
     ) {
+        if ($this->emptyToNull && '' === $value) {
+            $this->accessor->setValue($object, null);
+
+            return;
+        }
+
         $this->accessor->setValue($object, $value);
     }
 }
diff --git a/src/Mapping/DenormalizationFieldMappingBuilder.php b/src/Mapping/DenormalizationFieldMappingBuilder.php
@@ -42,9 +42,12 @@ private function __construct(string $name)
      *
      * @return DenormalizationFieldMappingBuilderInterface
      */
-    public static function create(string $name): DenormalizationFieldMappingBuilderInterface
+    public static function create(string $name, bool $emptyToNull = false): DenormalizationFieldMappingBuilderInterface
     {
-        return new self($name);
+        $self = new self($name);
+        $self->fieldDenormalizer = new FieldDenormalizer(new PropertyAccessor($name), $emptyToNull);
+
+        return $self;
     }
 
     /**
@@ -64,13 +67,14 @@ public static function createCallback(string $name, callable $callback): Denorma
     /**
      * @param string $name
      * @param string $type
+     * @param bool   $emptyToNull
      *
      * @return DenormalizationFieldMappingBuilderInterface
      */
-    public static function createConvertType(string $name, string $type): DenormalizationFieldMappingBuilderInterface
+    public static function createConvertType(string $name, string $type, bool $emptyToNull = false): DenormalizationFieldMappingBuilderInterface
     {
         $self = new self($name);
-        $self->fieldDenormalizer = new ConvertTypeFieldDenormalizer(new PropertyAccessor($name), $type);
+        $self->fieldDenormalizer = new ConvertTypeFieldDenormalizer(new PropertyAccessor($name), $type, $emptyToNull);
 
         return $self;
     }
@@ -80,10 +84,10 @@ public static function createConvertType(string $name, string $type): Denormaliz
      *
      * @return DenormalizationFieldMappingBuilderInterface
      */
-    public static function createDateTime(string $name): DenormalizationFieldMappingBuilderInterface
+    public static function createDateTime(string $name, bool $emptyToNull = false): DenormalizationFieldMappingBuilderInterface
     {
         $self = new self($name);
-        $self->fieldDenormalizer = new DateTimeFieldDenormalizer(new PropertyAccessor($name));
+        $self->fieldDenormalizer = new DateTimeFieldDenormalizer(new PropertyAccessor($name), $emptyToNull);
 
         return $self;
     }
@@ -181,7 +185,7 @@ public function getMapping(): DenormalizationFieldMappingInterface
         return new DenormalizationFieldMapping(
             $this->name,
             $this->groups,
-            $this->fieldDenormalizer ?? new FieldDenormalizer(new PropertyAccessor($this->name))
+            $this->fieldDenormalizer
         );
     }
 }
diff --git a/tests/Denormalizer/ConvertTypeFieldDenormalizerTest.php b/tests/Denormalizer/ConvertTypeFieldDenormalizerTest.php
@@ -380,4 +380,36 @@ public function testDenormalizeFieldWithSpecialIntegerConvertedToString()
         $fieldDenormalizer->denormalizeField('value', $object, 02471, $context);
         $fieldDenormalizer->denormalizeField('value', $object, 1337e0, $context);
     }
+
+    public function testDenormalizeFieldWithEmptyToNullDisabled()
+    {
+        $object = new \stdClass();
+
+        /** @var AccessorInterface|MockObject $accessor */
+        $accessor = $this->getMockByCalls(AccessorInterface::class, [
+            Call::create('setValue')->with($object, ''),
+        ]);
+
+        /** @var DenormalizerContextInterface|MockObject $context */
+        $context = $this->getMockByCalls(DenormalizerContextInterface::class);
+
+        $fieldDenormalizer = new ConvertTypeFieldDenormalizer($accessor, ConvertTypeFieldDenormalizer::TYPE_FLOAT);
+        $fieldDenormalizer->denormalizeField('value', $object, '', $context);
+    }
+
+    public function testDenormalizeFieldWithEmptyToNullEnabled()
+    {
+        $object = new \stdClass();
+
+        /** @var AccessorInterface|MockObject $accessor */
+        $accessor = $this->getMockByCalls(AccessorInterface::class, [
+            Call::create('setValue')->with($object, null),
+        ]);
+
+        /** @var DenormalizerContextInterface|MockObject $context */
+        $context = $this->getMockByCalls(DenormalizerContextInterface::class);
+
+        $fieldDenormalizer = new ConvertTypeFieldDenormalizer($accessor, ConvertTypeFieldDenormalizer::TYPE_FLOAT, true);
+        $fieldDenormalizer->denormalizeField('value', $object, '', $context);
+    }
 }
diff --git a/tests/Denormalizer/DateTimeFieldDenormalizerTest.php b/tests/Denormalizer/DateTimeFieldDenormalizerTest.php
@@ -288,4 +288,40 @@ public function testDenormalizeObjectField()
 
         self::assertNull(error_get_last());
     }
+
+    public function testDenormalizeFieldWithEmptyToNullDisabled()
+    {
+        $object = new \stdClass();
+
+        /** @var AccessorInterface|MockObject $accessor */
+        $accessor = $this->getMockByCalls(AccessorInterface::class, [
+            Call::create('setValue')->with($object, ''),
+        ]);
+
+        /** @var DenormalizerContextInterface|MockObject $context */
+        $context = $this->getMockByCalls(DenormalizerContextInterface::class);
+
+        $fieldDenormalizer = new DateTimeFieldDenormalizer($accessor);
+        $fieldDenormalizer->denormalizeField('date', $object, '', $context);
+
+        self::assertNull(error_get_last());
+    }
+
+    public function testDenormalizeFieldWithEmptyToNullEnabled()
+    {
+        $object = new \stdClass();
+
+        /** @var AccessorInterface|MockObject $accessor */
+        $accessor = $this->getMockByCalls(AccessorInterface::class, [
+            Call::create('setValue')->with($object, null),
+        ]);
+
+        /** @var DenormalizerContextInterface|MockObject $context */
+        $context = $this->getMockByCalls(DenormalizerContextInterface::class);
+
+        $fieldDenormalizer = new DateTimeFieldDenormalizer($accessor, true);
+        $fieldDenormalizer->denormalizeField('date', $object, '', $context);
+
+        self::assertNull(error_get_last());
+    }
 }
diff --git a/tests/Denormalizer/FieldDenormalizerTest.php b/tests/Denormalizer/FieldDenormalizerTest.php
@@ -34,4 +34,36 @@ public function testDenormalizeField()
         $fieldDenormalizer = new FieldDenormalizer($accessor);
         $fieldDenormalizer->denormalizeField('name', $object, 'name', $context);
     }
+
+    public function testDenormalizeFieldWithEmptyToNullDisabled()
+    {
+        $object = new \stdClass();
+
+        /** @var AccessorInterface|MockObject $accessor */
+        $accessor = $this->getMockByCalls(AccessorInterface::class, [
+            Call::create('setValue')->with($object, ''),
+        ]);
+
+        /** @var DenormalizerContextInterface|MockObject $context */
+        $context = $this->getMockByCalls(DenormalizerContextInterface::class);
+
+        $fieldDenormalizer = new FieldDenormalizer($accessor);
+        $fieldDenormalizer->denormalizeField('name', $object, '', $context);
+    }
+
+    public function testDenormalizeFieldWithEmptyToNullEnabled()
+    {
+        $object = new \stdClass();
+
+        /** @var AccessorInterface|MockObject $accessor */
+        $accessor = $this->getMockByCalls(AccessorInterface::class, [
+            Call::create('setValue')->with($object, null),
+        ]);
+
+        /** @var DenormalizerContextInterface|MockObject $context */
+        $context = $this->getMockByCalls(DenormalizerContextInterface::class);
+
+        $fieldDenormalizer = new FieldDenormalizer($accessor, true);
+        $fieldDenormalizer->denormalizeField('name', $object, '', $context);
+    }
 }