more clean up and tests

mtrajano · Feb 10, 2020 · 78c1fe5 · 78c1fe5
1 parent bad6685
commit 78c1fe5
Show file tree

Hide file tree

Showing 9 changed files with 82 additions and 69 deletions.
diff --git a/src/DataObjects/Route.php b/src/DataObjects/Route.php
@@ -112,7 +112,7 @@ private function getModelNameFromControllerDocs(): ?string
 
         $docBlock = $reflection->getDocComment();
 
-        return $this->getModelAnnotation($docBlock);
+        return $this->getModelNameFromMethodDocs($docBlock);
     }
 
     /**
@@ -154,18 +154,6 @@ private function getActionDocBlock()
         return $actionInstance ? $actionInstance->getDocComment() ?: '' : '';
     }
 
-    /**
-     * Get Model name from method DocBlock.
-     *
-     * @return string|null
-     *
-     * @throws ReflectionException
-     */
-    private function getModelNameFromMethodDocs(): ?string
-    {
-        return $this->getModelAnnotation();
-    }
-
     /**
      * Return a ReflectionMethod instance from current action.
      *
@@ -254,7 +242,9 @@ public function getThrows(): array
 
         if (!empty($exceptions)) {
             $exceptions = array_unique(array_map(function ($e) {
-                return trim($e, "\ \t\n\r\0\x0B");
+                $trimmed_exception = preg_replace('/^\s+|\s+$/', '', $e);
+
+                return trim($trimmed_exception, '\\');
             }, $exceptions));
         }
 
@@ -271,7 +261,7 @@ public function getThrows(): array
      *
      * @throws \ReflectionException
      */
-    private function getModelAnnotation(?string $docBlock = null): ?string
+    private function getModelNameFromMethodDocs(?string $docBlock = null): ?string
     {
         $docBlock = $docBlock ?? $this->getActionDocBlock();
 

diff --git a/src/Definitions/DefinitionGenerator.php b/src/Definitions/DefinitionGenerator.php
@@ -3,7 +3,6 @@
 namespace Mtrajano\LaravelSwagger\Definitions;
 
 use Illuminate\Database\Eloquent\Model;
-use Illuminate\Database\Schema\Builder;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Schema;
 use Illuminate\Support\Str;
@@ -102,17 +101,9 @@ private function allowsHttpMethodGenerate(): bool
         return true;
     }
 
-    /**
-     * Get the model's columns from table.
-     *
-     * @return array
-     */
     private function getModelColumns(): array
     {
-        /** @var Builder $schema */
-        $schema = Schema::getFacadeRoot();
-
-        return $schema->getColumnListing($this->model->getTable());
+        return Schema::getColumnListing($this->model->getTable());
     }
 
     private function getDefinitionProperties()
@@ -122,14 +113,6 @@ private function getDefinitionProperties()
         $hiddenColumns = $this->model->getHidden();
 
         if (method_exists($this->model, 'getAppends')) {
-            $appends = $this->model->getAppends();
-            // TODO: Test condition
-            if (!is_array($appends)) {
-                throw new RuntimeException(
-                    'The return type of the "getAppends" method must be an array.'
-                );
-            }
-
             $columns = array_merge($columns, $this->model->getAppends());
         }
 
