fix: Fix the null value should be removed only if set as default on t…

…yped properties (#FRAM-72) (#11)
b2pweb · Oct 26, 2022 · 99f202c · 99f202c
1 parent 09feb5e
commit 99f202c
Show file tree

Hide file tree

Showing 8 changed files with 75 additions and 13 deletions.
diff --git a/src/Context/NormalizationContext.php b/src/Context/NormalizationContext.php
@@ -199,12 +199,8 @@ public function skipPropertyValue(PropertyMetadata $property, $value): bool
             return !$this->shouldAddNull();
         }
 
-        // This does not remove the 'null' default value.
-        if ($this->removeDefaultValue()) {
-            return $property->defaultValue === $value;
-        }
-
-        return false;
+        // This does not remove the 'null' default value for non typed properties.
+        return $this->removeDefaultValue() && $property->isDefaultValue($value);
     }
 
     /**

diff --git a/src/Metadata/Builder/PropertyMetadataBuilder.php b/src/Metadata/Builder/PropertyMetadataBuilder.php
@@ -149,7 +149,7 @@ public function build(): PropertyMetadata
         $property->setDenormalizationOptions($this->denormalizationOptions);
 
         $defaultValues = $this->reflection->getDefaultProperties();
-        if (isset($defaultValues[$this->name])) {
+        if (array_key_exists($this->name, $defaultValues)) {
             $property->setDefaultValue($defaultValues[$this->name]);
         }
 

diff --git a/src/Metadata/PropertyMetadata.php b/src/Metadata/PropertyMetadata.php
@@ -91,6 +91,13 @@ class PropertyMetadata
      */
     public $defaultValue;
 
+    /**
+     * A flag to know if the property has a default value.
+     *
+     * @var bool
+     */
+    private $hasDefaultValue = false;
+
     /**
      * Flag to know if the property used php type.
      *
@@ -356,6 +363,7 @@ public function inline(): bool
     public function setDefaultValue($defaultValue): void
     {
         $this->defaultValue = $defaultValue;
+        $this->hasDefaultValue = true;
     }
 
     /**
@@ -368,6 +376,16 @@ public function defaultValue()
         return $this->defaultValue;
     }
 
+    /**
+     * Check whether the value is the default value of the property.
+     *
+     * @param mixed $value
+     */
+    public function isDefaultValue($value): bool
+    {
+        return $this->hasDefaultValue && $this->defaultValue === $value;
+    }
+
     /**
      * Set the options for normalization context
      *

diff --git a/tests/Test/Context/NormalizationContextTest.php b/tests/Test/Context/NormalizationContextTest.php
@@ -318,7 +318,7 @@ public function test_release_ref()
     public function test_default_value()
     {
         $property = $this->property();
-        $property->defaultValue = 1;
+        $property->setDefaultValue(1);
 
         $context = $this->context();
         $this->assertFalse($context->skipPropertyValue($property, 0));

diff --git a/tests/TestPhp72/Fixtures/entities.php b/tests/TestPhp72/Fixtures/entities.php
@@ -3,6 +3,18 @@
 namespace Bdf\Serializer\TestPhp72;
 
 
+class Bar
+{
+    public $id;
+    public $label;
+}
+
+class BarWithDefaultValue
+{
+    public $id;
+    public $label = null;
+}
+
 class UserNonTyped
 {
     private $id;

diff --git a/tests/TestPhp72/SerializerOptionsTest.php b/tests/TestPhp72/SerializerOptionsTest.php
@@ -2,6 +2,7 @@
 
 namespace Bdf\Serializer\TestPhp72;
 
+use Bdf\Serializer\Context\NormalizationContext;
 use Bdf\Serializer\SerializerBuilder;
 use PHPUnit\Framework\TestCase;
 
@@ -39,4 +40,19 @@ public function test_serialize_with_null_value()
         $data = ['id' => 1];
         $this->assertEquals($data, $result);
     }
+
+    /**
+     *
+     */
+    public function test_remove_default_null_value()
+    {
+        $serializer = SerializerBuilder::create()->build();
+
+        $object = new Bar();
+        $object->label = null;
+        $this->assertEquals([], $serializer->toArray($object, [NormalizationContext::REMOVE_DEFAULT_VALUE => true]));
+
+        $object = new BarWithDefaultValue();
+        $this->assertEquals([], $serializer->toArray($object, [NormalizationContext::REMOVE_DEFAULT_VALUE => true]));
+    }
 }
diff --git a/tests/TestPhp74/Fixtures/entities.php b/tests/TestPhp74/Fixtures/entities.php
@@ -61,5 +61,11 @@ class Foo
 class Bar
 {
     public int $id;
-    public string $label;
+    public ?string $label;
+}
+
+class BarWithDefaultValue
+{
+    public int $id;
+    public ?string $label = null;
 }
diff --git a/tests/TestPhp74/SerializerTest.php b/tests/TestPhp74/SerializerTest.php
@@ -33,11 +33,25 @@ public function test_normalize_add_null_value_for_typed_properties()
             'age' => null,
         ];
 
-        $result = $serializer->toArray($object, ['null' => true]);
-        $this->assertEquals($data, $result);
+        $this->assertEquals($data, $serializer->toArray($object));
+        $this->assertEquals($data, $serializer->toArray($object, [NormalizationContext::NULL => true]));
+    }
+
+    /**
+     *
+     */
+    public function test_remove_default_value_when_equals_to_null()
+    {
+        $serializer = SerializerBuilder::create()->build();
+
+        $object = new Bar();
+        $object->label = null;
+        $this->assertEquals(['label' => null], $serializer->toArray($object, [NormalizationContext::REMOVE_DEFAULT_VALUE => true]));
 
-        $result = $serializer->toArray($object);
-        $this->assertEquals($data, $result);
+        $object = new BarWithDefaultValue();
+        $object->label = null;
+        $this->assertEquals(['label' => null], $serializer->toArray($object));
+        $this->assertEquals([], $serializer->toArray($object, [NormalizationContext::REMOVE_DEFAULT_VALUE => true]));
     }
 
     /**