clean up using dtos

Author: mtrajano

src/DataObjects/Middleware.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Mtrajano\LaravelSwagger\DataObjects;
+
+class Middleware
+{
+    private $name;
+    private $parameters;
+
+    public function __construct(string $middleware)
+    {
+        $tokens = explode(':', $middleware, 2);
+        $this->name = $tokens[0];
+        $this->parameters = isset($tokens[1]) ? explode(',', $tokens[1]) : [];
+    }
+
+    public function name()
+    {
+        return $this->name;
+    }
+
+    public function parameters()
+    {
+        return $this->parameters;
+    }
+}

src/DataObjects/Route.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace Mtrajano\LaravelSwagger\DataObjects;
+
+use Illuminate\Routing\Route as LaravelRoute;
+use Illuminate\Support\Arr;
+use Illuminate\Support\Str;
+
+class Route
+{
+    private $route;
+    private $middleware;
+
+    public function __construct(LaravelRoute $route)
+    {
+        $this->route = $route;
+        $this->middleware = $this->formatMiddleware();
+    }
+
+    public function originalUri()
+    {
+        $uri = $this->route->uri();
+
+        if (!Str::startsWith($uri, '/')) {
+            $uri = '/' . $uri;
+        }
+
+        return $uri;
+    }
+
+    public function uri()
+    {
+        return strip_optional_char($this->originalUri());
+    }
+
+    public function middleware()
+    {
+        return $this->middleware;
+    }
+
+    public function action()
+    {
+        return $this->route->getAction()['uses'];
+    }
+
+    public function methods()
+    {
+        return array_map('strtolower', $this->route->methods());
+    }
+
+    protected function formatMiddleware()
+    {
+        $middleware = $this->route->getAction()['middleware'] ?? [];
+
+        return array_map(function ($middleware) {
+            return new Middleware($middleware);
+        }, Arr::wrap($middleware));
+    }
+}

src/Generator.php

@@ -3,9 +3,7 @@
 namespace Mtrajano\LaravelSwagger;
 
 use Illuminate\Foundation\Http\FormRequest;
-use Illuminate\Routing\Route;
 use Illuminate\Support\Str;
-use Illuminate\Support\Arr;
 use phpDocumentor\Reflection\DocBlockFactory;
 use ReflectionMethod;
 
@@ -18,11 +16,8 @@ class Generator
     protected $config;
     protected $routeFilter;
     protected $docs;
-    protected $uri;
-    protected $originalUri;
+    protected $route;
     protected $method;
-    protected $action;
-    protected $middleware;
     protected $docParser;
     protected $hasSecurityDefinitions;
 
