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 $urlParameters Dictionary of url params and example values
      *
-     * @return mixed
+     * @return string
      */
     public static function replaceUrlParameterPlaceholdersWithValues(string $uri, array $urlParameters)
     {

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');
             });

routes/laravel.php

Spacing +1 added lines, -1 removed lines

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

src/Writing/Writer.php

Spacing +9 added lines, -9 removed lines

@@ -114,8 +114,8 @@ 
             $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) {
+            $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) {
@@ -148,7 +148,7 @@ 
 
         $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);
         }
@@ -174,14 +174,14 @@ 
 
     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)
@@ -253,7 +253,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");
@@ -274,7 +274,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/Writing/PostmanCollectionWriter.php

Spacing +10 added lines, -10 removed lines

@@ -53,7 +53,7 @@ 
                 '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'],
@@ -62,7 +62,7 @@ 
             })->values()->toArray(),
         ];
 
-        if (! empty($this->auth)) {
+        if (!empty($this->auth)) {
             $collection['auth'] = $this->auth;
         }
 
@@ -97,7 +97,7 @@ 
 
         // Exclude authentication headers if they're handled by Postman auth
         $authHeader = $this->getAuthHeader();
-        if (! empty($authHeader)) {
+        if (!empty($authHeader)) {
             $headers = $headers->except($authHeader);
         }
 
@@ -105,7 +105,7 @@ 
             ->union([
                 'Accept' => 'application/json',
             ])
-            ->map(function ($value, $header) {
+            ->map(function($value, $header) {
                 return [
                     'key' => $header,
                     'value' => $value,
@@ -119,7 +119,7 @@ 
     {
         // 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) {
+        $urlParams = collect($route['urlParameters'])->filter(function($_, $key) use ($route) {
             return Str::contains($route['uri'], '{' . $key . '}');
         });
 
@@ -128,16 +128,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) {
+            '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(),
         ];
@@ -148,7 +148,7 @@ 
             return $base;
         }
 
-        $base['variable'] = $urlParams->map(function ($parameter, $key) {
+        $base['variable'] = $urlParams->map(function($parameter, $key) {
             return [
                 'id' => $key,
                 'key' => $key,
@@ -163,7 +163,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/Extracting/Strategies/Responses/ResponseCalls.php

Spacing +5 added lines, -5 removed lines

@@ -31,7 +31,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;
         }
 
@@ -194,14 +194,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);
         }
 
@@ -329,7 +329,7 @@ 
         }
 
         // Don't attempt a response call if there are already successful responses
-        $successResponses = collect($context['responses'])->filter(function ($response) {
+        $successResponses = collect($context['responses'])->filter(function($response) {
             return ((string) $response['status'])[0] == '2';
         })->count();
         if ($successResponses) {
@@ -365,7 +365,7 @@ 
         $prefix = 'HTTP_';
         foreach ($headers as $name => $value) {
             $name = strtr(strtoupper($name), '-', '_');
-            if (! Str::startsWith($name, $prefix) && $name !== 'CONTENT_TYPE') {
+            if (!Str::startsWith($name, $prefix) && $name !== 'CONTENT_TYPE') {
                 $name = $prefix . $name;
             }
             $server[$name] = $value;

src/Extracting/Strategies/Responses/UseResponseFileTag.php

Spacing +4 added lines, -4 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)) {
+            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/Commands/RebuildDocumentation.php

Spacing +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
     public function handle()
     {
         $sourceOutputPath = 'resources/docs/source';
-        if (! is_dir($sourceOutputPath)) {
+        if (!is_dir($sourceOutputPath)) {
             $this->error('There is no existing documentation available at ' . $sourceOutputPath . '.');
 
             return false;

src/Commands/GenerateDocumentation.php

Spacing +7 added lines, -7 removed lines

@@ -70,7 +70,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);
@@ -106,17 +106,17 @@ 
             }
 
             $routeControllerAndMethod = Utils::getRouteClassAndMethodNames($route->getAction());
-            if (! $this->isValidRoute($routeControllerAndMethod)) {
+            if (!$this->isValidRoute($routeControllerAndMethod)) {
                 $this->warn(sprintf($messageFormat, 'Skipping invalid', $routeMethods, $routePath));
                 continue;
             }
 
-            if (! $this->doesControllerMethodExist($routeControllerAndMethod)) {
+            if (!$this->doesControllerMethodExist($routeControllerAndMethod)) {
                 $this->warn(sprintf($messageFormat, 'Skipping', $routeMethods, $routePath) . ': Controller method does not exist.');
                 continue;
             }
 
-            if (! $this->isRouteVisibleForDocumentation($routeControllerAndMethod)) {
+            if (!$this->isRouteVisibleForDocumentation($routeControllerAndMethod)) {
                 $this->warn(sprintf($messageFormat, 'Skipping', $routeMethods, $routePath) . ': @hideFromAPIDocumentation was specified.');
                 continue;
             }
@@ -143,7 +143,7 @@ 
             $routeControllerAndMethod = implode('@', $routeControllerAndMethod);
         }
 
-        return ! is_callable($routeControllerAndMethod) && ! is_null($routeControllerAndMethod);
+        return !is_callable($routeControllerAndMethod) && !is_null($routeControllerAndMethod);
     }
 
     /**
@@ -168,7 +168,7 @@ 
         [$class, $method] = $routeControllerAndMethod;
         $reflection = new ReflectionClass($class);
 
-        if (! $reflection->hasMethod($method)) {
+        if (!$reflection->hasMethod($method)) {
             return false;
         }
 
@@ -193,7 +193,7 @@ 
             $phpdoc = new DocBlock($comment);
 
             return collect($phpdoc->getTags())
-                ->filter(function ($tag) {
+                ->filter(function($tag) {
                     return $tag->getName() === 'hideFromAPIDocumentation';
                 })
                 ->isEmpty();