Completed
Pull Request — master (#506)
by Faton
02:22
created
src/Tools/ResponseStrategies/ResponseCallStrategy.php 1 patch
Spacing   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -15,7 +15,7 @@  discard block
 block discarded – undo
15 15
     public function __invoke(Route $route, array $tags, array $routeProps)
16 16
     {
17 17
         $rulesToApply = $routeProps['rules']['response_calls'] ?? [];
18
-        if (! $this->shouldMakeApiCall($route, $rulesToApply)) {
18
+        if (!$this->shouldMakeApiCall($route, $rulesToApply)) {
19 19
             return;
20 20
         }
21 21
 
@@ -124,14 +124,14 @@  discard block
 block discarded – undo
124 124
         // set URL and query parameters
125 125
         $uri = $request->getRequestUri();
126 126
         $query = $request->getQueryString();
127
-        if (! empty($query)) {
127
+        if (!empty($query)) {
128 128
             $uri .= "?$query";
129 129
         }
130 130
         $response = call_user_func_array([$dispatcher, strtolower($request->method())], [$uri]);
131 131
 
132 132
         // the response from the Dingo dispatcher is the 'raw' response from the controller,
133 133
         // so we have to ensure it's JSON first
134
-        if (! $response instanceof Response) {
134
+        if (!$response instanceof Response) {
135 135
             $response = response()->json($response);
136 136
         }
137 137
 
@@ -238,8 +238,8 @@  discard block
 block discarded – undo
238 238
         $prefix = 'HTTP_';
239 239
         foreach ($headers as $name => $value) {
240 240
             $name = strtr(strtoupper($name), '-', '_');
241
-            if (! starts_with($name, $prefix) && $name !== 'CONTENT_TYPE') {
242
-                $name = $prefix.$name;
241
+            if (!starts_with($name, $prefix) && $name !== 'CONTENT_TYPE') {
242
+                $name = $prefix . $name;
243 243
             }
244 244
             $server[$name] = $value;
245 245
         }
Please login to merge, or discard this patch.
src/Tools/RouteMatcher.php 1 patch
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -50,14 +50,14 @@  discard block
 block discarded – undo
50 50
 
51 51
     private function getAllRoutes(bool $usingDingoRouter, array $versions = [])
52 52
     {
53
-        if (! $usingDingoRouter) {
53
+        if (!$usingDingoRouter) {
54 54
             return RouteFacade::getRoutes();
55 55
         }
56 56
 
57 57
         $allRouteCollections = app(\Dingo\Api\Routing\Router::class)->getRoutes();
58 58
 
59 59
         return collect($allRouteCollections)
60
-            ->flatMap(function (RouteCollection $collection) {
60
+            ->flatMap(function(RouteCollection $collection) {
61 61
                 return $collection->getRoutes();
62 62
             })->toArray();
63 63
     }
@@ -65,7 +65,7 @@  discard block
 block discarded – undo
65 65
     private function shouldIncludeRoute(Route $route, array $routeRule, array $mustIncludes, bool $usingDingoRouter)
66 66
     {
67 67
         $matchesVersion = $usingDingoRouter
68
-            ? ! empty(array_intersect($route->versions(), $routeRule['match']['versions'] ?? []))
68
+            ? !empty(array_intersect($route->versions(), $routeRule['match']['versions'] ?? []))
69 69
             : true;
70 70
 
71 71
         return str_is($mustIncludes, $route->getName())
Please login to merge, or discard this patch.
src/Tools/ResponseResolver.php 1 patch
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -48,8 +48,8 @@
 block discarded – undo
48 48
             /** @var Response[]|null $response */
49 49
             $responses = $strategy($this->route, $tags, $routeProps);
50 50
 
51
-            if (! is_null($responses)) {
52
-                return array_map(function (Response $response) {
51
+            if (!is_null($responses)) {
52
+                return array_map(function(Response $response) {
53 53
                     return ['status' => $response->getStatusCode(), 'content' => $this->getResponseContent($response)];
54 54
                 }, $responses);
55 55
             }
Please login to merge, or discard this patch.
src/Tools/ResponseStrategies/ResponseTagStrategy.php 1 patch
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -33,7 +33,7 @@  discard block
 block discarded – undo
33 33
     protected function getDocBlockResponses(array $tags)
34 34
     {
35 35
         $responseTags = array_values(
36
-            array_filter($tags, function ($tag) {
36
+            array_filter($tags, function($tag) {
37 37
                 return $tag instanceof Tag && strtolower($tag->getName()) === 'response';
38 38
             })
39 39
         );
@@ -42,7 +42,7 @@  discard block
 block discarded – undo
42 42
             return;
43 43
         }
44 44
 
45
-        return array_map(function (Tag $responseTag) {
45
+        return array_map(function(Tag $responseTag) {
46 46
             preg_match('/^(\d{3})?\s?([\s\S]*)$/', $responseTag->getContent(), $result);
47 47
 
48 48
             $status = $result[1] ?: 200;
Please login to merge, or discard this patch.
src/Tools/ResponseStrategies/ResponseFileStrategy.php 1 patch
Spacing   +3 added lines, -3 removed lines patch added patch discarded remove patch
@@ -34,7 +34,7 @@  discard block
 block discarded – undo
34 34
     {
35 35
         // avoid "holes" in the keys of the filtered array, by using array_values on the filtered array
36 36
         $responseFileTags = array_values(
37
-            array_filter($tags, function ($tag) {
37
+            array_filter($tags, function($tag) {
38 38
                 return $tag instanceof Tag && strtolower($tag->getName()) === 'responsefile';
39 39
             })
40 40
         );
@@ -43,11 +43,11 @@  discard block
 block discarded – undo
43 43
             return;
44 44
         }
45 45
 
46
-        return array_map(function (Tag $responseFileTag) {
46
+        return array_map(function(Tag $responseFileTag) {
47 47
             preg_match('/^(\d{3})?\s?([\S]*[\s]*?)(\{.*\})?$/', $responseFileTag->getContent(), $result);
48 48
             $status = $result[1] ?: 200;
49 49
             $content = $result[2] ? file_get_contents(storage_path(trim($result[2])), true) : '{}';
50
-            $json = ! empty($result[3]) ? str_replace("'", '"', $result[3]) : '{}';
50
+            $json = !empty($result[3]) ? str_replace("'", '"', $result[3]) : '{}';
51 51
             $merged = array_merge(json_decode($content, true), json_decode($json, true));
52 52
 
53 53
             return new JsonResponse($merged, (int) $status);
Please login to merge, or discard this patch.
src/Tools/ResponseStrategies/TransformerTagsStrategy.php 1 patch
Spacing   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -47,7 +47,7 @@  discard block
 block discarded – undo
47 47
 
48 48
             $fractal = new Manager();
49 49
  
50
-            if (! is_null(config('apidoc.fractal.serializer'))) {
50
+            if (!is_null(config('apidoc.fractal.serializer'))) {
51 51
                 $fractal->setSerializer(app(config('apidoc.fractal.serializer')));
52 52
             }
53 53
 
@@ -79,7 +79,7 @@  discard block
 block discarded – undo
79 79
      */
80 80
     private function getClassToBeTransformed(array $tags, ReflectionMethod $transformerMethod)
81 81
     {
82
-        $modelTag = array_first(array_filter($tags, function ($tag) {
82
+        $modelTag = array_first(array_filter($tags, function($tag) {
83 83
             return ($tag instanceof Tag) && strtolower($tag->getName()) == 'transformermodel';
84 84
         }));
85 85
 
@@ -88,7 +88,7 @@  discard block
 block discarded – undo
88 88
             $type = $modelTag->getContent();
89 89
         } else {
90 90
             $parameter = array_first($transformerMethod->getParameters());
91
-            if ($parameter->hasType() && ! $parameter->getType()->isBuiltin() && class_exists((string) $parameter->getType())) {
91
+            if ($parameter->hasType() && !$parameter->getType()->isBuiltin() && class_exists((string) $parameter->getType())) {
92 92
                 // ladies and gentlemen, we have a type!
93 93
                 $type = (string) $parameter->getType();
94 94
             }
@@ -133,7 +133,7 @@  discard block
 block discarded – undo
133 133
     private function getTransformerTag(array $tags)
134 134
     {
135 135
         $transFormerTags = array_values(
136
-            array_filter($tags, function ($tag) {
136
+            array_filter($tags, function($tag) {
137 137
                 return ($tag instanceof Tag) && in_array(strtolower($tag->getName()), ['transformer', 'transformercollection']);
138 138
             })
139 139
         );
Please login to merge, or discard this patch.
src/Postman/CollectionWriter.php 1 patch
Spacing   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -27,16 +27,16 @@  discard block
 block discarded – undo
27 27
         $collection = [
28 28
             'variables' => [],
29 29
             'info' => [
30
-                'name' => config('apidoc.postman.name') ?: config('app.name').' API',
30
+                'name' => config('apidoc.postman.name') ?: config('app.name') . ' API',
31 31
                 '_postman_id' => Uuid::uuid4()->toString(),
32 32
                 'description' => config('apidoc.postman.description') ?: '',
33 33
                 'schema' => 'https://schema.getpostman.com/json/collection/v2.0.0/collection.json',
34 34
             ],
35
-            'item' => $this->routeGroups->map(function ($routes, $groupName) {
35
+            'item' => $this->routeGroups->map(function($routes, $groupName) {
36 36
                 return [
37 37
                     'name' => $groupName,
38 38
                     'description' => '',
39
-                    'item' => $routes->map(function ($route) {
39
+                    'item' => $routes->map(function($route) {
40 40
                         $mode = $route['methods'][0] === 'PUT' ? 'urlencoded' : 'formdata';
41 41
 
42 42
                         return [
@@ -46,7 +46,7 @@  discard block
 block discarded – undo
46 46
                                 'method' => $route['methods'][0],
47 47
                                 'body' => [
48 48
                                     'mode' => $mode,
49
-                                    $mode => collect($route['bodyParameters'])->map(function ($parameter, $key) {
49
+                                    $mode => collect($route['bodyParameters'])->map(function($parameter, $key) {
50 50
                                         return [
51 51
                                             'key' => $key,
52 52
                                             'value' => isset($parameter['value']) ? $parameter['value'] : '',
Please login to merge, or discard this patch.
src/ApiDocGeneratorServiceProvider.php 1 patch
Spacing   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -15,17 +15,17 @@
 block discarded – undo
15 15
      */
16 16
     public function boot()
17 17
     {
18
-        $this->loadViewsFrom(__DIR__.'/../resources/views/', 'apidoc');
18
+        $this->loadViewsFrom(__DIR__ . '/../resources/views/', 'apidoc');
19 19
 
20 20
         $this->publishes([
21
-            __DIR__.'/../resources/views' => app()->basePath().'/resources/views/vendor/apidoc',
21
+            __DIR__ . '/../resources/views' => app()->basePath() . '/resources/views/vendor/apidoc',
22 22
         ], 'apidoc-views');
23 23
 
24 24
         $this->publishes([
25
-            __DIR__.'/../config/apidoc.php' => app()->basePath().'/config/apidoc.php',
25
+            __DIR__ . '/../config/apidoc.php' => app()->basePath() . '/config/apidoc.php',
26 26
         ], 'apidoc-config');
27 27
 
28
-        $this->mergeConfigFrom(__DIR__.'/../config/apidoc.php', 'apidoc');
28
+        $this->mergeConfigFrom(__DIR__ . '/../config/apidoc.php', 'apidoc');
29 29
 
30 30
         if ($this->app->runningInConsole()) {
31 31
             $this->commands([
Please login to merge, or discard this patch.
src/Commands/GenerateDocumentation.php 1 patch
Spacing   +26 added lines, -26 removed lines patch added patch discarded remove patch
@@ -58,7 +58,7 @@  discard block
 block discarded – undo
58 58
         $generator = new Generator(config('apidoc.faker_seed'));
59 59
         $parsedRoutes = $this->processRoutes($generator, $routes);
60 60
         $parsedRoutes = collect($parsedRoutes)->groupBy('group')
61
-            ->sortBy(static function ($group) {
61
+            ->sortBy(static function($group) {
62 62
                 /* @var $group Collection */
63 63
                 return $group->first()['group'];
64 64
             }, SORT_NATURAL);
@@ -74,18 +74,18 @@  discard block
 block discarded – undo
74 74
     private function writeMarkdown($parsedRoutes)
75 75
     {
76 76
         $outputPath = config('apidoc.output');
77
-        $targetFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'index.md';
78
-        $compareFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'.compare.md';
79
-        $prependFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'prepend.md';
80
-        $appendFile = $outputPath.DIRECTORY_SEPARATOR.'source'.DIRECTORY_SEPARATOR.'append.md';
77
+        $targetFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . 'index.md';
78
+        $compareFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . '.compare.md';
79
+        $prependFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . 'prepend.md';
80
+        $appendFile = $outputPath . DIRECTORY_SEPARATOR . 'source' . DIRECTORY_SEPARATOR . 'append.md';
81 81
 
82 82
         $infoText = view('apidoc::partials.info')
83 83
             ->with('outputPath', ltrim($outputPath, 'public/'))
84 84
             ->with('showPostmanCollectionButton', $this->shouldGeneratePostmanCollection());
85 85
 
86
-        $parsedRouteOutput = $parsedRoutes->map(function ($routeGroup) {
87
-            return $routeGroup->map(function ($route) {
88
-                if (count($route['cleanBodyParameters']) && ! isset($route['headers']['Content-Type'])) {
86
+        $parsedRouteOutput = $parsedRoutes->map(function($routeGroup) {
87
+            return $routeGroup->map(function($route) {
88
+                if (count($route['cleanBodyParameters']) && !isset($route['headers']['Content-Type'])) {
89 89
                     $route['headers']['Content-Type'] = 'application/json';
90 90
                 }
91 91
                 $route['output'] = (string) view('apidoc::partials.route')->with('route', $route)->render();
@@ -107,16 +107,16 @@  discard block
 block discarded – undo
107 107
                 $frontmatter = trim($generatedFrontmatter[1], "\n");
108 108
             }
109 109
 
110
-            $parsedRouteOutput->transform(function ($routeGroup) use ($generatedDocumentation, $compareDocumentation) {
111
-                return $routeGroup->transform(function ($route) use ($generatedDocumentation, $compareDocumentation) {
112
-                    if (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $generatedDocumentation, $existingRouteDoc)) {
113
-                        $routeDocumentationChanged = (preg_match('/<!-- START_'.$route['id'].' -->(.*)<!-- END_'.$route['id'].' -->/is', $compareDocumentation, $lastDocWeGeneratedForThisRoute) && $lastDocWeGeneratedForThisRoute[1] !== $existingRouteDoc[1]);
110
+            $parsedRouteOutput->transform(function($routeGroup) use ($generatedDocumentation, $compareDocumentation) {
111
+                return $routeGroup->transform(function($route) use ($generatedDocumentation, $compareDocumentation) {
112
+                    if (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $generatedDocumentation, $existingRouteDoc)) {
113
+                        $routeDocumentationChanged = (preg_match('/<!-- START_' . $route['id'] . ' -->(.*)<!-- END_' . $route['id'] . ' -->/is', $compareDocumentation, $lastDocWeGeneratedForThisRoute) && $lastDocWeGeneratedForThisRoute[1] !== $existingRouteDoc[1]);
114 114
                         if ($routeDocumentationChanged === false || $this->option('force')) {
115 115
                             if ($routeDocumentationChanged) {
116
-                                $this->warn('Discarded manual changes for route ['.implode(',', $route['methods']).'] '.$route['uri']);
116
+                                $this->warn('Discarded manual changes for route [' . implode(',', $route['methods']) . '] ' . $route['uri']);
117 117
                             }
118 118
                         } else {
119
-                            $this->warn('Skipping modified route ['.implode(',', $route['methods']).'] '.$route['uri']);
119
+                            $this->warn('Skipping modified route [' . implode(',', $route['methods']) . '] ' . $route['uri']);
120 120
                             $route['modified_output'] = $existingRouteDoc[0];
121 121
                         }
122 122
                     }
@@ -127,9 +127,9 @@  discard block
 block discarded – undo
127 127
         }
128 128
 
129 129
         $prependFileContents = file_exists($prependFile)
130
-            ? file_get_contents($prependFile)."\n" : '';
130
+            ? file_get_contents($prependFile) . "\n" : '';
131 131
         $appendFileContents = file_exists($appendFile)
132
-            ? "\n".file_get_contents($appendFile) : '';
132
+            ? "\n" . file_get_contents($appendFile) : '';
133 133
 
134 134
         $documentarian = new Documentarian();
135 135
 
@@ -143,7 +143,7 @@  discard block
 block discarded – undo
143 143
             ->with('showPostmanCollectionButton', $this->shouldGeneratePostmanCollection())
144 144
             ->with('parsedRoutes', $parsedRouteOutput);
145 145
 
146
-        if (! is_dir($outputPath)) {
146
+        if (!is_dir($outputPath)) {
147 147
             $documentarian->create($outputPath);
148 148
         }
149 149
 
@@ -163,24 +163,24 @@  discard block
 block discarded – undo
163 163
 
164 164
         file_put_contents($compareFile, $compareMarkdown);
165 165
 
166
-        $this->info('Wrote index.md to: '.$outputPath);
166
+        $this->info('Wrote index.md to: ' . $outputPath);
167 167
 
168 168
         $this->info('Generating API HTML code');
169 169
 
170 170
         $documentarian->generate($outputPath);
171 171
 
172
-        $this->info('Wrote HTML documentation to: '.$outputPath.'/index.html');
172
+        $this->info('Wrote HTML documentation to: ' . $outputPath . '/index.html');
173 173
 
174 174
         if ($this->shouldGeneratePostmanCollection()) {
175 175
             $this->info('Generating Postman collection');
176 176
 
177
-            file_put_contents($outputPath.DIRECTORY_SEPARATOR.'collection.json', $this->generatePostmanCollection($parsedRoutes));
177
+            file_put_contents($outputPath . DIRECTORY_SEPARATOR . 'collection.json', $this->generatePostmanCollection($parsedRoutes));
178 178
         }
179 179
 
180 180
         if ($logo = config('apidoc.logo')) {
181 181
             copy(
182 182
                 $logo,
183
-                $outputPath.DIRECTORY_SEPARATOR.'images'.DIRECTORY_SEPARATOR.'logo.png'
183
+                $outputPath . DIRECTORY_SEPARATOR . 'images' . DIRECTORY_SEPARATOR . 'logo.png'
184 184
             );
185 185
         }
186 186
     }
@@ -199,9 +199,9 @@  discard block
 block discarded – undo
199 199
             /** @var Route $route */
200 200
             if ($this->isValidRoute($route) && $this->isRouteVisibleForDocumentation($route->getAction()['uses'])) {
201 201
                 $parsedRoutes[] = $generator->processRoute($route, $routeItem['apply']);
202
-                $this->info('Processed route: ['.implode(',', $generator->getMethods($route)).'] '.$generator->getUri($route));
202
+                $this->info('Processed route: [' . implode(',', $generator->getMethods($route)) . '] ' . $generator->getUri($route));
203 203
             } else {
204
-                $this->warn('Skipping route: ['.implode(',', $generator->getMethods($route)).'] '.$generator->getUri($route));
204
+                $this->warn('Skipping route: [' . implode(',', $generator->getMethods($route)) . '] ' . $generator->getUri($route));
205 205
             }
206 206
         }
207 207
 
@@ -215,7 +215,7 @@  discard block
 block discarded – undo
215 215
      */
216 216
     private function isValidRoute(Route $route)
217 217
     {
218
-        return ! is_callable($route->getAction()['uses']) && ! is_null($route->getAction()['uses']);
218
+        return !is_callable($route->getAction()['uses']) && !is_null($route->getAction()['uses']);
219 219
     }
220 220
 
221 221
     /**
@@ -230,7 +230,7 @@  discard block
 block discarded – undo
230 230
         list($class, $method) = explode('@', $route);
231 231
         $reflection = new ReflectionClass($class);
232 232
 
233
-        if (! $reflection->hasMethod($method)) {
233
+        if (!$reflection->hasMethod($method)) {
234 234
             return false;
235 235
         }
236 236
 
@@ -240,7 +240,7 @@  discard block
 block discarded – undo
240 240
             $phpdoc = new DocBlock($comment);
241 241
 
242 242
             return collect($phpdoc->getTags())
243
-                ->filter(function ($tag) use ($route) {
243
+                ->filter(function($tag) use ($route) {
244 244
                     return $tag->getName() === 'hideFromAPIDocumentation';
245 245
                 })
246 246
                 ->isEmpty();
Please login to merge, or discard this patch.