mpociot / laravel-apidoc-generator

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/ParamHelpers.php

Spacing +7 added lines, -7 removed lines

@@ -14,25 +14,25 @@
             $faker->seed($this->config->get('faker_seed'));
         }
         $fakeFactories = [
-            'integer' => function () use ($faker) {
+            'integer' => function() use ($faker) {
                 return $faker->numberBetween(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 $faker->word;
             },
-            'array' => function () {
+            'array' => function() {
                 return [];
             },
-            'object' => function () {
+            'object' => function() {
                 return new stdClass();
             },
         ];

src/Extracting/Strategies/Responses/UseApiResourceTags.php

Spacing +2 added lines, -2 removed lines

@@ -123,7 +123,7 @@ 
      */
     private function getClassToBeTransformed(array $tags): string
     {
-        $modelTag = Arr::first(array_filter($tags, function ($tag) {
+        $modelTag = Arr::first(array_filter($tags, function($tag) {
             return ($tag instanceof Tag) && strtolower($tag->getName()) == 'apiresourcemodel';
         }));
 
@@ -184,7 +184,7 @@ 
     private function getApiResourceTag(array $tags)
     {
         $apiResourceTags = array_values(
-            array_filter($tags, function ($tag) {
+            array_filter($tags, function($tag) {
                 return ($tag instanceof Tag) && in_array(strtolower($tag->getName()), ['apiresource', 'apiresourcecollection']);
             })
         );

src/Extracting/Strategies/Responses/UseTransformerTags.php

Spacing +4 added lines, -4 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')));
             }
 
@@ -121,7 +121,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';
         }));
 
@@ -130,7 +130,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();
             }
@@ -191,7 +191,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']);
             })
         );

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/Extracting/Generator.php

Spacing +6 added lines, -6 removed lines

@@ -83,7 +83,7 @@ 
 
         $responses = $this->fetchResponses($controller, $method, $route, $routeRules, $parsedRoute);
         $parsedRoute['responses'] = $responses;
-        $parsedRoute['showresponse'] = ! empty($responses);
+        $parsedRoute['showresponse'] = !empty($responses);
 
         return $parsedRoute;
     }
@@ -120,7 +120,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;
             });
         }
@@ -170,7 +170,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
@@ -182,7 +182,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;
@@ -207,8 +207,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) {

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;