mpociot / laravel-apidoc-generator

src/Extracting/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/Extracting/Strategies/QueryParameters/GetFromQueryParamTag.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 $tag) {
+            ->mapWithKeys(function(Tag $tag) {
                 // Format:
                 // @queryParam <name> <"required" (optional)> <description>
                 // Examples:
@@ -82,7 +82,7 @@ 
                 }
 
                 list($description, $value) = $this->parseParamDescription($description, 'string');
-                if (is_null($value) && ! $this->shouldExcludeExample($tag->getContent())) {
+                if (is_null($value) && !$this->shouldExcludeExample($tag->getContent())) {
                     $value = Str::contains($description, ['number', 'count', 'page'])
                         ? $this->generateDummyValue('integer')
                         : $this->generateDummyValue('string');

src/Extracting/Strategies/BodyParameters/GetFromBodyParamTag.php

Spacing +3 added lines, -3 removed lines

@@ -54,10 +54,10 @@ 
     private function getBodyParametersFromDocBlock($tags)
     {
         $parameters = collect($tags)
-            ->filter(function ($tag) {
+            ->filter(function($tag) {
                 return $tag instanceof Tag && $tag->getName() === 'bodyParam';
             })
-            ->mapWithKeys(function (Tag $tag) {
+            ->mapWithKeys(function(Tag $tag) {
                 // Format:
                 // @bodyParam <name> <type> <"required" (optional)> <description>
                 // Examples:
@@ -82,7 +82,7 @@ 
 
                 $type = $this->normalizeParameterType($type);
                 list($description, $example) = $this->parseParamDescription($description, $type);
-                $value = is_null($example) && ! $this->shouldExcludeExample($tag->getContent())
+                $value = is_null($example) && !$this->shouldExcludeExample($tag->getContent())
                     ? $this->generateDummyValue($type)
                     : $example;
 

src/ApiDoc.php

Spacing +1 added lines, -1 removed lines

@@ -9,7 +9,7 @@
 {
     public static function routes($path = '/doc')
     {
-        return Route::get("$path{format?}", function (?string $format = null) {
+        return Route::get("$path{format?}", function(?string $format = null) {
             if ($format == '.json') {
                 return response(
                     Storage::disk('local')->get('apidoc/collection.json'),

src/Tools/Utils.php

Spacing +3 added lines, -3 removed lines

@@ -53,7 +53,7 @@ 
     public static function replaceUrlParameterPlaceholdersWithValues(string $uri, array $urlParameters)
     {
         $matches = preg_match_all('/{.+?}/i', $uri, $parameterPaths);
-        if (! $matches) {
+        if (!$matches) {
             return $uri;
         }
 
@@ -88,7 +88,7 @@ 
 
     public static function deleteDirectoryAndContents($dir)
     {
-        $adapter = new Local(realpath(__DIR__.'/../../'));
+        $adapter = new Local(realpath(__DIR__ . '/../../'));
         $fs = new Filesystem($adapter);
         $fs->deleteDir($dir);
     }
@@ -101,7 +101,7 @@ 
         $result = '';
         $padWith = str_repeat(' ', $indentationLevel);
         foreach ($split as $index => $line) {
-            $result .= ($index == 0 ? '' : "\n$padWith").$line;
+            $result .= ($index == 0 ? '' : "\n$padWith") . $line;
         }
 
         return $result;

Doc Comments +1 added lines, -1 removed lines

@@ -49,7 +49,7 @@
      * @param string $uri
      * @param array $urlParameters Dictionary of url params and example values
      *
-     * @return mixed
+     * @return string
      */
     public static function replaceUrlParameterPlaceholdersWithValues(string $uri, array $urlParameters)
     {

src/Writing/PostmanCollectionWriter.php

Spacing +7 added lines, -7 removed lines

@@ -40,32 +40,32 @@
         $collection = [
             'variables' => [],
             'info' => [
-                'name' => config('apidoc.postman.name') ?: config('app.name').' API',
+                'name' => config('apidoc.postman.name') ?: config('app.name') . ' API',
                 '_postman_id' => Uuid::uuid4()->toString(),
                 'description' => config('apidoc.postman.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 = 'raw';
 
                         return [
                             'name' => $route['metadata']['title'] != '' ? $route['metadata']['title'] : url($route['uri']),
                             'request' => [
-                                'url' => url($route['uri']).(collect($route['queryParameters'])->isEmpty()
+                                'url' => url($route['uri']) . (collect($route['queryParameters'])->isEmpty()
                                         ? ''
-                                        : ('?'.implode('&', collect($route['queryParameters'])->map(function ($parameter, $key) {
-                                            return urlencode($key).'='.urlencode($parameter['value'] ?? '');
+                                        : ('?' . implode('&', collect($route['queryParameters'])->map(function($parameter, $key) {
+                                            return urlencode($key) . '=' . urlencode($parameter['value'] ?? '');
                                         })->all()))),
                                 'method' => $route['methods'][0],
                                 'header' => collect($route['headers'])
                                     ->union([
                                         'Accept' => 'application/json',
                                     ])
-                                    ->map(function ($value, $header) {
+                                    ->map(function($value, $header) {
                                         return [
                                             'key' => $header,
                                             'value' => $value,

src/Writing/Writer.php

Spacing +21 added lines, -21 removed lines

@@ -83,8 +83,8 @@ 
      */
     public function writeMarkdownAndSourceFiles(Collection $parsedRoutes, string $sourceOutputPath)
     {
-        $targetFile = $sourceOutputPath.'/source/index.md';
-        $compareFile = $sourceOutputPath.'/source/.compare.md';
+        $targetFile = $sourceOutputPath . '/source/index.md';
+        $compareFile = $sourceOutputPath . '/source/.compare.md';
 
         $infoText = view('apidoc::partials.info')
             ->with('outputPath', 'docs')
@@ -106,16 +106,16 @@ 
             $generatedDocumentation = file_get_contents($targetFile);
             $compareDocumentation = file_get_contents($compareFile);
 
-            $parsedRouteOutput->transform(function (Collection $routeGroup) use ($generatedDocumentation, $compareDocumentation) {
-                return $routeGroup->transform(function (array $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(Collection $routeGroup) use ($generatedDocumentation, $compareDocumentation) {
+                return $routeGroup->transform(function(array $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->forceIt) {
                             if ($routeDocumentationChanged) {
-                                $this->output->warn('Discarded manual changes for route ['.implode(',', $route['methods']).'] '.$route['uri']);
+                                $this->output->warn('Discarded manual changes for route [' . implode(',', $route['methods']) . '] ' . $route['uri']);
                             }
                         } else {
-                            $this->output->warn('Skipping modified route ['.implode(',', $route['methods']).'] '.$route['uri']);
+                            $this->output->warn('Skipping modified route [' . implode(',', $route['methods']) . '] ' . $route['uri']);
                             $route['modified_output'] = $existingRouteDoc[0];
                         }
                     }
@@ -138,9 +138,9 @@ 
             ->with('showPostmanCollectionButton', $this->shouldGeneratePostmanCollection)
             ->with('parsedRoutes', $parsedRouteOutput);
 
-        $this->output->info('Writing index.md and source files to: '.$sourceOutputPath);
+        $this->output->info('Writing index.md and source files to: ' . $sourceOutputPath);
 
-        if (! is_dir($sourceOutputPath)) {
+        if (!is_dir($sourceOutputPath)) {
             $documentarian = new Documentarian();
             $documentarian->create($sourceOutputPath);
         }
@@ -161,19 +161,19 @@ 
 
         file_put_contents($compareFile, $compareMarkdown);
 
-        $this->output->info('Wrote index.md and source files to: '.$sourceOutputPath);
+        $this->output->info('Wrote index.md and source files to: ' . $sourceOutputPath);
     }
 
     public function generateMarkdownOutputForEachRoute(Collection $parsedRoutes, array $settings): Collection
     {
-        $parsedRouteOutput = $parsedRoutes->map(function (Collection $routeGroup) use ($settings) {
-            return $routeGroup->map(function (array $route) use ($settings) {
-                if (count($route['cleanBodyParameters']) && ! isset($route['headers']['Content-Type'])) {
+        $parsedRouteOutput = $parsedRoutes->map(function(Collection $routeGroup) use ($settings) {
+            return $routeGroup->map(function(array $route) use ($settings) {
+                if (count($route['cleanBodyParameters']) && !isset($route['headers']['Content-Type'])) {
                     // Set content type if the user forgot to set it
                     $route['headers']['Content-Type'] = 'application/json';
                 }
 
-                $hasRequestOptions = ! empty($route['headers']) || ! empty($route['cleanQueryParameters']) || ! empty($route['cleanBodyParameters']);
+                $hasRequestOptions = !empty($route['headers']) || !empty($route['cleanQueryParameters']) || !empty($route['cleanBodyParameters']);
                 $route['output'] = (string) view('apidoc::partials.route')
                     ->with('hasRequestOptions', $hasRequestOptions)
                     ->with('route', $route)
@@ -227,9 +227,9 @@ 
      */
     protected function getMarkdownToPrepend(string $sourceOutputPath): string
     {
-        $prependFile = $sourceOutputPath.'/source/prepend.md';
+        $prependFile = $sourceOutputPath . '/source/prepend.md';
         $prependFileContents = file_exists($prependFile)
-            ? file_get_contents($prependFile)."\n" : '';
+            ? file_get_contents($prependFile) . "\n" : '';
 
         return $prependFileContents;
     }
@@ -241,9 +241,9 @@ 
      */
     protected function getMarkdownToAppend(string $sourceOutputPath): string
     {
-        $appendFile = $sourceOutputPath.'/source/append.md';
+        $appendFile = $sourceOutputPath . '/source/append.md';
         $appendFileContents = file_exists($appendFile)
-            ? "\n".file_get_contents($appendFile) : '';
+            ? "\n" . file_get_contents($appendFile) : '';
 
         return $appendFileContents;
     }
@@ -251,7 +251,7 @@ 
     protected function copyAssetsFromSourceFolderToPublicFolder(string $sourceOutputPath, bool $isStatic = true): void
     {
         $publicPath = 'public/docs';
-        if (! is_dir($publicPath)) {
+        if (!is_dir($publicPath)) {
             mkdir($publicPath, 0777, true);
             mkdir("{$publicPath}/css");
             mkdir("{$publicPath}/js");
@@ -274,7 +274,7 @@ 
             rename("{$sourceOutputPath}/index.html", "{$outputPath}/index.html");
         } else {
             // Move output to resources/views
-            if (! is_dir($outputPath)) {
+            if (!is_dir($outputPath)) {
                 mkdir($outputPath);
             }
             rename("{$sourceOutputPath}/index.html", "$outputPath/index.blade.php");

src/Commands/GenerateDocumentation.php

Spacing +6 added lines, -6 removed lines

@@ -73,7 +73,7 @@ 
 
         $groupedRoutes = collect($parsedRoutes)
             ->groupBy('metadata.groupName')
-            ->sortBy(static function ($group) {
+            ->sortBy(static function($group) {
                 /* @var $group Collection */
                 return $group->first()['metadata']['groupName'];
             }, SORT_NATURAL);
@@ -102,7 +102,7 @@ 
             $routeMethods = implode(',', $generator->getMethods($route));
             $routePath = $generator->getUri($route);
 
-            if (! $this->isValidRoute($route) || ! $this->isRouteVisibleForDocumentation($route->getAction())) {
+            if (!$this->isValidRoute($route) || !$this->isRouteVisibleForDocumentation($route->getAction())) {
                 $this->warn(sprintf($messageFormat, 'Skipping', $routeMethods, $routePath));
                 continue;
             }
@@ -111,7 +111,7 @@ 
                 $parsedRoutes[] = $generator->processRoute($route, $routeItem['apply'] ?? []);
                 $this->info(sprintf($messageFormat, 'Processed', $routeMethods, $routePath));
             } catch (\Exception $exception) {
-                $this->warn(sprintf($messageFormat, 'Skipping', $routeMethods, $routePath).' - '.$exception->getMessage());
+                $this->warn(sprintf($messageFormat, 'Skipping', $routeMethods, $routePath) . ' - ' . $exception->getMessage());
             }
         }
 
@@ -130,7 +130,7 @@ 
             $action = implode('@', $action);
         }
 
-        return ! is_callable($action) && ! is_null($action);
+        return !is_callable($action) && !is_null($action);
     }
 
     /**
@@ -145,7 +145,7 @@ 
         list($class, $method) = Utils::getRouteClassAndMethodNames($action);
         $reflection = new ReflectionClass($class);
 
-        if (! $reflection->hasMethod($method)) {
+        if (!$reflection->hasMethod($method)) {
             return false;
         }
 
@@ -155,7 +155,7 @@ 
             $phpdoc = new DocBlock($comment);
 
             return collect($phpdoc->getTags())
-                ->filter(function ($tag) {
+                ->filter(function($tag) {
                     return $tag->getName() === 'hideFromAPIDocumentation';
                 })
                 ->isEmpty();

src/Extracting/Strategies/Responses/UseResponseFileTag.php

Spacing +5 added lines, -5 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,16 +53,16 @@ 
             return null;
         }
 
-        $responses = array_map(function (Tag $responseFileTag) {
+        $responses = array_map(function(Tag $responseFileTag) {
             preg_match('/^(\d{3})?\s?([\S]*[\s]*?)(\{.*\})?$/', $responseFileTag->getContent(), $result);
             $relativeFilePath = trim($result[2]);
             $filePath = storage_path($relativeFilePath);
-            if (! file_exists($filePath)) {
-                throw new \Exception('@responseFile '.$relativeFilePath.' does not exist');
+            if (!file_exists($filePath)) {
+                throw new \Exception('@responseFile ' . $relativeFilePath . ' does not exist');
             }
             $status = $result[1] ?: 200;
             $content = $result[2] ? file_get_contents($filePath, 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 ['content' => json_encode($merged), 'status' => (int) $status];