Apply fixes from StyleCI

mpociot · StyleCIBot · commit c089591a74dd · 2020-03-07T17:13:23.000Z
diff --git a/src/ApiDocGeneratorServiceProvider.php b/src/ApiDocGeneratorServiceProvider.php
@@ -17,17 +17,17 @@ class ApiDocGeneratorServiceProvider extends ServiceProvider
      */
     public function boot()
     {
-        $this->loadViewsFrom(__DIR__.'/../resources/views/', 'apidoc');
+        $this->loadViewsFrom(__DIR__ . '/../resources/views/', 'apidoc');
 
         $this->publishes([
-            __DIR__.'/../resources/views' => $this->app->basePath('resources/views/vendor/apidoc'),
+            __DIR__ . '/../resources/views' => $this->app->basePath('resources/views/vendor/apidoc'),
         ], 'apidoc-views');
 
         $this->publishes([
-            __DIR__.'/../config/apidoc.php' => $this->app->configPath('apidoc.php'),
+            __DIR__ . '/../config/apidoc.php' => $this->app->configPath('apidoc.php'),
         ], 'apidoc-config');
 
-        $this->mergeConfigFrom(__DIR__.'/../config/apidoc.php', 'apidoc');
+        $this->mergeConfigFrom(__DIR__ . '/../config/apidoc.php', 'apidoc');
 
         $this->bootRoutes();
 
@@ -52,7 +52,7 @@ protected function bootRoutes()
             config('apidoc.laravel.autoload', false)
         ) {
             $this->loadRoutesFrom(
-                __DIR__.'/../routes/laravel.php'
+                __DIR__ . '/../routes/laravel.php'
             );
         }
     }
diff --git a/src/Commands/GenerateDocumentation.php b/src/Commands/GenerateDocumentation.php
@@ -101,7 +101,7 @@ private function processRoutes(Generator $generator, array $routes)
             $routePath = $generator->getUri($route);
 
             if ($this->isClosureRoute($route->getAction())) {
-                $this->warn(sprintf($messageFormat, 'Skipping', $routeMethods, $routePath).': Closure routes are not supported.');
+                $this->warn(sprintf($messageFormat, 'Skipping', $routeMethods, $routePath) . ': Closure routes are not supported.');
                 continue;
             }
 
@@ -112,20 +112,20 @@ private function processRoutes(Generator $generator, array $routes)
             }
 
             if (! $this->doesControllerMethodExist($routeControllerAndMethod)) {
-                $this->warn(sprintf($messageFormat, 'Skipping', $routeMethods, $routePath).': Controller method does not exist.');
+                $this->warn(sprintf($messageFormat, 'Skipping', $routeMethods, $routePath) . ': Controller method does not exist.');
                 continue;
             }
 
             if (! $this->isRouteVisibleForDocumentation($routeControllerAndMethod)) {
-                $this->warn(sprintf($messageFormat, 'Skipping', $routeMethods, $routePath).': @hideFromAPIDocumentation was specified.');
+                $this->warn(sprintf($messageFormat, 'Skipping', $routeMethods, $routePath) . ': @hideFromAPIDocumentation was specified.');
                 continue;
             }
 
             try {
                 $parsedRoutes[] = $generator->processRoute($route, $routeItem->getRules());
                 $this->info(sprintf($messageFormat, 'Processed', $routeMethods, $routePath));
             } catch (\Exception $exception) {
-                $this->warn(sprintf($messageFormat, 'Skipping', $routeMethods, $routePath).'- Exception '.get_class($exception).' encountered : '.$exception->getMessage());
+                $this->warn(sprintf($messageFormat, 'Skipping', $routeMethods, $routePath) . '- Exception ' . get_class($exception) . ' encountered : ' . $exception->getMessage());
             }
         }
 
diff --git a/src/Commands/RebuildDocumentation.php b/src/Commands/RebuildDocumentation.php
@@ -16,12 +16,12 @@ public function handle()
     {
         $sourceOutputPath = 'resources/docs/source';
         if (! is_dir($sourceOutputPath)) {
-            $this->error('There is no existing documentation available at '.$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();
diff --git a/src/Extracting/Generator.php b/src/Extracting/Generator.php
@@ -58,7 +58,7 @@ public function processRoute(Route $route, array $routeRules = [])
         $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),
         ];
@@ -213,7 +213,9 @@ protected function cleanParams(array $params)
 
         foreach ($params as $paramName => $details) {
             $this->generateConcreteSampleForArrayKeys(
-                $paramName, $details['value'], $values
+                $paramName,
+                $details['value'],
+                $values
             );
         }
 
diff --git a/src/Extracting/ParamHelpers.php b/src/Extracting/ParamHelpers.php
@@ -33,7 +33,7 @@ protected function generateDummyValue(string $type)
                 return [];
             },
             'object' => function () {
-                return new stdClass;
+                return new stdClass();
             },
         ];
 
