Completed
Pull Request — master (#445)
by
unknown
02:10
created
src/Tools/Generator.php 1 patch
Spacing   +14 added lines, -14 removed lines patch added patch discarded remove patch
@@ -58,7 +58,7 @@  discard block
 block discarded – undo
58 58
         ]);
59 59
 
60 60
         $parsedRoute = [
61
-            'id' => md5($this->getUri($route).':'.implode($this->getMethods($route))),
61
+            'id' => md5($this->getUri($route) . ':' . implode($this->getMethods($route))),
62 62
             'group' => $routeGroup,
63 63
             'title' => $docBlock['short'],
64 64
             'description' => $docBlock['long'],
@@ -69,7 +69,7 @@  discard block
 block discarded – undo
69 69
             'queryParameters' => $queryParameters,
70 70
             'authenticated' => $this->getAuthStatusFromDocBlock($docBlock['tags']),
71 71
             'response' => $content,
72
-            'showresponse' => ! empty($content),
72
+            'showresponse' => !empty($content),
73 73
         ];
74 74
         $parsedRoute['headers'] = $rulesToApply['headers'] ?? [];
75 75
 
@@ -84,10 +84,10 @@  discard block
 block discarded – undo
84 84
     protected function getBodyParametersFromDocBlock(array $tags)
