mpociot / laravel-apidoc-generator

src/Mpociot/ApiDoc/Commands/GenerateDocumentation.php

Spacing +24 added lines, -24 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,15 +109,15 @@ 
     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';
+        $targetFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . 'index.md';
+        $compareFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . '.compare.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;
@@ -137,16 +137,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];
                         }
                     }
@@ -163,10 +163,10 @@ 
             ->with('frontmatter', $frontmatter)
             ->with('infoText', $infoText)
             ->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);
         }
 
@@ -179,23 +179,23 @@ 
             ->with('frontmatter', $frontmatter)
             ->with('infoText', $infoText)
             ->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));
         }
     }
 
@@ -224,7 +224,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);
@@ -273,9 +273,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));
                 }
             }
         }
@@ -290,7 +290,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']);
     }
 
     /**
@@ -307,7 +307,7 @@ 
             $phpdoc = new DocBlock($comment);
 
             return collect($phpdoc->getTags())
-                ->filter(function ($tag) use ($route) {
+                ->filter(function($tag) use ($route) {
                     return $tag->getName() === 'hideFromAPIDocumentation';
                 })
                 ->isEmpty();

src/Mpociot/ApiDoc/Generators/AbstractGenerator.php

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();