Remove obsolete ItemDocumentSerializer in favor of JsonSerializable

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Removed
+
+* Removed obsolete `ItemDocumentSerializer` in favor of `JsonSerializable`.
+N.B. This is a breaking change if you use this class directly, construct the `DocumentClient` yourself or have overwritten `\Swis\JsonApi\Client\Providers\ServiceProvider::registerClients`. The `ItemDocument` can now be serialized using its `jsonSerialize` method.
+
 ## [0.11.0] - 2018-12-21
 
 ### Changed

src/Document.php

@@ -6,7 +6,7 @@
 use Swis\JsonApi\Client\Interfaces\DataInterface;
 use Swis\JsonApi\Client\Interfaces\DocumentInterface;
 
-class Document implements DocumentInterface, \JsonSerializable
+class Document implements DocumentInterface
 {
     /**
      * @var \Swis\JsonApi\Client\Interfaces\DataInterface

src/DocumentClient.php

@@ -16,28 +16,18 @@ class DocumentClient implements DocumentClientInterface
      */
     private $client;
 
-    /**
-     * @var \Swis\JsonApi\Client\ItemDocumentSerializer
-     */
-    private $itemDocumentSerializer;
-
     /**
      * @var \Swis\JsonApi\Client\Interfaces\ParserInterface
      */
     private $parser;
 
     /**
      * @param \Swis\JsonApi\Client\Interfaces\ClientInterface $client
-     * @param \Swis\JsonApi\Client\ItemDocumentSerializer     $itemDocumentSerializer
      * @param \Swis\JsonApi\Client\Interfaces\ParserInterface $parser
      */
-    public function __construct(
-        ClientInterface $client,
-        ItemDocumentSerializer $itemDocumentSerializer,
-        ParserInterface $parser
-    ) {
+    public function __construct(ClientInterface $client, ParserInterface $parser)
+    {
         $this->client = $client;
-        $this->itemDocumentSerializer = $itemDocumentSerializer;
         $this->parser = $parser;
     }
 
@@ -106,7 +96,7 @@ public function delete(string $endpoint): DocumentInterface
      */
     protected function prepareBody(ItemDocumentInterface $body): string
     {
-        return $this->sanitizeJson($this->itemDocumentSerializer->serialize($body));
+        return $this->sanitizeJson($body->jsonSerialize());
     }
 
     /**

src/Interfaces/DocumentInterface.php

@@ -5,7 +5,7 @@
 use Swis\JsonApi\Client\Collection;
 use Swis\JsonApi\Client\Errors\ErrorCollection;
 
-interface DocumentInterface
+interface DocumentInterface extends \JsonSerializable
 {
     /**
      * @return \Swis\JsonApi\Client\Interfaces\DataInterface

src/InvalidResponseDocument.php

@@ -63,6 +63,21 @@ public function getJsonapi()
         return null;
     }
 
+    /**
+     * Specify data which should be serialized to JSON.
+     *
+     * @see  http://php.net/manual/en/jsonserializable.jsonserialize.php
+     *
+     * @return mixed data which can be serialized by <b>json_encode</b>,
+     *               which is a value of any type other than a resource
+     *
+     * @since 5.4.0
+     */
+    public function jsonSerialize()
+    {
+        return $this->toArray();
+    }
+
     /**
      * @return array
      */

src/Providers/ServiceProvider.php

@@ -15,7 +15,6 @@
 use Swis\JsonApi\Client\Interfaces\DocumentClientInterface as ApiDocumentClientInterface;
 use Swis\JsonApi\Client\Interfaces\ParserInterface;
 use Swis\JsonApi\Client\Interfaces\TypeMapperInterface;
-use Swis\JsonApi\Client\ItemDocumentSerializer;
 use Swis\JsonApi\Client\JsonApi\ErrorsParser;
 use Swis\JsonApi\Client\JsonApi\Hydrator;
 use Swis\JsonApi\Client\JsonApi\Parser;
@@ -84,7 +83,6 @@ function () {
             function (Application $app) {
                 return new ApiDocumentClient(
                     $app->make(ApiClientInterface::class),
-                    new ItemDocumentSerializer(),
                     $app->make(ParserInterface::class)
                 );
             }