mpociot / laravel-apidoc-generator

src/Tools/Utils.php

Doc Comments +1 added lines, -1 removed lines

@@ -49,7 +49,7 @@
      * @param string $uri
      * @param array $bindings
      *
-     * @return mixed
+     * @return string
      */
     public static function replaceUrlParameterBindings(string $uri, array $bindings)
     {

src/Strategies/Metadata/GetFromDocBlocks.php

Spacing +2 added lines, -2 removed lines

@@ -37,7 +37,7 @@ 
     protected function getAuthStatusFromDocBlock(array $tags)
     {
         $authTag = collect($tags)
-            ->first(function ($tag) {
+            ->first(function($tag) {
                 return $tag instanceof Tag && strtolower($tag->getName()) === 'authenticated';
             });
 
@@ -53,7 +53,7 @@ 
     protected function getRouteGroupDescriptionAndTitle(DocBlock $methodDocBlock, DocBlock $controllerDocBlock)
     {
         // @group tag on the method overrides that on the controller
-        if (! empty($methodDocBlock->getTags())) {
+        if (!empty($methodDocBlock->getTags())) {
             foreach ($methodDocBlock->getTags() as $tag) {
                 if ($tag->getName() === 'group') {
                     $routeGroupParts = explode("\n", trim($tag->getContent()));

src/Strategies/QueryParameters/GetFromDocBlocks.php

Spacing +3 added lines, -3 removed lines

@@ -55,10 +55,10 @@ 
     private function getQueryParametersFromDocBlock($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);
                 $content = preg_replace('/\s?No-example.?/', '', $content);
                 if (empty($content)) {
@@ -77,7 +77,7 @@ 
                 }
 
                 list($description, $value) = $this->parseParamDescription($description, 'string');
-                if (is_null($value) && ! $this->shouldExcludeExample($tag)) {
+                if (is_null($value) && !$this->shouldExcludeExample($tag)) {
                     $value = str_contains($description, ['number', 'count', 'page'])
                         ? $this->generateDummyValue('integer')
                         : $this->generateDummyValue('string');

src/Strategies/Responses/UseResponseTag.php

Spacing +2 added lines, -2 removed lines

@@ -43,7 +43,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';
             })
         );
@@ -52,7 +52,7 @@ 
             return null;
         }
 
-        $responses = array_map(function (Tag $responseTag) {
+        $responses = array_map(function(Tag $responseTag) {
             preg_match('/^(\d{3})?\s?([\s\S]*)$/', $responseTag->getContent(), $result);
 
             $status = $result[1] ?: 200;

src/Strategies/Responses/ResponseCalls.php

Spacing +7 added lines, -7 removed lines

@@ -30,7 +30,7 @@ 
     public function __invoke(Route $route, \ReflectionClass $controller, \ReflectionMethod $method, array $routeRules, array $context = [])
     {
         $rulesToApply = $routeRules['response_calls'] ?? [];
-        if (! $this->shouldMakeApiCall($route, $rulesToApply, $context)) {
+        if (!$this->shouldMakeApiCall($route, $rulesToApply, $context)) {
             return null;
         }
 
@@ -44,7 +44,7 @@ 
         try {
             $response = [200 => $this->makeApiCall($request)->getContent()];
         } catch (\Exception $e) {
-            echo 'Exception thrown during response call for ['.implode(',', $route->methods)."] {$route->uri}.\n";
+            echo 'Exception thrown during response call for [' . implode(',', $route->methods) . "] {$route->uri}.\n";
             if (Flags::$shouldBeVerbose) {
                 Utils::dumpException($e);
             } else {
@@ -177,14 +177,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);
         }
 
@@ -304,7 +304,7 @@ 
             return false;
         }
 
-        if (! empty($context['responses'])) {
+        if (!empty($context['responses'])) {
             // Don't attempt a response call if there are already responses
             return false;
         }
@@ -338,8 +338,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/Strategies/Responses/UseResponseFileTag.php

Spacing +3 added lines, -3 removed lines

@@ -44,7 +44,7 @@ 
     {
         // Avoid "holes" in the keys of the filtered array, by using array_values on the filtered array
         $responseFileTags = array_values(
-            array_filter($tags, function ($tag) {
+            array_filter($tags, function($tag) {
                 return $tag instanceof Tag && strtolower($tag->getName()) === 'responsefile';
             })
         );
@@ -53,11 +53,11 @@ 
             return null;
         }
 
-        $responses = array_map(function (Tag $responseFileTag) {
+        $responses = array_map(function(Tag $responseFileTag) {
             preg_match('/^(\d{3})?\s?([\S]*[\s]*?)(\{.*\})?$/', $responseFileTag->getContent(), $result);
             $status = $result[1] ?: 200;
             $content = $result[2] ? file_get_contents(storage_path(trim($result[2])), true) : '{}';
-            $json = ! empty($result[3]) ? str_replace("'", '"', $result[3]) : '{}';
+            $json = !empty($result[3]) ? str_replace("'", '"', $result[3]) : '{}';
             $merged = array_merge(json_decode($content, true), json_decode($json, true));
 
             return [json_encode($merged), (int) $status];

src/Strategies/BodyParameters/GetFromDocBlocks.php

Spacing +3 added lines, -3 removed lines

@@ -55,10 +55,10 @@ 
     private function getBodyParametersFromDocBlock($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);
                 $content = preg_replace('/\s?No-example.?/', '', $content);
                 if (empty($content)) {
@@ -78,7 +78,7 @@ 
 
                 $type = $this->normalizeParameterType($type);
                 list($description, $example) = $this->parseParamDescription($description, $type);
-                $value = is_null($example) && ! $this->shouldExcludeExample($tag) ? $this->generateDummyValue($type) : $example;
+                $value = is_null($example) && !$this->shouldExcludeExample($tag) ? $this->generateDummyValue($type) : $example;
 
                 return [$name => compact('type', 'description', 'required', 'value')];
             })->toArray();

src/Commands/GenerateDocumentation.php

Spacing +26 added lines, -26 removed lines

@@ -84,7 +84,7 @@ 
         $parsedRoutes = $this->processRoutes($generator, $routes);
         $groupedRoutes = collect($parsedRoutes)
             ->groupBy('groupName')
-            ->sortBy(static function ($group) {
+            ->sortBy(static function($group) {
                 /* @var $group Collection */
                 return $group->first()['groupName'];
             }, SORT_NATURAL);
@@ -100,19 +100,19 @@ 
     private function writeMarkdown($parsedRoutes)
     {
         $outputPath = $this->docConfig->get('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', $this->shouldGeneratePostmanCollection());
 
         $settings = ['languages' => $this->docConfig->get('example_languages')];
-        $parsedRouteOutput = $parsedRoutes->map(function ($routeGroup) use ($settings) {
-            return $routeGroup->map(function ($route) use ($settings) {
-                if (count($route['cleanBodyParameters']) && ! isset($route['headers']['Content-Type'])) {
+        $parsedRouteOutput = $parsedRoutes->map(function($routeGroup) use ($settings) {
+            return $routeGroup->map(function($route) use ($settings) {
+                if (count($route['cleanBodyParameters']) && !isset($route['headers']['Content-Type'])) {
                     $route['headers']['Content-Type'] = 'application/json';
                 }
                 $route['output'] = (string) view('apidoc::partials.route')
@@ -139,16 +139,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];
                         }
                     }
@@ -159,9 +159,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();
 
@@ -175,7 +175,7 @@ 
             ->with('showPostmanCollectionButton', $this->shouldGeneratePostmanCollection())
             ->with('parsedRoutes', $parsedRouteOutput);
 
-        if (! is_dir($outputPath)) {
+        if (!is_dir($outputPath)) {
             $documentarian->create($outputPath);
         }
 
@@ -195,24 +195,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 ($this->shouldGeneratePostmanCollection()) {
             $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 = $this->docConfig->get('logo')) {
             copy(
                 $logo,
-                $outputPath.DIRECTORY_SEPARATOR.'images'.DIRECTORY_SEPARATOR.'logo.png'
+                $outputPath . DIRECTORY_SEPARATOR . 'images' . DIRECTORY_SEPARATOR . 'logo.png'
             );
         }
     }
@@ -231,9 +231,9 @@ 
             /** @var Route $route */
             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));
+                $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));
             }
         }
 
@@ -252,7 +252,7 @@ 
             $action = implode('@', $action);
         }
 
-        return ! is_callable($action) && ! is_null($action);
+        return !is_callable($action) && !is_null($action);
     }
 
     /**
@@ -267,7 +267,7 @@ 
         list($class, $method) = Utils::getRouteClassAndMethodNames($action);
         $reflection = new ReflectionClass($class);
 
-        if (! $reflection->hasMethod($method)) {
+        if (!$reflection->hasMethod($method)) {
             return false;
         }
 
@@ -277,7 +277,7 @@ 
             $phpdoc = new DocBlock($comment);
 
             return collect($phpdoc->getTags())
-                ->filter(function ($tag) {
+                ->filter(function($tag) {
                     return $tag->getName() === 'hideFromAPIDocumentation';
                 })
                 ->isEmpty();

src/Tools/Generator.php

Spacing +5 added lines, -5 removed lines

@@ -55,7 +55,7 @@ 
         $method = $controller->getMethod($methodName);
 
         $parsedRoute = [
-            'id' => md5($this->getUri($route).':'.implode($this->getMethods($route))),
+            'id' => md5($this->getUri($route) . ':' . implode($this->getMethods($route))),
             'methods' => $this->getMethods($route),
             'uri' => $this->getUri($route),
             'boundUri' => Utils::getFullUrl($route, $rulesToApply['bindings'] ?? ($rulesToApply['response_calls']['bindings'] ?? [])),
@@ -72,7 +72,7 @@ 
 
         $responses = $this->fetchResponses($controller, $method, $route, $rulesToApply, $parsedRoute);
         $parsedRoute['response'] = $responses;
-        $parsedRoute['showresponse'] = ! empty($responses);
+        $parsedRoute['showresponse'] = !empty($responses);
 
         $parsedRoute['headers'] = $rulesToApply['headers'] ?? [];
 
@@ -110,7 +110,7 @@ 
     {
         $responses = $this->iterateThroughStrategies('responses', $context, [$route, $controller, $method, $rulesToApply]);
         if (count($responses)) {
-            return collect($responses)->map(function (string $response, int $status) {
+            return collect($responses)->map(function(string $response, int $status) {
                 return [
                     'status' => $status ?: 200,
                     'content' => $response,
@@ -129,14 +129,14 @@ 
             $strategy = new $strategyClass($this->config);
             $arguments[] = $context;
             $results = $strategy(...$arguments);
-            if (! is_null($results)) {
+            if (!is_null($results)) {
                 foreach ($results as $index => $item) {
                     // Using a for loop rather than array_merge or +=
                     // so it does not renumber numeric keys
                     // and also allows values to be overwritten
 
                     // Don't allow overwriting if an empty value is trying to replace a set one
-                    if (! in_array($context[$key], [null, ''], true) && in_array($item, [null, ''], true)) {
+                    if (!in_array($context[$key], [null, ''], true) && in_array($item, [null, ''], true)) {
                         continue;
                     } else {
                         $context[$key][$index] = $item;