Add store contract

Author: lindyhopchris

src/Contracts/Http/Server.php

@@ -17,10 +17,10 @@
 
 namespace LaravelJsonApi\Contracts\Http;
 
+use LaravelJsonApi\Contracts\Encoder\Encoder;
 use LaravelJsonApi\Contracts\Resources\Container as ResourceContainer;
 use LaravelJsonApi\Contracts\Schema\Container as SchemaContainer;
-use LaravelJsonApi\Contracts\Encoder\Encoder;
-use LaravelJsonApi\Core\Store\Store;
+use LaravelJsonApi\Contracts\Store\Store;
 
 interface Server
 {

src/Contracts/Store/Store.php

@@ -0,0 +1,90 @@
+<?php
+/**
+ * Copyright 2020 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace LaravelJsonApi\Contracts\Store;
+
+use Illuminate\Database\Eloquent\Model;
+
+interface Store
+{
+    /**
+     * Get a model by JSON API resource type and id.
+     *
+     * @param string $resourceType
+     * @param string $resourceId
+     * @return Model|mixed|null
+     */
+    public function find(string $resourceType, string $resourceId);
+
+    /**
+     * Does a model exist for the supplied resource type and id?
+     *
+     * @param string $resourceType
+     * @param string $resourceId
+     * @return bool
+     */
+    public function exists(string $resourceType, string $resourceId): bool;
+
+    /**
+     * Query all resources by JSON API resource type.
+     *
+     * @param string $resourceType
+     * @return QueryAllBuilder
+     */
+    public function queryAll(string $resourceType): QueryAllBuilder;
+
+    /**
+     * Query one resource by JSON API resource type.
+     *
+     * @param string $resourceType
+     * @param Model|string $modelOrResourceId
+     * @return QueryOneBuilder
+     */
+    public function queryOne(string $resourceType, $modelOrResourceId): QueryOneBuilder;
+
+    /**
+     * Create a new resource.
+     *
+     * @param string $resourceType
+     * @return ResourceBuilder
+     */
+    public function create(string $resourceType): ResourceBuilder;
+
+    /**
+     * Update an existing resource.
+     *
+     * @param string $resourceType
+     * @param Model|mixed|string $modelOrResourceId
+     * @return ResourceBuilder
+     */
+    public function update(string $resourceType, $modelOrResourceId): ResourceBuilder;
+
+    /**
+     * @param string $resourceType
+     * @param $modelOrResourceId
+     * @return void
+     */
+    public function delete(string $resourceType, $modelOrResourceId): void;
+
+    /**
+     * Access a resource repository by its JSON API resource type.
+     *
+     * @param string $resourceType
+     * @return Repository
+     */
+    public function resources(string $resourceType): Repository;
+}

src/Core/Store/Store.php

@@ -19,7 +19,6 @@
 
 namespace LaravelJsonApi\Core\Store;
 
-use Illuminate\Database\Eloquent\Model;
 use LaravelJsonApi\Contracts\Schema\Container;
 use LaravelJsonApi\Contracts\Store\CreatesResources;
 use LaravelJsonApi\Contracts\Store\DeletesResources;
@@ -29,11 +28,12 @@
 use LaravelJsonApi\Contracts\Store\QueryOneBuilder;
 use LaravelJsonApi\Contracts\Store\Repository;
 use LaravelJsonApi\Contracts\Store\ResourceBuilder;
+use LaravelJsonApi\Contracts\Store\Store as StoreContract;
 use LaravelJsonApi\Contracts\Store\UpdatesResources;
 use LaravelJsonApi\Core\Support\Str;
 use LogicException;
 