85 85
     {
86 86
         $parameters = collect($tags)
87
-            ->filter(function ($tag) {
87
+            ->filter(function($tag) {
88 88
                 return $tag instanceof Tag && $tag->getName() === 'bodyParam';
89 89
             })
90
-            ->mapWithKeys(function ($tag) {
90
+            ->mapWithKeys(function($tag) {
91 91
                 preg_match('/(.+?)\s+(.+?)\s+(required\s+)?(.*)/', $tag->getContent(), $content);
92 92
                 if (empty($content)) {
93 93
                     // this means only name and type were supplied
@@ -122,10 +122,10 @@  discard block
 block discarded – undo
122 122
     protected function getQueryParametersFromDocBlock(array $tags)
123 123
     {
124 124
         $parameters = collect($tags)
125
-            ->filter(function ($tag) {
125
+            ->filter(function($tag) {
126 126
                 return $tag instanceof Tag && $tag->getName() === 'queryParam';
127 127
             })
128
-            ->mapWithKeys(function ($tag) {
128
+            ->mapWithKeys(function($tag) {
129 129
                 preg_match('/(.+?)\s+(required\s+)?(.*)/', $tag->getContent(), $content);
130 130
                 if (empty($content)) {
131 131
                     // this means only name was supplied
@@ -163,7 +163,7 @@  discard block
 block discarded – undo
163 163
     protected function getAuthStatusFromDocBlock(array $tags)
164 164
     {
165 165
         $authTag = collect($tags)
166
-            ->first(function ($tag) {
166
+            ->first(function($tag) {
167 167
                 return $tag instanceof Tag && strtolower($tag->getName()) === 'authenticated';
168 168
             });
169 169
 
@@ -234,25 +234,25 @@  discard block
 block discarded – undo
234 234
     {
235 235
         $faker = Factory::create();
236 236
         $fakes = [
237
-            'integer' => function () {
237
+            'integer' => function() {
238 238
                 return rand(1, 20);
239 239
             },
240
-            'number' => function () use ($faker) {
240
+            'number' => function() use ($faker) {
241 241
                 return $faker->randomFloat();
242 242
             },
243
-            'float' => function () use ($faker) {
243
+            'float' => function() use ($faker) {
244 244
                 return $faker->randomFloat();
245 245
             },
246
-            'boolean' => function () use ($faker) {
246
+            'boolean' => function() use ($faker) {
247 247
                 return $faker->boolean();
248 248
             },
249
-            'string' => function () use ($faker) {
249
+            'string' => function() use ($faker) {
250 250
                 return str_random();
251 251
             },
252
-            'array' => function () {
252
+            'array' => function() {
253 253
                 return [];
254 254
             },
255
-            'object' => function () {
255
+            'object' => function() {
256 256
                 return new \stdClass;
257 257
             },
258 258
         ];
Please login to merge, or discard this patch.
src/Commands/GenerateDocumentation.php 1 patch
Spacing   +25 added lines, -25 removed lines patch added patch discarded remove patch
@@ -56,7 +56,7 @@  discard block
 block discarded – undo
56 56
         $generator = new Generator();
57 57
         $parsedRoutes = $this->processRoutes($generator, $routes);
58 58
         $parsedRoutes = collect($parsedRoutes)->groupBy('group')
59
-            ->sortBy(static function ($group) {
59
+            ->sortBy(static function($group) {
60 60
                 /* @var $group Collection */
61 61
                 return $group->first()['group'];
62 62
             }, SORT_NATURAL);
@@ -72,17 +72,17 @@  discard block
 block discarded – undo
72 72
     private function writeMarkdown($parsedRoutes)
73 73
     {
74 74
         $outputPath = config('apidoc.output');
75
-        $targetFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'index.md';
76
-        $compareFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'.compare.md';
77
-        $prependFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'prepend.md';
78
-        $appendFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'append.md';
75
+        $targetFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . 'index.md';
76
+        $compareFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . '.compare.md';
77
+        $prependFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . 'prepend.md';
78
+        $appendFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . 'append.md';
79 79
 
80 80
         $infoText = view('apidoc::partials.info')
81 81
             ->with('outputPath', ltrim($outputPath, 'public/'))
82 82
             ->with('showPostmanCollectionButton', config('apidoc.postman'));
83 83
 
84
-        $parsedRouteOutput = $parsedRoutes->map(function ($routeGroup) {
85
-            return $routeGroup->map(function ($route) {
84
+        $parsedRouteOutput = $parsedRoutes->map(function($routeGroup) {
85
+            return $routeGroup->map(function($route) {
86 86
                 if (count($route['cleanBodyParameters'])) {
87 87
                     $route['headers']['Content-Type'] = 'application/json';
88 88
                 }
@@ -105,16 +105,16 @@  discard block
 block discarded – undo
105 105
                 $frontmatter = trim($generatedFrontmatter[1], "\n");
106 106
             }
107 107
 
108
-            $parsedRouteOutput->transform(function ($routeGroup) use ($generatedDocumentation, $compareDocumentation) {
109
-                return $routeGroup->transform(function ($route) use ($generatedDocumentation, $compareDocumentation) {
110
-                    if (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $generatedDocumentation, $existingRouteDoc)) {
111
-                        $routeDocumentationChanged = (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $compareDocumentation, $lastDocWeGeneratedForThisRoute) && $lastDocWeGeneratedForThisRoute[1] !== $existingRouteDoc[1]);
108
+            $parsedRouteOutput->transform(function($routeGroup) use ($generatedDocumentation, $compareDocumentation) {
109
+                return $routeGroup->transform(function($route) use ($generatedDocumentation, $compareDocumentation) {
110
+                    if (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $generatedDocumentation, $existingRouteDoc)) {
111
+                        $routeDocumentationChanged = (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $compareDocumentation, $lastDocWeGeneratedForThisRoute) && $lastDocWeGeneratedForThisRoute[1] !== $existingRouteDoc[1]);
112 112
                         if ($routeDocumentationChanged === false || $this->option('force')) {
113 113
                             if ($routeDocumentationChanged) {
114
-                                $this->warn('Discarded manual changes for route ['.implode(',', $route['methods']).'] '.$route['uri']);
114
+                                $this->warn('Discarded manual changes for route [' . implode(',', $route['methods']) . '] ' . $route['uri']);
115 115
                             }
116 116
                         } else {
117
-                            $this->warn('Skipping modified route ['.implode(',', $route['methods']).'] '.$route['uri']);
117
+                            $this->warn('Skipping modified route [' . implode(',', $route['methods']) . '] ' . $route['uri']);
118 118
                             $route['modified_output'] = $existingRouteDoc[0];
119 119
                         }
120 120
                     }
@@ -125,9 +125,9 @@  discard block
 block discarded – undo
125 125
         }
126 126
 
127 127
         $prependFileContents = file_exists($prependFile)
128
-            ? file_get_contents($prependFile)."\n" : '';
128
+            ? file_get_contents($prependFile) . "\n" : '';
129 129
         $appendFileContents = file_exists($appendFile)
130
-            ? "\n".file_get_contents($appendFile) : '';
130
+            ? "\n" . file_get_contents($appendFile) : '';
131 131
 
132 132
         $documentarian = new Documentarian();
133 133
 
@@ -141,7 +141,7 @@  discard block
 block discarded – undo
141 141
             ->with('showPostmanCollectionButton', config('apidoc.postman'))
142 142
             ->with('parsedRoutes', $parsedRouteOutput);
143 143
 
144
-        if (! is_dir($outputPath)) {
144
+        if (!is_dir($outputPath)) {
145 145
             $documentarian->create($outputPath);
146 146
         }
147 147
 
@@ -161,24 +161,24 @@  discard block
 block discarded – undo
161 161
 
162 162
         file_put_contents($compareFile, $compareMarkdown);
163 163
 
164
-        $this->info('Wrote index.md to: '.$outputPath);
164
+        $this->info('Wrote index.md to: ' . $outputPath);
165 165
 
166 166
         $this->info('Generating API HTML code');
167 167
 
168 168
         $documentarian->generate($outputPath);
169 169
 
170
-        $this->info('Wrote HTML documentation to: '.$outputPath.'/index.html');
170
+        $this->info('Wrote HTML documentation to: ' . $outputPath . '/index.html');
171 171
 
172 172
         if (config('apidoc.postman')) {
173 173
             $this->info('Generating Postman collection');
174 174
 
175
-            file_put_contents($outputPath.DIRECTORY_SEPARATOR.'collection.json', $this->generatePostmanCollection($parsedRoutes));
175
+            file_put_contents($outputPath . DIRECTORY_SEPARATOR . 'collection.json', $this->generatePostmanCollection($parsedRoutes));
176 176
         }
177 177
 
178 178
         if ($logo = config('apidoc.logo')) {
179 179
             copy(
180 180
                 $logo,
181
-                $outputPath.DIRECTORY_SEPARATOR.'images'.DIRECTORY_SEPARATOR.'logo.png'
181
+                $outputPath . DIRECTORY_SEPARATOR . 'images' . DIRECTORY_SEPARATOR . 'logo.png'
182 182
             );
183 183
         }
184 184
     }
@@ -197,9 +197,9 @@  discard block
 block discarded – undo
197 197
             /** @var Route $route */
198 198
             if ($this->isValidRoute($route) && $this->isRouteVisibleForDocumentation($route->getAction()['uses'])) {
199 199
                 $parsedRoutes[] = $generator->processRoute($route, $routeItem['apply']);
200
-                $this->info('Processed route: ['.implode(',', $generator->getMethods($route)).'] '.$generator->getUri($route));
200
+                $this->info('Processed route: [' . implode(',', $generator->getMethods($route)) . '] ' . $generator->getUri($route));
201 201
             } else {
202
-                $this->warn('Skipping route: ['.implode(',', $generator->getMethods($route)).'] '.$generator->getUri($route));
202
+                $this->warn('Skipping route: [' . implode(',', $generator->getMethods($route)) . '] ' . $generator->getUri($route));
203 203
             }
204 204
         }
205 205
 
@@ -213,7 +213,7 @@  discard block
 block discarded – undo
213 213
      */
214 214
     private function isValidRoute(Route $route)
215 215
     {
216
-        return ! is_callable($route->getAction()['uses']) && ! is_null($route->getAction()['uses']);
216
+        return !is_callable($route->getAction()['uses']) && !is_null($route->getAction()['uses']);
217 217
     }
218 218
 
219 219
     /**
@@ -228,7 +228,7 @@  discard block
 block discarded – undo
228 228
         list($class, $method) = explode('@', $route);
229 229
         $reflection = new ReflectionClass($class);
230 230
 
231
-        if (! $reflection->hasMethod($method)) {
231
+        if (!$reflection->hasMethod($method)) {
232 232
             return false;
233 233
         }
234 234
 
@@ -238,7 +238,7 @@  discard block
 block discarded – undo
238 238
             $phpdoc = new DocBlock($comment);
239 239
 
240 240
             return collect($phpdoc->getTags())
241
-                ->filter(function ($tag) use ($route) {
241
+                ->filter(function($tag) use ($route) {
242 242
                     return $tag->getName() === 'hideFromAPIDocumentation';
243 243
                 })
244 244
                 ->isEmpty();
Please login to merge, or discard this patch.