mpociot / laravel-apidoc-generator

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;

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];

src/Extracting/Generator.php

Spacing +7 added lines, -7 removed lines

@@ -56,7 +56,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),
         ];
@@ -81,7 +81,7 @@ 
 
         $responses = $this->fetchResponses($controller, $method, $route, $routeRules, $parsedRoute);
         $parsedRoute['responses'] = $responses;
-        $parsedRoute['showresponse'] = ! empty($responses);
+        $parsedRoute['showresponse'] = !empty($responses);
 
         return $parsedRoute;
     }
@@ -118,7 +118,7 @@ 
     {
         $responses = $this->iterateThroughStrategies('responses', $context, [$route, $controller, $method, $rulesToApply]);
         if (count($responses)) {
-            return array_filter($responses, function ($response) {
+            return array_filter($responses, function($response) {
                 return $response['content'] != null;
             });
         }
@@ -168,7 +168,7 @@ 
             $strategyArgs = $arguments;
             $strategyArgs[] = $context;
             $results = $strategy(...$strategyArgs);
-            if (! is_null($results)) {
+            if (!is_null($results)) {
                 foreach ($results as $index => $item) {
                     if ($stage == 'responses') {
                         // Responses are additive
@@ -180,7 +180,7 @@ 
                     // 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[$stage], [null, ''], true) && in_array($item, [null, ''], true)) {
+                    if (!in_array($context[$stage], [null, ''], true) && in_array($item, [null, ''], true)) {
                         continue;
                     } else {
                         $context[$stage][$index] = $item;
@@ -205,8 +205,8 @@ 
         $values = [];
 
         // Remove params which have no examples.
-        $params = array_filter($params, function ($details) {
-            return ! is_null($details['value']);
+        $params = array_filter($params, function($details) {
+            return !is_null($details['value']);
         });
 
         foreach ($params as $paramName => $details) {

Doc Comments +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
     /**
      * @param Route $route
      *
-     * @return mixed
+     * @return string
      */
     public function getUri(Route $route)
     {

src/Commands/RebuildDocumentation.php

Spacing +3 added lines, -3 removed lines

@@ -15,13 +15,13 @@
     public function handle()
     {
         $sourceOutputPath = 'resources/docs/source';
-        if (! is_dir($sourceOutputPath)) {
-            $this->error('There is no existing documentation available at '.$sourceOutputPath.'.');
+        if (!is_dir($sourceOutputPath)) {
+            $this->error('There is no existing documentation available at ' . $sourceOutputPath . '.');
 
             return false;
         }
 
-        $this->info('Rebuilding API documentation from '.$sourceOutputPath.'/index.md');
+        $this->info('Rebuilding API documentation from ' . $sourceOutputPath . '/index.md');
 
         $writer = new Writer($this, new DocumentationConfig(config('apidoc')));
         $writer->writeHtmlDocs();

src/Writing/Writer.php

Spacing +21 added lines, -21 removed lines

@@ -91,8 +91,8 @@ 
      */
     public function writeMarkdownAndSourceFiles(Collection $parsedRoutes)
     {
-        $targetFile = $this->sourceOutputPath.'/source/index.md';
-        $compareFile = $this->sourceOutputPath.'/source/.compare.md';
+        $targetFile = $this->sourceOutputPath . '/source/index.md';
+        $compareFile = $this->sourceOutputPath . '/source/.compare.md';
 
         $infoText = view('apidoc::partials.info')
             ->with('outputPath', 'docs')
@@ -114,16 +114,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];
                         }
                     }
@@ -146,9 +146,9 @@ 
             ->with('showPostmanCollectionButton', $this->shouldGeneratePostmanCollection)
             ->with('parsedRoutes', $parsedRouteOutput);
 
-        $this->output->info('Writing index.md and source files to: '.$this->sourceOutputPath);
+        $this->output->info('Writing index.md and source files to: ' . $this->sourceOutputPath);
 
-        if (! is_dir($this->sourceOutputPath)) {
+        if (!is_dir($this->sourceOutputPath)) {
             $documentarian = new Documentarian();
             $documentarian->create($this->sourceOutputPath);
         }
@@ -169,19 +169,19 @@ 
 
         file_put_contents($compareFile, $compareMarkdown);
 
-        $this->output->info('Wrote index.md and source files to: '.$this->sourceOutputPath);
+        $this->output->info('Wrote index.md and source files to: ' . $this->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)
@@ -230,18 +230,18 @@ 
 
     protected function getMarkdownToPrepend(): string
     {
-        $prependFile = $this->sourceOutputPath.'/source/prepend.md';
+        $prependFile = $this->sourceOutputPath . '/source/prepend.md';
         $prependFileContents = file_exists($prependFile)
-            ? file_get_contents($prependFile)."\n" : '';
+            ? file_get_contents($prependFile) . "\n" : '';
 
         return $prependFileContents;
     }
 
     protected function getMarkdownToAppend(): string
     {
-        $appendFile = $this->sourceOutputPath.'/source/append.md';
+        $appendFile = $this->sourceOutputPath . '/source/append.md';
         $appendFileContents = file_exists($appendFile)
-            ? "\n".file_get_contents($appendFile) : '';
+            ? "\n" . file_get_contents($appendFile) : '';
 
         return $appendFileContents;
     }
@@ -249,7 +249,7 @@ 
     protected function copyAssetsFromSourceFolderToPublicFolder(): void
     {
         $publicPath = 'public/docs';
-        if (! is_dir($publicPath)) {
+        if (!is_dir($publicPath)) {
             mkdir($publicPath, 0777, true);
             mkdir("{$publicPath}/css");
             mkdir("{$publicPath}/js");
@@ -272,7 +272,7 @@ 
             rename("{$this->sourceOutputPath}/index.html", "{$this->outputPath}/index.html");
         } else {
             // Move output to resources/views
-            if (! is_dir($this->outputPath)) {
+            if (!is_dir($this->outputPath)) {
                 mkdir($this->outputPath);
             }
             rename("{$this->sourceOutputPath}/index.html", "$this->outputPath/index.blade.php");

src/Matching/RouteMatcher/Match.php

Spacing +2 added lines, -2 removed lines

@@ -49,7 +49,7 @@ 
      */
     public function offsetExists($offset)
     {
-        return is_callable([$this, 'get'.ucfirst($offset)]);
+        return is_callable([$this, 'get' . ucfirst($offset)]);
     }
 
     /**
@@ -57,7 +57,7 @@ 
      */
     public function offsetGet($offset)
     {
-        return call_user_func([$this, 'get'.ucfirst($offset)]);
+        return call_user_func([$this, 'get' . ucfirst($offset)]);
     }
 
     /**

src/Extracting/Strategies/Responses/UseTransformerTags.php

Unused Use Statements -1 removed lines

@@ -3,7 +3,6 @@
 namespace Mpociot\ApiDoc\Extracting\Strategies\Responses;
 
 use Exception;
-use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Model as IlluminateModel;
 use Illuminate\Routing\Route;
 use Illuminate\Support\Arr;

Spacing +5 added lines, -5 removed lines

@@ -65,7 +65,7 @@ 
 
             $fractal = new Manager();
 
-            if (! is_null(config('apidoc.fractal.serializer'))) {
+            if (!is_null(config('apidoc.fractal.serializer'))) {
                 $fractal->setSerializer(app(config('apidoc.fractal.serializer')));
             }
 
@@ -84,7 +84,7 @@ 
                 ],
             ];
         } catch (Exception $e) {
-            echo 'Exception thrown when fetching transformer response for ['.implode(',', $route->methods)."] {$route->uri}.\n";
+            echo 'Exception thrown when fetching transformer response for [' . implode(',', $route->methods) . "] {$route->uri}.\n";
             if (Flags::$shouldBeVerbose) {
                 Utils::dumpException($e);
             } else {
@@ -120,7 +120,7 @@ 
      */
     private function getClassToBeTransformed(array $tags, ReflectionMethod $transformerMethod): string
     {
-        $modelTag = Arr::first(array_filter($tags, function ($tag) {
+        $modelTag = Arr::first(array_filter($tags, function($tag) {
             return ($tag instanceof Tag) && strtolower($tag->getName()) == 'transformermodel';
         }));
 
@@ -129,7 +129,7 @@ 
             $type = $modelTag->getContent();
         } else {
             $parameter = Arr::first($transformerMethod->getParameters());
-            if ($parameter->hasType() && ! $parameter->getType()->isBuiltin() && class_exists($parameter->getType()->getName())) {
+            if ($parameter->hasType() && !$parameter->getType()->isBuiltin() && class_exists($parameter->getType()->getName())) {
                 // Ladies and gentlemen, we have a type!
                 $type = $parameter->getType()->getName();
             }
@@ -190,7 +190,7 @@ 
     private function getTransformerTag(array $tags)
     {
         $transformerTags = array_values(
-            array_filter($tags, function ($tag) {
+            array_filter($tags, function($tag) {
                 return ($tag instanceof Tag) && in_array(strtolower($tag->getName()), ['transformer', 'transformercollection']);
             })
         );

Doc Comments +2 added lines, -2 removed lines

@@ -47,7 +47,7 @@ 
     /**
      * Get a response from the transformer tags.
      *
-     * @param array $tags
+     * @param Tag[] $tags
      * @param Route $route
      *
      * @return array|null
@@ -145,7 +145,7 @@ 
     /**
      * @param string $type
      *
-     * @return Model|object
+     * @return string
      */
     protected function instantiateTransformerModel(string $type)
     {

src/Writing/PostmanCollectionWriter.php

Spacing +13 added lines, -13 removed lines

@@ -47,12 +47,12 @@ 
         $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 (Collection $routes, $groupName) {
+            'item' => $this->routeGroups->map(function(Collection $routes, $groupName) {
                 return [
                     'name' => $groupName,
                     'description' => $routes->first()['metadata']['groupDescription'],
@@ -61,7 +61,7 @@ 
             })->values()->toArray(),
         ];
 
-        if (! empty($this->auth)) {
+        if (!empty($this->auth)) {
             $collection['auth'] = $this->auth;
         }
 
@@ -96,7 +96,7 @@ 
 
         // Exclude authentication headers if they're handled by Postman auth
         $authHeader = $this->getAuthHeader();
-        if (! empty($authHeader)) {
+        if (!empty($authHeader)) {
             $headers = $headers->except($authHeader);
         }
 
@@ -104,7 +104,7 @@ 
             ->union([
                 'Accept' => 'application/json',
             ])
-            ->map(function ($value, $header) {
+            ->map(function($value, $header) {
                 return [
                     'key' => $header,
                     'value' => $value,
@@ -118,8 +118,8 @@ 
     {
         // URL Parameters are collected by the `UrlParameters` strategies, but only make sense if they're in the route
         // definition. Filter out any URL parameters that don't appear in the URL.
-        $urlParams = collect($route['urlParameters'])->filter(function ($_, $key) use ($route) {
-            return Str::contains($route['uri'], '{'.$key.'}');
+        $urlParams = collect($route['urlParameters'])->filter(function($_, $key) use ($route) {
+            return Str::contains($route['uri'], '{' . $key . '}');
         });
 
         /** @var Collection $queryParams */
@@ -127,16 +127,16 @@ 
             'protocol' => $this->protocol,
             'host' => $this->baseUrl,
             // Substitute laravel/symfony query params ({example}) to Postman style, prefixed with a colon
-            'path' => preg_replace_callback('/\/{(\w+)\??}(?=\/|$)/', function ($matches) {
-                return '/:'.$matches[1];
+            'path' => preg_replace_callback('/\/{(\w+)\??}(?=\/|$)/', function($matches) {
+                return '/:' . $matches[1];
             }, $route['uri']),
-            'query' => collect($route['queryParameters'])->map(function ($parameter, $key) {
+            'query' => collect($route['queryParameters'])->map(function($parameter, $key) {
                 return [
                     'key' => $key,
                     'value' => urlencode($parameter['value']),
                     'description' => $parameter['description'],
                     // Default query params to disabled if they aren't required and have empty values
-                    'disabled' => ! $parameter['required'] && empty($parameter['value']),
+                    'disabled' => !$parameter['required'] && empty($parameter['value']),
                 ];
             })->values()->toArray(),
         ];
@@ -147,7 +147,7 @@ 
             return $base;
         }
 
-        $base['variable'] = $urlParams->map(function ($parameter, $key) {
+        $base['variable'] = $urlParams->map(function($parameter, $key) {
             return [
                 'id' => $key,
                 'key' => $key,
@@ -162,7 +162,7 @@ 
     protected function getAuthHeader()
     {
         $auth = $this->auth;
-        if (empty($auth) || ! is_string($auth['type'] ?? null)) {
+        if (empty($auth) || !is_string($auth['type'] ?? null)) {
             return null;
         }
 

src/ApiDoc.php

Spacing +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
         Route::prefix($path)
             ->namespace('\Mpociot\ApiDoc\Http')
             ->middleware(static::middleware())
-            ->group(function () {
+            ->group(function() {
                 Route::get('/', 'Controller@html')->name('apidoc');
                 Route::get('.json', 'Controller@json')->name('apidoc.json');
             });