@@ -44,26 +39,18 @@ public function generate()
         }
 
         foreach ($this->getAppRoutes() as $route) {
-            $this->originalUri = $uri = $this->getRouteUri($route);
-            $this->uri = strip_optional_char($uri);
+            $this->route = $route;
 
             if ($this->routeFilter && $this->isFilteredRoute()) {
                 continue;
             }
 
-            $middleware = isset($route->getAction()['middleware']) ? $route->getAction()['middleware'] : [];
-
-            $this->action = $route->getAction()['uses'];
-            $this->middleware = $this->formatMiddleware($middleware);
-
-            $methods = $route->methods();
-
-            if (!isset($this->docs['paths'][$this->uri])) {
-                $this->docs['paths'][$this->uri] = [];
+            if (!isset($this->docs['paths'][$this->route->uri()])) {
+                $this->docs['paths'][$this->route->uri()] = [];
             }
 
-            foreach ($methods as $method) {
-                $this->method = strtolower($method);
+            foreach ($route->methods() as $method) {
+                $this->method = $method;
 
                 if (in_array($this->method, $this->config['ignoredMethods'])) {
                     continue;
@@ -108,18 +95,9 @@ protected function getBaseInfo()
 
     protected function getAppRoutes()
     {
-        return app('router')->getRoutes();
-    }
-
-    protected function getRouteUri(Route $route)
-    {
-        $uri = $route->uri();
-
-        if (!Str::startsWith($uri, '/')) {
-            $uri = '/' . $uri;
-        }
-
-        return $uri;
+        return array_map(function ($route) {
+            return new DataObjects\Route($route);
+        }, app('router')->getRoutes()->getRoutes());
     }
 
     protected function generateSecurityDefinitions()
@@ -151,12 +129,12 @@ protected function generateSecurityDefinitions()
 
     protected function generatePath()
     {
-        $actionInstance = is_string($this->action) ? $this->getActionClassInstance($this->action) : null;
+        $actionInstance = is_string($this->route->action()) ? $this->getActionClassInstance($this->route->action()) : null;
         $docBlock = $actionInstance ? ($actionInstance->getDocComment() ?: '') : '';
 
         [$isDeprecated, $summary, $description] = $this->parseActionDocBlock($docBlock);
 
-        $this->docs['paths'][$this->uri][$this->method] = [
+        $this->docs['paths'][$this->route->uri()][$this->method] = [
             'summary' => $summary,
             'description' => $description,
             'deprecated' => $isDeprecated,
@@ -178,7 +156,7 @@ protected function addActionParameters()
     {
         $rules = $this->getFormRules() ?: [];
 
-        $parameters = (new Parameters\PathParameterGenerator($this->originalUri))->getParameters();
+        $parameters = (new Parameters\PathParameterGenerator($this->route->originalUri()))->getParameters();
 
         if (!empty($rules)) {
             $parameterGenerator = $this->getParameterGenerator($rules);
@@ -187,28 +165,28 @@ protected function addActionParameters()
         }
 
         if (!empty($parameters)) {
-            $this->docs['paths'][$this->uri][$this->method]['parameters'] = $parameters;
+            $this->docs['paths'][$this->route->uri()][$this->method]['parameters'] = $parameters;
         }
     }
 
     protected function addActionScopes()
     {
-        foreach ($this->middleware as $middleware) {
-            if ($middleware['name'] === 'scope' || $middleware['name'] === 'scopes') {
-                $this->docs['paths'][$this->uri][$this->method]['security'] = [
-                    self::SECURITY_DEFINITION_NAME => $middleware['parameters']
+        foreach ($this->route->middleware() as $middleware) {
+            if ($middleware->name() === 'scope' || $middleware->name() === 'scopes') {
+                $this->docs['paths'][$this->route->uri()][$this->method]['security'] = [
+                    self::SECURITY_DEFINITION_NAME => $middleware->parameters()
                 ];
             }
         }
     }
 
     protected function getFormRules()
     {
-        if (!is_string($this->action)) {
+        if (!is_string($this->route->action())) {
             return false;
         }
 
-        $parameters = $this->getActionClassInstance($this->action)->getParameters();
+        $parameters = $this->getActionClassInstance($this->route->action())->getParameters();
 
         foreach ($parameters as $parameter) {
             $class = (string) $parameter->getClass();
@@ -260,7 +238,7 @@ private function parseActionDocBlock(string $docBlock)
 
     private function isFilteredRoute()
     {
-        return !preg_match('/^' . preg_quote($this->routeFilter, '/') . '/', $this->uri);
+        return !preg_match('/^' . preg_quote($this->routeFilter, '/') . '/', $this->route->uri());
     }
 
     /**
@@ -269,7 +247,7 @@ private function isFilteredRoute()
     private function hasOauthRoutes()
     {
         foreach ($this->getAppRoutes() as $route) {
-            $uri = $this->getRouteUri($route);
+            $uri = $route->uri();
 
             if ($uri === self::OAUTH_TOKEN_PATH || $uri === self::OAUTH_AUTHORIZE_PATH) {
                 return true;
@@ -301,17 +279,4 @@ private function validateAuthFlow(string $flow)
             throw new LaravelSwaggerException('Invalid OAuth flow passed');
         }
     }
-
-    private function formatMiddleware($middleware)
-    {
-        $middleware = Arr::wrap($middleware);
-
-        return array_map(function($mw) {
-            $tokens = explode(':', $mw, 2);
-            $name = $tokens[0];
-            $parameters = isset($tokens[1]) ? explode(',', $tokens[1]) : [];
-
-            return compact('name', 'parameters');
-        }, $middleware);
-    }
 }

tests/Stubs/Middleware/RandomMiddleware.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Mtrajano\LaravelSwagger\Tests\Stubs\Middleware;
+
+class RandomMiddleware
+{
+    public function handle($request, $next)
+    {
+        return $next($request);
+    }
+}

tests/TestCase.php

@@ -2,8 +2,9 @@
 
 namespace Mtrajano\LaravelSwagger\Tests;
 
-use Orchestra\Testbench\TestCase as OrchestraTestCase;
 use Laravel\Passport\Passport;
+use Mtrajano\LaravelSwagger\Tests\Stubs\Middleware\RandomMiddleware;
+use Orchestra\Testbench\TestCase as OrchestraTestCase;
 
 class TestCase extends OrchestraTestCase
 {
@@ -25,7 +26,8 @@ protected function getEnvironmentSetUp($app)
             });
         });
 
-        $app['router']->get('/api', 'Mtrajano\\LaravelSwagger\\Tests\\Stubs\\Controllers\\ApiController@index');
+        $app['router']->get('/api', 'Mtrajano\\LaravelSwagger\\Tests\\Stubs\\Controllers\\ApiController@index')
+            ->middleware(RandomMiddleware::class);
         $app['router']->put('/api/store', 'Mtrajano\\LaravelSwagger\\Tests\\Stubs\\Controllers\\ApiController@store');
 
         Passport::routes();