-class Store
+class Store implements StoreContract
 {
 
     /**
@@ -64,11 +64,7 @@ public function __call(string $name, $arguments)
     }
 
     /**
-     * Get a model by JSON API resource type and id.
-     *
-     * @param string $resourceType
-     * @param string $resourceId
-     * @return Model|mixed|null
+     * @inheritDoc
      */
     public function find(string $resourceType, string $resourceId)
     {
@@ -78,11 +74,7 @@ public function find(string $resourceType, string $resourceId)
     }
 
     /**
-     * Does a model exist for the supplied resource type and id?
-     *
-     * @param string $resourceType
-     * @param string $resourceId
-     * @return bool
+     * @inheritDoc
      */
     public function exists(string $resourceType, string $resourceId): bool
     {
@@ -92,10 +84,7 @@ public function exists(string $resourceType, string $resourceId): bool
     }
 
     /**
-     * Query all resources by JSON API resource type.
-     *
-     * @param string $resourceType
-     * @return QueryAllBuilder
+     * @inheritDoc
      */
     public function queryAll(string $resourceType): QueryAllBuilder
     {
@@ -109,11 +98,7 @@ public function queryAll(string $resourceType): QueryAllBuilder
     }
 
     /**
-     * Query one resource by JSON API resource type.
-     *
-     * @param string $resourceType
-     * @param Model|string $modelOrResourceId
-     * @return QueryOneBuilder
+     * @inheritDoc
      */
     public function queryOne(string $resourceType, $modelOrResourceId): QueryOneBuilder
     {
@@ -127,10 +112,7 @@ public function queryOne(string $resourceType, $modelOrResourceId): QueryOneBuil
     }
 
     /**
-     * Create a new resource.
-     *
-     * @param string $resourceType
-     * @return ResourceBuilder
+     * @inheritDoc
      */
     public function create(string $resourceType): ResourceBuilder
     {
@@ -144,11 +126,7 @@ public function create(string $resourceType): ResourceBuilder
     }
 
     /**
-     * Update an existing resource.
-     *
-     * @param string $resourceType
-     * @param Model|mixed|string $modelOrResourceId
-     * @return ResourceBuilder
+     * @inheritDoc
      */
     public function update(string $resourceType, $modelOrResourceId): ResourceBuilder
     {
@@ -162,9 +140,7 @@ public function update(string $resourceType, $modelOrResourceId): ResourceBuilde
     }
 
     /**
-     * @param string $resourceType
-     * @param $modelOrResourceId
-     * @return void
+     * @inheritDoc
      */
     public function delete(string $resourceType, $modelOrResourceId): void
     {
@@ -179,10 +155,7 @@ public function delete(string $resourceType, $modelOrResourceId): void
     }
 
     /**
-     * Access a resource repository by its JSON API resource type.
-     *
-     * @param string $resourceType
-     * @return Repository
+     * @inheritDoc
      */
     public function resources(string $resourceType): Repository
     {

src/Http/Controllers/Actions/Destroy.php

@@ -20,8 +20,8 @@
 namespace LaravelJsonApi\Http\Controllers\Actions;
 
 use Illuminate\Http\Response;
-use LaravelJsonApi\Core\Store\Store as ResourceStore;
-use LaravelJsonApi\Routing\Route;
+use LaravelJsonApi\Contracts\Routing\Route;
+use LaravelJsonApi\Contracts\Store\Store as StoreContract;
 
 trait Destroy
 {
@@ -30,10 +30,10 @@ trait Destroy
      * Destroy a resource.
      *
      * @param Route $route
-     * @param ResourceStore $store
+     * @param StoreContract $store
      * @return Response
      */
-    public function destroy(Route $route, ResourceStore $store): Response
+    public function destroy(Route $route, StoreContract $store): Response
     {
         $store->delete(
             $route->resourceType(),

src/Http/Controllers/Actions/FetchMany.php

@@ -20,10 +20,10 @@
 namespace LaravelJsonApi\Http\Controllers\Actions;
 
 use Illuminate\Contracts\Support\Responsable;
+use LaravelJsonApi\Contracts\Routing\Route;
+use LaravelJsonApi\Contracts\Store\Store as StoreContract;
 use LaravelJsonApi\Core\Resources\DataResponse;
-use LaravelJsonApi\Core\Store\Store as ResourceStore;
 use LaravelJsonApi\Http\Requests\ResourceQuery;
-use LaravelJsonApi\Routing\Route;
 
 trait FetchMany
 {
@@ -32,10 +32,10 @@ trait FetchMany
      * Fetch zero to many JSON API resources.
      *
      * @param Route $route
-     * @param ResourceStore $store
+     * @param StoreContract $store
      * @return Responsable
      */
-    public function index(Route $route, ResourceStore $store): Responsable
+    public function index(Route $route, StoreContract $store): Responsable
     {
         $request = ResourceQuery::queryMany(
             $resourceType = $route->resourceType()

src/Http/Controllers/Actions/FetchOne.php

@@ -20,10 +20,10 @@
 namespace LaravelJsonApi\Http\Controllers\Actions;
 
 use Illuminate\Contracts\Support\Responsable;
+use LaravelJsonApi\Contracts\Routing\Route;
+use LaravelJsonApi\Contracts\Store\Store as StoreContract;
 use LaravelJsonApi\Core\Resources\DataResponse;
-use LaravelJsonApi\Core\Store\Store as ResourceStore;
 use LaravelJsonApi\Http\Requests\ResourceQuery;
-use LaravelJsonApi\Routing\Route;
 
 trait FetchOne
 {
@@ -32,10 +32,10 @@ trait FetchOne
      * Fetch one JSON API resource.
      *
      * @param Route $route
-     * @param ResourceStore $store
+     * @param StoreContract $store
      * @return Responsable
      */
-    public function read(Route $route, ResourceStore $store): Responsable
+    public function read(Route $route, StoreContract $store): Responsable
     {
         $request = ResourceQuery::queryOne(
             $resourceType = $route->resourceType()

src/Http/Controllers/Actions/Store.php

@@ -20,11 +20,11 @@
 namespace LaravelJsonApi\Http\Controllers\Actions;
 
 use Illuminate\Contracts\Support\Responsable;
+use LaravelJsonApi\Contracts\Routing\Route;
+use LaravelJsonApi\Contracts\Store\Store as StoreContract;
 use LaravelJsonApi\Core\Resources\DataResponse;
-use LaravelJsonApi\Core\Store\Store as ResourceStore;
 use LaravelJsonApi\Http\Requests\ResourceQuery;
 use LaravelJsonApi\Http\Requests\ResourceRequest;
-use LaravelJsonApi\Routing\Route;
 
 trait Store
 {
@@ -33,10 +33,10 @@ trait Store
      * Create a new resource.
      *
      * @param Route $route
-     * @param ResourceStore $store
+     * @param StoreContract $store
      * @return Responsable
      */
-    public function store(Route $route, ResourceStore $store): Responsable
+    public function store(Route $route, StoreContract $store): Responsable
     {
         $request = ResourceRequest::forResource(
             $resourceType = $route->resourceType()

src/Http/Controllers/Actions/Update.php

@@ -20,11 +20,11 @@
 namespace LaravelJsonApi\Http\Controllers\Actions;
 
 use Illuminate\Contracts\Support\Responsable;
+use LaravelJsonApi\Contracts\Routing\Route;
+use LaravelJsonApi\Contracts\Store\Store as StoreContract;
 use LaravelJsonApi\Core\Resources\DataResponse;
-use LaravelJsonApi\Core\Store\Store as ResourceStore;
 use LaravelJsonApi\Http\Requests\ResourceQuery;
 use LaravelJsonApi\Http\Requests\ResourceRequest;
-use LaravelJsonApi\Routing\Route;
 
 trait Update
 {
@@ -33,10 +33,10 @@ trait Update
      * Update an existing resource.
      *
      * @param Route $route
-     * @param ResourceStore $store
+     * @param StoreContract $store
      * @return Responsable
      */
-    public function update(Route $route, ResourceStore $store): Responsable
+    public function update(Route $route, StoreContract $store): Responsable
     {
         $request = ResourceRequest::forResource(
             $resourceType = $route->resourceType()

src/Http/Server.php

@@ -27,6 +27,7 @@
 use LaravelJsonApi\Contracts\Schema\Container as SchemaContainerContract;
 use LaravelJsonApi\Contracts\Encoder\Encoder;
 use LaravelJsonApi\Contracts\Encoder\Factory as EncoderFactory;
+use LaravelJsonApi\Contracts\Store\Store as StoreContract;
 use LaravelJsonApi\Core\Resources\Container as ResourceContainer;
 use LaravelJsonApi\Core\Resources\Factory as ResourceFactory;
 use LaravelJsonApi\Core\Schema\Container as SchemaContainer;
@@ -118,7 +119,7 @@ public function resources(): ResourceContainerContract
     /**
      * @inheritDoc
      */
-    public function store(): Store
+    public function store(): StoreContract
     {
         return new Store($this->schemas());
     }

src/ServiceProvider.php

@@ -23,9 +23,8 @@
 use Illuminate\Routing\Router;
 use Illuminate\Support\ServiceProvider as BaseServiceProvider;
 use LaravelJsonApi\Contracts;
-use LaravelJsonApi\Encoder\Neomerx\Factory as EncoderFactory;
 use LaravelJsonApi\Core\JsonApiService;
-use LaravelJsonApi\Core\Store\Store;
+use LaravelJsonApi\Encoder\Neomerx\Factory as EncoderFactory;
 use LaravelJsonApi\Http\Middleware\BootJsonApi;
 use LaravelJsonApi\Http\Server;
 use LaravelJsonApi\Http\ServerRepository;
@@ -79,7 +78,7 @@ private function bindHttp(): void
         $this->app->bind(Contracts\Http\Repository::class, ServerRepository::class);
         $this->app->bind(Contracts\Http\Server::class, Server::class);
 
-        $this->app->bind(Store::class, static function (Application $app) {
+        $this->app->bind(Contracts\Store\Store::class, static function (Application $app) {
             return $app->make(Contracts\Http\Server::class)->store();
         });