Move responses to own namespace

Author: lindyhopchris

src/Contracts/Http/Server.php

@@ -21,6 +21,7 @@
 use LaravelJsonApi\Contracts\Resources\Container as ResourceContainer;
 use LaravelJsonApi\Contracts\Schema\Container as SchemaContainer;
 use LaravelJsonApi\Contracts\Store\Store;
+use LaravelJsonApi\Core\Document\JsonApi;
 
 interface Server
 {
@@ -38,6 +39,13 @@ public function serving(): void;
      */
     public function name(): string;
 
+    /**
+     * Get the server's JSON API object.
+     *
+     * @return JsonApi
+     */
+    public function jsonApi(): JsonApi;
+
     /**
      * Get the server's schemas.
      *

src/Core/Document/ErrorList.php

@@ -24,6 +24,7 @@
 use Illuminate\Http\Response;
 use IteratorAggregate;
 use LaravelJsonApi\Contracts\Serializable;
+use LaravelJsonApi\Core\Responses\ErrorResponse;
 use LogicException;
 use function array_merge;
 use function collect;

src/Core/Pagination/Page.php

@@ -26,7 +26,7 @@
 use LaravelJsonApi\Contracts\Pagination\Page as PageContract;
 use LaravelJsonApi\Core\Document\Link;
 use LaravelJsonApi\Core\Document\Links;
-use LaravelJsonApi\Core\Resources\PaginatedResourceResponse;
+use LaravelJsonApi\Core\Responses\PaginatedResourceResponse;
 use function array_filter;
 use function collect;
 use function count;
@@ -258,12 +258,21 @@ public function count()
         return count($this->paginator);
     }
 
+    /**
+     * @param $request
+     * @return PaginatedResourceResponse
+     */
+    public function prepareResponse($request): PaginatedResourceResponse
+    {
+        return new PaginatedResourceResponse($this);
+    }
+
     /**
      * @inheritDoc
      */
     public function toResponse($request)
     {
-        return (new PaginatedResourceResponse($this))->toResponse($request);
+        return $this->prepareResponse($request)->toResponse($request);
     }
 
     /**

src/Core/Resources/JsonApiResource.php

@@ -27,6 +27,7 @@
 use LaravelJsonApi\Core\Document\Links;
 use LaravelJsonApi\Core\Document\ResourceIdentifier;
 use LaravelJsonApi\Core\Resources\Concerns\ConditionallyLoadsAttributes;
+use LaravelJsonApi\Core\Responses\ResourceResponse;
 use LogicException;
 use function sprintf;
 

src/Core/Resources/ResourceCollection.php

@@ -27,13 +27,13 @@
 use LaravelJsonApi\Contracts\Pagination\Page as PageContract;
 use LaravelJsonApi\Core\Document\Links;
 use LaravelJsonApi\Core\Pagination\Page;
+use LaravelJsonApi\Core\Responses\PaginatedResourceResponse;
+use LaravelJsonApi\Core\Responses\ResourceCollectionResponse;
 use function count;
 
 class ResourceCollection implements Responsable, IteratorAggregate, Countable
 {
 
-    use Concerns\CreatesResponse;
-
     /**
      * @var iterable|PageContract
      */

src/Core/Resources/Concerns/CreatesResponse.php renamed to src/Core/Responses/Concerns/IsResponsable.php

@@ -17,17 +17,25 @@
 
 declare(strict_types=1);
 
-namespace LaravelJsonApi\Core\Resources\Concerns;
+namespace LaravelJsonApi\Core\Responses\Concerns;
 
 use Illuminate\Http\Request;
+use LaravelJsonApi\Core\Document\JsonApi;
+use LaravelJsonApi\Core\Document\Link;
 use LaravelJsonApi\Core\Document\Links;
+use LaravelJsonApi\Core\Facades\JsonApi as JsonApiFacade;
 use LaravelJsonApi\Core\Json\Hash;
 use LaravelJsonApi\Core\Query\FieldSets;
 use LaravelJsonApi\Core\Query\IncludePaths;
 
-trait CreatesResponse
+trait IsResponsable
 {
 
+    /**
+     * @var JsonApi|null
+     */
+    private ?JsonApi $jsonApi = null;
+
     /**
      * @var Hash|null
      */
@@ -44,9 +52,34 @@ trait CreatesResponse
     private int $encodeOptions = 0;
 
     /**
-     * @var array|null
+     * @var array
      */
-    private ?array $headers = null;
+    private array $headers = [];
+
+    /**
+     * Add the top-level JSON API member to the response.
+     *
+     * @param $jsonApi
+     * @return $this
+     */
+    public function withJsonApi($jsonApi): self
+    {
+        $this->jsonApi = JsonApi::cast($jsonApi);
+
+        return $this;
+    }
+
+    /**
+     * @return JsonApi
+     */
+    public function jsonApi(): JsonApi
+    {
+        if ($this->jsonApi) {
+            return $this->jsonApi;
+        }
+
+        return $this->jsonApi = JsonApiFacade::server()->jsonApi();
+    }
 
     /**
      * Add top-level meta to the response.
@@ -61,6 +94,18 @@ public function withMeta($meta): self
         return $this;
     }
 
+    /**
+     * @return Hash
+     */
+    public function meta(): Hash
+    {
+        if ($this->meta) {
+            return $this->meta;
+        }
+
+        return $this->meta = new Hash();
+    }
+
     /**
      * Add top-level links to the response.
      *
@@ -74,6 +119,18 @@ public function withLinks($links): self
         return $this;
     }
 
+    /**
+     * @return Links
+     */
+    public function links(): Links
+    {
+        if ($this->links) {
+            return $this->links;
+        }
+
+        return $this->links = new Links();
+    }
+
     /**
      * Set JSON encode options.
      *

src/Core/Resources/DataResponse.php renamed to src/Core/Responses/DataResponse.php

@@ -17,19 +17,21 @@
 
 declare(strict_types=1);
 
-namespace LaravelJsonApi\Core\Resources;
+namespace LaravelJsonApi\Core\Responses;
 
 use Illuminate\Contracts\Support\Responsable;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Http\Request;
 use LaravelJsonApi\Contracts\Pagination\Page;
 use LaravelJsonApi\Core\Facades\JsonApi;
+use LaravelJsonApi\Core\Resources\JsonApiResource;
+use LaravelJsonApi\Core\Resources\ResourceCollection;
 use function is_null;
 
 class DataResponse implements Responsable
 {
 
-    use Concerns\CreatesResponse;
+    use Concerns\IsResponsable;
 
     /**
      * @var Page|Model|iterable|null
@@ -50,7 +52,34 @@ public function __construct($value)
      * @param Request $request
      * @return ResourceCollectionResponse|ResourceResponse
      */
-    public function prepareResponse($request)
+    public function prepareResponse($request): Responsable
+    {
+        return $this
+            ->prepareDataResponse($request)
+            ->withJsonApi($this->jsonApi())
+            ->withMeta($this->meta)
+            ->withLinks($this->links)
+            ->withEncodeOptions($this->encodeOptions)
+            ->withHeaders($this->headers);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function toResponse($request)
+    {
+        return $this
+            ->prepareResponse($request)
+            ->toResponse($request);
+    }
+
+    /**
+     * Convert the data member to a response class.
+     *
+     * @param $request
+     * @return PaginatedResourceResponse|ResourceCollectionResponse|ResourceResponse
+     */
+    private function prepareDataResponse($request)
     {
         if ($this->value instanceof Page) {
             return new PaginatedResourceResponse($this->value);
@@ -71,18 +100,4 @@ public function prepareResponse($request)
         return (new ResourceCollection($parsed))->prepareResponse($request);
     }
 
-    /**
-     * @inheritDoc
-     */
-    public function toResponse($request)
-    {
-        return $this
-            ->prepareResponse($request)
-            ->withMeta($this->meta)
-            ->withLinks($this->links)
-            ->withEncodeOptions($this->encodeOptions)
-            ->withHeaders((array) $this->headers)
-            ->toResponse($request);
-    }
-
 }

src/Core/Document/ErrorResponse.php renamed to src/Core/Responses/ErrorResponse.php

@@ -17,15 +17,20 @@
 
 declare(strict_types=1);
 
-namespace LaravelJsonApi\Core\Document;
+namespace LaravelJsonApi\Core\Responses;
 
 use Illuminate\Contracts\Support\Responsable;
-use LaravelJsonApi\Contracts\Serializable;
+use LaravelJsonApi\Contracts\Serializable as SerializableContract;
+use LaravelJsonApi\Core\Document\Concerns\Serializable;
+use LaravelJsonApi\Core\Document\Error;
+use LaravelJsonApi\Core\Document\ErrorList;
+use LaravelJsonApi\Core\Responses\Concerns\IsResponsable;
 
-class ErrorResponse implements Serializable, Responsable
+class ErrorResponse implements SerializableContract, Responsable
 {
 
-    use Concerns\Serializable;
+    use IsResponsable;
+    use Serializable;
 
     /**
      * @var ErrorList
@@ -37,16 +42,6 @@ class ErrorResponse implements Serializable, Responsable
      */
     private ?int $status = null;
 
-    /**
-     * @var array
-     */
-    private array $headers = [];
-
-    /**
-     * @var int
-     */
-    private int $encodeOptions = 0;
-
     /**
      * ErrorResponse constructor.
      *
@@ -57,32 +52,6 @@ public function __construct($errors)
         $this->errors = ErrorList::cast($errors);
     }
 
-    /**
-     * Set JSON encode options.
-     *
-     * @param int $options
-     * @return $this
-     */
-    public function withEncodeOptions(int $options): self
-    {
-        $this->encodeOptions = $options;
-
-        return $this;
-    }
-
-    /**
-     * Set response headers.
-     *
-     * @param array $headers
-     * @return $this
-     */
-    public function withHeaders(array $headers): self
-    {
-        $this->headers = $headers;
-
-        return $this;
-    }
-
     /**
      * Set the response status.
      *
@@ -116,19 +85,25 @@ public function toResponse($request)
      */
     public function toArray()
     {
-        return [
-            'errors' => $this->errors->toArray(),
-        ];
+        return array_filter([
+            'jsonapi' => $this->jsonApi()->toArray() ?: null,
+            'meta' => $this->meta()->toArray() ?: null,
+            'links' => $this->links->toArray() ?: null,
+            'errors' => $this->errors,
+        ]);
     }
 
     /**
      * @inheritDoc
      */
     public function jsonSerialize()
     {
-        return [
+        return array_filter([
+            'jsonapi' => $this->jsonApi()->jsonSerialize(),
+            'meta' => $this->meta()->jsonSerialize(),
+            'links' => $this->links()->jsonSerialize(),
             'errors' => $this->errors,
-        ];
+        ]);
     }
 
 }

src/Core/Resources/PaginatedResourceResponse.php renamed to src/Core/Responses/PaginatedResourceResponse.php

@@ -17,14 +17,16 @@
 
 declare(strict_types=1);
 
-namespace LaravelJsonApi\Core\Resources;
+namespace LaravelJsonApi\Core\Responses;
 
 use Illuminate\Contracts\Pagination\Paginator;
 use InvalidArgumentException;
 use LaravelJsonApi\Contracts\Pagination\Page as PageContract;
 use LaravelJsonApi\Core\Document\Links;
 use LaravelJsonApi\Core\Json\Hash;
 use LaravelJsonApi\Core\Pagination\Page;
+use LaravelJsonApi\Core\Resources\ResourceCollection;
+use LaravelJsonApi\Core\Responses\ResourceCollectionResponse;
 
 class PaginatedResourceResponse extends ResourceCollectionResponse
 {