Omit item from included when it has no attributes or relationships

Author: JaZo

CHANGELOG.md

@@ -6,7 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
-* Nothing
+### Fixed
+
+* Omit item from included when it has no attributes or relationships (only type and id)
+N.B. This is a breaking change if you implement the `ItemInterface` yourself instead of using the supplied `Item`.
 
 ## [0.12.1] - 2019-01-11
 

src/Interfaces/ItemInterface.php

@@ -93,4 +93,9 @@ public function setRelation($relation, $value);
      * @return \Swis\JsonApi\Client\Collection
      */
     public function getIncluded();
+
+    /**
+     * @return bool
+     */
+    public function canBeIncluded(): bool;
 }

src/Item.php

@@ -203,14 +203,14 @@ public function getIncluded(): Collection
 
             $includedFromRelationship = $relationship->getIncluded();
             if ($includedFromRelationship instanceof ItemInterface) {
-                if (!empty($includedFromRelationship->getType()) && null !== $includedFromRelationship->getId()) {
+                if ($includedFromRelationship->canBeIncluded()) {
                     $included->push($includedFromRelationship->toJsonApiArray());
                 }
                 $included = $included->merge($includedFromRelationship->getIncluded());
             } elseif ($includedFromRelationship instanceof Collection) {
                 $includedFromRelationship->each(
                     function (ItemInterface $item) use (&$included) {
-                        if (!empty($item->getType()) && null !== $item->getId()) {
+                        if ($item->canBeIncluded()) {
                             $included->push($item->toJsonApiArray());
                         }
                         $included = $included->merge($item->getIncluded());
@@ -228,6 +228,26 @@ function (array $item) {
         );
     }
 
+    /**
+     * @return bool
+     */
+    public function canBeIncluded(): bool
+    {
+        if (empty($this->getType())) {
+            return false;
+        }
+
+        if (null === $this->getId()) {
+            return false;
+        }
+
+        if (empty($this->relationships) && empty($this->toArray())) {
+            return false;
+        }
+
+        return true;
+    }
+
     /**
      * @param string $key
      *