feat: enable skipping of null-valued properties

Author: edumarques

phpunit.xml

@@ -3,6 +3,7 @@
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/12.1/phpunit.xsd"
          colors="true"
+         displayDetailsOnAllIssues="true"
 >
   <php>
     <ini name="display_errors" value="1"/>

src/Attribute/Attribute.php

@@ -11,6 +11,7 @@ class Attribute
 {
     public function __construct(
         public ?string $name = null,
+        public bool $ignoreIfNull = true,
     ) {
     }
 }

src/Serializer/EntityNormalizer.php

@@ -338,7 +338,10 @@ protected function normalizeAttributes(object $entity): array
         foreach ($propertyAttributes as $prop => $attr) {
             $reflectionProperty = $classMetadata->get($prop);
             $propertyValue = $reflectionProperty?->getValue($entity);
-            $attributes[$attr->name ?: $prop] = $this->normalizer->normalize($propertyValue);
+
+            if (false === $attr->ignoreIfNull || null !== $propertyValue) {
+                $attributes[$attr->name ?: $prop] = $this->normalizer->normalize($propertyValue);
+            }
         }
 
         return $attributes;

tests/Integration/Serializer/EntityNormalizerTest.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace EduardoMarques\DynamoPHP\Tests\Integration\Serializer;
+
+use DateTime;
+use EduardoMarques\DynamoPHP\Metadata\MetadataLoader;
+use EduardoMarques\DynamoPHP\Serializer\EntityNormalizer;
+use EduardoMarques\DynamoPHP\Tests\Integration\Stubs\EntityA;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Serializer\Normalizer\BackedEnumNormalizer;
+use Symfony\Component\Serializer\Normalizer\DateTimeNormalizer;
+use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
+use Symfony\Component\Serializer\Serializer;
+
+final class EntityNormalizerTest extends TestCase
+{
+    private MetadataLoader $metadataLoader;
+
+    private Serializer $serializer;
+
+    private EntityNormalizer $entityNormalizer;
+
+    #[Test]
+    public function itReturnsNormalizedEntity(): void
+    {
+        $id = '8798b91f-fe8e-498c-8145-c757029346ef';
+        $name = 'John Doe';
+        $creationDate = new DateTime();
+        $entity = new EntityA($id);
+        $entity->name = $name;
+        $entity->creationDate = $creationDate;
+
+        $expected = [
+            'PK' => $id,
+            'SK' => $creationDate->format('c'),
+            'name' => $name,
+            'type' => 'A',
+            'createdAt' => $creationDate->format('c'),
+            'birthDate' => null,
+            'id' => $id,
+        ];
+
+        $this->assertSame($expected, $this->entityNormalizer->normalize($entity));
+    }
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->metadataLoader = new MetadataLoader();
+
+        $this->serializer = new Serializer([
+            new BackedEnumNormalizer(),
+            new DateTimeNormalizer(),
+            new ObjectNormalizer(),
+        ]);
+
+        $this->entityNormalizer = new EntityNormalizer($this->metadataLoader, $this->serializer);
+    }
+}

tests/Integration/Stubs/EntityA.php

@@ -30,6 +30,12 @@ final class EntityA
     #[Attribute(name: 'createdAt')]
     public DateTimeInterface $creationDate;
 
+    #[Attribute]
+    public ?string $nationality = null;
+
+    #[Attribute(ignoreIfNull: false)]
+    public ?DateTimeInterface $birthDate = null;
+
     public function __construct(
         #[Attribute]
         protected string $id,