diff --git a/src/Extracting/RouteDocBlocker.php b/src/Extracting/RouteDocBlocker.php
@@ -63,9 +63,9 @@ protected static function cacheDocBlocks(Route $route, string $className, string
     private static function getRouteCacheId(Route $route, string $className, string $methodName): string
     {
         return $route->uri()
-            .':'
-            .implode(array_diff($route->methods(), ['HEAD']))
-            .$className
-            .$methodName;
+            . ':'
+            . implode(array_diff($route->methods(), ['HEAD']))
+            . $className
+            . $methodName;
     }
 }
diff --git a/src/Extracting/Strategies/Responses/ResponseCalls.php b/src/Extracting/Strategies/Responses/ResponseCalls.php
@@ -52,7 +52,7 @@ public function __invoke(Route $route, \ReflectionClass $controller, \Reflection
                 ],
             ];
         } 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 {
@@ -366,7 +366,7 @@ protected function transformHeadersToServerVars(array $headers)
         foreach ($headers as $name => $value) {
             $name = strtr(strtoupper($name), '-', '_');
             if (! Str::startsWith($name, $prefix) && $name !== 'CONTENT_TYPE') {
-                $name = $prefix.$name;
+                $name = $prefix . $name;
             }
             $server[$name] = $value;
         }
diff --git a/src/Extracting/Strategies/Responses/UseApiResourceTags.php b/src/Extracting/Strategies/Responses/UseApiResourceTags.php
@@ -90,7 +90,7 @@ protected function getApiResourceResponse(array $tags, Route $route)
                 ],
             ];
         } catch (\Exception $e) {
-            echo 'Exception thrown when fetching Eloquent API resource response for ['.implode(',', $route->methods)."] {$route->uri}.\n";
+            echo 'Exception thrown when fetching Eloquent API resource response for [' . implode(',', $route->methods) . "] {$route->uri}.\n";
             if (Flags::$shouldBeVerbose) {
                 Utils::dumpException($e);
             } else {
@@ -156,7 +156,7 @@ protected function instantiateApiResourceModel(string $type)
                 echo "Eloquent model factory failed to instantiate {$type}; trying to fetch from database.\n";
             }
 
-            $instance = new $type;
+            $instance = new $type();
             if ($instance instanceof \Illuminate\Database\Eloquent\Model) {
                 try {
                     // we can't use a factory but can try to get one from the database
diff --git a/src/Extracting/Strategies/Responses/UseResponseFileTag.php b/src/Extracting/Strategies/Responses/UseResponseFileTag.php
@@ -58,7 +58,7 @@ protected function getFileResponses(array $tags)
             $relativeFilePath = trim($result[2]);
             $filePath = storage_path($relativeFilePath);
             if (! file_exists($filePath)) {
-                throw new \Exception('@responseFile '.$relativeFilePath.' does not exist');
+                throw new \Exception('@responseFile ' . $relativeFilePath . ' does not exist');
             }
             $status = $result[1] ?: 200;
             $content = $result[2] ? file_get_contents($filePath, true) : '{}';
diff --git a/src/Extracting/Strategies/Responses/UseTransformerTags.php b/src/Extracting/Strategies/Responses/UseTransformerTags.php
@@ -72,8 +72,9 @@ protected function getTransformerResponse(array $tags, Route $route)
             $resource = (strtolower($transformerTag->getName()) == 'transformercollection')
                 ? new Collection(
                     [$modelInstance, $this->instantiateTransformerModel($model)],
-                    new $transformer)
-                : new Item($modelInstance, new $transformer);
+                    new $transformer()
+                )
+                : new Item($modelInstance, new $transformer());
 
             $response = response($fractal->createData($resource)->toJson());
 
@@ -84,7 +85,7 @@ protected function getTransformerResponse(array $tags, Route $route)
                 ],
             ];
         } 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 {
@@ -162,7 +163,7 @@ protected function instantiateTransformerModel(string $type)
                 echo "Eloquent model factory failed to instantiate {$type}; trying to fetch from database.\n";
             }
 
