Merge pull request #26 from square/nullparent

If a parent object on the same path was previously set but was null and other properties need to still set that path to set themselves because they're not marked with `omit_empty: true`, allow nesting deeper

Author: khepin

src/Json.php

@@ -168,7 +168,7 @@ public function appendValue(array &$data, $value)
                 throw new \Exception('invalid path: '.json_encode($this->path));
             }
 
-            if (!array_key_exists($pathBit, $d) && $i < $max) {
+            if ((!array_key_exists($pathBit, $d) || is_null($d[$pathBit])) && $i < $max) {
                 $d[$pathBit] = [];
             }
 

tests/Definitions/Child.php

@@ -0,0 +1,25 @@
+<?php declare(strict_types=1);
+
+namespace Square\Pjson\Tests\Definitions;
+
+use Square\Pjson\Json;
+use Square\Pjson\JsonSerialize;
+
+/**
+ * Keep properties in this exact order in this class. We want to confirm valid serialization when serializing `parent`
+ * set that value to `null` but something further down needs to set a nested property there.
+ */
+// phpcs:ignore PSR1.Classes.ClassDeclaration
+class Child
+{
+    use JsonSerialize;
+
+    #[Json("identifier")]
+    public $id;
+
+    #[Json(["parent"], omit_empty: true)]
+    public ?ParentObject $parent = null;
+
+    #[Json(["parent", "id"])]
+    public ?string $parentId = null;
+}

tests/Definitions/ParentObject.php

@@ -0,0 +1,15 @@
+<?php declare(strict_types=1);
+
+namespace Square\Pjson\Tests\Definitions;
+
+use Square\Pjson\Json;
+use Square\Pjson\JsonSerialize;
+
+// phpcs:ignore PSR1.Classes.ClassDeclaration
+class ParentObject
+{
+    use JsonSerialize;
+
+    #[Json("identifier")]
+    public $id;
+}

tests/SerializationTest.php

@@ -10,6 +10,7 @@
 use Square\Pjson\Tests\Definitions\CatalogItem;
 use Square\Pjson\Tests\Definitions\CatalogObject;
 use Square\Pjson\Tests\Definitions\Category;
+use Square\Pjson\Tests\Definitions\Child;
 use Square\Pjson\Tests\Definitions\Collector;
 use Square\Pjson\Tests\Definitions\MenuList;
 use Square\Pjson\Tests\Definitions\Privateer;
@@ -286,4 +287,14 @@ public function testCollections()
 
         $this->assertEquals(json_encode(json_decode($json)), $data->toJson());
     }
+
+    public function testMissingParent()
+    {
+        // Ensure that while the `parent` object is null, we can still serialize the parent.id property which is
+        // nested under `parent`.
+        $data = new Child();
+        $json = '{"identifier":null,"parent":{"id":null}}';
+
+        $this->assertEquals(json_encode(json_decode($json)), $data->toJson());
+    }
 }