mpociot / laravel-apidoc-generator

src/Commands/UpdateDocumentation.php

Spacing +4 added lines, -4 removed lines

@@ -42,15 +42,15 @@
 
         $documentarian = new Documentarian();
 
-        if (! is_dir($outputPath)) {
-            $this->error('There is no existing documentation available at '.$outputPath.'.');
+        if (!is_dir($outputPath)) {
+            $this->error('There is no existing documentation available at ' . $outputPath . '.');
 
             return false;
         }
-        $this->info('Rebuilding API HTML code from '.$outputPath.'/source/index.md');
+        $this->info('Rebuilding API HTML code from ' . $outputPath . '/source/index.md');
 
         $documentarian->generate($outputPath);
 
-        $this->info('Wrote HTML documentation to: '.$outputPath.'/index.html');
+        $this->info('Wrote HTML documentation to: ' . $outputPath . '/index.html');
     }
 }

src/Tools/ResponseStrategies/ResponseCallStrategy.php

Doc Comments +1 added lines, -1 removed lines

@@ -63,7 +63,7 @@
      * @param Route $route
      * @param array $bindings
      *
-     * @return mixed
+     * @return string
      */
     protected function replaceUrlParameterBindings(Route $route, $bindings)
     {

Spacing +5 added lines, -5 removed lines

@@ -15,7 +15,7 @@ 
     public function __invoke(Route $route, array $tags, array $routeProps)
     {
         $rulesToApply = $routeProps['rules']['response_calls'] ?? [];
-        if (! $this->shouldMakeApiCall($route, $rulesToApply)) {
+        if (!$this->shouldMakeApiCall($route, $rulesToApply)) {
             return;
         }
 
@@ -124,14 +124,14 @@ 
         // set URL and query parameters
         $uri = $request->getRequestUri();
         $query = $request->getQueryString();
-        if (! empty($query)) {
+        if (!empty($query)) {
             $uri .= "?$query";
         }
         $response = call_user_func_array([$dispatcher, strtolower($request->method())], [$uri]);
 
         // the response from the Dingo dispatcher is the 'raw' response from the controller,
         // so we have to ensure it's JSON first
-        if (! $response instanceof Response) {
+        if (!$response instanceof Response) {
             $response = response()->json($response);
         }
 
@@ -238,8 +238,8 @@ 
         $prefix = 'HTTP_';
         foreach ($headers as $name => $value) {
             $name = strtr(strtoupper($name), '-', '_');
-            if (! starts_with($name, $prefix) && $name !== 'CONTENT_TYPE') {
-                $name = $prefix.$name;
+            if (!starts_with($name, $prefix) && $name !== 'CONTENT_TYPE') {
+                $name = $prefix . $name;
             }
             $server[$name] = $value;
         }

src/Tools/Generator.php

Spacing +14 added lines, -14 removed lines

@@ -55,7 +55,7 @@ 
         ]);
 
         $parsedRoute = [
-            'id' => md5($this->getUri($route).':'.implode($this->getMethods($route))),
+            'id' => md5($this->getUri($route) . ':' . implode($this->getMethods($route))),
             'group' => $routeGroup,
             'title' => $docBlock['short'],
             'description' => $docBlock['long'],
@@ -65,7 +65,7 @@ 
             'queryParameters' => $queryParameters,
             'authenticated' => $this->getAuthStatusFromDocBlock($docBlock['tags']),
             'response' => $content,
-            'showresponse' => ! empty($content),
+            'showresponse' => !empty($content),
         ];
         $parsedRoute['headers'] = $rulesToApply['headers'] ?? [];
 
@@ -80,10 +80,10 @@ 
     protected function getBodyParametersFromDocBlock(array $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
@@ -117,10 +117,10 @@ 
     protected function getQueryParametersFromDocBlock(array $tags)
     {
         $parameters = collect($tags)
-            ->filter(function ($tag) {
+            ->filter(function($tag) {
                 return $tag instanceof Tag && $tag->getName() === 'queryParam';
             })
-            ->mapWithKeys(function ($tag) {
+            ->mapWithKeys(function($tag) {
                 preg_match('/(.+?)\s+(required\s+)?(.*)/', $tag->getContent(), $content);
                 if (empty($content)) {
                     // this means only name was supplied
@@ -157,7 +157,7 @@ 
     protected function getAuthStatusFromDocBlock(array $tags)
     {
         $authTag = collect($tags)
-            ->first(function ($tag) {
+            ->first(function($tag) {
                 return $tag instanceof Tag && strtolower($tag->getName()) === 'authenticated';
             });
 
@@ -228,25 +228,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 '{}';
             },
         ];

Doc Comments +1 added lines, -2 removed lines

@@ -14,7 +14,7 @@ 
     /**
      * @param Route $route
      *
-     * @return mixed
+     * @return string
      */
     public function getUri(Route $route)
     {
@@ -33,7 +33,6 @@ 
 
     /**
      * @param  \Illuminate\Routing\Route $route
-     * @param array $apply Rules to apply when generating documentation for this route
      *
      * @return array
      */

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' => app()->basePath().'/config/apidoc.php',
+            __DIR__ . '/../config/apidoc.php' => app()->basePath() . '/config/apidoc.php',
         ], 'config');
 
-        $this->mergeConfigFrom(__DIR__.'/../config/apidoc.php', 'apidoc');
+        $this->mergeConfigFrom(__DIR__ . '/../config/apidoc.php', 'apidoc');
 
         if ($this->app->runningInConsole()) {
             $this->commands([

src/Tools/RouteMatcher.php

Spacing +3 added lines, -3 removed lines

@@ -50,14 +50,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();
     }
@@ -65,7 +65,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 str_is($mustIncludes, $route->getName())

src/Tools/ResponseResolver.php

Spacing +2 added lines, -2 removed lines

@@ -48,8 +48,8 @@
             /** @var Response[]|null $response */
             $responses = $strategy($this->route, $tags, $routeProps);
 
-            if (! is_null($responses)) {
-                return array_map(function (Response $response) {
+            if (!is_null($responses)) {
+                return array_map(function(Response $response) {
                     return ['status' => $response->getStatusCode(), 'content' => $this->getResponseContent($response)];
                 }, $responses);
             }

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) {
                         $mode = $route['methods'][0] === 'PUT' ? 'urlencoded' : 'formdata';
 
                         return [
@@ -46,7 +46,7 @@ 
                                 'method' => $route['methods'][0],
                                 'body' => [
                                     'mode' => $mode,
-                                    $mode => collect($route['bodyParameters'])->map(function ($parameter, $key) {
+                                    $mode => collect($route['bodyParameters'])->map(function($parameter, $key) {
                                         return [
                                             'key' => $key,
                                             'value' => isset($parameter['value']) ? $parameter['value'] : '',

src/Tools/ResponseStrategies/ResponseTagStrategy.php

Spacing +2 added lines, -2 removed lines

@@ -33,7 +33,7 @@ 
     protected function getDocBlockResponses(array $tags)
     {
         $responseTags = array_values(
-            array_filter($tags, function ($tag) {
+            array_filter($tags, function($tag) {
                 return $tag instanceof Tag && strtolower($tag->getName()) === 'response';
             })
         );
@@ -42,7 +42,7 @@ 
             return;
         }
 
-        return array_map(function (Tag $responseTag) {
+        return array_map(function(Tag $responseTag) {
             preg_match('/^(\d{3})?\s?([\s\S]*)$/', $responseTag->getContent(), $result);
 
             $status = $result[1] ?: 200;

src/Commands/GenerateDocumentation.php

Spacing +25 added lines, -25 removed lines

@@ -56,7 +56,7 @@ 
         $generator = new Generator();
         $parsedRoutes = $this->processRoutes($generator, $routes);
         $parsedRoutes = collect($parsedRoutes)->groupBy('group')
-            ->sortBy(static function ($group) {
+            ->sortBy(static function($group) {
                 /* @var $group Collection */
                 return $group->first()['group'];
             }, SORT_NATURAL);
@@ -72,17 +72,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('route', $route)->render();
 
                 return $route;
@@ -102,16 +102,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];
                         }
                     }
@@ -122,9 +122,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();
 
@@ -138,7 +138,7 @@ 
             ->with('showPostmanCollectionButton', config('apidoc.postman'))
             ->with('parsedRoutes', $parsedRouteOutput);
 
-        if (! is_dir($outputPath)) {
+        if (!is_dir($outputPath)) {
             $documentarian->create($outputPath);
         }
 
@@ -158,24 +158,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')) {
             copy(
                 $logo,
-                $outputPath.DIRECTORY_SEPARATOR.'images'.DIRECTORY_SEPARATOR.'logo.png'
+                $outputPath . DIRECTORY_SEPARATOR . 'images' . DIRECTORY_SEPARATOR . 'logo.png'
             );
         }
     }
@@ -194,9 +194,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));
             }
         }
 
@@ -210,7 +210,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']);
     }
 
     /**
@@ -225,7 +225,7 @@ 
         list($class, $method) = explode('@', $route);
         $reflection = new ReflectionClass($class);
 
-        if (! $reflection->hasMethod($method)) {
+        if (!$reflection->hasMethod($method)) {
             return false;
         }
 
@@ -235,7 +235,7 @@ 
             $phpdoc = new DocBlock($comment);
 
             return collect($phpdoc->getTags())
-                ->filter(function ($tag) use ($route) {
+                ->filter(function($tag) use ($route) {
                     return $tag->getName() === 'hideFromAPIDocumentation';
                 })
                 ->isEmpty();