Merge pull request #3 from paysera/null-values-removal

Ability to easily filter out keys with null values
paysera · Apr 9, 2020 · 62e99bb · 62e99bb
2 parents 5182b28 + f1f6ca3
commit 62e99bb
Show file tree

Hide file tree

Showing 5 changed files with 78 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0]
+### Added
+- `NormalizationContext::markNullValuesForRemoval` method to be called in normalizers.
+If this is called, elements with `null` values will be removed from currently normalized object.
+
 ## [1.0.0]
 ### Changed
 - `null` values are kept by `DataFilter` and will be available in resulted normalized data.
@@ -28,3 +33,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 [1.0.0]: https://github.com/paysera/lib-normalization/compare/0.1.3...1.0.0
+[1.1.0]: https://github.com/paysera/lib-normalization/compare/1.0.0...1.1.0
diff --git a/src/DataFilter.php b/src/DataFilter.php
@@ -37,10 +37,16 @@ private function filterObject($data, NormalizationContext $context)
     {
         $result = new stdClass();
         foreach ($data as $key => $value) {
+            if ($context->areNullValuesRemoved() && $value === null) {
+                continue;
+            }
+
             $key = (string)$key;
-            if ($context->isFieldIncluded($key)) {
-                $result->$key = $this->filterData($value, $context->createScopedContext($key));
+            if (!$context->isFieldIncluded($key)) {
+                continue;
             }
+
+            $result->$key = $this->filterData($value, $context->createScopedContext($key));
         }
         return $result;
     }

diff --git a/src/NormalizationContext.php b/src/NormalizationContext.php
@@ -10,6 +10,7 @@ class NormalizationContext
     private $includedFields;
     private $path;
     private $normalizationGroup;
+    private $nullValuesRemoved;
 
     public function __construct(
         CoreNormalizer $coreNormalizer,
@@ -20,6 +21,7 @@ public function __construct(
         $this->setIncludedFields($includedFields);
         $this->normalizationGroup = $normalizationGroup;
         $this->path = [];
+        $this->nullValuesRemoved = false;
     }
 
     private function setIncludedFields(array $includedFields, bool $defaultFieldsIncluded = false)
@@ -57,6 +59,7 @@ public function normalize($data, string $fieldName, string $type = null)
     public function createScopedContext(string $fieldName): self
     {
         $context = clone $this;
+        $context->nullValuesRemoved = false;
 
         if ($this->isArrayItem($fieldName)) {
             return $context;
@@ -91,4 +94,14 @@ private function isArrayItem(string $fieldName)
     {
         return $fieldName === '';
     }
+
+    public function markNullValuesForRemoval()
+    {
+        $this->nullValuesRemoved = true;
+    }
+
+    public function areNullValuesRemoved(): bool
+    {
+        return $this->nullValuesRemoved;
+    }
 }
diff --git a/tests/CoreNormalizerFunctionalTest.php b/tests/CoreNormalizerFunctionalTest.php
@@ -13,6 +13,7 @@
 use Paysera\Component\Normalization\Registry\GroupedNormalizerRegistryProvider;
 use Paysera\Component\Normalization\Tests\Fixtures\Entity\InnerData;
 use Paysera\Component\Normalization\Tests\Fixtures\Entity\MyData;
+use Paysera\Component\Normalization\Tests\Fixtures\Normalizer\FilterOutNullsNormalizer;
 use Paysera\Component\Normalization\Tests\Fixtures\Normalizer\InnerDataNormalizer;
 use Paysera\Component\Normalization\Tests\Fixtures\Normalizer\MyDataNormalizer;
 use Paysera\Component\Normalization\Tests\Fixtures\Normalizer\WrappedNormalizer;
@@ -114,4 +115,27 @@ public function testNormalizeWithDifferentGroups()
 
         $this->assertEquals($arrayForA, (array)$result);
     }
+
+    public function testNormalizeWithFilterOutNullsFunctionality()
+    {
+        $normalizerRegistryProvider = new GroupedNormalizerRegistryProvider();
+        $normalizerRegistryProvider->addNormalizer(new FilterOutNullsNormalizer(), MyData::class);
+        $normalizerRegistryProvider->addNormalizer(new InnerDataNormalizer());
+
+        $typeGuesser = new TypeGuesser();
+        $dataFilter = new DataFilter();
+
+        $coreNormalizer = new CoreNormalizer($normalizerRegistryProvider, $typeGuesser, $dataFilter);
+
+        $result = $coreNormalizer->normalize((new MyData())->setInnerData(
+            (new InnerData())->setProperty('inner_data')
+        ));
+        $this->assertEquals(
+            (object)[
+                'inner' => (object)['inner_property' => 'inner_data', 'optional_property' => null],
+                'inner_list' => [],
+            ],
+            $result
+        );
+    }
 }
diff --git a/tests/Fixtures/Normalizer/FilterOutNullsNormalizer.php b/tests/Fixtures/Normalizer/FilterOutNullsNormalizer.php
@@ -0,0 +1,27 @@
+<?php
+declare(strict_types=1);
+
+namespace Paysera\Component\Normalization\Tests\Fixtures\Normalizer;
+
+use Paysera\Component\Normalization\NormalizationContext;
+use Paysera\Component\Normalization\NormalizerInterface;
+use Paysera\Component\Normalization\Tests\Fixtures\Entity\MyData;
+
+class FilterOutNullsNormalizer implements NormalizerInterface
+{
+    /**
+     * @param MyData $data
+     * @param NormalizationContext $normalizationContext
+     *
+     * @return mixed
+     */
+    public function normalize($data, NormalizationContext $normalizationContext)
+    {
+        $normalizationContext->markNullValuesForRemoval();
+        return [
+            'property' => $data->getProperty(),
+            'inner' => $data->getInnerData(),
+            'inner_list' => $data->getInnerDataList(),
+        ];
+    }
+}