@@ -152,8 +135,6 @@ private function getDefinitionName(): string
 
     /**
      * Create an instance of the model with fake data or return null.
-     *
-     * @return Model|null
      */
     private function getModelFake(): ?Model
     {

diff --git a/src/Generator.php b/src/Generator.php
@@ -61,8 +61,7 @@ public function __construct($config, $routeFilter = null)
      */
     public function generate()
     {
-        $this->docs = $this->getBaseInfo();
-        $this->docs['definitions'] = [];
+        $this->docs = $this->getBaseStructure();
 
         $securityDefinitions = $this->generateSecurityDefinitions();
         if ($securityDefinitions) {
@@ -91,7 +90,7 @@ public function generate()
         return $this->docs;
     }
 
-    protected function getBaseInfo()
+    protected function getBaseStructure()
     {
         $baseInfo = [
             'swagger' => '2.0',
@@ -117,6 +116,7 @@ protected function getBaseInfo()
         }
 
         $baseInfo['paths'] = [];
+        $baseInfo['definitions'] = [];
 
         return $baseInfo;
     }

diff --git a/src/LaravelSwaggerException.php b/src/LaravelSwaggerException.php
@@ -2,6 +2,4 @@
 
 namespace Mtrajano\LaravelSwagger;
 
-class LaravelSwaggerException extends \Exception
-{
-}
+class LaravelSwaggerException extends \Exception {}
diff --git a/src/SwaggerDocsManager.php b/src/SwaggerDocsManager.php
@@ -105,15 +105,12 @@ public function getLastVersionKey()
             ->last();
     }
 
-    /**
-     * @return array
-     */
     public function getRoutesWithVersions(): array
     {
         $versions = array_column($this->getAllVersionsConfigs(), 'appVersion');
 
         $routesWithVersions = [];
-        foreach ($versions as $key => $version) {
+        foreach ($versions as $version) {
             $route = route(
                 config('laravel-swagger.route.name'),
                 $version,

diff --git a/src/Traits/HasAppends.php b/src/Traits/HasAppends.php
@@ -2,20 +2,15 @@
 
 namespace Mtrajano\LaravelSwagger\Traits;
 
-use Exception;
-
 trait HasAppends
 {
     /**
-     * Get appends.
-     *
-     * @return array
-     * @throws Exception
+     * @throws \Mtrajano\LaravelSwagger\LaravelSwaggerException
      */
     public function getAppends(): array
     {
         if (!property_exists($this, 'appends')) {
-            throw new Exception('The class that use HasAppend must have the property $appends');
+            return [];
         }
 
         return $this->appends;

diff --git a/src/helpers.php b/src/helpers.php
@@ -199,6 +199,6 @@ function laravel_swagger_asset($asset)
      */
     function is_valid_file_name(string $file)
     {
-        return preg_match('/^([-.\w]+)$/', $file) > 0;
+        return preg_match('/^([-_.\w]+)$/', $file) > 0;
     }
 }
diff --git a/tests/DataObjects/RouteTest.php b/tests/DataObjects/RouteTest.php
@@ -24,9 +24,12 @@ protected function getEnvironmentSetUp($app)
             ->get('/middleware-controller-route', 'Mtrajano\LaravelSwagger\Tests\DataObjects\MiddlewareControllerRoute@index')
             ->name('middleware-controller-route')
             ->middleware('test');
+        $app['router']
+            ->get('/exception-route', 'Mtrajano\LaravelSwagger\Tests\DataObjects\ExceptionRoute@index')
+            ->name('exception-route');
     }
 
-    public function provideRoutesWithMiddleware()
+    public function provideRoutesWithMiddleware() : array
     {
         return [
             [
@@ -68,15 +71,20 @@ public function provideRoutesWithMiddleware()
         ];
     }
 
+    public function testGetThrows()
+    {
+        $laravelRoute = app('router')->getRoutes()->getByName('exception-route');
+
+        $route = new Route($laravelRoute);
+
+        $this->assertEquals(['Exception', 'SpaceExcetion', 'TabException'], $route->getThrows());
+    }
+
     /**
      * @dataProvider provideRoutesWithMiddleware
-     * @param string $routeName
-     * @param array $expectedMiddleware
      */
-    public function testCreateFromOnlyControllerWithMiddleware(
-        string $routeName,
-        array $expectedMiddleware
-    ) {
+    public function testCreateFromOnlyControllerWithMiddleware(string $routeName, array $expectedMiddleware)
+    {
         $laravelRoute = app('router')->getRoutes()->getByName($routeName);
 
         $route = new Route($laravelRoute);
@@ -99,9 +107,7 @@ public function __construct()
         $this->middleware('auth');
     }
 
-    public function index()
-    {
-    }
+    public function index() {}
 }
 
 class MiddlewareControllerRoute extends Controller
@@ -111,14 +117,22 @@ public function __construct()
         $this->middleware('auth:api');
     }
 
-    public function index()
-    {
-    }
+    public function index() {}
 }
 
 class OnlyRouteMiddleware extends Controller
 {
-    public function index()
-    {
-    }
+    public function index() {}
+}
+
+class ExceptionRoute extends Controller
+{
+    /**
+     * some description
+     *
+     * @throws \Exception
+     * @throws    \SpaceExcetion
+     * @throws  \TabException
+     */
+    public function index() {}
 }
diff --git a/tests/Traits/HasAppendsTest.php b/tests/Traits/HasAppendsTest.php
@@ -0,0 +1,38 @@
+<?php
+
+namespace Mtrajano\LaravelSwagger\Tests\Parameters;
+
+use Mtrajano\LaravelSwagger\Tests\TestCase;
+use Mtrajano\LaravelSwagger\Traits\HasAppends;
+use Illuminate\Database\Eloquent\Model;
+
+class HasAppendsTest extends TestCase
+{
+    public function testModelReturnsAppends() : void
+    {
+        $this->assertEquals([
+            'property-1',
+            'property-2',
+        ], (new ModelWithAppends())->getAppends());
+    }
+
+    public function testModelWithoutAppendsReturnsEmpty() : void
+    {
+        $this->assertEquals([], (new ModelWithoutAppends())->getAppends());
+    }
+}
+
+class ModelWithAppends extends Model
+{
+    use HasAppends;
+
+    protected $appends = [
+        'property-1',
+        'property-2',
+    ];
+}
+
+class ModelWithoutAppends extends Model
+{
+    use HasAppends;
+}