feat: Includes add method "includes" which return the remaining includes for current resource

Author: Ark4ne

src/Support/Includes.php

@@ -12,7 +12,15 @@ class Includes
 
     private static array $stack = [];
 
-    public static function through(string $type, callable $callable)
+    /**
+     * Defined current resource-type/relation through callback
+     *
+     * @param string   $type
+     * @param callable $callable
+     *
+     * @return mixed
+     */
+    public static function through(string $type, callable $callable): mixed
     {
         try {
             self::$stack[] = $type;
@@ -23,13 +31,41 @@ public static function through(string $type, callable $callable)
         }
     }
 
+    /**
+     * Return remaining includes for current resource
+     *
+     * @param \Illuminate\Http\Request $request
+     *
+     * @return array
+     */
     public static function get(Request $request): array
     {
-        return array_keys(Arr::get(
-            self::parse($request->input('include', '')),
-            implode('.', self::$stack) ?: null,
-            []
-        ));
+        return array_keys(self::currentStack($request));
+    }
+
+    /**
+     * Return if a resource-type/relation is included
+     *
+     * @param \Illuminate\Http\Request $request
+     * @param string                   $type
+     *
+     * @return bool
+     */
+    public static function include(Request $request, string $type): bool
+    {
+        return in_array($type, self::get($request), true);
+    }
+
+    /**
+     * Return remaining includes
+     *
+     * @param \Illuminate\Http\Request $request
+     *
+     * @return array
+     */
+    public static function includes(Request $request): array
+    {
+        return array_keys(Arr::dot(self::currentStack($request)));
     }
 
     public static function parse(string $include): array
@@ -39,8 +75,12 @@ public static function parse(string $include): array
         );
     }
 
-    public static function include(Request $request, string $type): bool
+    private static function currentStack(Request $request): array
     {
-        return in_array($type, self::get($request), true);
+        return Arr::get(
+            self::parse($request->input('include', '')),
+            implode('.', self::$stack) ?: null,
+            []
+        );
     }
 }

tests/Unit/Support/IncludesTest.php

@@ -10,7 +10,7 @@ class IncludesTest extends TestCase
 {
     public $count = 0;
 
-    public function testIncludes()
+    public function testCyclelife()
     {
         $request = new Request([
             'include' => implode(',', [
@@ -97,4 +97,35 @@ public function testParse()
             ],
         ], $parsed);
     }
+
+    public function testIncludes()
+    {
+        $request = new Request([
+            'include' => implode(',', [
+                'user',
+                'posts',
+                'posts.user',
+                'posts.user.comment',
+                'posts',
+                'posts.user',
+                'posts.user.posts',
+                'posts.test',
+            ])
+        ]);
+
+        $this->assertEquals([
+            'user',
+            'posts.user.comment',
+            'posts.user.posts',
+            'posts.test',
+        ], Includes::includes($request));
+
+        Includes::through('posts', function () use ($request) {
+            $this->assertEquals([
+                'user.comment',
+                'user.posts',
+                'test',
+            ], Includes::includes($request));
+        });
+    }
 }