[Feature] Support Eloquent morph-one relation

Author: lindyhopchris

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file. This projec
 
 ## Unreleased
 
+### Added
+- [#503](https://github.com/cloudcreativity/laravel-json-api/issues/503)
+The JSON API `hasOne` relation now also supports an Eloquent `morphOne` relation.
+
 ### Changed
 - Minimum Laravel version is now `5.8` (previously `5.5`).
 

docs/basics/adapters.md

@@ -230,6 +230,7 @@ for Eloquent models. The relationship types available are `belongsTo`, `hasOne`,
 | `belongsToMany` | `hasMany` |
 | `hasManyThrough` | `hasManyThrough` |
 | `morphTo` | `belongsTo` |
+| `morphOne` | `hasOne` |
 | `morphMany` | `hasMany` |
 | `morphToMany` | `hasMany` |
 | `morphedByMany` | `morphMany` |
@@ -512,7 +513,7 @@ in user. In this case, you would only ever want resources owned by that user to
 from the client's perspective, any resources belonging to other users do not exist. In this case, a global
 scope would ensure that a `404 Not Found` is returned for resources that belong to other users.
 
-> In contrast, if your API serves a mixture of resources belonging to different users, then 
+> In contrast, if your API serves a mixture of resources belonging to different users, then
 `401 Unauthorized` or `403 Forbidden` responses might be more appropriate when attempting to access other
 users' resources. In this scenario, [Authorizers](./security.md) would be a better approach than global
 scopes.
@@ -610,10 +611,10 @@ class DummyClass extends AbstractResourceAdapter
     {
         // TODO: Implement persist() method.
     }
-  
+
     /**
      * @inheritDoc
-     */  
+     */
     protected function destroy($record)
     {
         // TODO: Implement destroy() method.
@@ -704,15 +705,15 @@ on our adapter:
 class Adapter extends AbstractAdapter
 {
     // ...
-    
+
     protected function creating(Comment $comment): void
     {
         $comment->createdBy()->associate(Auth::user());
     }
 }
 ```
 
-> If your resource uses a [client-generated ID](../crud/creating.md#client-generated-ids), you 
+> If your resource uses a [client-generated ID](../crud/creating.md#client-generated-ids), you
 will need to use the `creating` hook to assign the id to the model.
 
 There are two additional hooks that are invoked when an adapter is deleting a resource: `deleting` and `deleted`.

src/Eloquent/HasOne.php

@@ -41,7 +41,7 @@ public function update($record, array $relationship, EncodingParametersInterface
 
         /** If there is a current related model, we need to clear it. */
         if ($current) {
-            $current->setAttribute($relation->getForeignKeyName(), null)->save();
+            $this->clear($current, $relation);
         }
 
         /** If there is a related model, save it. */
@@ -68,6 +68,25 @@ public function replace($record, array $relationship, EncodingParametersInterfac
      */
     protected function acceptRelation($relation)
     {
-        return $relation instanceof Relations\HasOne;
+        if ($relation instanceof Relations\HasOne) {
+            return true;
+        }
+
+        return $relation instanceof Relations\MorphOne;
+    }
+
+    /**
+     * Clear the relation.
+     *
+     * @param Model $current
+     * @param $relation
+     */
+    private function clear(Model $current, $relation)
+    {
+        if ($relation instanceof Relations\MorphOne) {
+            $current->setAttribute($relation->getMorphType(), null);
+        }
+
+        $current->setAttribute($relation->getForeignKeyName(), null)->save();
     }
 }

tests/dummy/app/Image.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace DummyApp;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
+
+class Image extends Model
+{
+
+    /**
+     * @return MorphTo
+     */
+    public function imageable()
+    {
+        return $this->morphTo();
+    }
+}

tests/dummy/app/JsonApi/Images/Adapter.php

@@ -0,0 +1,63 @@
+<?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 DummyApp\JsonApi\Images;
+
+use CloudCreativity\LaravelJsonApi\Eloquent\AbstractAdapter;
+use CloudCreativity\LaravelJsonApi\Pagination\StandardStrategy;
+use DummyApp\Image;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Support\Collection;
+
+class Adapter extends AbstractAdapter
+{
+
+    /**
+     * Mapping of JSON API attribute field names to model keys.
+     *
+     * @var array
+     */
+    protected $attributes = [];
+
+    /**
+     * Mapping of JSON API filter names to model scopes.
+     *
+     * @var array
+     */
+    protected $filterScopes = [];
+
+    /**
+     * Adapter constructor.
+     *
+     * @param StandardStrategy $paging
+     */
+    public function __construct(StandardStrategy $paging)
+    {
+        parent::__construct(new Image(), $paging);
+    }
+
+    /**
+     * @param Builder $query
+     * @param Collection $filters
+     * @return void
+     */
+    protected function filter($query, Collection $filters)
+    {
+        $this->filterWithScopes($query, $filters);
+    }
+
+}

tests/dummy/app/JsonApi/Images/Schema.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace DummyApp\JsonApi\Images;
+
+use DummyApp\Image;
+use Neomerx\JsonApi\Schema\SchemaProvider;
+
+class Schema extends SchemaProvider
+{
+
+    /**
+     * @var string
+     */
+    protected $resourceType = 'images';
+
+    /**
+     * @param Image $resource
+     *      the domain record being serialized.
+     * @return string
+     */
+    public function getId($resource)
+    {
+        return (string) $resource->getRouteKey();
+    }
+
+    /**
+     * @param Image $resource
+     *      the domain record being serialized.
+     * @return array
+     */
+    public function getAttributes($resource)
+    {
+        return [
+            'created-at' => $resource->created_at->toAtomString(),
+            'updated-at' => $resource->updated_at->toAtomString(),
+            'url' => $resource->url,
+        ];
+    }
+}

tests/dummy/app/JsonApi/Posts/Adapter.php

@@ -21,6 +21,7 @@
 use CloudCreativity\LaravelJsonApi\Eloquent\BelongsTo;
 use CloudCreativity\LaravelJsonApi\Eloquent\Concerns\SoftDeletesModels;
 use CloudCreativity\LaravelJsonApi\Eloquent\HasMany;
+use CloudCreativity\LaravelJsonApi\Eloquent\HasOne;
 use CloudCreativity\LaravelJsonApi\Eloquent\QueriesMany;
 use CloudCreativity\LaravelJsonApi\Eloquent\QueriesOne;
 use CloudCreativity\LaravelJsonApi\Pagination\StandardStrategy;
@@ -88,6 +89,14 @@ protected function comments()
         return $this->hasMany();
     }
 
+    /**
+     * @return HasOne
+     */
+    protected function image()
+    {
+        return $this->hasOne();
+    }
+
     /**
      * @return HasMany
      */

tests/dummy/app/JsonApi/Posts/Schema.php

@@ -44,6 +44,7 @@ class Schema extends EloquentSchema
     protected $relationships = [
         'author',
         'comments',
+        'image',
         'tags',
     ];
 

tests/dummy/app/JsonApi/Posts/Validators.php

@@ -54,6 +54,7 @@ class Validators extends AbstractValidators
         'author',
         'comments',
         'comments.created-by',
+        'image',
         'tags',
     ];
 

tests/dummy/app/Post.php

@@ -21,6 +21,7 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\MorphMany;
+use Illuminate\Database\Eloquent\Relations\MorphOne;
 use Illuminate\Database\Eloquent\Relations\MorphToMany;
 use Illuminate\Database\Eloquent\SoftDeletes;
 
@@ -63,6 +64,14 @@ public function comments()
         return $this->morphMany(Comment::class, 'commentable');
     }
 
+    /**
+     * @return MorphOne
+     */
+    public function image()
+    {
+        return $this->morphOne(Image::class, 'imageable');
+    }
+
     /**
      * @return MorphToMany
      */