mpociot / laravel-apidoc-generator

src/Tools/ResponseResolver.php

Doc Comments +3 added lines

@@ -37,6 +37,9 @@
         }
     }
 
+    /**
+     * @param Route $route
+     */
     public static function getResponse($route, $tags, $rulesToApply)
     {
         return (new static($route))->resolve($tags, $rulesToApply);

Spacing +1 added lines, -1 removed lines

@@ -31,7 +31,7 @@
         foreach (static::$strategies as $strategy) {
             $strategy = new $strategy();
             $response = $strategy($this->route, $tags, $rulesToApply);
-            if (! is_null($response)) {
+            if (!is_null($response)) {
                 return $this->getResponseContent($response);
             }
         }

src/Tools/ResponseStrategies/ResponseCallStrategy.php

Doc Comments +2 added lines, -2 removed lines

@@ -58,7 +58,7 @@ 
      * @param Route $route
      * @param array $bindings
      *
-     * @return mixed
+     * @return string
      */
     protected function replaceUrlParameterBindings(Route $route, $bindings)
     {
@@ -189,7 +189,7 @@ 
     }
 
     /**
-     * @param $request
+     * @param Request $request
      *
      * @return \Symfony\Component\HttpFoundation\Response
      */

Spacing +5 added lines, -5 removed lines

@@ -15,7 +15,7 @@ 
     public function __invoke(Route $route, array $tags, array $rulesToApply)
     {
         $rulesToApply = $rulesToApply['response_calls'] ?? [];
-        if (! $this->shouldMakeApiCall($route, $rulesToApply)) {
+        if (!$this->shouldMakeApiCall($route, $rulesToApply)) {
             return;
         }
 
@@ -119,14 +119,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);
         }
 
@@ -233,8 +233,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 +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
      */
     protected function getDocBlockResponse(array $tags)
     {
-        $responseTags = array_filter($tags, function ($tag) {
+        $responseTags = array_filter($tags, function($tag) {
             return $tag instanceof Tag && strtolower($tag->getName()) == 'response';
         });
         if (empty($responseTags)) {

src/Generators/Generator.php

Doc Comments +4 added lines, -2 removed lines

@@ -15,7 +15,7 @@ 
     /**
      * @param Route $route
      *
-     * @return mixed
+     * @return string
      */
     public function getUri(Route $route)
     {
@@ -34,7 +34,6 @@ 
 
     /**
      * @param  \Illuminate\Routing\Route $route
-     * @param array $apply Rules to apply when generating documentation for this route
      *
      * @return array
      */
@@ -167,6 +166,9 @@ 
         return 'general';
     }
 
+    /**
+     * @return string
+     */
     private function normalizeParameterType($type)
     {
         $typeMap = [

Spacing +12 added lines, -12 removed lines

@@ -60,7 +60,7 @@ 
         $content = ResponseResolver::getResponse($route, $docBlock['tags'], $rulesToApply);
 
         $parsedRoute = [
-            'id' => md5($this->getUri($route).':'.implode($this->getMethods($route))),
+            'id' => md5($this->getUri($route) . ':' . implode($this->getMethods($route))),
             'group' => $routeGroup,
             'title' => $docBlock['short'],
             'description' => $docBlock['long'],
@@ -69,7 +69,7 @@ 
             'parameters' => $this->getParametersFromDocBlock($docBlock['tags']),
             'authenticated' => $this->getAuthStatusFromDocBlock($docBlock['tags']),
             'response' => $content,
-            'showresponse' => ! empty($content),
+            'showresponse' => !empty($content),
         ];
         $parsedRoute['headers'] = $rulesToApply['headers'] ?? [];
 
@@ -93,10 +93,10 @@ 
     protected function getParametersFromDocBlock(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);
                 if (empty($content)) {
                     // this means only name and type were supplied
@@ -130,7 +130,7 @@ 
     protected function getAuthStatusFromDocBlock(array $tags)
     {
         $authTag = collect($tags)
-            ->first(function ($tag) {
+            ->first(function($tag) {
                 return $tag instanceof Tag && strtolower($tag->getName()) === 'authenticated';
             });
 
@@ -202,25 +202,25 @@ 
     {
         $faker = Factory::create();
         $fakes = [
-            'integer' => function () {
+            'integer' => function() {
                 return rand(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 str_random();
             },
-            'array' => function () {
+            'array' => function() {
                 return '[]';
             },
-            'object' => function () {
+            'object' => function() {
                 return '{}';
             },
         ];

src/Commands/GenerateDocumentation.php

Spacing +23 added lines, -23 removed lines

@@ -55,7 +55,7 @@ 
         $generator = new Generator();
         $parsedRoutes = $this->processRoutes($generator, $routes);
         $parsedRoutes = collect($parsedRoutes)->groupBy('group')
-            ->sort(function ($a, $b) {
+            ->sort(function($a, $b) {
                 return strcmp($a->first()['group'], $b->first()['group']);
             });
 
@@ -70,17 +70,17 @@ 
     private function writeMarkdown($parsedRoutes)
     {
         $outputPath = config('apidoc.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', config('apidoc.postman'));
 
-        $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('route', $route)->render();
 
                 return $route;
@@ -100,16 +100,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, $existingRouteDoc)) {
-                        $routeDocumentationChanged = (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $compareDocumentation, $lastDocWeGeneratedForThisRoute) && $lastDocWeGeneratedForThisRoute[1] !== $existingRouteDoc[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, $existingRouteDoc)) {
+                        $routeDocumentationChanged = (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $compareDocumentation, $lastDocWeGeneratedForThisRoute) && $lastDocWeGeneratedForThisRoute[1] !== $existingRouteDoc[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'] = $existingRouteDoc[0];
                         }
                     }
@@ -120,9 +120,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();
 
@@ -136,7 +136,7 @@ 
             ->with('showPostmanCollectionButton', config('apidoc.postman'))
             ->with('parsedRoutes', $parsedRouteOutput);
 
-        if (! is_dir($outputPath)) {
+        if (!is_dir($outputPath)) {
             $documentarian->create($outputPath);
         }
 
@@ -156,18 +156,18 @@ 
 
         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 (config('apidoc.postman')) {
             $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));
         }
     }
 
@@ -185,9 +185,9 @@ 
             /** @var Route $route */
             if ($this->isValidRoute($route) && $this->isRouteVisibleForDocumentation($route->getAction()['uses'])) {
                 $parsedRoutes[] = $generator->processRoute($route, $routeItem['apply']);
-                $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));
             }
         }
 
@@ -201,7 +201,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']);
     }
 
     /**
@@ -218,7 +218,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/Tools/ResponseStrategies/TransformerTagsStrategy.php

Spacing +3 added lines, -3 removed lines

@@ -67,7 +67,7 @@ 
      */
     private function getClassToBeTransformed(array $tags, ReflectionMethod $transformerMethod)
     {
-        $modelTag = array_first(array_filter($tags, function ($tag) {
+        $modelTag = array_first(array_filter($tags, function($tag) {
             return ($tag instanceof Tag) && strtolower($tag->getName()) == 'transformermodel';
         }));
 
@@ -76,7 +76,7 @@ 
             $type = $modelTag->getContent();
         } else {
             $parameter = array_first($transformerMethod->getParameters());
-            if ($parameter->hasType() && ! $parameter->getType()->isBuiltin() && class_exists((string) $parameter->getType())) {
+            if ($parameter->hasType() && !$parameter->getType()->isBuiltin() && class_exists((string) $parameter->getType())) {
                 // ladies and gentlemen, we have a type!
                 $type = (string) $parameter->getType();
             }
@@ -120,7 +120,7 @@ 
      */
     private function getTransformerTag(array $tags)
     {
-        $transFormerTags = array_filter($tags, function ($tag) {
+        $transFormerTags = array_filter($tags, function($tag) {
             return ($tag instanceof Tag) && in_array(strtolower($tag->getName()), ['transformer', 'transformercollection']);
         });