Merge pull request #8 from Lomkit/morph-relationships

Morph relationships

Author: GautierDele

README.md

@@ -76,12 +76,10 @@ TODO
 
 TODO
 
-## Roadmap
+## Roadmap for the end of bêta (Estimated delivery October 2023)
 
-- Morph support
-- Through relation support
 - Custom directives (Filters / sorting)
 - Actions / Metrics
-- Automatic Gates
+- Automatic Gates (with config customisation)
 - Aggregating
 - Automatic documentation with extension possible

src/Concerns/PerformsRestOperations.php

@@ -60,7 +60,6 @@ public function destroy(DestroyRequest $request) {
             $resource->performDelete($request, $model);
         }
 
-        //@TODO: il faut prévoir de pouvoir load des relations ici ?
         return $resource::newResponse()
             ->resource($resource)
             ->responsable($models);

src/Concerns/Relations/HasPivotFields.php

@@ -5,6 +5,7 @@
 trait HasPivotFields
 {
     protected array $pivotFields = [];
+    protected array $pivotRules = [];
 
     public function getPivotFields() {
         return $this->pivotFields;
@@ -15,4 +16,18 @@ public function withPivotFields(array $pivotFields) {
             $this->pivotFields = $pivotFields;
         });
     }
+
+    public function withPivotRules(array $pivotRules) {
+        return tap($this, function () use ($pivotRules) {
+            $this->pivotRules = $pivotRules;
+        });
+    }
+
+    /**
+     * @return array
+     */
+    public function getPivotRules(): array
+    {
+        return $this->pivotRules;
+    }
 }

src/Concerns/Resource/Relationable.php

@@ -19,7 +19,6 @@ public function relation($name) {
             return $relation->relation === $relationName;
         });
 
-        //TODO: be careful here, nested morph relation here are not supported, might need to protect params validator
         if ($isSubRelation && Str::contains($nestedRelation = Str::after($name, '.'), '.')) {
             return $relation->resource()->relation($nestedRelation);
         }

src/Concerns/Resource/Rulable.php

@@ -9,6 +9,10 @@
 
 trait Rulable
 {
+    public function rules(RestRequest $request) {
+        return [];
+    }
+
     public function createRules(RestRequest $request) {
         return [];
     }

src/Http/Requests/MutateRequest.php

@@ -13,6 +13,9 @@
 use Lomkit\Rest\Relations\BelongsToMany;
 use Lomkit\Rest\Relations\HasMany;
 use Lomkit\Rest\Relations\HasManyThrough;
+use Lomkit\Rest\Relations\MorphedByMany;
+use Lomkit\Rest\Relations\MorphMany;
+use Lomkit\Rest\Relations\MorphToMany;
 use Lomkit\Rest\Rules\CustomRulable;
 use Lomkit\Rest\Rules\Includable;
 use Lomkit\Rest\Rules\RequiredRelation;
@@ -70,15 +73,13 @@ protected function relationRules(Resource $resource, string $prefix = '', $loade
         ) {
             $prefixRelation = $prefix.'.'.$relation->relation;
 
-            if ($relation instanceof BelongsToMany || $relation instanceof HasMany || $relation instanceof HasManyThrough) {
+            if ($relation->hasMultipleEntries()) {
                 $prefixRelation .= '.*';
             }
 
             $rules = array_merge_recursive(
                 $rules,
-                [
-                    $prefix.'.'.$relation->relation => $relation->rules($resource)
-                ],
+                $relation->rules($resource, $prefix.'.'.$relation->relation),
                 $this->mutateRules($relation->resource(), $prefixRelation, array_merge($loadedRelations, [$relation->relation]))
             );
         }

src/Query/Traits/PerformSearch.php

@@ -85,7 +85,7 @@ public function sort($field, $direction = 'asc') {
 
     public function applySorts($sorts) {
         foreach ($sorts as $sort) {
-            $this->sort($sort['field'], $sort['direction'] ?? 'asc');
+            $this->sort($this->queryBuilder->getModel()->getTable().'.'.$sort['field'], $sort['direction'] ?? 'asc');
         }
     }
 

src/Relations/BelongsToMany.php

@@ -5,23 +5,55 @@
 use Closure;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Arr;
+use Illuminate\Validation\Rule;
 use Lomkit\Rest\Concerns\Relations\HasPivotFields;
 use Lomkit\Rest\Contracts\QueryBuilder;
 use Lomkit\Rest\Contracts\RelationResource;
+use Lomkit\Rest\Http\Resource;
+use Lomkit\Rest\Relations\Traits\HasMultipleResults;
 
 class BelongsToMany extends Relation implements RelationResource
 {
-    use HasPivotFields;
+    use HasPivotFields, HasMultipleResults;
+
+    public function rules(Resource $resource, string $prefix)
+    {
+        return array_merge(
+            parent::rules($resource, $prefix),
+            [
+                $prefix.'.*.pivot' => [
+                    'prohibited_if:'.$prefix.'.*.operation,detach',
+                    'array:'.Arr::join($this->getPivotFields(), ',')
+                ]
+            ]
+        );
+    }
 
     public function afterMutating(Model $model, Relation $relation, array $mutationRelations)
     {
         foreach ($mutationRelations[$relation->relation] as $mutationRelation) {
-            $model
-                ->{$relation->relation}()
-                ->{$mutationRelation['operation'] === 'detach' ? 'detach' : 'attach'}(
-                    app()->make(QueryBuilder::class, ['resource' => $relation->resource()])
-                        ->applyMutation($mutationRelation)
-                );
+            if ($mutationRelation['operation'] === 'detach') {
+                $model
+                    ->{$relation->relation}()
+                    ->detach(
+                        app()->make(QueryBuilder::class, ['resource' => $relation->resource()])
+                            ->applyMutation($mutationRelation)
+                            ->getKey()
+                    );
+            } else {
+                $model
+                    ->{$relation->relation}()
+                    ->attach(
+                        [
+                            app()->make(QueryBuilder::class, ['resource' => $relation->resource()])
+                                ->applyMutation($mutationRelation)
+                                ->getKey()
+                            =>
+                                $mutationRelation['pivot'] ?? []
+                        ]
+                    );
+            }
         }
     }
 }

src/Relations/HasMany.php

@@ -7,9 +7,12 @@
 use Illuminate\Database\Eloquent\Model;
 use Lomkit\Rest\Contracts\QueryBuilder;
 use Lomkit\Rest\Contracts\RelationResource;
+use Lomkit\Rest\Relations\Traits\HasMultipleResults;
 
 class HasMany extends Relation implements RelationResource
 {
+    use HasMultipleResults;
+
     public function afterMutating(Model $model, Relation $relation, array $mutationRelations)
     {
         foreach ($mutationRelations[$relation->relation] as $mutationRelation) {

src/Relations/HasManyThrough.php

@@ -8,18 +8,21 @@
 use Lomkit\Rest\Contracts\QueryBuilder;
 use Lomkit\Rest\Contracts\RelationResource;
 use Lomkit\Rest\Http\Resource;
+use Lomkit\Rest\Relations\Traits\HasMultipleResults;
 
 class HasManyThrough extends Relation implements RelationResource
 {
+    use HasMultipleResults;
+
     public function afterMutating(Model $model, Relation $relation, array $mutationRelations)
     {
         throw new \RuntimeException('You can\'t mutate a \'HasManyThrough\' relation.');
     }
 
-    public function rules(Resource $resource)
+    public function rules(Resource $resource, string $prefix)
     {
         return [
-            'prohibited'
+            $prefix => 'prohibited'
         ];
     }
 }