Skip to content

Commit 1cd8bb5

Browse files
committed
Merge pull request #26 from mpociot/analysis-XVBYoD
Applied fixes from StyleCI
2 parents 204eeeb + 3ba920c commit 1cd8bb5

File tree

5 files changed

+21
-19
lines changed

5 files changed

+21
-19
lines changed

src/Mpociot/ApiDoc/Commands/GenerateDocumentation.php

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@ private function getBindings()
120120
list($name, $id) = explode(',', $binding);
121121
$resultBindings[$name] = $id;
122122
}
123+
123124
return $resultBindings;
124125
}
125126

@@ -128,7 +129,7 @@ private function getBindings()
128129
*/
129130
private function setUserToBeImpersonated($actAs)
130131
{
131-
if (!empty($actAs)) {
132+
if (! empty($actAs)) {
132133
if (version_compare($this->laravel->version(), '5.2.0', '<')) {
133134
$userModel = config('auth.model');
134135
$user = $userModel::find($actAs);
@@ -157,6 +158,7 @@ private function getRoutes()
157158
* @param AbstractGenerator $generator
158159
* @param $allowedRoutes
159160
* @param $routePrefix
161+
*
160162
* @return array
161163
*/
162164
private function processLaravelRoutes(AbstractGenerator $generator, $allowedRoutes, $routePrefix)
@@ -170,13 +172,15 @@ private function processLaravelRoutes(AbstractGenerator $generator, $allowedRout
170172
$this->info('Processed route: '.$route->getUri());
171173
}
172174
}
175+
173176
return $parsedRoutes;
174177
}
175178

176179
/**
177180
* @param AbstractGenerator $generator
178181
* @param $allowedRoutes
179182
* @param $routePrefix
183+
*
180184
* @return array
181185
*/
182186
private function processDingoRoutes(AbstractGenerator $generator, $allowedRoutes, $routePrefix)
@@ -190,6 +194,7 @@ private function processDingoRoutes(AbstractGenerator $generator, $allowedRoutes
190194
$this->info('Processed route: '.$route->uri());
191195
}
192196
}
197+
193198
return $parsedRoutes;
194199
}
195200
}

src/Mpociot/ApiDoc/Generators/AbstractGenerator.php

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212

1313
abstract class AbstractGenerator
1414
{
15-
1615
/**
1716
* @param Route $route
17+
*
1818
* @return mixed
1919
*/
2020
abstract protected function getUri(Route $route);
@@ -30,9 +30,11 @@ abstract public function processRoute(Route $route, $bindings = []);
3030
/**
3131
* @param array $routeData
3232
* @param array $routeAction
33+
*
3334
* @return mixed
3435
*/
35-
protected function getParameters($routeData, $routeAction) {
36+
protected function getParameters($routeData, $routeAction)
37+
{
3638
$validator = Validator::make([], $this->getRouteRules($routeAction['uses']));
3739
foreach ($validator->getRules() as $attribute => $rules) {
3840
$attributeData = [
@@ -65,10 +67,10 @@ protected function getRouteResponse(Route $route, $bindings)
6567
return $this->callRoute(array_shift($methods), $uri);
6668
}
6769

68-
6970
/**
7071
* @param Route $route
7172
* @param array $bindings
73+
*
7274
* @return mixed
7375
*/
7476
protected function addRouteModelBindings(Route $route, $bindings)
@@ -77,6 +79,7 @@ protected function addRouteModelBindings(Route $route, $bindings)
7779
foreach ($bindings as $model => $id) {
7880
$uri = str_replace('{'.$model.'}', $id, $uri);
7981
}
82+
8083
return $uri;
8184
}
8285

@@ -100,7 +103,6 @@ protected function getRouteDescription($route)
100103
];
101104
}
102105

103-
104106
/**
105107
* @param string $route
106108
*
@@ -117,6 +119,7 @@ protected function getRouteGroup($route)
117119
return $tag->getContent();
118120
}
119121
}
122+
120123
return 'general';
121124
}
122125

src/Mpociot/ApiDoc/Generators/DingoGenerator.php

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,9 @@
44

55
use Illuminate\Routing\Route;
66
use Illuminate\Support\Facades\App;
7-
use Illuminate\Support\Facades\Request;
87

98
class DingoGenerator extends AbstractGenerator
109
{
11-
1210
/**
1311
* @param \Illuminate\Routing\Route $route
1412
* @param array $bindings
@@ -22,15 +20,15 @@ public function processRoute(Route $route, $bindings = [])
2220
$routeAction = $route->getAction();
2321
$routeGroup = $this->getRouteGroup($routeAction['uses']);
2422
$routeDescription = $this->getRouteDescription($routeAction['uses']);
25-
23+
2624
if ($response->headers->get('Content-Type') === 'application/json') {
2725
$content = json_encode(json_decode($response->getContent()), JSON_PRETTY_PRINT);
2826
} else {
2927
$content = $response->getContent();
3028
}
3129

3230
return $this->getParameters([
33-
'resource' => $routeGroup,
31+
'resource' => $routeGroup,
3432
'title' => $routeDescription['short'],
3533
'description' => $routeDescription['long'],
3634
'methods' => $route->getMethods(),
@@ -40,7 +38,6 @@ public function processRoute(Route $route, $bindings = [])
4038
], $routeAction);
4139
}
4240

43-
4441
/**
4542
* {@inheritdoc}
4643
*/
@@ -56,5 +53,4 @@ protected function getUri(Route $route)
5653
{
5754
return $route->uri();
5855
}
59-
60-
}
56+
}

src/Mpociot/ApiDoc/Generators/LaravelGenerator.php

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88

99
class LaravelGenerator extends AbstractGenerator
1010
{
11-
1211
/**
1312
* @param Route $route
13+
*
1414
* @return mixed
1515
*/
1616
protected function getUri(Route $route)
@@ -27,19 +27,19 @@ protected function getUri(Route $route)
2727
public function processRoute(Route $route, $bindings = [])
2828
{
2929
$response = $this->getRouteResponse($route, $bindings);
30-
30+
3131
$routeAction = $route->getAction();
3232
$routeGroup = $this->getRouteGroup($routeAction['uses']);
3333
$routeDescription = $this->getRouteDescription($routeAction['uses']);
34-
34+
3535
if ($response->headers->get('Content-Type') === 'application/json') {
3636
$content = json_encode(json_decode($response->getContent()), JSON_PRETTY_PRINT);
3737
} else {
3838
$content = $response->getContent();
3939
}
4040

4141
return $this->getParameters([
42-
'resource' => $routeGroup,
42+
'resource' => $routeGroup,
4343
'title' => $routeDescription['short'],
4444
'description' => $routeDescription['long'],
4545
'methods' => $route->getMethods(),
@@ -83,5 +83,4 @@ public function callRoute($method, $uri, $parameters = [], $cookies = [], $files
8383

8484
return $response;
8585
}
86-
87-
}
86+
}

tests/ApiDocGeneratorTest.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
use Illuminate\Routing\Route;
66
use Mpociot\ApiDoc\Generators\LaravelGenerator;
77
use Orchestra\Testbench\TestCase;
8-
use Mpociot\ApiDoc\AbstractGenerator;
98
use Mpociot\ApiDoc\Tests\Fixtures\TestRequest;
109
use Mpociot\ApiDoc\Tests\Fixtures\TestController;
1110
use Illuminate\Support\Facades\Route as RouteFacade;

0 commit comments

Comments
 (0)