Completed
Push — master ( 8a4595...976f5e )
by Marcel
04:24 queued 01:58
created
src/Mpociot/ApiDoc/Commands/GenerateDocumentation.php 1 patch
Spacing   +25 added lines, -25 removed lines patch added patch discarded remove patch
@@ -69,7 +69,7 @@  discard block
 block discarded – undo
69 69
 
70 70
         $this->setUserToBeImpersonated($this->option('actAsUserId'));
71 71
 
72
-        if ($routePrefix === null && ! count($allowedRoutes) && $middleware === null) {
72
+        if ($routePrefix === null && !count($allowedRoutes) && $middleware === null) {
73 73
             $this->error('You must provide either a route prefix or a route or a middleware to generate the documentation.');
74 74
 
75 75
             return false;
@@ -93,15 +93,15 @@  discard block
 block discarded – undo
93 93
     private function writeMarkdown($parsedRoutes)
94 94
     {
95 95
         $outputPath = $this->option('output');
96
-        $targetFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'index.md';
97
-        $compareFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'.compare.md';
96
+        $targetFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . 'index.md';
97
+        $compareFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . '.compare.md';
98 98
 
99 99
         $infoText = view('apidoc::partials.info')
100 100
             ->with('outputPath', ltrim($outputPath, 'public/'))
101
-            ->with('showPostmanCollectionButton', ! $this->option('noPostmanCollection'));
101
+            ->with('showPostmanCollectionButton', !$this->option('noPostmanCollection'));
102 102
 
103
-        $parsedRouteOutput = $parsedRoutes->map(function ($routeGroup) {
104
-            return $routeGroup->map(function ($route) {
103
+        $parsedRouteOutput = $parsedRoutes->map(function($routeGroup) {
104
+            return $routeGroup->map(function($route) {
105 105
                 $route['output'] = (string) view('apidoc::partials.route')->with('parsedRoute', $route);
106 106
 
107 107
                 return $route;
@@ -125,16 +125,16 @@  discard block
 block discarded – undo
125 125
                 $frontmatter = trim($generatedFrontmatter[1], "\n");
126 126
             }
127 127
 
128
-            $parsedRouteOutput->transform(function ($routeGroup) use ($generatedDocumentation, $compareDocumentation) {
129
-                return $routeGroup->transform(function ($route) use ($generatedDocumentation, $compareDocumentation) {
130
-                    if (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $generatedDocumentation, $routeMatch)) {
131
-                        $routeDocumentationChanged = (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $compareDocumentation, $compareMatch) && $compareMatch[1] !== $routeMatch[1]);
132
-                        if ($routeDocumentationChanged === false ||  $this->option('force')) {
128
+            $parsedRouteOutput->transform(function($routeGroup) use ($generatedDocumentation, $compareDocumentation) {
129
+                return $routeGroup->transform(function($route) use ($generatedDocumentation, $compareDocumentation) {
130
+                    if (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $generatedDocumentation, $routeMatch)) {
131
+                        $routeDocumentationChanged = (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $compareDocumentation, $compareMatch) && $compareMatch[1] !== $routeMatch[1]);
132
+                        if ($routeDocumentationChanged === false || $this->option('force')) {
133 133
                             if ($routeDocumentationChanged) {
134
-                                $this->warn('Discarded manual changes for route ['.implode(',', $route['methods']).'] '.$route['uri']);
134
+                                $this->warn('Discarded manual changes for route [' . implode(',', $route['methods']) . '] ' . $route['uri']);
135 135
                             }
136 136
                         } else {
137
-                            $this->warn('Skipping modified route ['.implode(',', $route['methods']).'] '.$route['uri']);
137
+                            $this->warn('Skipping modified route [' . implode(',', $route['methods']) . '] ' . $route['uri']);
138 138
                             $route['modified_output'] = $routeMatch[0];
139 139
                         }
140 140
                     }
@@ -151,10 +151,10 @@  discard block
 block discarded – undo
151 151
             ->with('frontmatter', $frontmatter)
152 152
             ->with('infoText', $infoText)
153 153
             ->with('outputPath', $this->option('output'))
154
-            ->with('showPostmanCollectionButton', ! $this->option('noPostmanCollection'))
154
+            ->with('showPostmanCollectionButton', !$this->option('noPostmanCollection'))
155 155
             ->with('parsedRoutes', $parsedRouteOutput);
156 156
 
157
-        if (! is_dir($outputPath)) {
157
+        if (!is_dir($outputPath)) {
158 158
             $documentarian->create($outputPath);
159 159
         }
160 160
 
@@ -167,24 +167,24 @@  discard block
 block discarded – undo
167 167
             ->with('frontmatter', $frontmatter)
168 168
             ->with('infoText', $infoText)
169 169
             ->with('outputPath', $this->option('output'))
170
-            ->with('showPostmanCollectionButton', ! $this->option('noPostmanCollection'))
170
+            ->with('showPostmanCollectionButton', !$this->option('noPostmanCollection'))
171 171
             ->with('parsedRoutes', $parsedRouteOutput);
172 172
 
173 173
         file_put_contents($compareFile, $compareMarkdown);
174 174
 
175
-        $this->info('Wrote index.md to: '.$outputPath);
175
+        $this->info('Wrote index.md to: ' . $outputPath);
176 176
 
177 177
         $this->info('Generating API HTML code');
178 178
 
179 179
         $documentarian->generate($outputPath);
180 180
 
181
-        $this->info('Wrote HTML documentation to: '.$outputPath.'/public/index.html');
181
+        $this->info('Wrote HTML documentation to: ' . $outputPath . '/public/index.html');
182 182
 
183 183
 
184 184
         if ($this->option('noPostmanCollection') !== true) {
185 185
             $this->info('Generating Postman collection');
186 186
 
187
-            file_put_contents($outputPath.DIRECTORY_SEPARATOR.'collection.json', $this->generatePostmanCollection($parsedRoutes));
187
+            file_put_contents($outputPath . DIRECTORY_SEPARATOR . 'collection.json', $this->generatePostmanCollection($parsedRoutes));
188 188
         }
189 189
     }
190 190
 
@@ -212,7 +212,7 @@  discard block
 block discarded – undo
212 212
      */
213 213
     private function setUserToBeImpersonated($actAs)
214 214
     {
215
-        if (! empty($actAs)) {
215
+        if (!empty($actAs)) {
216 216
             if (version_compare($this->laravel->version(), '5.2.0', '<')) {
217 217
                 $userModel = config('auth.model');
218 218
                 $user = $userModel::find((int) $actAs);
@@ -254,9 +254,9 @@  discard block
 block discarded – undo
254 254
             if (in_array($route->getName(), $allowedRoutes) || str_is($routePrefix, $route->getUri()) || in_array($middleware, $route->middleware())) {
255 255
                 if ($this->isValidRoute($route) && $this->isRouteVisibleForDocumentation($route->getAction()['uses'])) {
256 256
                     $parsedRoutes[] = $generator->processRoute($route, $bindings, $withResponse);
257
-                    $this->info('Processed route: ['.implode(',', $route->getMethods()).'] '.$route->getUri());
257
+                    $this->info('Processed route: [' . implode(',', $route->getMethods()) . '] ' . $route->getUri());
258 258
                 } else {
259
-                    $this->warn('Skipping route: ['.implode(',', $route->getMethods()).'] '.$route->getUri());
259
+                    $this->warn('Skipping route: [' . implode(',', $route->getMethods()) . '] ' . $route->getUri());
260 260
                 }
261 261
             }
262 262
         }
@@ -280,7 +280,7 @@  discard block
 block discarded – undo
280 280
         foreach ($routes as $route) {
281 281
             if (empty($allowedRoutes) || in_array($route->getName(), $allowedRoutes) || str_is($routePrefix, $route->uri())) {
282 282
                 $parsedRoutes[] = $generator->processRoute($route, $bindings, $withResponse);
283
-                $this->info('Processed route: ['.implode(',', $route->getMethods()).'] '.$route->uri());
283
+                $this->info('Processed route: [' . implode(',', $route->getMethods()) . '] ' . $route->uri());
284 284
             }
285 285
         }
286 286
 
@@ -294,7 +294,7 @@  discard block
 block discarded – undo
294 294
      */
295 295
     private function isValidRoute($route)
296 296
     {
297
-        return ! is_callable($route->getAction()['uses']) && ! is_null($route->getAction()['uses']);
297
+        return !is_callable($route->getAction()['uses']) && !is_null($route->getAction()['uses']);
298 298
     }
299 299
 
300 300
     /**
@@ -311,7 +311,7 @@  discard block
 block discarded – undo
311 311
             $phpdoc = new DocBlock($comment);
312 312
 
313 313
             return collect($phpdoc->getTags())
314
-                ->filter(function ($tag) use ($route) {
314
+                ->filter(function($tag) use ($route) {
315 315
                     return $tag->getName() === 'hideFromAPIDocumentation';
316 316
                 })
317 317
                 ->isEmpty();
Please login to merge, or discard this patch.