Merge pull request #133 from rakutentech/feature/group

Implement group feature

Author: kevincobain2000

README.md

@@ -29,7 +29,7 @@
 - Support for Authorization Headers
 - Display extra documentation using markdown
 - Saves history previous requests
-- Added filters to sort, group and filter routes by methods, controllers, middlewares, routes (also see Roadmap 2.x)
+- Added filters to sort, group and filter routes by methods, controllers, middlewares, routes
 - Export laravel API, routes, rules and documentation to Postman and OpenAPI 3.0.0
 
 # Read on Medium
@@ -156,9 +156,8 @@ Fixing lints
 
 # Roadmap for v2.x
 
-- [DONE] UI renewal
-- [WIP] Introduce groupby controller names, routes, middlewares
-- [WIP] Introduce fetch rules from PHP doc annotations
+- UI renewal
+- Introduce groupby controller names, routes, middlewares
 
 # Changelog
 
@@ -181,5 +180,7 @@ Fixing lints
 - v2.0 UI Renewal to React static
     - `@QAParam` is now `@LRDparam`
     - No special changes for users, upgrade to v2.x as usual
+    - Upgrading users will need to republish config
 - v2.1 UI - adds search bar and few aligment fixes on table
 - v2.2 PHP 8.1 and 8.2 support added
+- v2.3 Groupby enabled for routes and controllers

config/request-docs.php

@@ -37,6 +37,15 @@
     // Can be overridden as // @LRDResponses 200|400|401
     'default_responses' => [ "200", "400", "401", "403", "404", "405", "422", "429", "500", "503"],
 
+    // By default, LRD group your routes by the first /path.
+    // This is a set of regex to group your routes by prefix.
+    'group_by' => [
+        'uri_patterns' => [
+            '^api/v[\d]+/', // `/api/v1/users/store` group as `/api/v1/users`.
+            '^api/',        // `/api/users/store` group as `/api/users`.
+        ]
+    ],
+
     // No need to touch below
     // open api config
     // used to generate open api json

src/Controllers/LaravelRequestDocsController.php

@@ -60,8 +60,6 @@ public function api(Request $request)
             Response::HTTP_OK,
             [
                 'Content-type'=> 'application/json; charset=utf-8',
-                'Cache-Control' => 'public, max-age=60',
-                'Expires' => gmdate('D, d M Y H:i:s \G\M\T', time() + 60),
             ],
             JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE
         );

src/LaravelRequestDocs.php

@@ -2,6 +2,7 @@
 
 namespace Rakutentech\LaravelRequestDocs;
 
+use Illuminate\Support\Collection;
 use Route;
 use ReflectionMethod;
 use ReflectionClass;
@@ -118,11 +119,15 @@ public function filterByMethods($docs, $get, $post, $put, $path, $delete, $head)
 
     public function groupDocs($docs, $group = 'default')
     {
-        if ($group == 'default') {
-            return $docs;
+        if ($group === 'api_uri') {
+            return $this->groupDocsByAPIURI($docs);
+        }
+
+        if ($group === 'controller_full_path') {
+            return $this->groupDocsByFQController($docs);
         }
-        $grouped = [];//unimplemented
-        return $docs;  //unimplemented, returning as it is
+
+        return $docs;
     }
 
     public function getControllersInfo(): array
@@ -363,4 +368,94 @@ private function multiexplode($delimiters, $string)
         $launch = explode($delimiters[0], $ready);
         return  $launch;
     }
+
+    /**
+     * Parse the `$docs['uri']` and attach `group` and `group_index` details.
+     *
+     * @param  array  $docs
+     * @return array  $docs
+     */
+    private function groupDocsByAPIURI(array $docs): array
+    {
+        $patterns = config('request-docs.group_by.uri_patterns', []);
+
+        $regex = count($patterns) > 0 ? '(' . implode('|', $patterns) . ')' : '';
+
+        // A collection<string, int> to remember indexes with `group` => `index` pair.
+        $groupIndexes = collect();
+
+        foreach ($docs as $i => $doc) {
+            if ($regex !== '') {
+                // If $regex    = '^api/v[\d]+/',
+                // and $uri     = '/api/v1/users',
+                // then $prefix = '/api/v1/'.
+                $prefix = Str::match($regex, $doc['uri']);
+            }
+
+            $group = $this->getGroupByURI($prefix ?? '', $doc['uri']);
+            $groupIndexes = $this->rememberGroupIndex($groupIndexes, $group);
+            $docs[$i] = $this->attachGroupInfo($doc, $group, $groupIndexes->get($group));
+        }
+
+        return $docs;
+    }
+
+    /**
+     * Create and return group name by the `$uri`.
+     */
+    private function getGroupByURI(string $prefix, string $uri): string
+    {
+        if ($prefix === '') {
+            // No prefix, create group by the first path.
+            $paths = explode('/', $uri);
+            return $paths[0];
+        }
+
+        // Glue the prefix + "first path after prefix" to form a group.
+        $after = (Str::after($uri, $prefix));
+        $paths = explode('/', $after);
+        return $prefix . $paths[0];
+    }
+
+    /**
+     * Parse the `$docs['controller_full_path']` and attach `group` and `group_index` details.
+     */
+    private function groupDocsByFQController(array $docs): array
+    {
+        // To remember group indexes with group => index pair.
+        $groupIndexes = collect();
+
+        foreach ($docs as $i => $doc) {
+            $group = $doc['controller_full_path'];
+            $groupIndexes = $this->rememberGroupIndex($groupIndexes, $group);
+            $docs[$i] = $this->attachGroupInfo($doc, $group, $groupIndexes->get($group));
+        }
+        return $docs;
+    }
+
+    /**
+     * Set the last index number into `$groupIndexes`
+     *
+     * @param  \Illuminate\Support\Collection<string, int>  $groupIndexes  [`group` => `index`]
+     */
+    private function rememberGroupIndex(Collection $groupIndexes, string $key): Collection
+    {
+        if (!$groupIndexes->has($key)) {
+            $groupIndexes->put($key, 0);
+            return $groupIndexes;
+        }
+
+        $groupIndexes->put($key, $groupIndexes->get($key) + 1);
+        return $groupIndexes;
+    }
+
+    /**
+     * Attach `group` and `group_index` into `$doc`.
+     */
+    private function attachGroupInfo(array $doc, string $group, int $groupIndex): array
+    {
+        $doc['group'] = $group;
+        $doc['group_index'] = $groupIndex;
+        return $doc;
+    }
 }