-            $instance = new $type;
+            $instance = new $type();
             if ($instance instanceof IlluminateModel) {
                 try {
                     // we can't use a factory but can try to get one from the database
diff --git a/src/Matching/RouteMatcher/Match.php b/src/Matching/RouteMatcher/Match.php
@@ -49,15 +49,15 @@ public function getRules()
      */
     public function offsetExists($offset)
     {
-        return is_callable([$this, 'get'.ucfirst($offset)]);
+        return is_callable([$this, 'get' . ucfirst($offset)]);
     }
 
     /**
      * {@inheritdoc}
      */
     public function offsetGet($offset)
     {
-        return call_user_func([$this, 'get'.ucfirst($offset)]);
+        return call_user_func([$this, 'get' . ucfirst($offset)]);
     }
 
     /**
diff --git a/src/Writing/PostmanCollectionWriter.php b/src/Writing/PostmanCollectionWriter.php
@@ -48,7 +48,7 @@ public function getCollection()
         $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',
@@ -120,7 +120,7 @@ protected function makeUrlData($route)
         // 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.'}');
+            return Str::contains($route['uri'], '{' . $key . '}');
         });
 
         /** @var Collection $queryParams */
@@ -129,7 +129,7 @@ protected function makeUrlData($route)
             '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];
+                return '/:' . $matches[1];
             }, $route['uri']),
             'query' => collect($route['queryParameters'])->map(function ($parameter, $key) {
                 return [
diff --git a/src/Writing/Writer.php b/src/Writing/Writer.php
@@ -91,8 +91,8 @@ public function writeDocs(Collection $routes)
      */
     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')
@@ -116,14 +116,14 @@ public function writeMarkdownAndSourceFiles(Collection $parsedRoutes)
 
             $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 (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,7 +146,7 @@ public function writeMarkdownAndSourceFiles(Collection $parsedRoutes)
             ->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)) {
             $documentarian = new Documentarian();
@@ -169,7 +169,7 @@ public function writeMarkdownAndSourceFiles(Collection $parsedRoutes)
 
         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
@@ -234,18 +234,18 @@ public function generatePostmanCollection(Collection $routes)
 
     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;
     }
diff --git a/tests/Fixtures/TestController.php b/tests/Fixtures/TestController.php
@@ -190,7 +190,7 @@ public function shouldFetchRouteResponse()
             'id' => (int) $fruit->id,
             'name' => trim($fruit->name),
             'color' => strtolower($fruit->color),
-            'weight' => $fruit->weight.' kg',
+            'weight' => $fruit->weight . ' kg',
             'delicious' => $fruit->delicious,
             'responseCall' => true,
         ];
diff --git a/tests/Fixtures/TestUserApiResource.php b/tests/Fixtures/TestUserApiResource.php
@@ -17,7 +17,7 @@ public function toArray($request)
     {
         return [
             'id' => $this->id,
-            'name' => $this->first_name.' '.$this->last_name,
+            'name' => $this->first_name . ' ' . $this->last_name,
             'email' => $this->email,
         ];
     }
diff --git a/tests/GenerateDocumentationTest.php b/tests/GenerateDocumentationTest.php
diff --git a/tests/Unit/DingoGeneratorTest.php b/tests/Unit/DingoGeneratorTest.php
diff --git a/tests/Unit/GeneratorTestCase.php b/tests/Unit/GeneratorTestCase.php
diff --git a/tests/Unit/LaravelGeneratorTest.php b/tests/Unit/LaravelGeneratorTest.php

Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@ private function processRoutes(Generator $generator, array $routes)`
`101`	`101`	`$routePath = $generator->getUri($route);`
`102`	`102`
`103`	`103`	`if ($this->isClosureRoute($route->getAction())) {`
`104`		`- $this->warn(sprintf($messageFormat, 'Skipping', $routeMethods, $routePath).': Closure routes are not supported.');`
	`104`	`+ $this->warn(sprintf($messageFormat, 'Skipping', $routeMethods, $routePath) . ': Closure routes are not supported.');`
`105`	`105`	`continue;`
`106`	`106`	`}`
`107`	`107`
`@@ -112,20 +112,20 @@ private function processRoutes(Generator $generator, array $routes)`
`112`	`112`	`}`
`113`	`113`
`114`	`114`	`if (! $this->doesControllerMethodExist($routeControllerAndMethod)) {`
`115`		`- $this->warn(sprintf($messageFormat, 'Skipping', $routeMethods, $routePath).': Controller method does not exist.');`
	`115`	`+ $this->warn(sprintf($messageFormat, 'Skipping', $routeMethods, $routePath) . ': Controller method does not exist.');`
`116`	`116`	`continue;`
`117`	`117`	`}`
`118`	`118`
`119`	`119`	`if (! $this->isRouteVisibleForDocumentation($routeControllerAndMethod)) {`
`120`		`- $this->warn(sprintf($messageFormat, 'Skipping', $routeMethods, $routePath).': @hideFromAPIDocumentation was specified.');`
	`120`	`+ $this->warn(sprintf($messageFormat, 'Skipping', $routeMethods, $routePath) . ': @hideFromAPIDocumentation was specified.');`
`121`	`121`	`continue;`
`122`	`122`	`}`
`123`	`123`
`124`	`124`	`try {`
`125`	`125`	`$parsedRoutes[] = $generator->processRoute($route, $routeItem->getRules());`
`126`	`126`	`$this->info(sprintf($messageFormat, 'Processed', $routeMethods, $routePath));`
`127`	`127`	`} catch (\Exception $exception) {`
`128`		`- $this->warn(sprintf($messageFormat, 'Skipping', $routeMethods, $routePath).'- Exception '.get_class($exception).' encountered : '.$exception->getMessage());`
	`128`	`+ $this->warn(sprintf($messageFormat, 'Skipping', $routeMethods, $routePath) . '- Exception ' . get_class($exception) . ' encountered : ' . $exception->getMessage());`
`129`	`129`	`}`
`130`	`130`	`}`
`131`	`131`
Original file line number	Diff line number	Diff line change
`@@ -16,12 +16,12 @@ public function handle()`
`16`	`16`	`{`
`17`	`17`	`$sourceOutputPath = 'resources/docs/source';`
`18`	`18`	`if (! is_dir($sourceOutputPath)) {`
`19`		`- $this->error('There is no existing documentation available at '.$sourceOutputPath.'.');`
	`19`	`+ $this->error('There is no existing documentation available at ' . $sourceOutputPath . '.');`
`20`	`20`
`21`	`21`	`return false;`
`22`	`22`	`}`
`23`	`23`
`24`		`- $this->info('Rebuilding API documentation from '.$sourceOutputPath.'/index.md');`
	`24`	`+ $this->info('Rebuilding API documentation from ' . $sourceOutputPath . '/index.md');`
`25`	`25`
`26`	`26`	`$writer = new Writer($this, new DocumentationConfig(config('apidoc')));`
`27`	`27`	`$writer->writeHtmlDocs();`
Original file line number	Diff line number	Diff line change
`@@ -63,9 +63,9 @@ protected static function cacheDocBlocks(Route $route, string $className, string`
`63`	`63`	`private static function getRouteCacheId(Route $route, string $className, string $methodName): string`
`64`	`64`	`{`
`65`	`65`	`return $route->uri()`
`66`		`- .':'`
`67`		`- .implode(array_diff($route->methods(), ['HEAD']))`
`68`		`- .$className`
`69`		`- .$methodName;`
	`66`	`+ . ':'`
	`67`	`+ . implode(array_diff($route->methods(), ['HEAD']))`
	`68`	`+ . $className`
	`69`	`+ . $methodName;`
`70`	`70`	`}`
`71`	`71`	`}`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ protected function getFileResponses(array $tags)`
`58`	`58`	`$relativeFilePath = trim($result[2]);`
`59`	`59`	`$filePath = storage_path($relativeFilePath);`
`60`	`60`	`if (! file_exists($filePath)) {`
`61`		`- throw new \Exception('@responseFile '.$relativeFilePath.' does not exist');`
	`61`	`+ throw new \Exception('@responseFile ' . $relativeFilePath . ' does not exist');`
`62`	`62`	`}`
`63`	`63`	`$status = $result[1] ?: 200;`
`64`	`64`	`$content = $result[2] ? file_get_contents($filePath, true) : '{}';`