🐛 morph to relation global usage

Author: Gautier Deleglise

src/Concerns/Resource/Relationable.php

@@ -34,18 +34,6 @@ public function relation($name)
         return $relation;
     }
 
-    /**
-     * Get the resource associated with a relation by name.
-     *
-     * @param string $name
-     *
-     * @return \Lomkit\Rest\Http\Resource
-     */
-    public function relationResource($name)
-    {
-        return $this->relation($name)?->resource();
-    }
-
     /**
      * The calculated relations if already done in this request.
      *

src/Query/Traits/PerformSearch.php

@@ -192,7 +192,7 @@ public function applyInstructions($instructions)
     public function include($include)
     {
         return $this->queryBuilder->with($include['relation'], function (Relation $query) use ($include) {
-            $resource = $this->resource->relationResource($include['relation']);
+            $resource = $this->resource->relation($include['relation'])?->resource();
 
             $queryBuilder = $this->newQueryBuilder(['resource' => $resource, 'query' => $query]);
 
@@ -220,7 +220,7 @@ public function applyIncludes($includes)
     public function aggregate($aggregate)
     {
         return $this->queryBuilder->withAggregate([$aggregate['relation'] => function (Builder $query) use ($aggregate) {
-            $resource = $this->resource->relationResource($aggregate['relation']);
+            $resource = $this->resource->relation($aggregate['relation'])?->resource();
 
             $queryBuilder = $this->newQueryBuilder(['resource' => $resource, 'query' => $query]);
 

src/Relations/MorphTo.php

@@ -2,6 +2,7 @@
 
 namespace Lomkit\Rest\Relations;
 
+use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Validation\Rule;
 use Lomkit\Rest\Contracts\QueryBuilder;
@@ -10,18 +11,6 @@
 
 class MorphTo extends MorphRelation implements RelationResource
 {
-    /**
-     * Create a new MorphTo instance.
-     *
-     * @param string $relation The name of the relation.
-     * @param array  $types    An array of allowed types for the relation.
-     */
-    public function __construct($relation, array $types)
-    {
-        $this->relation = $relation;
-        $this->types = $types;
-    }
-
     /**
      * Perform actions before mutating the MorphTo relation.
      *
@@ -34,29 +23,8 @@ public function beforeMutating(Model $model, Relation $relation, array $mutation
         $model
             ->{$relation->relation}()
             ->{$mutationRelations[$relation->relation]['operation'] === 'detach' ? 'dissociate' : 'associate'}(
-                app()->make(QueryBuilder::class, ['resource' => new $mutationRelations[$relation->relation]['type']()])
+                app()->make(QueryBuilder::class, ['resource' => $relation->resource()])
                     ->applyMutation($mutationRelations[$relation->relation])
             );
     }
-
-    /**
-     * Define validation rules for the MorphTo relation.
-     *
-     * @param resource $resource The resource associated with the relation.
-     * @param string   $prefix   The prefix used for validation rules.
-     *
-     * @return array An array of validation rules.
-     */
-    public function rules(Resource $resource, string $prefix)
-    {
-        return [
-            ...parent::rules($resource, $prefix),
-            $prefix.'.type' => [
-                'required_with:'.$prefix,
-                Rule::in(
-                    $this->types
-                ),
-            ],
-        ];
-    }
 }

src/Relations/Relation.php

@@ -5,6 +5,7 @@
 use Closure;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Support\Str;
+use Illuminate\Validation\Rule;
 use Lomkit\Rest\Concerns\Makeable;
 use Lomkit\Rest\Concerns\Relations\HasPivotFields;
 use Lomkit\Rest\Http\Requests\RestRequest;
@@ -18,7 +19,7 @@ class Relation implements \JsonSerializable
     use Mutates;
     use Constrained;
     public string $relation;
