Merge pull request #52 from swisnl/feature/refactor-document-builders

Refactor both DocumentBuilders to one DocumentFactory

Author: JaZo

CHANGELOG.md

@@ -8,12 +8,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
-* Added facades for `CollectionDocumentBuilder`, `ItemDocumentBuilder`, `ItemHydrator` and `TypeMapper`.
+* Added `DocumentFactory`.
+* Added facades for `DocumentFactory`, `ItemHydrator` and `TypeMapper`.
 
 ### Changed
 
 * The `TypeMapper` now checks if the class exists in the setter instead of the getter.
 * The `ItemHydrator` now also hydrates the id if provided.
+* Added `hasType`, `hasAttributes`, `hasRelationships` and `getRelations` to `ItemInterface`.
+* Removed `canBeIncluded` and `getIncluded` from `ItemInterface` as the `DocumentFactory` is now responsible for gathering the included items.
+
+### Removed
+
+* Removed `CollectionDocumentBuilder` and `ItemDocumentBuilder` in favor of `DocumentFactory`.
 
 ## [0.18.0] - 2019-07-01
 

composer.json

@@ -59,8 +59,7 @@
                 "Swis\\JsonApi\\Client\\Providers\\ServiceProvider"
             ],
             "aliases":{
-                "CollectionDocumentBuilder": "Swis\\JsonApi\\Client\\Facades\\CollectionDocumentBuilderFacade",
-                "ItemDocumentBuilder": "Swis\\JsonApi\\Client\\Facades\\ItemDocumentBuilderFacade",
+                "DocumentFactory": "Swis\\JsonApi\\Client\\Facades\\DocumentFactoryFacade",
                 "ItemHydrator": "Swis\\JsonApi\\Client\\Facades\\ItemHydratorFacade",
                 "TypeMapper": "Swis\\JsonApi\\Client\\Facades\\TypeMapperFacade"
             }

src/CollectionDocumentBuilder.php

@@ -0,0 +1,93 @@
+<?php
+
+namespace Swis\JsonApi\Client;
+
+use Swis\JsonApi\Client\Interfaces\DataInterface;
+use Swis\JsonApi\Client\Interfaces\DocumentInterface;
+use Swis\JsonApi\Client\Interfaces\ItemInterface;
+
+class DocumentFactory
+{
+    /**
+     * @param \Swis\JsonApi\Client\Interfaces\DataInterface $data
+     *
+     * @return \Swis\JsonApi\Client\Interfaces\DocumentInterface
+     */
+    public function make(DataInterface $data): DocumentInterface
+    {
+        if ($data instanceof ItemInterface) {
+            $document = new ItemDocument();
+        } elseif ($data instanceof Collection) {
+            $document = new CollectionDocument();
+        } else {
+            throw new \InvalidArgumentException(sprintf('%s is not supported as input', get_class($data)));
+        }
+
+        return $document->setData($data)->setIncluded($this->getIncluded($data));
+    }
+
+    /**
+     * @param \Swis\JsonApi\Client\Interfaces\DataInterface $data
+     *
+     * @return \Swis\JsonApi\Client\Collection
+     */
+    private function getIncluded(DataInterface $data): Collection
+    {
+        return Collection::wrap($data)
+            ->flatMap(
+                function (ItemInterface $item) {
+                    return $this->getIncludedFromItem($item);
+                }
+            )
+            ->unique(
+                static function (ItemInterface $item) {
+                    return sprintf('%s:%s', $item->getType(), $item->getId());
+                }
+            )
+            ->values();
+    }
+
+    /**
+     * @param \Swis\JsonApi\Client\Interfaces\ItemInterface $item
+     *
+     * @return \Swis\JsonApi\Client\Collection
+     */
+    private function getIncludedFromItem(ItemInterface $item): Collection
+    {
+        return Collection::make($item->getRelations())
+            ->reject(
+                static function ($relationship) {
+                    /* @var \Swis\JsonApi\Client\Interfaces\OneRelationInterface|\Swis\JsonApi\Client\Interfaces\ManyRelationInterface $relationship */
+                    return $relationship->shouldOmitIncluded() || !$relationship->hasIncluded();
+                }
+            )
+            ->flatMap(
+                static function ($relationship) {
+                    /* @var \Swis\JsonApi\Client\Interfaces\OneRelationInterface|\Swis\JsonApi\Client\Interfaces\ManyRelationInterface $relationship */
+                    return Collection::wrap($relationship->getIncluded());
+                }
+            )
+            ->flatMap(
+                function (ItemInterface $item) {
+                    return Collection::wrap($item)->merge($this->getIncludedFromItem($item));
+                }
+            )
+            ->filter(
+                function (ItemInterface $item) {
+                    return $this->itemCanBeIncluded($item);
+                }
+            );
+    }
+
+    /**
+     * @param \Swis\JsonApi\Client\Interfaces\ItemInterface $item
+     *
+     * @return bool
+     */
+    private function itemCanBeIncluded(ItemInterface $item): bool
+    {
+        return $item->hasType()
+            && $item->hasId()
+            && ($item->hasAttributes() || $item->hasRelationships());
+    }
+}

