mpociot / laravel-apidoc-generator

src/Tools/ResponseResolver.php

Spacing +2 added lines, -2 removed lines

@@ -48,8 +48,8 @@
             /** @var Response[]|null $response */
             $responses = $strategy($this->route, $tags, $routeProps);
 
-            if (! is_null($responses)) {
-                return array_map(function (Response $response) {
+            if (!is_null($responses)) {
+                return array_map(function(Response $response) {
                     return ['status' => $response->getStatusCode(), 'content' => $this->getResponseContent($response)];
                 }, $responses);
             }

src/ApiDocGeneratorServiceProvider.php

Spacing +4 added lines, -4 removed lines

@@ -15,17 +15,17 @@
      */
     public function boot()
     {
-        $this->loadViewsFrom(__DIR__.'/../resources/views/', 'apidoc');
+        $this->loadViewsFrom(__DIR__ . '/../resources/views/', 'apidoc');
 
         $this->publishes([
-            __DIR__.'/../resources/views' => app()->basePath().'/resources/views/vendor/apidoc',
+            __DIR__ . '/../resources/views' => app()->basePath() . '/resources/views/vendor/apidoc',
         ], 'apidoc-views');
 
         $this->publishes([
-            __DIR__.'/../config/apidoc.php' => app()->basePath().'/config/apidoc.php',
+            __DIR__ . '/../config/apidoc.php' => app()->basePath() . '/config/apidoc.php',
         ], 'apidoc-config');
 
-        $this->mergeConfigFrom(__DIR__.'/../config/apidoc.php', 'apidoc');
+        $this->mergeConfigFrom(__DIR__ . '/../config/apidoc.php', 'apidoc');
 
         if ($this->app->runningInConsole()) {
             $this->commands([

src/Commands/RebuildDocumentation.php

Spacing +4 added lines, -4 removed lines

@@ -42,15 +42,15 @@
 
         $documentarian = new Documentarian();
 
-        if (! is_dir($outputPath)) {
-            $this->error('There is no existing documentation available at '.$outputPath.'.');
+        if (!is_dir($outputPath)) {
+            $this->error('There is no existing documentation available at ' . $outputPath . '.');
 
             return false;
         }
-        $this->info('Rebuilding API HTML code from '.$outputPath.'/source/index.md');
+        $this->info('Rebuilding API HTML code from ' . $outputPath . '/source/index.md');
 
         $documentarian->generate($outputPath);
 
-        $this->info('Wrote HTML documentation to: '.$outputPath.'/index.html');
+        $this->info('Wrote HTML documentation to: ' . $outputPath . '/index.html');
     }
 }

src/Tools/DocumentationConfig.php

Doc Comments +4 added lines

@@ -11,6 +11,10 @@
         $this->data = $config;
     }
 
+    /**
+     * @param string $key
+     * @param boolean $default
+     */
     public function get($key, $default = null)
     {
         return data_get($this->data, $key, $default);

src/Tools/Utils.php

Spacing +1 added lines, -1 removed lines

@@ -68,7 +68,7 @@
 
     public static function deleteDirectoryAndContents($dir)
     {
-        $adapter = new Local(realpath(__DIR__.'/../../'));
+        $adapter = new Local(realpath(__DIR__ . '/../../'));
         $fs = new Filesystem($adapter);
         $fs->deleteDir($dir);
     }

src/Postman/CollectionWriter.php

Spacing +8 added lines, -8 removed lines

@@ -41,32 +41,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 = $route['methods'][0] === 'PUT' ? 'urlencoded' : 'formdata';
 
                         return [
                             'name' => $route['title'] != '' ? $route['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,
@@ -75,7 +75,7 @@ 
                                     ->values()->all(),
                                 'body' => [
                                     'mode' => $mode,
-                                    $mode => collect($route['bodyParameters'])->map(function ($parameter, $key) {
+                                    $mode => collect($route['bodyParameters'])->map(function($parameter, $key) {
                                         return [
                                             'key' => $key,
                                             'value' => $parameter['value'] ?? '',

src/Tools/Generator.php

Doc Comments +2 added lines, -2 removed lines

@@ -28,7 +28,7 @@ 
     /**
      * @param Route $route
      *
-     * @return mixed
+     * @return string
      */
     public function getUri(Route $route)
     {
@@ -163,7 +163,7 @@ 
      * @param ReflectionMethod $method
      * @param array $tags
      *
-     * @return array
+     * @return Route
      */
     protected function getQueryParameters(ReflectionMethod $method, array $tags)
     {

Spacing +17 added lines, -17 removed lines

@@ -69,7 +69,7 @@ 
         ]);
 
         $parsedRoute = [
-            'id' => md5($this->getUri($route).':'.implode($this->getMethods($route))),
+            'id' => md5($this->getUri($route) . ':' . implode($this->getMethods($route))),
             'groupName' => $routeGroupName,
             'groupDescription' => $routeGroupDescription,
             'title' => $routeTitle ?: $docBlock['short'],
@@ -83,7 +83,7 @@ 
             'cleanQueryParameters' => $this->cleanParams($queryParameters),
             'authenticated' => $this->getAuthStatusFromDocBlock($docBlock['tags']),
             'response' => $content,
-            'showresponse' => ! empty($content),
+            'showresponse' => !empty($content),
         ];
         $parsedRoute['headers'] = $rulesToApply['headers'] ?? [];
 
@@ -129,10 +129,10 @@ 
     protected function getBodyParametersFromDocBlock(array $tags)
     {
         $parameters = collect($tags)
-            ->filter(function ($tag) {
+            ->filter(function($tag) {
                 return $tag instanceof Tag && $tag->getName() === 'bodyParam';
             })
-            ->mapWithKeys(function ($tag) {
+            ->mapWithKeys(function($tag) {
                 preg_match('/(.+?)\s+(.+?)\s+(required\s+)?(.*)/', $tag->getContent(), $content);
                 $content = preg_replace('/\s?No-example.?/', '', $content);
                 if (empty($content)) {
@@ -152,7 +152,7 @@ 
 
                 $type = $this->normalizeParameterType($type);
                 list($description, $example) = $this->parseDescription($description, $type);
-                $value = is_null($example) && ! $this->shouldExcludeExample($tag) ? $this->generateDummyValue($type) : $example;
+                $value = is_null($example) && !$this->shouldExcludeExample($tag) ? $this->generateDummyValue($type) : $example;
 
                 return [$name => compact('type', 'description', 'required', 'value')];
             })->toArray();
@@ -205,10 +205,10 @@ 
     protected function getQueryParametersFromDocBlock(array $tags)
     {
         $parameters = collect($tags)
-            ->filter(function ($tag) {
+            ->filter(function($tag) {
                 return $tag instanceof Tag && $tag->getName() === 'queryParam';
             })
-            ->mapWithKeys(function ($tag) {
+            ->mapWithKeys(function($tag) {
                 preg_match('/(.+?)\s+(required\s+)?(.*)/', $tag->getContent(), $content);
                 $content = preg_replace('/\s?No-example.?/', '', $content);
                 if (empty($content)) {
@@ -227,7 +227,7 @@ 
                 }
 
                 list($description, $value) = $this->parseDescription($description, 'string');
-                if (is_null($value) && ! $this->shouldExcludeExample($tag)) {
+                if (is_null($value) && !$this->shouldExcludeExample($tag)) {
                     $value = Str::contains($description, ['number', 'count', 'page'])
                         ? $this->generateDummyValue('integer')
                         : $this->generateDummyValue('string');
@@ -247,7 +247,7 @@ 
     protected function getAuthStatusFromDocBlock(array $tags)
     {
         $authTag = collect($tags)
-            ->first(function ($tag) {
+            ->first(function($tag) {
                 return $tag instanceof Tag && strtolower($tag->getName()) === 'authenticated';
             });
 
@@ -280,7 +280,7 @@ 
     protected function getRouteGroup(ReflectionClass $controller, array $methodDocBlock)
     {
         // @group tag on the method overrides that on the controller
-        if (! empty($methodDocBlock['tags'])) {
+        if (!empty($methodDocBlock['tags'])) {
             foreach ($methodDocBlock['tags'] as $tag) {
                 if ($tag->getName() === 'group') {
                     $routeGroupParts = explode("\n", trim($tag->getContent()));
@@ -347,25 +347,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/Tools/ResponseStrategies/ResponseCallStrategy.php

Spacing +6 added lines, -6 removed lines

@@ -27,7 +27,7 @@ 
     public function __invoke(Route $route, array $tags, array $routeProps)
     {
         $rulesToApply = $routeProps['rules']['response_calls'] ?? [];
-        if (! $this->shouldMakeApiCall($route, $rulesToApply)) {
+        if (!$this->shouldMakeApiCall($route, $rulesToApply)) {
             return null;
         }
 
@@ -37,7 +37,7 @@ 
         try {
             $response = [$this->makeApiCall($request)];
         } 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 {
@@ -174,14 +174,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);
         }
 
@@ -330,8 +330,8 @@ 
         $prefix = 'HTTP_';
         foreach ($headers as $name => $value) {
             $name = strtr(strtoupper($name), '-', '_');
-            if (! starts_with($name, $prefix) && $name !== 'CONTENT_TYPE') {
-                $name = $prefix.$name;
+            if (!starts_with($name, $prefix) && $name !== 'CONTENT_TYPE') {
+                $name = $prefix . $name;
             }
             $server[$name] = $value;
         }

src/Tools/ResponseStrategies/ResponseTagStrategy.php

Spacing +2 added lines, -2 removed lines

@@ -33,7 +33,7 @@ 
     protected function getDocBlockResponses(array $tags)
     {
         $responseTags = array_values(
-            array_filter($tags, function ($tag) {
+            array_filter($tags, function($tag) {
                 return $tag instanceof Tag && strtolower($tag->getName()) === 'response';
             })
         );
@@ -42,7 +42,7 @@ 
             return null;
         }
 
-        return array_map(function (Tag $responseTag) {
+        return array_map(function(Tag $responseTag) {
             preg_match('/^(\d{3})?\s?([\s\S]*)$/', $responseTag->getContent(), $result);
 
             $status = $result[1] ?: 200;