-    protected array $types;
+    protected string $type;
 
     /**
      * The displayable name of the relation.
@@ -32,7 +33,7 @@ class Relation implements \JsonSerializable
     public function __construct($relation, $type)
     {
         $this->relation = $relation;
-        $this->types = [$type];
+        $this->type = $type;
     }
 
     /**
@@ -103,7 +104,7 @@ public function hasMultipleEntries()
      */
     public function resource()
     {
-        $resource = $this->types[0];
+        $resource = $this->type;
 
         // If the resource isn't registered, do it
         if (!app()->has($resource)) {
@@ -164,7 +165,7 @@ public function jsonSerialize(): mixed
         $request = app(RestRequest::class);
 
         return [
-            'resources'   => $this->types,
+            'resource'   => $this->type,
             'relation'    => $this->relation,
             'constraints' => [
                 'required_on_creation'   => $this->isRequiredOnCreation($request),

src/Rules/AggregateField.php

@@ -86,7 +86,7 @@ public function passes($attribute, $value)
      */
     protected function buildValidationRules($attribute, $value)
     {
-        $relationResource = $this->resource->relationResource($value['relation']);
+        $relationResource = $this->resource->relation($value['relation'])?->resource();
 
         if (is_null($relationResource)) {
             return [];

src/Rules/Includable.php

@@ -56,20 +56,18 @@ public function setValidator(\Illuminate\Validation\Validator $validator): stati
      */
     public function validate(string $attribute, mixed $value, Closure $fail): void
     {
-        $relationResource = $this->resource->relationResource($value['relation']);
+        $resource = $this->resource->relation($value['relation'])?->resource();
 
-        if (is_null($relationResource)) {
+        if (is_null($resource)) {
             return;
         }
 
         $this
             ->validator
             ->setRules(
-                is_null($relationResource) ?
-                    [] :
-                    [
-                        $attribute => [new SearchRules($relationResource, app(RestRequest::class), false)],
-                    ]
+                [
+                    $attribute => [new SearchRules($resource, app(RestRequest::class), false)],
+                ]
             )
             ->validate();
     }

src/Rules/NestedRelation.php

@@ -60,7 +60,7 @@ public function validate(string $attribute, mixed $value, Closure $fail): void
         $relationResource = $this->resource;
 
         do {
-            $relationResource = $relationResource->relationResource(Str::before($relation, '.'));
+            $relationResource = $relationResource->relation(Str::before($relation, '.'))?->resource();
 
             if ($relationResource === null) {
                 $fail('The relation is not allowed');

tests/Feature/Controllers/MutateCreateMorphOperationsTest.php

@@ -61,45 +61,6 @@ public function test_creating_a_resource_with_creating_first_morph_to_relation()
         $this->assertNotNull(Model::first()->morph_to_relation_type);
     }
 
-    public function test_creating_a_resource_with_creating_second_morph_to_relation(): void
-    {
-        $modelToCreate = ModelFactory::new()->makeOne();
-
-        Gate::policy(Model::class, GreenPolicy::class);
-        Gate::policy(MorphedByManyRelation::class, GreenPolicy::class);
-
-        $response = $this->post(
-            '/api/models/mutate',
-            [
-                'mutate' => [
-                    [
-                        'operation'  => 'create',
-                        'attributes' => [
-                            'name'   => $modelToCreate->name,
-                            'number' => $modelToCreate->number,
-                        ],
-                        'relations' => [
-                            'morphToRelation' => [
-                                'operation'  => 'create',
-                                'type'       => MorphedByManyResource::class,
-                                'attributes' => [],
-                            ],
-                        ],
-                    ],
-                ],
-            ],
-            ['Accept' => 'application/json']
-        );
-
-        $this->assertMutatedResponse(
-            $response,
-            [$modelToCreate],
-        );
-
-        $this->assertNotNull(Model::first()->morph_to_relation_id);
-        $this->assertNotNull(Model::first()->morph_to_relation_type);
-    }
-
     public function test_creating_a_resource_with_attaching_morph_to_relation(): void
     {
         $modelToCreate = ModelFactory::new()->makeOne();

tests/Feature/Controllers/MutateUpdateMorphOperationsTest.php

@@ -66,7 +66,6 @@ public function test_updating_a_resource_with_creating_morph_to_relation(): void
                         'relations' => [
                             'morphToRelation' => [
                                 'operation'  => 'create',
-                                'type'       => MorphToResource::class,
                                 'attributes' => [],
                             ],
                         ],
@@ -116,7 +115,6 @@ public function test_updating_a_resource_with_attaching_morph_to_relation(): voi
                         'relations' => [
                             'morphToRelation' => [
                                 'operation' => 'attach',
-                                'type'      => MorphToResource::class,
                                 'key'       => $morphToRelationToAttach->getKey(),
                             ],
                         ],
@@ -163,7 +161,6 @@ public function test_updating_a_resource_with_detaching_morph_to_relation(): voi
                         'relations' => [
                             'morphToRelation' => [
                                 'operation' => 'detach',
-                                'type'      => MorphToResource::class,
                                 'key'       => $morphToRelationToDetach->getKey(),
                             ],
                         ],
@@ -205,7 +202,6 @@ public function test_updating_a_resource_with_updating_morph_to_relation(): void
                         'relations' => [
                             'morphToRelation' => [
                                 'operation'  => 'update',
-                                'type'       => MorphToResource::class,
                                 'key'        => $morphToRelationToUpdate->getKey(),
                                 'attributes' => ['number' => 5001], // 5001 because with factory it can't exceed 5000
                             ],

tests/Support/Rest/Resources/ModelResource.php

@@ -64,7 +64,7 @@ public function relations(RestRequest $request): array
             HasManyThrough::make('hasManyThroughRelation', HasManyThroughResource::class),
 
             // Morph relationships
-            MorphTo::make('morphToRelation', [MorphToResource::class, MorphedByManyResource::class]),
+            MorphTo::make('morphToRelation', MorphToResource::class),
             MorphOne::make('morphOneRelation', MorphOneResource::class),
             MorphOneOfMany::make('morphOneOfManyRelation', MorphOneOfManyResource::class),
             MorphMany::make('morphManyRelation', MorphManyResource::class),