src/DocumentFactory.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Swis\JsonApi\Client\Facades;
+
+use Illuminate\Support\Facades\Facade;
+use Swis\JsonApi\Client\DocumentFactory;
+
+/**
+ * @method static \Swis\JsonApi\Client\Interfaces\DocumentInterface make(\Swis\JsonApi\Client\Interfaces\DataInterface $data)
+ *
+ * @see \Swis\JsonApi\Client\DocumentFactory
+ */
+class DocumentFactoryFacade extends Facade
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected static function getFacadeAccessor()
+    {
+        return DocumentFactory::class;
+    }
+}

src/Facades/CollectionDocumentBuilderFacade.php

@@ -34,6 +34,11 @@ public function setId(? string $id);
      */
     public function getType(): string;
 
+    /**
+     * @return bool
+     */
+    public function hasType(): bool;
+
     /**
      * @param string $type
      *
@@ -97,6 +102,16 @@ public function getAttribute($key);
      */
     public function setAttribute($key, $value);
 
+    /**
+     * @return bool
+     */
+    public function hasAttributes(): bool;
+
+    /**
+     * @return bool
+     */
+    public function hasRelationships(): bool;
+
     /**
      * @return array
      */
@@ -115,14 +130,7 @@ public function getAvailableRelations(): array;
     public function setRelation(string $relation, DataInterface $value, Links $links = null, Meta $meta = null);
 
     /**
-     * @TODO: MEGA TODO. Set up a serializer for the Item so that we can remove this, getRelationships etc
-     *
-     * @return \Swis\JsonApi\Client\Collection
-     */
-    public function getIncluded();
-
-    /**
-     * @return bool
+     * @return \Swis\JsonApi\Client\Interfaces\OneRelationInterface|\Swis\JsonApi\Client\Interfaces\ManyRelationInterface[]
      */
-    public function canBeIncluded(): bool;
+    public function getRelations(): array;
 }

src/Facades/DocumentFactoryFacade.php

@@ -161,66 +161,12 @@ public function getRelationships(): array
         return $relationships;
     }
 
-    /**
-     * @TODO: MEGA TODO. Set up a serializer for the Item so that we can remove this, getRelationships etc
-     *
-     * @return \Swis\JsonApi\Client\Collection
-     */
-    public function getIncluded(): Collection
-    {
-        $included = new Collection();
-
-        foreach ($this->relationships as $name => $relationship) {
-            if ($relationship->shouldOmitIncluded() || !$relationship->hasIncluded()) {
-                continue;
-            }
-
-            if ($relationship instanceof OneRelationInterface) {
-                /** @var \Swis\JsonApi\Client\Interfaces\ItemInterface $item */
-                $item = $relationship->getIncluded();
-                if ($item->canBeIncluded()) {
-                    $included->push($item->toJsonApiArray());
-                }
-                $included = $included->merge($item->getIncluded());
-            } elseif ($relationship instanceof ManyRelationInterface) {
-                $relationship->getIncluded()->each(
-                    function (ItemInterface $item) use (&$included) {
-                        if ($item->canBeIncluded()) {
-                            $included->push($item->toJsonApiArray());
-                        }
-                        $included = $included->merge($item->getIncluded());
-                    }
-                );
-            }
-        }
-
-        return $included
-            ->unique(
-                function (array $item) {
-                    return $item['type'].':'.$item['id'];
-                }
-            )
-            ->values();
-    }
-
     /**
      * @return bool
      */
-    public function canBeIncluded(): bool
+    public function hasRelationships(): bool
     {
-        if (empty($this->getType())) {
-            return false;
-        }
-
-        if (null === $this->getId()) {
-            return false;
-        }
-
-        if (empty($this->relationships) && empty($this->toArray())) {
-            return false;
-        }
-
-        return true;
+        return !empty($this->getRelationships());
     }
 
     /**
@@ -261,6 +207,14 @@ public function hasAttribute($key): bool
         return array_key_exists($key, $this->attributes);
     }
 
+    /**
+     * @return bool
+     */
+    public function hasAttributes(): bool
+    {
+        return !empty($this->toArray());
+    }
+
     /**
      * @param string $key
      * @param mixed  $value
@@ -510,4 +464,12 @@ public function setRelation(string $relation, DataInterface $value, Links $links
 
         return $this;
     }
+
+    /**
+     * @return array
+     */
+    public function getRelations(): array
+    {
+        return $this->relationships;
+    }
 }