Merge branch 'master' of github.com:mpociot/laravel-apidoc-generator

Author: mpociot

src/Mpociot/ApiDoc/Commands/GenerateDocumentation.php

@@ -120,6 +120,7 @@ private function getBindings()
             list($name, $id) = explode(',', $binding);
             $resultBindings[$name] = $id;
         }
+
         return $resultBindings;
     }
 
@@ -128,7 +129,7 @@ private function getBindings()
      */
     private function setUserToBeImpersonated($actAs)
     {
-        if (!empty($actAs)) {
+        if (! empty($actAs)) {
             if (version_compare($this->laravel->version(), '5.2.0', '<')) {
                 $userModel = config('auth.model');
                 $user = $userModel::find($actAs);
@@ -157,6 +158,7 @@ private function getRoutes()
      * @param AbstractGenerator  $generator
      * @param $allowedRoutes
      * @param $routePrefix
+     *
      * @return array
      */
     private function processLaravelRoutes(AbstractGenerator $generator, $allowedRoutes, $routePrefix)
@@ -170,13 +172,15 @@ private function processLaravelRoutes(AbstractGenerator $generator, $allowedRout
                 $this->info('Processed route: '.$route->getUri());
             }
         }
+
         return $parsedRoutes;
     }
 
     /**
      * @param AbstractGenerator $generator
      * @param $allowedRoutes
      * @param $routePrefix
+     *
      * @return array
      */
     private function processDingoRoutes(AbstractGenerator $generator, $allowedRoutes, $routePrefix)
@@ -190,6 +194,7 @@ private function processDingoRoutes(AbstractGenerator $generator, $allowedRoutes
                 $this->info('Processed route: '.$route->uri());
             }
         }
+
         return $parsedRoutes;
     }
 }

src/Mpociot/ApiDoc/Generators/AbstractGenerator.php

@@ -12,9 +12,9 @@
 
 abstract class AbstractGenerator
 {
-
     /**
      * @param Route $route
+     *
      * @return mixed
      */
     abstract protected function getUri(Route $route);
@@ -30,9 +30,11 @@ abstract public function processRoute(Route $route, $bindings = []);
     /**
      * @param array $routeData
      * @param array $routeAction
+     *
      * @return mixed
      */
-    protected function getParameters($routeData, $routeAction) {
+    protected function getParameters($routeData, $routeAction)
+    {
         $validator = Validator::make([], $this->getRouteRules($routeAction['uses']));
         foreach ($validator->getRules() as $attribute => $rules) {
             $attributeData = [
@@ -65,10 +67,10 @@ protected function getRouteResponse(Route $route, $bindings)
         return $this->callRoute(array_shift($methods), $uri);
     }
 
-
     /**
      * @param Route $route
      * @param array $bindings
+     *
      * @return mixed
      */
     protected function addRouteModelBindings(Route $route, $bindings)
@@ -77,6 +79,7 @@ protected function addRouteModelBindings(Route $route, $bindings)
         foreach ($bindings as $model => $id) {
             $uri = str_replace('{'.$model.'}', $id, $uri);
         }
+
         return $uri;
     }
 
@@ -100,7 +103,6 @@ protected function getRouteDescription($route)
         ];
     }
 
-
     /**
      * @param  string  $route
      *
@@ -117,6 +119,7 @@ protected function getRouteGroup($route)
                 return $tag->getContent();
             }
         }
+
         return 'general';
     }
 

src/Mpociot/ApiDoc/Generators/DingoGenerator.php

@@ -4,11 +4,9 @@
 
 use Illuminate\Routing\Route;
 use Illuminate\Support\Facades\App;
-use Illuminate\Support\Facades\Request;
 
 class DingoGenerator extends AbstractGenerator
 {
-
     /**
      * @param  \Illuminate\Routing\Route $route
      * @param array $bindings
@@ -22,15 +20,15 @@ public function processRoute(Route $route, $bindings = [])
         $routeAction = $route->getAction();
         $routeGroup = $this->getRouteGroup($routeAction['uses']);
         $routeDescription = $this->getRouteDescription($routeAction['uses']);
-        
+
         if ($response->headers->get('Content-Type') === 'application/json') {
             $content = json_encode(json_decode($response->getContent()), JSON_PRETTY_PRINT);
         } else {
             $content = $response->getContent();
         }
 
         return $this->getParameters([
-            'resource'    => $routeGroup,
+            'resource' => $routeGroup,
             'title' => $routeDescription['short'],
             'description' => $routeDescription['long'],
             'methods' => $route->getMethods(),
@@ -40,7 +38,6 @@ public function processRoute(Route $route, $bindings = [])
         ], $routeAction);
     }
 
-
     /**
      * {@inheritdoc}
      */
@@ -56,5 +53,4 @@ protected function getUri(Route $route)
     {
         return $route->uri();
     }
-    
-}
+}

src/Mpociot/ApiDoc/Generators/LaravelGenerator.php

@@ -8,9 +8,9 @@
 
 class LaravelGenerator extends AbstractGenerator
 {
-
     /**
      * @param Route $route
+     *
      * @return mixed
      */
     protected function getUri(Route $route)
@@ -27,19 +27,19 @@ protected function getUri(Route $route)
     public function processRoute(Route $route, $bindings = [])
     {
         $response = $this->getRouteResponse($route, $bindings);
-        
+
         $routeAction = $route->getAction();
         $routeGroup = $this->getRouteGroup($routeAction['uses']);
         $routeDescription = $this->getRouteDescription($routeAction['uses']);
-        
+
         if ($response->headers->get('Content-Type') === 'application/json') {
             $content = json_encode(json_decode($response->getContent()), JSON_PRETTY_PRINT);
         } else {
             $content = $response->getContent();
         }
 
         return $this->getParameters([
-            'resource'    => $routeGroup,
+            'resource' => $routeGroup,
             'title' => $routeDescription['short'],
             'description' => $routeDescription['long'],
             'methods' => $route->getMethods(),
@@ -83,5 +83,4 @@ public function callRoute($method, $uri, $parameters = [], $cookies = [], $files
 
         return $response;
     }
-    
-}
+}

tests/ApiDocGeneratorTest.php

@@ -5,7 +5,6 @@
 use Illuminate\Routing\Route;
 use Mpociot\ApiDoc\Generators\LaravelGenerator;
 use Orchestra\Testbench\TestCase;
-use Mpociot\ApiDoc\AbstractGenerator;
 use Mpociot\ApiDoc\Tests\Fixtures\TestRequest;
 use Mpociot\ApiDoc\Tests\Fixtures\TestController;
 use Illuminate\Support\Facades\Route as RouteFacade;