mpociot / laravel-apidoc-generator

src/Generators/LaravelGenerator.php

Doc Comments -1 removed lines

@@ -41,7 +41,6 @@
     /**
      * Prepares / Disables route middlewares.
      *
-     * @param  bool $disable
      *
      * @return  void
      */

Spacing +1 added lines, -1 removed lines

@@ -57,7 +57,7 @@
      */
     public function prepareMiddleware($enable = true)
     {
-        App::instance('middleware.disable', ! $enable);
+        App::instance('middleware.disable', !$enable);
     }
 
     /**

src/Generators/DingoGenerator.php

Spacing +1 added lines, -1 removed lines

@@ -25,7 +25,7 @@
     {
         $dispatcher = app('Dingo\Api\Dispatcher')->raw();
 
-        collect($server)->map(function ($key, $value) use ($dispatcher) {
+        collect($server)->map(function($key, $value) use ($dispatcher) {
             $dispatcher->header($value, $key);
         });
 

src/Commands/UpdateDocumentation.php

Spacing +3 added lines, -3 removed lines

@@ -44,8 +44,8 @@ 
 
         $documentarian = new Documentarian();
 
-        if (! is_dir($outputPath)) {
-            $this->error('There is no generated documentation available at '.$outputPath.'.');
+        if (!is_dir($outputPath)) {
+            $this->error('There is no generated documentation available at ' . $outputPath . '.');
 
             return false;
         }
@@ -53,6 +53,6 @@ 
 
         $documentarian->generate($outputPath);
 
-        $this->info('Wrote HTML documentation to: '.$outputPath.'/index.html');
+        $this->info('Wrote HTML documentation to: ' . $outputPath . '/index.html');
     }
 }

src/Postman/CollectionWriter.php

Spacing +3 added lines, -3 removed lines

@@ -32,11 +32,11 @@ 
                 'description' => '',
                 'schema' => 'https://schema.getpostman.com/json/collection/v2.0.0/collection.json',
             ],
-            'item' => $this->routeGroups->map(function ($routes, $groupName) {
+            'item' => $this->routeGroups->map(function($routes, $groupName) {
                 return [
                     'name' => $groupName,
                     'description' => '',
-                    'item' => $routes->map(function ($route) {
+                    'item' => $routes->map(function($route) {
                         return [
                             'name' => $route['title'] != '' ? $route['title'] : url($route['uri']),
                             'request' => [
@@ -44,7 +44,7 @@ 
                                 'method' => $route['methods'][0],
                                 'body' => [
                                     'mode' => 'formdata',
-                                    'formdata' => collect($route['parameters'])->map(function ($parameter, $key) {
+                                    'formdata' => collect($route['parameters'])->map(function($parameter, $key) {
                                         return [
                                             'key' => $key,
                                             'value' => isset($parameter['value']) ? $parameter['value'] : '',

src/Tools/RouteMatcher.php

Spacing +3 added lines, -3 removed lines

@@ -48,14 +48,14 @@ 
 
     private function getAllRoutes(bool $usingDingoRouter, array $versions = [])
     {
-        if (! $usingDingoRouter) {
+        if (!$usingDingoRouter) {
             return RouteFacade::getRoutes();
         }
 
         $allRouteCollections = app(\Dingo\Api\Routing\Router::class)->getRoutes();
 
         return collect($allRouteCollections)
-            ->flatMap(function (RouteCollection $collection) {
+            ->flatMap(function(RouteCollection $collection) {
                 return $collection->getRoutes();
             })->toArray();
     }
@@ -63,7 +63,7 @@ 
     private function shouldIncludeRoute(Route $route, array $routeRule, array $mustIncludes, bool $usingDingoRouter)
     {
         $matchesVersion = $usingDingoRouter
-            ? ! empty(array_intersect($route->versions(), $routeRule['match']['versions'] ?? []))
+            ? !empty(array_intersect($route->versions(), $routeRule['match']['versions'] ?? []))
             : true;
 
         return in_array($route->getName(), $mustIncludes)

src/ApiDocGeneratorServiceProvider.php

Spacing +4 added lines, -4 removed lines

@@ -15,17 +15,17 @@
      */
     public function boot()
     {
-        $this->loadViewsFrom(__DIR__.'/../resources/views/', 'apidoc');
+        $this->loadViewsFrom(__DIR__ . '/../resources/views/', 'apidoc');
 
         $this->publishes([
-            __DIR__.'/../resources/views' => app()->basePath().'/resources/views/vendor/apidoc',
+            __DIR__ . '/../resources/views' => app()->basePath() . '/resources/views/vendor/apidoc',
         ], 'views');
 
         $this->publishes([
-            __DIR__.'/../config/apidoc.php' => config_path('apidoc.php'),
+            __DIR__ . '/../config/apidoc.php' => config_path('apidoc.php'),
         ], 'config');
 
-        $this->mergeConfigFrom(__DIR__.'/../config/apidoc.php', 'apidoc');
+        $this->mergeConfigFrom(__DIR__ . '/../config/apidoc.php', 'apidoc');
 
         if ($this->app->runningInConsole()) {
             $this->commands([

src/Generators/AbstractGenerator.php

Doc Comments +6 added lines, -5 removed lines

@@ -27,7 +27,7 @@ 
     /**
      * @param Route $route
      *
-     * @return mixed
+     * @return string
      */
     public function getUri(Route $route)
     {
@@ -46,7 +46,6 @@ 
 
     /**
      * @param  \Illuminate\Routing\Route $route
-     * @param array $apply Rules to apply when generating documentation for this route
      *
      * @return array
      */
@@ -73,7 +72,6 @@ 
     /**
      * Prepares / Disables route middlewares.
      *
-     * @param  bool $disable
      *
      * @return  void
      */
@@ -168,7 +166,7 @@ 
      * @param $route
      * @param array $bindings
      *
-     * @return mixed
+     * @return string
      */
     protected function addRouteModelBindings($route, $bindings)
     {
@@ -184,7 +182,7 @@ 
     /**
      * @param  \Illuminate\Routing\Route  $route
      *
-     * @return array
+     * @return Route
      */
     protected function parseDocBlock($route)
     {
@@ -392,6 +390,9 @@ 
         return $content;
     }
 
+    /**
+     * @return string
+     */
     private function normalizeParameterType($type)
     {
         $typeMap = [

Spacing +24 added lines, -24 removed lines

@@ -58,7 +58,7 @@ 
         $content = $this->getResponse($docBlock['tags']);
 
         return [
-            'id' => md5($this->getUri($route).':'.implode($this->getMethods($route))),
+            'id' => md5($this->getUri($route) . ':' . implode($this->getMethods($route))),
             'resource' => $routeGroup,
             'title' => $docBlock['short'],
             'description' => $docBlock['long'],
@@ -66,7 +66,7 @@ 
             'uri' => $this->getUri($route),
             'parameters' => $this->getParametersFromDocBlock($docBlock['tags']),
             'response' => $content,
-            'showresponse' => ! empty($content),
+            'showresponse' => !empty($content),
         ];
     }
 
@@ -88,7 +88,7 @@ 
      */
     protected function getDocblockResponse($tags)
     {
-        $responseTags = array_filter($tags, function ($tag) {
+        $responseTags = array_filter($tags, function($tag) {
             return $tag instanceof Tag && \strtolower($tag->getName()) == 'response';
         });
         if (empty($responseTags)) {
@@ -107,10 +107,10 @@ 
     protected function getParametersFromDocBlock($tags)
     {
         $parameters = collect($tags)
-            ->filter(function ($tag) {
+            ->filter(function($tag) {
                 return $tag instanceof Tag && $tag->getName() === 'bodyParam';
             })
-            ->mapWithKeys(function ($tag) {
+            ->mapWithKeys(function($tag) {
                 preg_match('/(.+?)\s+(.+?)\s+(required\s+)?(.*)/', $tag->getContent(), $content);
                 if (empty($content)) {
                     // this means only name and type were supplied
@@ -150,7 +150,7 @@ 
         $methods = $this->getMethods($route);
 
         // Split headers into key - value pairs
-        $headers = collect($headers)->map(function ($value) {
+        $headers = collect($headers)->map(function($value) {
             $split = explode(':', $value); // explode to get key + values
             $key = array_shift($split); // extract the key and keep the values in the array
             $value = implode(':', $split); // implode values into string again
@@ -174,8 +174,8 @@ 
     {
         $uri = $this->getUri($route);
         foreach ($bindings as $model => $id) {
-            $uri = str_replace('{'.$model.'}', $id, $uri);
-            $uri = str_replace('{'.$model.'?}', $id, $uri);
+            $uri = str_replace('{' . $model . '}', $id, $uri);
+            $uri = str_replace('{' . $model . '?}', $id, $uri);
         }
 
         return $uri;
@@ -254,8 +254,8 @@ 
         foreach ($headers as $name => $value) {
             $name = strtr(strtoupper($name), '-', '_');
 
-            if (! Str::startsWith($name, $prefix) && $name !== 'CONTENT_TYPE') {
-                $name = $prefix.$name;
+            if (!Str::startsWith($name, $prefix) && $name !== 'CONTENT_TYPE') {
+                $name = $prefix . $name;
             }
 
             $server[$name] = $value;
@@ -293,8 +293,8 @@ 
     protected function getTransformerResponse($tags)
     {
         try {
-            $transFormerTags = array_filter($tags, function ($tag) {
-                if (! ($tag instanceof Tag)) {
+            $transFormerTags = array_filter($tags, function($tag) {
+                if (!($tag instanceof Tag)) {
                     return false;
                 }
 
@@ -305,8 +305,8 @@ 
                 return false;
             }
 
-            $modelTag = array_first(array_filter($tags, function ($tag) {
-                if (! ($tag instanceof Tag)) {
+            $modelTag = array_first(array_filter($tags, function($tag) {
+                if (!($tag instanceof Tag)) {
                     return false;
                 }
 
@@ -314,7 +314,7 @@ 
             }));
             $tag = \array_first($transFormerTags);
             $transformer = $tag->getContent();
-            if (! \class_exists($transformer)) {
+            if (!\class_exists($transformer)) {
                 // if we can't find the transformer we can't generate a response
                 return;
             }
@@ -329,7 +329,7 @@ 
             }
             if (\is_null($type)) {
                 if ($parameter->hasType() &&
-                    ! $parameter->getType()->isBuiltin() &&
+                    !$parameter->getType()->isBuiltin() &&
                     \class_exists((string) $parameter->getType())) {
                     //we have a type
                     $type = (string) $parameter->getType();
@@ -382,7 +382,7 @@ 
             // we have a response from the docblock ( @response )
             $response = $docblockResponse;
         }
-        if (! $response && ($transformerResponse = $this->getTransformerResponse($annotationTags))) {
+        if (!$response && ($transformerResponse = $this->getTransformerResponse($annotationTags))) {
             // we have a transformer response from the docblock ( @transformer || @transformercollection )
             $response = $transformerResponse;
         }
@@ -407,25 +407,25 @@ 
     {
         $faker = Factory::create();
         $fakes = [
-            'integer' => function () {
+            'integer' => function() {
                 return rand(1, 20);
             },
-            'number' => function () use ($faker) {
+            'number' => function() use ($faker) {
                 return $faker->randomFloat();
             },
-            'float' => function () use ($faker) {
+            'float' => function() use ($faker) {
                 return $faker->randomFloat();
             },
-            'boolean' => function () use ($faker) {
+            'boolean' => function() use ($faker) {
                 return $faker->boolean();
             },
-            'string' => function () use ($faker) {
+            'string' => function() use ($faker) {
                 return str_random();
             },
-            'array' => function () {
+            'array' => function() {
                 return '[]';
             },
-            'object' => function () {
+            'object' => function() {
                 return '{}';
             },
         ];

src/Commands/GenerateDocumentation.php

Spacing +24 added lines, -24 removed lines

@@ -59,7 +59,7 @@ 
 
         $parsedRoutes = $this->processRoutes($generator, $routes);
         $parsedRoutes = collect($parsedRoutes)->groupBy('resource')
-            ->sort(function ($a, $b) {
+            ->sort(function($a, $b) {
                 return strcmp($a->first()['resource'], $b->first()['resource']);
             });
 
@@ -74,17 +74,17 @@ 
     private function writeMarkdown($parsedRoutes)
     {
         $outputPath = config('apidoc.output');
-        $targetFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'index.md';
-        $compareFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'.compare.md';
-        $prependFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'prepend.md';
-        $appendFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'append.md';
+        $targetFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . 'index.md';
+        $compareFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . '.compare.md';
+        $prependFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . 'prepend.md';
+        $appendFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . 'append.md';
 
         $infoText = view('apidoc::partials.info')
             ->with('outputPath', ltrim($outputPath, 'public/'))
             ->with('showPostmanCollectionButton', config('apidoc.postman'));
 
-        $parsedRouteOutput = $parsedRoutes->map(function ($routeGroup) {
-            return $routeGroup->map(function ($route) {
+        $parsedRouteOutput = $parsedRoutes->map(function($routeGroup) {
+            return $routeGroup->map(function($route) {
                 $route['output'] = (string) view('apidoc::partials.route')->with('parsedRoute', $route)->render();
 
                 return $route;
@@ -104,16 +104,16 @@ 
                 $frontmatter = trim($generatedFrontmatter[1], "\n");
             }
 
-            $parsedRouteOutput->transform(function ($routeGroup) use ($generatedDocumentation, $compareDocumentation) {
-                return $routeGroup->transform(function ($route) use ($generatedDocumentation, $compareDocumentation) {
-                    if (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $generatedDocumentation, $existingRouteDoc)) {
-                        $routeDocumentationChanged = (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $compareDocumentation, $lastDocWeGeneratedForThisRoute) && $lastDocWeGeneratedForThisRoute[1] !== $existingRouteDoc[1]);
+            $parsedRouteOutput->transform(function($routeGroup) use ($generatedDocumentation, $compareDocumentation) {
+                return $routeGroup->transform(function($route) use ($generatedDocumentation, $compareDocumentation) {
+                    if (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $generatedDocumentation, $existingRouteDoc)) {
+                        $routeDocumentationChanged = (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $compareDocumentation, $lastDocWeGeneratedForThisRoute) && $lastDocWeGeneratedForThisRoute[1] !== $existingRouteDoc[1]);
                         if ($routeDocumentationChanged === false || $this->option('force')) {
                             if ($routeDocumentationChanged) {
-                                $this->warn('Discarded manual changes for route ['.implode(',', $route['methods']).'] '.$route['uri']);
+                                $this->warn('Discarded manual changes for route [' . implode(',', $route['methods']) . '] ' . $route['uri']);
                             }
                         } else {
-                            $this->warn('Skipping modified route ['.implode(',', $route['methods']).'] '.$route['uri']);
+                            $this->warn('Skipping modified route [' . implode(',', $route['methods']) . '] ' . $route['uri']);
                             $route['modified_output'] = $existingRouteDoc[0];
                         }
                     }
@@ -124,9 +124,9 @@ 
         }
 
         $prependFileContents = file_exists($prependFile)
-            ? file_get_contents($prependFile)."\n" : '';
+            ? file_get_contents($prependFile) . "\n" : '';
         $appendFileContents = file_exists($appendFile)
-            ? "\n".file_get_contents($appendFile) : '';
+            ? "\n" . file_get_contents($appendFile) : '';
 
         $documentarian = new Documentarian();
 
@@ -140,7 +140,7 @@ 
             ->with('showPostmanCollectionButton', config('apidoc.postman'))
             ->with('parsedRoutes', $parsedRouteOutput);
 
-        if (! is_dir($outputPath)) {
+        if (!is_dir($outputPath)) {
             $documentarian->create($outputPath);
         }
 
@@ -160,24 +160,24 @@ 
 
         file_put_contents($compareFile, $compareMarkdown);
 
-        $this->info('Wrote index.md to: '.$outputPath);
+        $this->info('Wrote index.md to: ' . $outputPath);
 
         $this->info('Generating API HTML code');
 
         $documentarian->generate($outputPath);
 
-        $this->info('Wrote HTML documentation to: '.$outputPath.'/index.html');
+        $this->info('Wrote HTML documentation to: ' . $outputPath . '/index.html');
 
         if (config('apidoc.postman')) {
             $this->info('Generating Postman collection');
 
-            file_put_contents($outputPath.DIRECTORY_SEPARATOR.'collection.json', $this->generatePostmanCollection($parsedRoutes));
+            file_put_contents($outputPath . DIRECTORY_SEPARATOR . 'collection.json', $this->generatePostmanCollection($parsedRoutes));
         }
 
         if ($logo = config('apidoc.logo')) {
             Storage::copy(
                 $logo,
-                $outputPath.DIRECTORY_SEPARATOR.'images'.DIRECTORY_SEPARATOR.'logo.png'
+                $outputPath . DIRECTORY_SEPARATOR . 'images' . DIRECTORY_SEPARATOR . 'logo.png'
             );
         }
     }
@@ -196,9 +196,9 @@ 
             /** @var Route $route */
             if ($this->isValidRoute($route) && $this->isRouteVisibleForDocumentation($route->getAction()['uses'])) {
                 $parsedRoutes[] = $generator->processRoute($route) + $routeItem['apply'];
-                $this->info('Processed route: ['.implode(',', $generator->getMethods($route)).'] '.$generator->getUri($route));
+                $this->info('Processed route: [' . implode(',', $generator->getMethods($route)) . '] ' . $generator->getUri($route));
             } else {
-                $this->warn('Skipping route: ['.implode(',', $generator->getMethods($route)).'] '.$generator->getUri($route));
+                $this->warn('Skipping route: [' . implode(',', $generator->getMethods($route)) . '] ' . $generator->getUri($route));
             }
         }
 
@@ -212,7 +212,7 @@ 
      */
     private function isValidRoute(Route $route)
     {
-        return ! is_callable($route->getAction()['uses']) && ! is_null($route->getAction()['uses']);
+        return !is_callable($route->getAction()['uses']) && !is_null($route->getAction()['uses']);
     }
 
     /**
@@ -229,7 +229,7 @@ 
             $phpdoc = new DocBlock($comment);
 
             return collect($phpdoc->getTags())
-                ->filter(function ($tag) use ($route) {
+                ->filter(function($tag) use ($route) {
                     return $tag->getName() === 'hideFromAPIDocumentation';
                 })
                 ->isEmpty();