Merge pull request #20 from mtrajano/analysis-KZZ4aR

mtrajano · web-flow · commit 78487d4a021a · 2019-12-21T00:28:03.000-05:00
Apply fixes from StyleCI
diff --git a/config/laravel-swagger.php b/config/laravel-swagger.php
@@ -62,4 +62,4 @@
     */
 
     'parseDocBlock' => true,
-];
+];
diff --git a/src/FormatterManager.php b/src/FormatterManager.php
@@ -40,4 +40,4 @@ public function format()
     {
         return $this->formatter->format();
     }
-}
+}
diff --git a/src/Formatters/Formatter.php b/src/Formatters/Formatter.php
@@ -12,4 +12,4 @@ public function __construct($docs)
     }
 
     abstract public function format();
-}
+}
diff --git a/src/Formatters/JsonFormatter.php b/src/Formatters/JsonFormatter.php
@@ -14,4 +14,4 @@ public function format()
 
         return json_encode($this->docs, JSON_PRETTY_PRINT);
     }
-}
+}
diff --git a/src/Formatters/YamlFormatter.php b/src/Formatters/YamlFormatter.php
@@ -14,4 +14,4 @@ public function format()
 
         return yaml_emit($this->docs);
     }
-}
+}
diff --git a/src/Generator.php b/src/Generator.php
@@ -2,11 +2,11 @@
 
 namespace Mtrajano\LaravelSwagger;
 
-use ReflectionMethod;
-use Illuminate\Support\Str;
-use Illuminate\Routing\Route;
 use Illuminate\Foundation\Http\FormRequest;
+use Illuminate\Routing\Route;
+use Illuminate\Support\Str;
 use phpDocumentor\Reflection\DocBlockFactory;
+use ReflectionMethod;
 
 class Generator
 {
@@ -53,7 +53,9 @@ public function generate()
             foreach ($methods as $method) {
                 $this->method = strtolower($method);
 
-                if (in_array($this->method, $this->config['ignoredMethods'])) continue;
+                if (in_array($this->method, $this->config['ignoredMethods'])) {
+                    continue;
+                }
 
                 $this->generatePath();
             }
@@ -111,18 +113,18 @@ protected function getRouteUri(Route $route)
     protected function generatePath()
     {
         $actionInstance = is_string($this->action) ? $this->getActionClassInstance($this->action) : null;
-        $docBlock = $actionInstance ? ($actionInstance->getDocComment() ?: "") : "";
+        $docBlock = $actionInstance ? ($actionInstance->getDocComment() ?: '') : '';
 
-        list($isDeprecated, $summary, $description) = $this->parseActionDocBlock($docBlock);
+        [$isDeprecated, $summary, $description] = $this->parseActionDocBlock($docBlock);
 
         $this->docs['paths'][$this->uri][$this->method] = [
             'summary' => $summary,
             'description' => $description,
             'deprecated' => $isDeprecated,
             'responses' => [
                 '200' => [
-                    'description' => 'OK'
-                ]
+                    'description' => 'OK',
+                ],
             ],
         ];
 
@@ -148,7 +150,9 @@ protected function addActionParameters()
 
     protected function getFormRules()
     {
-        if (!is_string($this->action)) return false;
+        if (!is_string($this->action)) {
+            return false;
+        }
 
         $parameters = $this->getActionClassInstance($this->action)->getParameters();
 
@@ -175,15 +179,15 @@ protected function getParameterGenerator($rules)
 
     private function getActionClassInstance(string $action)
     {
-        list($class, $method) = Str::parseCallback($action);
+        [$class, $method] = Str::parseCallback($action);
 
         return new ReflectionMethod($class, $method);
     }
 
     private function parseActionDocBlock(string $docBlock)
     {
         if (empty($docBlock) || !$this->config['parseDocBlock']) {
-            return [false, "", ""];
+            return [false, '', ''];
         }
 
         try {
@@ -195,8 +199,8 @@ private function parseActionDocBlock(string $docBlock)
             $description = (string) $parsedComment->getDescription();
 
             return [$isDeprecated, $summary, $description];
-        } catch(\Exception $e) {
-            return [false, "", ""];
+        } catch (\Exception $e) {
+            return [false, '', ''];
         }
     }
-}
+}
diff --git a/src/LaravelSwaggerException.php b/src/LaravelSwaggerException.php
@@ -4,4 +4,4 @@
 
 class LaravelSwaggerException extends \Exception
 {
-}
+}
diff --git a/src/Parameters/BodyParameterGenerator.php b/src/Parameters/BodyParameterGenerator.php
@@ -81,7 +81,7 @@ protected function addToProperties(&$properties, $nameTokens, $rules)
 
         if ($type === 'array') {
             $this->addToProperties($properties[$name]['items'], $nameTokens, $rules);
-        } else if ($type === 'object') {
+        } elseif ($type === 'object') {
             $this->addToProperties($properties[$name]['properties'], $nameTokens, $rules);
         }
     }
