feat: recursive nested relationships

Author: alexzarbn

src/Contracts/RelationsResolver.php

@@ -23,7 +23,7 @@ public function relationForeignKeyFromRelationInstance(Relation $relationInstanc
 
     public function relationLocalKeyFromRelationInstance(Relation $relationInstance): string;
 
-    public function guardRelationsForCollection(Collection $entities, array $requestedRelations, bool $normalized = false): Collection;
+    public function guardRelationsForCollection(Collection $entities, array $requestedRelations, ?string $parentRelation = null, bool $normalized = false): Collection;
 
-    public function guardRelations(Model $entity, array $requestedRelations, bool $normalized = false);
+    public function guardRelations(Model $entity, array $requestedRelations, ?string $parentRelation = null, bool $normalized = false);
 }

src/Drivers/Standard/RelationsResolver.php

@@ -115,7 +115,10 @@ public function relationForeignKeyFromRelationInstance(Relation $relationInstanc
     {
         $laravelVersion = (float)app()->version();
 
-        return $laravelVersion > 5.7 || get_class($relationInstance) === HasOne::class ? $relationInstance->getQualifiedForeignKeyName() : $relationInstance->getQualifiedForeignKey();
+        return $laravelVersion > 5.7 || get_class(
+            $relationInstance
+        ) === HasOne::class ? $relationInstance->getQualifiedForeignKeyName(
+        ) : $relationInstance->getQualifiedForeignKey();
     }
 
     /**
@@ -129,15 +132,12 @@ public function relationLocalKeyFromRelationInstance(Relation $relationInstance)
         switch (get_class($relationInstance)) {
             case HasOne::class:
             case MorphOne::class:
-                return $relationInstance->getParent()->getTable().'.'.$relationInstance->getLocalKeyName();
-                break;
+                return $relationInstance->getParent()->getTable() . '.' . $relationInstance->getLocalKeyName();
             case BelongsTo::class:
             case MorphTo::class:
                 return $relationInstance->getQualifiedOwnerKeyName();
-                break;
             default:
                 return $relationInstance->getQualifiedLocalKeyName();
-                break;
         }
     }
 
@@ -146,14 +146,19 @@ public function relationLocalKeyFromRelationInstance(Relation $relationInstance)
      *
      * @param Collection $entities
      * @param array $requestedRelations
+     * @param string|null $parentRelation
      * @param bool $normalized
      * @return Collection
      */
-    public function guardRelationsForCollection(Collection $entities, array $requestedRelations, bool $normalized = false): Collection
-    {
+    public function guardRelationsForCollection(
+        Collection $entities,
+        array $requestedRelations,
+        ?string $parentRelation = null,
+        bool $normalized = false
+    ): Collection {
         return $entities->transform(
-            function ($entity) use ($requestedRelations, $normalized) {
-                return $this->guardRelations($entity, $requestedRelations, $normalized);
+            function ($entity) use ($requestedRelations, $parentRelation, $normalized) {
+                return $this->guardRelations($entity, $requestedRelations, $parentRelation, $normalized);
             }
         );
     }
@@ -163,11 +168,16 @@ function ($entity) use ($requestedRelations, $normalized) {
      *
      * @param Model $entity
      * @param array $requestedRelations
+     * @param string|null $parentRelation
      * @param bool $normalized
      * @return Model
      */
-    public function guardRelations(Model $entity, array $requestedRelations, bool $normalized = false): Model
-    {
+    public function guardRelations(
+        Model $entity,
+        array $requestedRelations,
+        ?string $parentRelation = null,
+        bool $normalized = false
+    ): Model {
         if (!$normalized) {
             $requestedRelations = $this->normalizeRequestedRelations($requestedRelations);
         }
@@ -176,17 +186,27 @@ public function guardRelations(Model $entity, array $requestedRelations, bool $n
         ksort($relations);
 
         foreach ($relations as $relationName => $relation) {
-            if ($relationName === 'pivot') {
+            if ($relationName === 'pivot' || $relationName === $parentRelation) {
                 continue;
             }
 
             if (!array_key_exists($relationName, $requestedRelations)) {
                 unset($relations[$relationName]);
             } elseif ($relation !== null) {
                 if ($relation instanceof Model) {
-                    $relation = $this->guardRelations($relation, $requestedRelations[$relationName], true);
+                    $relation = $this->guardRelations(
+                        $relation,
+                        $requestedRelations[$relationName],
+                        $relationName,
+                        true
+                    );
                 } else {
-                    $relation = $this->guardRelationsForCollection($relation, $requestedRelations[$relationName], true);
+                    $relation = $this->guardRelationsForCollection(
+                        $relation,
+                        $requestedRelations[$relationName],
+                        $relationName,
+                        true
+                    );
                 }
             }
         }

tests/Unit/Drivers/Standard/RelationsResolverTest.php

@@ -4,6 +4,7 @@
 
 use Orion\Drivers\Standard\RelationsResolver;
 use Orion\Http\Requests\Request;
+use Orion\Tests\Fixtures\App\Models\Category;
 use Orion\Tests\Fixtures\App\Models\Company;
 use Orion\Tests\Fixtures\App\Models\Post;
 use Orion\Tests\Fixtures\App\Models\Team;
@@ -85,6 +86,35 @@ public function guarding_entity_nested_relations()
     {
         $post = new Post(['title' => 'test post']);
 
+        $parentCategory = new Category(['name' => 'parent category']); // categories
+        $childCategory = new Category(['name' => 'child category']); // categories.categories
+        $nestedChildCategory = new Category(['name' => 'nested child category']); // categories.categories.categories
+
+        $childCategory->setRelation('categories', collect([$nestedChildCategory]));
+        $parentCategory->setRelation('categories', collect([$childCategory]));
+
+        $post->setRelations(
+            [
+                'categories' => collect([$parentCategory]),
+            ]
+        );
+
+        $relationsResolver = new RelationsResolver(['categories'], []);
+        $guardedPost = $relationsResolver->guardRelations($post, ['categories']);
+
+        self::assertArrayHasKey('categories', $guardedPost->getRelations());
+        self::assertArrayHasKey('categories', $guardedPost->getRelation('categories')->first()->getRelations());
+        self::assertArrayHasKey(
+            'categories',
+            $guardedPost->getRelation('categories')->first()->getRelation('categories')->first()->getRelations()
+        );
+    }
+
+    /** @test */
+    public function guarding_entity_recursive_nested_relations()
+    {
+        $post = new Post(['title' => 'test post']);
+
         $manager = new User(['name' => 'manager user']);
 
         $team = new Team(['name' => 'test team']);
@@ -102,7 +132,10 @@ public function guarding_entity_nested_relations()
         );
 
         $relationsResolver = new RelationsResolver(['user', 'editors.team.users', 'editors.team.company'], []);
-        $guardedPost = $relationsResolver->guardRelations($post, ['user', 'editors.team.users', 'editors.team.company']);
+        $guardedPost = $relationsResolver->guardRelations(
+            $post,
+            ['user', 'editors.team.users', 'editors.team.company']
+        );
 
         self::assertArrayHasKey('user', $guardedPost->getRelations());
         self::assertArrayHasKey('editors', $guardedPost->getRelations());
@@ -159,4 +192,4 @@ public function resolving_deep_relation_from_param_constraint(): void
 
         self::assertSame('user.posts', $relation);
     }
-}
+}