mpociot / laravel-apidoc-generator

src/Mpociot/ApiDoc/Parsers/RuleDescriptionParser.php

Doc Comments +1 added lines, -1 removed lines

@@ -77,7 +77,7 @@
     }
 
     /**
-     * @param null $rule
+     * @param string $rule
      *
      * @return static
      */

Spacing +2 added lines, -4 removed lines

@@ -34,8 +34,7 @@ 
     public function with($parameters)
     {
         is_array($parameters) ?
-            $this->parameters += $parameters :
-            $this->parameters[] = $parameters;
+            $this->parameters += $parameters : $this->parameters[] = $parameters;
 
         return $this;
     }
@@ -54,8 +53,7 @@ 
     protected function makeDescription()
     {
         $description = trans()->hasForLocale($this->rule) ?
-                            trans()->get($this->rule) :
-                            trans()->get($this->rule, [], self::DEFAULT_LOCALE);
+                            trans()->get($this->rule) : trans()->get($this->rule, [], self::DEFAULT_LOCALE);
 
         return $this->replaceAttributes($description);
     }

src/Mpociot/ApiDoc/ApiDocGeneratorServiceProvider.php

Spacing +7 added lines, -7 removed lines

@@ -15,12 +15,12 @@ 
      */
     public function boot()
     {
-        $this->loadViewsFrom(__DIR__.'/../../resources/views/', 'apidoc');
-        $this->loadTranslationsFrom(__DIR__.'/../../resources/lang', 'apidoc');
+        $this->loadViewsFrom(__DIR__ . '/../../resources/views/', 'apidoc');
+        $this->loadTranslationsFrom(__DIR__ . '/../../resources/lang', 'apidoc');
 
         $this->publishes([
-            __DIR__.'/../../resources/lang' => $this->resource_path('lang/vendor/apidoc'),
-            __DIR__.'/../../resources/views' => $this->resource_path('views/vendor/apidoc'),
+            __DIR__ . '/../../resources/lang' => $this->resource_path('lang/vendor/apidoc'),
+            __DIR__ . '/../../resources/views' => $this->resource_path('views/vendor/apidoc'),
         ]);
     }
 