@@ -98,7 +98,7 @@ protected function getNestedParamType($nameTokens)
     protected function getNewPropObj($type, $rules)
     {
         $propObj = [
-            'type' => $type
+            'type' => $type,
         ];
 
         if ($enums = $this->getEnumValues($rules)) {
@@ -107,10 +107,10 @@ protected function getNewPropObj($type, $rules)
 
         if ($type === 'array') {
             $propObj['items'] = [];
-        } else if ($type === 'object') {
+        } elseif ($type === 'object') {
             $propObj['properties'] = [];
         }
 
         return $propObj;
     }
-}
+}
diff --git a/src/Parameters/Concerns/GeneratesFromRules.php b/src/Parameters/Concerns/GeneratesFromRules.php
@@ -19,11 +19,11 @@ protected function getParamType(array $paramRules)
     {
         if (in_array('integer', $paramRules)) {
             return 'integer';
-        } else if (in_array('numeric', $paramRules)) {
+        } elseif (in_array('numeric', $paramRules)) {
             return 'number';
-        } else if (in_array('boolean', $paramRules)) {
+        } elseif (in_array('boolean', $paramRules)) {
             return 'boolean';
-        } else if (in_array('array', $paramRules)) {
+        } elseif (in_array('array', $paramRules)) {
             return 'array';
         } else {
             //date, ip, email, etc..
@@ -54,15 +54,15 @@ protected function getEnumValues(array $paramRules)
             return [];
         }
 
-        list($param, $vals) = explode(':', $in);
+        [$param, $vals] = explode(':', $in);
 
         return explode(',', $vals);
     }
 
     private function getInParameter(array $paramRules)
     {
         foreach ($paramRules as $rule) {
-            if ((is_string($rule) || method_exists($rule , '__toString')) && Str::startsWith($rule, 'in:')) {
+            if ((is_string($rule) || method_exists($rule, '__toString')) && Str::startsWith($rule, 'in:')) {
                 return $rule;
             }
         }
diff --git a/src/Parameters/ParameterGenerator.php b/src/Parameters/ParameterGenerator.php
@@ -7,4 +7,4 @@ interface ParameterGenerator
     public function getParameters();
 
     public function getParamLocation();
-}
+}
diff --git a/src/Parameters/PathParameterGenerator.php b/src/Parameters/PathParameterGenerator.php
@@ -18,7 +18,7 @@ public function getParameters()
         $params = [];
         $pathVariables = $this->getAllVariablesFromUri();
 
-        foreach  ($pathVariables as $variable) {
+        foreach ($pathVariables as $variable) {
             $params[] = [
                 'in' => $this->getParamLocation(),
                 'name' => strip_optional_char($variable),
@@ -47,4 +47,4 @@ private function isPathVariableRequired($pathVariable)
     {
         return !Str::contains($pathVariable, '?');
     }
-}
+}
diff --git a/src/Parameters/QueryParameterGenerator.php b/src/Parameters/QueryParameterGenerator.php
@@ -18,7 +18,7 @@ public function getParameters()
         $params = [];
         $arrayTypes = [];
 
-        foreach  ($this->rules as $param => $rule) {
+        foreach ($this->rules as $param => $rule) {
             $paramRules = $this->splitRules($rule);
             $enums = $this->getEnumValues($paramRules);
             $type = $this->getParamType($paramRules);
@@ -80,4 +80,4 @@ public function getParamLocation()
     {
         return 'query';
     }
-}
+}
diff --git a/src/SwaggerServiceProvider.php b/src/SwaggerServiceProvider.php
@@ -19,7 +19,7 @@ public function boot()
             ]);
         }
 
-        $source = __DIR__.'/../config/laravel-swagger.php';
+        $source = __DIR__ . '/../config/laravel-swagger.php';
 
         $this->publishes([
             $source => config_path('laravel-swagger.php'),
@@ -29,4 +29,4 @@ public function boot()
             $source, 'laravel-swagger'
         );
     }
-}
+}
diff --git a/src/helpers.php b/src/helpers.php
@@ -1,9 +1,8 @@
 <?php
 
