Merge pull request #516 from Zolotov88/master

add uses arrays in routes support

Author: shalvah

src/Commands/GenerateDocumentation.php

@@ -6,6 +6,7 @@
 use ReflectionException;
 use Illuminate\Routing\Route;
 use Illuminate\Console\Command;
+use Mpociot\ApiDoc\Tools\Utils;
 use Mpociot\Reflection\DocBlock;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\URL;
@@ -207,7 +208,7 @@ private function processRoutes(Generator $generator, array $routes)
         foreach ($routes as $routeItem) {
             $route = $routeItem['route'];
             /** @var Route $route */
-            if ($this->isValidRoute($route) && $this->isRouteVisibleForDocumentation($route->getAction()['uses'])) {
+            if ($this->isValidRoute($route) && $this->isRouteVisibleForDocumentation($route->getAction())) {
                 $parsedRoutes[] = $generator->processRoute($route, $routeItem['apply']);
                 $this->info('Processed route: ['.implode(',', $generator->getMethods($route)).'] '.$generator->getUri($route));
             } else {
@@ -225,19 +226,24 @@ private function processRoutes(Generator $generator, array $routes)
      */
     private function isValidRoute(Route $route)
     {
-        return ! is_callable($route->getAction()['uses']) && ! is_null($route->getAction()['uses']);
+        $action = Utils::getRouteActionUses($route->getAction());
+        if (is_array($action)) {
+            $action = implode('@', $action);
+        }
+
+        return ! is_callable($action) && ! is_null($action);
     }
 
     /**
-     * @param $route
+     * @param $action
      *
      * @throws ReflectionException
      *
      * @return bool
      */
-    private function isRouteVisibleForDocumentation($route)
+    private function isRouteVisibleForDocumentation($action)
     {
-        list($class, $method) = explode('@', $route);
+        list($class, $method) = Utils::getRouteActionUses($action);
         $reflection = new ReflectionClass($class);
 
         if (! $reflection->hasMethod($method)) {
@@ -250,7 +256,7 @@ private function isRouteVisibleForDocumentation($route)
             $phpdoc = new DocBlock($comment);
 
             return collect($phpdoc->getTags())
-                ->filter(function ($tag) use ($route) {
+                ->filter(function ($tag) use ($action) {
                     return $tag->getName() === 'hideFromAPIDocumentation';
                 })
                 ->isEmpty();

src/Tools/Generator.php

@@ -53,8 +53,7 @@ public function getMethods(Route $route)
      */
     public function processRoute(Route $route, array $rulesToApply = [])
     {
-        $routeAction = $route->getAction();
-        list($class, $method) = explode('@', $routeAction['uses']);
+        list($class, $method) = Utils::getRouteActionUses($route->getAction());
         $controller = new ReflectionClass($class);
         $method = $controller->getMethod($method);
 

src/Tools/Utils.php

@@ -14,6 +14,28 @@ public static function getFullUrl(Route $route, array $bindings = []): string
         return self::replaceUrlParameterBindings($uri, $bindings);
     }
 
+    /**
+     * @param array $action
+     *
+     * @return array|null
+     */
+    public static function getRouteActionUses(array $action)
+    {
+        if ($action['uses'] !== null) {
+            if (is_array($action['uses'])) {
+                return $action['uses'];
+            } elseif (is_string($action['uses'])) {
+                return explode('@', $action['uses']);
+            }
+        }
+        if (array_key_exists(0, $action) && array_key_exists(1, $action)) {
+            return [
+                0 => $action[0],
+                1 => $action[1],
+            ];
+        }
+    }
+
     /**
      * Transform parameters in URLs into real values (/users/{user} -> /users/2).
      * Uses bindings specified by caller, otherwise just uses '1'.

tests/GenerateDocumentationTest.php

@@ -93,6 +93,35 @@ public function console_command_does_not_work_with_closure_using_dingo()
         $this->assertContains('Processed route: [GET] test', $output);
     }
 
+    /** @test */
+    public function console_command_work_with_routes_uses_array()
+    {
+        RouteFacade::get('/api/array/test', [TestController::class, 'withEndpointDescription']);
+
+        config(['apidoc.routes.0.match.prefixes' => ['api/*']]);
+        $output = $this->artisan('apidoc:generate');
+
+        $this->assertNotContains('Skipping route: [GET] api/array/test', $output);
+        $this->assertContains('Processed route: [GET] api/array/test', $output);
+    }
+
+    /** @test */
+    public function console_command_work_with_dingo_routes_uses_array()
+    {
+        $api = app(\Dingo\Api\Routing\Router::class);
+        $api->version('v1', function ($api) {
+            $api->get('/array/dingo/test', [TestController::class, 'withEndpointDescription']);
+        });
+
+        config(['apidoc.router' => 'dingo']);
+        config(['apidoc.routes.0.match.prefixes' => ['*']]);
+        config(['apidoc.routes.0.match.versions' => ['v1']]);
+        $output = $this->artisan('apidoc:generate');
+
+        $this->assertNotContains('Skipping route: [GET] array/dingo/test', $output);
+        $this->assertContains('Processed route: [GET] array/dingo/test', $output);
+    }
+
     /** @test */
     public function can_skip_single_routes()
     {

tests/Unit/DingoGeneratorTest.php

@@ -34,4 +34,16 @@ public function createRoute(string $httpMethod, string $path, string $controller
 
         return $route;
     }
+
+    public function createRouteUsesArray(string $httpMethod, string $path, string $controllerMethod, $register = false)
+    {
+        $route = null;
+        /** @var Router $api */
+        $api = app(Router::class);
+        $api->version('v1', function (Router $api) use ($controllerMethod, $path, $httpMethod, &$route) {
+            $route = $api->$httpMethod($path, [TestController::class, $controllerMethod]);
+        });
+
+        return $route;
+    }
 }

tests/Unit/GeneratorTestCase.php

@@ -600,5 +600,18 @@ public function uses_configured_settings_when_calling_route()
         $this->assertEquals('value', $responseContent['header']);
     }
 
+    /** @test */
+    public function can_use_arrays_in_routes_uses()
+    {
+        $route = $this->createRouteUsesArray('GET', '/api/array/test', 'withEndpointDescription');
+
+        $parsed = $this->generator->processRoute($route);
+
+        $this->assertSame('Example title.', $parsed['title']);
+        $this->assertSame("This will be the long description.\nIt can also be multiple lines long.", $parsed['description']);
+    }
+
     abstract public function createRoute(string $httpMethod, string $path, string $controllerMethod, $register = false);
+
+    abstract public function createRouteUsesArray(string $httpMethod, string $path, string $controllerMethod, $register = false);
 }

tests/Unit/LaravelGeneratorTest.php

@@ -24,4 +24,13 @@ public function createRoute(string $httpMethod, string $path, string $controller
             return new Route([$httpMethod], $path, ['uses' => TestController::class."@$controllerMethod"]);
         }
     }
+
+    public function createRouteUsesArray(string $httpMethod, string $path, string $controllerMethod, $register = false)
+    {
+        if ($register) {
+            return RouteFacade::{$httpMethod}($path, TestController::class."@$controllerMethod");
+        } else {
+            return new Route([$httpMethod], $path, ['uses' => [TestController::class, $controllerMethod]]);
+        }
+    }
 }