@@ -31,10 +31,10 @@ 
      */
     public function register()
     {
-        $this->app->singleton('apidoc.generate', function () {
+        $this->app->singleton('apidoc.generate', function() {
             return new GenerateDocumentation();
         });
-        $this->app->singleton('apidoc.update', function () {
+        $this->app->singleton('apidoc.update', function() {
             return new UpdateDocumentation();
         });
 
@@ -53,6 +53,6 @@ 
      */
     public function resource_path($path = '')
     {
-        return app()->basePath().'/resources'.($path ? '/'.$path : $path);
+        return app()->basePath() . '/resources' . ($path ? '/' . $path : $path);
     }
 }

src/Mpociot/ApiDoc/Postman/CollectionWriter.php

Spacing +3 added lines, -3 removed lines

@@ -32,11 +32,11 @@ 
                 '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) {
                         return [
                             'name' => $route['title'] != '' ? $route['title'] : url($route['uri']),
                             'request' => [
@@ -44,7 +44,7 @@ 
                                 'method' => $route['methods'][0],
                                 'body' => [
                                     'mode' => 'formdata',
-                                    'formdata' => collect($route['parameters'])->map(function ($parameter, $key) {
+                                    'formdata' => collect($route['parameters'])->map(function($parameter, $key) {
                                         return [
                                             'key' => $key,
                                             'value' => isset($parameter['value']) ? $parameter['value'] : '',

src/Mpociot/ApiDoc/Commands/UpdateDocumentation.php

Spacing +3 added lines, -3 removed lines

@@ -44,8 +44,8 @@ 
 
         $documentarian = new Documentarian();
 
-        if (! is_dir($outputPath)) {
-            $this->error('There is no generated documentation available at '.$outputPath.'.');
+        if (!is_dir($outputPath)) {
+            $this->error('There is no generated documentation available at ' . $outputPath . '.');
 
             return false;
         }
@@ -53,6 +53,6 @@ 
 
         $documentarian->generate($outputPath);
 
-        $this->info('Wrote HTML documentation to: '.$outputPath.'/index.html');
+        $this->info('Wrote HTML documentation to: ' . $outputPath . '/index.html');
     }
 }

src/Mpociot/ApiDoc/Generators/DingoGenerator.php

Spacing +1 added lines, -1 removed lines

@@ -25,7 +25,7 @@
     {
         $dispatcher = app('Dingo\Api\Dispatcher')->raw();
 
-        collect($server)->map(function ($key, $value) use ($dispatcher) {
+        collect($server)->map(function($key, $value) use ($dispatcher) {
             $dispatcher->header($value, $key);
         });
 

src/Mpociot/ApiDoc/Generators/LaravelGenerator.php

Spacing +1 added lines, -1 removed lines

@@ -57,7 +57,7 @@
      */
     public function prepareMiddleware($enable = true)
     {
-        App::instance('middleware.disable', ! $enable);
+        App::instance('middleware.disable', !$enable);
     }
 
     /**

Doc Comments -1 removed lines

@@ -41,7 +41,6 @@
     /**
      * Prepares / Disables route middlewares.
      *
-     * @param  bool $disable
      *
      * @return  void
      */

src/Mpociot/ApiDoc/Generators/AbstractGenerator.php

Doc Comments +7 added lines, -8 removed lines

@@ -22,7 +22,7 @@ 
     /**
      * @param Route $route
      *
-     * @return mixed
+     * @return string|null
      */
     public function getDomain(Route $route)
     {
@@ -32,7 +32,7 @@ 
     /**
      * @param Route $route
      *
-     * @return mixed
+     * @return string
      */
     public function getUri(Route $route)
     {
@@ -109,7 +109,6 @@ 
     /**
      * Prepares / Disables route middlewares.
      *
-     * @param  bool $disable
      *
      * @return  void
      */
@@ -120,7 +119,7 @@ 
      *
      * @param array $tags
      *
-     * @return mixed
+     * @return null|\Symfony\Component\HttpFoundation\Response
      */
     protected function getDocblockResponse($tags)
     {
@@ -193,7 +192,7 @@ 
     }
 
     /**
-     * @param  $route
+     * @param  Route $route
      * @param  $bindings
      * @param  $headers
      *
@@ -224,7 +223,7 @@ 
      * @param $route
      * @param array $bindings
      *
-     * @return mixed
+     * @return string
      */
     protected function addRouteModelBindings($route, $bindings)
     {
@@ -643,7 +642,7 @@ 
      * @param  string  $rule
      * @param  string  $parameter
      *
-     * @return array
+     * @return string
      */
     protected function parseParameters($rule, $parameter)
     {
@@ -674,7 +673,7 @@ 
     }
 
     /**
-     * @param $response
+     * @param null|\Symfony\Component\HttpFoundation\Response $response
      *
      * @return mixed
      */

Spacing +25 added lines, -25 removed lines

@@ -75,7 +75,7 @@ 
             $response = $docblockResponse;
             $showresponse = true;
         }
-        if (! $response) {
+        if (!$response) {
             $transformerResponse = $this->getTransformerResponse($routeDescription['tags']);
             if ($transformerResponse) {
                 // we have a transformer response from the docblock ( @transformer || @transformercollection )
@@ -83,18 +83,18 @@ 
                 $showresponse = true;
             }
         }
-        if (! $response && $withResponse) {
+        if (!$response && $withResponse) {
             try {
                 $response = $this->getRouteResponse($route, $bindings, $headers);
             } catch (\Exception $e) {
-                echo "Couldn't get response for route: ".implode(',', $this->getMethods($route)).$route->uri().']: '.$e->getMessage()."\n";
+                echo "Couldn't get response for route: " . implode(',', $this->getMethods($route)) . $route->uri() . ']: ' . $e->getMessage() . "\n";
             }
         }
 
         $content = $this->getResponseContent($response);
 
         return $this->getParameters([
-            'id' => md5($this->getUri($route).':'.implode($this->getMethods($route))),
+            'id' => md5($this->getUri($route) . ':' . implode($this->getMethods($route))),
             'resource' => $routeGroup,
             'title' => $routeDescription['short'],
             'description' => $routeDescription['long'],
@@ -124,8 +124,8 @@ 
      */
     protected function getDocblockResponse($tags)
     {
-        $responseTags = array_filter($tags, function ($tag) {
-            if (! ($tag instanceof Tag)) {
+        $responseTags = array_filter($tags, function($tag) {
+            if (!($tag instanceof Tag)) {
                 return false;
             }
 
@@ -187,9 +187,9 @@ 
         // Laravel will ignore the nested array rules unless the key referenced exists and is an array
         // So we'll to create an empty array for each array attribute
         $values = collect($rules)
-            ->filter(function ($values) {
+            ->filter(function($values) {
                 return in_array('array', $values);
-            })->map(function ($val, $key) {
+            })->map(function($val, $key) {
                 return [''];
             })->all();
 
@@ -212,7 +212,7 @@ 
         $methods = $this->getMethods($route);
 
         // Split headers into key - value pairs
-        $headers = collect($headers)->map(function ($value) {
+        $headers = collect($headers)->map(function($value) {
             $split = explode(':', $value); // explode to get key + values
             $key = array_shift($split); // extract the key and keep the values in the array
             $value = implode(':', $split); // implode values into string again
@@ -236,8 +236,8 @@ 
     {
         $uri = $this->getUri($route);
         foreach ($bindings as $model => $id) {
-            $uri = str_replace('{'.$model.'}', $id, $uri);
-            $uri = str_replace('{'.$model.'?}', $id, $uri);
+            $uri = str_replace('{' . $model . '}', $id, $uri);
+            $uri = str_replace('{' . $model . '?}', $id, $uri);
         }
 
         return $uri;
@@ -301,7 +301,7 @@ 
 
         foreach ($reflectionMethod->getParameters() as $parameter) {
             $parameterType = $parameter->getClass();
-            if (! is_null($parameterType) && class_exists($parameterType->name)) {
+            if (!is_null($parameterType) && class_exists($parameterType->name)) {
                 $className = $parameterType->name;
 
                 if (is_subclass_of($className, FormRequest::class)) {
@@ -337,8 +337,8 @@ 
      */
     protected function fancyImplode($arr, $first, $last)
     {
-        $arr = array_map(function ($value) {
-            return '`'.$value.'`';
+        $arr = array_map(function($value) {
+            return '`' . $value . '`';
         }, $arr);
         array_push($arr, implode($last, array_splice($arr, -2)));
 
@@ -348,8 +348,8 @@ 
     protected function splitValuePairs($parameters, $first = 'is ', $last = 'or ')
     {
         $attribute = '';
-        collect($parameters)->map(function ($item, $key) use (&$attribute, $first, $last) {
-            $attribute .= '`'.$item.'` ';
+        collect($parameters)->map(function($item, $key) use (&$attribute, $first, $last) {
+            $attribute .= '`' . $item . '` ';
             if (($key + 1) % 2 === 0) {
                 $attribute .= $last;
             } else {
@@ -432,7 +432,7 @@ 
                 }
                 break;
             case 'between':
-                if (! isset($attributeData['type'])) {
+                if (!isset($attributeData['type'])) {
                     $attributeData['type'] = 'numeric';
                 }
                 $attributeData['description'][] = Description::parse($rule)->with($parameters)->getDescription();
@@ -610,8 +610,8 @@ 
         foreach ($headers as $name => $value) {
             $name = strtr(strtoupper($name), '-', '_');
 
-            if (! Str::startsWith($name, $prefix) && $name !== 'CONTENT_TYPE') {
-                $name = $prefix.$name;
+            if (!Str::startsWith($name, $prefix) && $name !== 'CONTENT_TYPE') {
+                $name = $prefix . $name;
             }
 
             $server[$name] = $value;
@@ -708,8 +708,8 @@ 
     protected function getTransformerResponse($tags)
     {
         try {
-            $transFormerTags = array_filter($tags, function ($tag) {
-                if (! ($tag instanceof Tag)) {
+            $transFormerTags = array_filter($tags, function($tag) {
+                if (!($tag instanceof Tag)) {
                     return false;
                 }
 
@@ -720,8 +720,8 @@ 
                 return false;
             }
 
-            $modelTag = array_first(array_filter($tags, function ($tag) {
-                if (! ($tag instanceof Tag)) {
+            $modelTag = array_first(array_filter($tags, function($tag) {
+                if (!($tag instanceof Tag)) {
                     return false;
                 }
 
@@ -729,7 +729,7 @@ 
             }));
             $tag = \array_first($transFormerTags);
             $transformer = $tag->getContent();
-            if (! \class_exists($transformer)) {
+            if (!\class_exists($transformer)) {
                 // if we can't find the transformer we can't generate a response
                 return;
             }
@@ -745,7 +745,7 @@ 
             if (version_compare(PHP_VERSION, '7.0.0') >= 0 && \is_null($type)) {
                 // we can only get the type with reflection for PHP 7
                 if ($parameter->hasType() &&
-                    ! $parameter->getType()->isBuiltin() &&
+                    !$parameter->getType()->isBuiltin() &&
                     \class_exists((string) $parameter->getType())) {
                     //we have a type
                     $type = (string) $parameter->getType();

src/Mpociot/ApiDoc/Commands/GenerateDocumentation.php

Indentation +1 added lines, -1 removed lines

@@ -278,7 +278,7 @@
                 || (str_is($routeDomain, $generator->getDomain($route))
                     && str_is($routePrefix, $generator->getUri($route)))
                 || in_array($middleware, $route->middleware())
-               ) {
+                ) {
                 if ($this->isValidRoute($route) && $this->isRouteVisibleForDocumentation($route->getAction()['uses'])) {
                     $parsedRoutes[] = $generator->processRoute($route, $bindings, $this->option('header'), $withResponse && in_array('GET', $generator->getMethods($route)));
                     $this->info('Processed route: ['.implode(',', $generator->getMethods($route)).'] '.$generator->getUri($route));

Spacing +28 added lines, -28 removed lines

@@ -76,7 +76,7 @@ 
 
         $this->setUserToBeImpersonated($this->option('actAsUserId'));
 
-        if ($routePrefix === null && $routeDomain === null && ! count($allowedRoutes) && $middleware === null) {
+        if ($routePrefix === null && $routeDomain === null && !count($allowedRoutes) && $middleware === null) {
             $this->error('You must provide either a route prefix, a route domain, a route or a middleware to generate the documentation.');
 
             return false;
@@ -94,7 +94,7 @@ 
                 $parsedRoutes += $this->processRoutes($generator, $allowedRoutes, $routeDomain, $routePrefix, $middleware);
             }
         }
-        $parsedRoutes = collect($parsedRoutes)->groupBy('resource')->sort(function ($a, $b) {
+        $parsedRoutes = collect($parsedRoutes)->groupBy('resource')->sort(function($a, $b) {
             return strcmp($a->first()['resource'], $b->first()['resource']);
         });
 
@@ -109,17 +109,17 @@ 
     private function writeMarkdown($parsedRoutes)
     {
         $outputPath = $this->option('output');
-        $targetFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'index.md';
-        $compareFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'.compare.md';
-        $prependFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'prepend.md';
-        $appendFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'append.md';
+        $targetFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . 'index.md';
+        $compareFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . '.compare.md';
+        $prependFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . 'prepend.md';
+        $appendFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . 'append.md';
 
         $infoText = view('apidoc::partials.info')
             ->with('outputPath', ltrim($outputPath, 'public/'))
-            ->with('showPostmanCollectionButton', ! $this->option('noPostmanCollection'));
+            ->with('showPostmanCollectionButton', !$this->option('noPostmanCollection'));
 
-        $parsedRouteOutput = $parsedRoutes->map(function ($routeGroup) {
-            return $routeGroup->map(function ($route) {
+        $parsedRouteOutput = $parsedRoutes->map(function($routeGroup) {
+            return $routeGroup->map(function($route) {
                 $route['output'] = (string) view('apidoc::partials.route')->with('parsedRoute', $route)->render();
 
                 return $route;
@@ -139,16 +139,16 @@ 
                 $frontmatter = trim($generatedFrontmatter[1], "\n");
             }
 
-            $parsedRouteOutput->transform(function ($routeGroup) use ($generatedDocumentation, $compareDocumentation) {
-                return $routeGroup->transform(function ($route) use ($generatedDocumentation, $compareDocumentation) {
-                    if (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $generatedDocumentation, $routeMatch)) {
-                        $routeDocumentationChanged = (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $compareDocumentation, $compareMatch) && $compareMatch[1] !== $routeMatch[1]);
+            $parsedRouteOutput->transform(function($routeGroup) use ($generatedDocumentation, $compareDocumentation) {
+                return $routeGroup->transform(function($route) use ($generatedDocumentation, $compareDocumentation) {
+                    if (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $generatedDocumentation, $routeMatch)) {
+                        $routeDocumentationChanged = (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $compareDocumentation, $compareMatch) && $compareMatch[1] !== $routeMatch[1]);
                         if ($routeDocumentationChanged === false || $this->option('force')) {
                             if ($routeDocumentationChanged) {
-                                $this->warn('Discarded manual changes for route ['.implode(',', $route['methods']).'] '.$route['uri']);
+                                $this->warn('Discarded manual changes for route [' . implode(',', $route['methods']) . '] ' . $route['uri']);
                             }
                         } else {
-                            $this->warn('Skipping modified route ['.implode(',', $route['methods']).'] '.$route['uri']);
+                            $this->warn('Skipping modified route [' . implode(',', $route['methods']) . '] ' . $route['uri']);
                             $route['modified_output'] = $routeMatch[0];
                         }
                     }
@@ -159,9 +159,9 @@ 
         }
 
         $prependFileContents = file_exists($prependFile)
-            ? file_get_contents($prependFile)."\n" : '';
+            ? file_get_contents($prependFile) . "\n" : '';
         $appendFileContents = file_exists($appendFile)
-            ? "\n".file_get_contents($appendFile) : '';
+            ? "\n" . file_get_contents($appendFile) : '';
 
         $documentarian = new Documentarian();
 
@@ -172,10 +172,10 @@ 
             ->with('prependMd', $prependFileContents)
             ->with('appendMd', $appendFileContents)
             ->with('outputPath', $this->option('output'))
-            ->with('showPostmanCollectionButton', ! $this->option('noPostmanCollection'))
+            ->with('showPostmanCollectionButton', !$this->option('noPostmanCollection'))
             ->with('parsedRoutes', $parsedRouteOutput);
 
-        if (! is_dir($outputPath)) {
+        if (!is_dir($outputPath)) {
             $documentarian->create($outputPath);
         }
 
@@ -190,23 +190,23 @@ 
             ->with('prependMd', $prependFileContents)
             ->with('appendMd', $appendFileContents)
             ->with('outputPath', $this->option('output'))
-            ->with('showPostmanCollectionButton', ! $this->option('noPostmanCollection'))
+            ->with('showPostmanCollectionButton', !$this->option('noPostmanCollection'))
             ->with('parsedRoutes', $parsedRouteOutput);
 
         file_put_contents($compareFile, $compareMarkdown);
 
-        $this->info('Wrote index.md to: '.$outputPath);
+        $this->info('Wrote index.md to: ' . $outputPath);
 
         $this->info('Generating API HTML code');
 
         $documentarian->generate($outputPath);
 
-        $this->info('Wrote HTML documentation to: '.$outputPath.'/index.html');
+        $this->info('Wrote HTML documentation to: ' . $outputPath . '/index.html');
 
         if ($this->option('noPostmanCollection') !== true) {
             $this->info('Generating Postman collection');
 
-            file_put_contents($outputPath.DIRECTORY_SEPARATOR.'collection.json', $this->generatePostmanCollection($parsedRoutes));
+            file_put_contents($outputPath . DIRECTORY_SEPARATOR . 'collection.json', $this->generatePostmanCollection($parsedRoutes));
         }
     }
 
@@ -235,7 +235,7 @@ 
      */
     private function setUserToBeImpersonated($actAs)
     {
-        if (! empty($actAs)) {
+        if (!empty($actAs)) {
             if (version_compare($this->laravel->version(), '5.2.0', '<')) {
                 $userModel = config('auth.model');
                 $user = $userModel::find($actAs);
@@ -284,9 +284,9 @@ 
                ) {
                 if ($this->isValidRoute($route) && $this->isRouteVisibleForDocumentation($route->getAction()['uses'])) {
                     $parsedRoutes[] = $generator->processRoute($route, $bindings, $this->option('header'), $withResponse && in_array('GET', $generator->getMethods($route)));
-                    $this->info('Processed route: ['.implode(',', $generator->getMethods($route)).'] '.$generator->getUri($route));
+                    $this->info('Processed route: [' . implode(',', $generator->getMethods($route)) . '] ' . $generator->getUri($route));
                 } else {
-                    $this->warn('Skipping route: ['.implode(',', $generator->getMethods($route)).'] '.$generator->getUri($route));
+                    $this->warn('Skipping route: [' . implode(',', $generator->getMethods($route)) . '] ' . $generator->getUri($route));
                 }
             }
         }
@@ -301,7 +301,7 @@ 
      */
     private function isValidRoute(Route $route)
     {
-        return ! is_callable($route->getAction()['uses']) && ! is_null($route->getAction()['uses']);
+        return !is_callable($route->getAction()['uses']) && !is_null($route->getAction()['uses']);
     }
 
     /**
@@ -318,7 +318,7 @@ 
             $phpdoc = new DocBlock($comment);
 
             return collect($phpdoc->getTags())
-                ->filter(function ($tag) use ($route) {
+                ->filter(function($tag) use ($route) {
                     return $tag->getName() === 'hideFromAPIDocumentation';
                 })
                 ->isEmpty();