-if (! function_exists('strip_optional_char')) {
-
+if (!function_exists('strip_optional_char')) {
     function strip_optional_char($uri)
     {
         return str_replace('?', '', $uri);
     }
-}
+}
diff --git a/tests/GeneratorTest.php b/tests/GeneratorTest.php
@@ -103,8 +103,7 @@ public function testPathMethods($paths)
      */
     public function testRouteData($paths)
     {
-
-        $expectedPostDescription = <<<EOD
+        $expectedPostDescription = <<<'EOD'
 Data is validated [see description here](https://example.com) so no bad data can be passed.
 Please read the documentation for more information
 EOD;
diff --git a/tests/Parameters/BodyParameterGeneratorTest.php b/tests/Parameters/BodyParameterGeneratorTest.php
diff --git a/tests/Parameters/PathParameterGeneratorTest.php b/tests/Parameters/PathParameterGeneratorTest.php
diff --git a/tests/Parameters/QueryParameterGeneratorTest.php b/tests/Parameters/QueryParameterGeneratorTest.php
diff --git a/tests/TestCase.php b/tests/TestCase.php

-Original file line number
+Diff line change
     */
     'parseDocBlock' => true,
 -];
 +];
Original file line number	Diff line number	Diff line change
`@@ -40,4 +40,4 @@ public function format()`
`40`	`40`	`{`
`41`	`41`	`return $this->formatter->format();`
`42`	`42`	`}`
`43`		`-}`
	`43`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -12,4 +12,4 @@ public function __construct($docs)`
`12`	`12`	`}`
`13`	`13`
`14`	`14`	`abstract public function format();`
`15`		`-}`
	`15`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -14,4 +14,4 @@ public function format()`
`14`	`14`
`15`	`15`	`return json_encode($this->docs, JSON_PRETTY_PRINT);`
`16`	`16`	`}`
`17`		`-}`
	`17`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -4,4 +4,4 @@`
`4`	`4`
`5`	`5`	`class LaravelSwaggerException extends \Exception`
`6`	`6`	`{`
`7`		`-}`
	`7`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ protected function addToProperties(&$properties, $nameTokens, $rules)`
`81`	`81`
`82`	`82`	`if ($type === 'array') {`
`83`	`83`	`$this->addToProperties($properties[$name]['items'], $nameTokens, $rules);`
`84`		`- } else if ($type === 'object') {`
	`84`	`+ } elseif ($type === 'object') {`
`85`	`85`	`$this->addToProperties($properties[$name]['properties'], $nameTokens, $rules);`
`86`	`86`	`}`
`87`	`87`	`}`
`@@ -98,7 +98,7 @@ protected function getNestedParamType($nameTokens)`
`98`	`98`	`protected function getNewPropObj($type, $rules)`
`99`	`99`	`{`
`100`	`100`	`$propObj = [`
`101`		`- 'type' => $type`
	`101`	`+ 'type' => $type,`
`102`	`102`	`];`
`103`	`103`
`104`	`104`	`if ($enums = $this->getEnumValues($rules)) {`
`@@ -107,10 +107,10 @@ protected function getNewPropObj($type, $rules)`
`107`	`107`
`108`	`108`	`if ($type === 'array') {`
`109`	`109`	`$propObj['items'] = [];`
`110`		`- } else if ($type === 'object') {`
	`110`	`+ } elseif ($type === 'object') {`
`111`	`111`	`$propObj['properties'] = [];`
`112`	`112`	`}`
`113`	`113`
`114`	`114`	`return $propObj;`
`115`	`115`	`}`
`116`		`-}`
	`116`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -19,11 +19,11 @@ protected function getParamType(array $paramRules)`
`19`	`19`	`{`
`20`	`20`	`if (in_array('integer', $paramRules)) {`
`21`	`21`	`return 'integer';`
`22`		`- } else if (in_array('numeric', $paramRules)) {`
	`22`	`+ } elseif (in_array('numeric', $paramRules)) {`
`23`	`23`	`return 'number';`
`24`		`- } else if (in_array('boolean', $paramRules)) {`
	`24`	`+ } elseif (in_array('boolean', $paramRules)) {`
`25`	`25`	`return 'boolean';`
`26`		`- } else if (in_array('array', $paramRules)) {`
	`26`	`+ } elseif (in_array('array', $paramRules)) {`
`27`	`27`	`return 'array';`
`28`	`28`	`} else {`
`29`	`29`	`//date, ip, email, etc..`
`@@ -54,15 +54,15 @@ protected function getEnumValues(array $paramRules)`
`54`	`54`	`return [];`
`55`	`55`	`}`
`56`	`56`
`57`		`- list($param, $vals) = explode(':', $in);`
	`57`	`+ [$param, $vals] = explode(':', $in);`
`58`	`58`
`59`	`59`	`return explode(',', $vals);`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`private function getInParameter(array $paramRules)`
`63`	`63`	`{`
`64`	`64`	`foreach ($paramRules as $rule) {`
`65`		`- if ((is_string($rule) \|\| method_exists($rule , '__toString')) && Str::startsWith($rule, 'in:')) {`
	`65`	`+ if ((is_string($rule) \|\| method_exists($rule, '__toString')) && Str::startsWith($rule, 'in:')) {`
`66`	`66`	`return $rule;`
`67`	`67`	`}`
`68`	`68`	`}`