Merge pull request #63 from swisnl/bugfix/issue-62-empty-singular-relationship

Fix parsing of empty singular relationships

Author: JaZo

CHANGELOG.md

@@ -6,7 +6,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
-* Nothing
+### Fixed
+
+* Fixed parsing of empty singular relationships.
 
 ## [1.0.0-beta.2] - 2019-09-20
 

src/Parsers/DocumentParser.php

@@ -178,9 +178,13 @@ function (ItemInterface $item) {
             function (ItemInterface $item) use ($keyedItems) {
                 foreach ($item->getRelations() as $name => $relation) {
                     if ($relation instanceof OneRelationInterface) {
-                        /** @var \Swis\JsonApi\Client\Interfaces\ItemInterface $relatedItem */
+                        /** @var \Swis\JsonApi\Client\Interfaces\ItemInterface|null $relatedItem */
                         $relatedItem = $relation->getIncluded();
 
+                        if ($relatedItem === null) {
+                            continue;
+                        }
+
                         $includedItem = $this->getItem($keyedItems, $relatedItem);
                         if ($includedItem !== null) {
                             $relation->associate($includedItem);

tests/Parsers/DocumentParserTest.php

@@ -302,6 +302,49 @@ public function it_links_singular_relations_to_items_from_included()
         $this->assertSame($document->getIncluded()->get(0), $document->getData()->child()->getIncluded());
     }
 
+    /**
+     * @test
+     */
+    public function it_does_not_link_empty_singular_relations()
+    {
+        $typeMapper = new TypeMapper();
+        $typeMapper->setMapping('master', MasterItem::class);
+        $typeMapper->setMapping('child', ChildItem::class);
+        $parser = $this->getDocumentParser($typeMapper);
+
+        $document = $parser->parse(
+            json_encode(
+                [
+                    'data'     => [
+                        'type'          => 'master',
+                        'id'            => '1',
+                        'attributes'    => [
+                            'foo' => 'bar',
+                        ],
+                        'relationships' => [
+                            'child' => [
+                                'data' => null,
+                            ],
+                        ],
+                    ],
+                    'included' => [
+                        [
+                            'type'       => 'child',
+                            'id'         => '1',
+                            'attributes' => [
+                                'foo' => 'baz',
+                            ],
+                        ],
+                    ],
+                ]
+            )
+        );
+
+        $this->assertInstanceOf(MasterItem::class, $document->getData());
+        $this->assertNull($document->getData()->child()->getIncluded());
+        $this->assertInstanceOf(ChildItem::class, $document->getIncluded()->get(0));
+    }
+
     /**
      * @test
      */
@@ -363,6 +406,58 @@ public function it_links_plural_relations_to_items_from_included()
         $this->assertSame($document->getIncluded()->get(1), $document->getData()->children()->getIncluded()->get(1));
     }
 
+    /**
+     * @test
+     */
+    public function it_does_not_link_empty_plural_relations()
+    {
+        $typeMapper = new TypeMapper();
+        $typeMapper->setMapping('master', MasterItem::class);
+        $typeMapper->setMapping('child', ChildItem::class);
+        $parser = $this->getDocumentParser($typeMapper);
+
+        $document = $parser->parse(
+            json_encode(
+                [
+                    'data'     => [
+                        'type'          => 'master',
+                        'id'            => '1',
+                        'attributes'    => [
+                            'foo' => 'bar',
+                        ],
+                        'relationships' => [
+                            'children' => [
+                                'data' => [],
+                            ],
+                        ],
+                    ],
+                    'included' => [
+                        [
+                            'type'       => 'child',
+                            'id'         => '1',
+                            'attributes' => [
+                                'foo' => 'baz',
+                            ],
+                        ],
+                        [
+                            'type'       => 'child',
+                            'id'         => '2',
+                            'attributes' => [
+                                'foo' => 'baz',
+                            ],
+                        ],
+                    ],
+                ]
+            )
+        );
+
+        $this->assertInstanceOf(MasterItem::class, $document->getData());
+        $this->assertInstanceOf(Collection::class, $document->getData()->children()->getIncluded());
+        $this->assertEmpty($document->getData()->children()->getIncluded());
+        $this->assertInstanceOf(ChildItem::class, $document->getIncluded()->get(0));
+        $this->assertInstanceOf(ChildItem::class, $document->getIncluded()->get(1));
+    }
+
     /**
      * @test
      */