feat(config): add include/exclude models settings (#46)

ForestAdmin · May 9, 2022 · 1dcab5a · 1dcab5a
1 parent 456bd57
commit 1dcab5a
Show file tree

Hide file tree

Showing 7 changed files with 60 additions and 56 deletions.
diff --git a/config/forest.php b/config/forest.php
@@ -10,4 +10,6 @@
         'secret'      => env('FOREST_ENV_SECRET'),
         'auth-secret' => env('FOREST_AUTH_SECRET'),
     ],
+    'included_models' => [],
+    'excluded_models' => [],
 ];
diff --git a/src/Schema/Schema.php b/src/Schema/Schema.php
@@ -13,7 +13,6 @@
 use Illuminate\Contracts\Container\BindingResolutionException;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Http\Response;
-use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\File;
@@ -90,6 +89,23 @@ public function sendApiMap(): void
         }
     }
 
+    /**
+     * @param string $modelName
+     * @return bool
+     */
+    public function modelIncluded(string $modelName): bool
+    {
+        if (empty(config('forest.included_models')) && empty(config('forest.excluded_models'))) {
+            return true;
+        }
+
+        if (!empty(config('forest.included_models'))) {
+            return in_array($modelName, config('forest.included_models'), true);
+        } else {
+            return !in_array($modelName, config('forest.excluded_models'), true);
+        }
+    }
+
     /**
      * @return array
      * @throws BindingResolutionException
@@ -105,7 +121,7 @@ private function generate(): array
         foreach ($files as $file) {
             if (class_exists($file)) {
                 $class = (new \ReflectionClass($file));
-                if ($class->isSubclassOf(Model::class) && $class->isInstantiable()) {
+                if ($class->isSubclassOf(Model::class) && $class->isInstantiable() && $this->modelIncluded($file)) {
                     $model = app()->make($file);
                     $forestModel = new ForestModel($model);
                     $collections[] = $forestModel->serialize();

diff --git a/tests/Feature/Listeners/RouteMatchedTest.php b/tests/Feature/Listeners/RouteMatchedTest.php
@@ -57,8 +57,7 @@ protected function getEnvironmentSetUp($app): void
      */
     public function testApiMapNotSendWithOutFile(): void
     {
-        App::partialMock()->shouldReceive('basePath')->andReturn(config('forest.json_file_path'));
-        $schema = new Schema($this->getConfig(), new ForestApiRequester(), $this->getConsole('<info>Apimap Received<info>'));
+        $schema = new Schema(config(), new ForestApiRequester(), $this->getConsole('<info>Apimap Received<info>'));
         App::shouldReceive('make')->andReturn($schema);
 
         $this->assertNull(Cache::get(RouteMatched::APIMAP_DATE));
@@ -71,8 +70,7 @@ public function testApiMapNotSendWithOutFile(): void
      */
     public function testApiMapRouteNotMatchPattern(): void
     {
-        App::partialMock()->shouldReceive('basePath')->andReturn(config('forest.json_file_path'));
-        $schema = new Schema($this->getConfig(), new ForestApiRequester(), $this->getConsole('<info>Apimap Received<info>'));
+        $schema = new Schema(config(), new ForestApiRequester(), $this->getConsole('<info>Apimap Received<info>'));
         App::shouldReceive('make')->andReturn($schema);
 
         $this->assertNull(Cache::get(RouteMatched::APIMAP_DATE));
@@ -86,7 +84,7 @@ public function testApiMapRouteNotMatchPattern(): void
     public function testApiMapSend(): void
     {
         App::partialMock()->shouldReceive('basePath')->andReturn(config('forest.json_file_path'));
-        $schema = new Schema($this->getConfig(), $this->forestApiPost(), $this->getConsole('<info>Apimap Received<info>'));
+        $schema = new Schema(config(), $this->forestApiPost(), $this->getConsole('<info>Apimap Received<info>'));
         App::shouldReceive('make')->andReturn($schema);
         file_put_contents(App::basePath(config('forest.json_file_path')), '{}');
 
@@ -103,7 +101,7 @@ public function testApiMapSend(): void
     public function testApiMapSendOnce(): void
     {
         App::partialMock()->shouldReceive('basePath')->andReturn(config('forest.json_file_path'));
-        $schema = new Schema($this->getConfig(), new ForestApiRequester(), $this->getConsole('<info>Apimap Received<info>'));
+        $schema = new Schema(config(), new ForestApiRequester(), $this->getConsole('<info>Apimap Received<info>'));
         App::shouldReceive('make')->andReturn($schema);
         file_put_contents(App::basePath(config('forest.json_file_path')), '{}');
 
@@ -129,28 +127,6 @@ public function forestApiPost()
         return $forestApiPost->reveal();
     }
 
-    /**
-     * @return object
-     */
-    private function getConfig()
-    {
-        $config = $this->prophesize(Repository::class);
-        $config
-            ->get('database.default')
-            ->willReturn('sqlite');
-        $config
-            ->get('database.connections.sqlite.driver')
-            ->willReturn('sqlite');
-        $config
-            ->get('forest.models_directory')
-            ->willReturn(__DIR__ . '/../Feature/Models');
-        $config
-            ->get('forest.json_file_path')
-            ->willReturn('.forestadmin-schema.json');
-
-        return $config->reveal();
-    }
-
     /**
      * @return object
      */

diff --git a/tests/Feature/RelationshipsControllerTest.php b/tests/Feature/RelationshipsControllerTest.php
@@ -207,7 +207,8 @@ public function testAssociateMorphMany(): void
     public function testAssociateBelongsToMany(): void
     {
         $book = Book::first();
-        $range = Range::whereRelation('books', 'books.id', '!=', $book->id)->first();
+        $range = Range::whereDoesntHave('books', static fn($query) => $query->where('books.id', $book->id))->first();
+
         $call = $this->post(
             '/forest/book/' . $book->id . '/relationships/ranges',
             [

diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -95,6 +95,8 @@ protected function getEnvironmentSetUp($app): void
         parent::getEnvironmentSetUp($app);
         $config = $app['config'];
         $config->set('app.debug', true);
+        $config->set('database.default', 'sqlite');
+        $config->set('database.connections.sqlite.database', ':memory:');
         $config->set('forest.api.secret', 'my-secret-key');
         $config->set('forest.api.auth-secret', 'auth-secret-key');
         $config->set('forest.models_namespace', 'ForestAdmin\LaravelForestAdmin\Tests\Utils\Models\\');

diff --git a/tests/Unit/SchemaTest.php b/tests/Unit/SchemaTest.php
@@ -30,7 +30,7 @@ class SchemaTest extends TestCase
      */
     public function testFetchFiles(): void
     {
-        $schema = new Schema($this->getConfig(), $this->getForestApi(), $this->getConsole());
+        $schema = new Schema(config(), $this->getForestApi(), $this->getConsole());
         $this->invokeProperty($schema, 'directory', __DIR__ . '/../Feature/Models');
         $files = $this->invokeMethod($schema, 'fetchFiles');
 
@@ -55,7 +55,7 @@ public function testFetchFiles(): void
      */
     public function testMetadata(): void
     {
-        $schema = new Schema($this->getConfig(), $this->getForestApi(), $this->getConsole());
+        $schema = new Schema(config(), $this->getForestApi(), $this->getConsole());
         $metadata = $this->invokeMethod($schema, 'metadata');
 
         $this->assertIsArray($metadata);
@@ -75,9 +75,7 @@ public function testMetadata(): void
      */
     public function testGenerate(): void
     {
-        App::partialMock()->shouldReceive('basePath')
-            ->andReturn(__DIR__ . '/../Feature/Models');
-        $schema = new Schema($this->getConfig(), $this->getForestApi(), $this->getConsole());
+        $schema = new Schema(config(), $this->getForestApi(), $this->getConsole());
         File::shouldReceive('put')->andReturn(true);
         $generate = $this->invokeMethod($schema, 'generate');
 
@@ -87,33 +85,42 @@ public function testGenerate(): void
     }
 
     /**
-     * @return object
+     * @return void
      */
-    private function getForestApi()
+    public function testModelIncludedWithoutIncludedOrExcludedModels(): void
     {
-        return $this->prophesize(ForestApiRequester::class)->reveal();
+        $schema = new Schema(config(), $this->getForestApi(), $this->getConsole());
+        $this->assertTrue($schema->modelIncluded('foo'));
+    }
+
+    /**
+     * @return void
+     */
+    public function testModelIncludedWithIncludedModelsConfig(): void
+    {
+        config()->set('forest.included_models', ['foo', 'bar']);
+        $schema = new Schema(config(), $this->getForestApi(), $this->getConsole());
+        $this->assertTrue($schema->modelIncluded('foo'));
+        $this->assertFalse($schema->modelIncluded('foo2'));
+    }
+
+    /**
+     * @return void
+     */
+    public function testModelIncludedWithExcludedModelsConfig(): void
+    {
+        config()->set('forest.excluded_models', ['foo', 'bar']);
+        $schema = new Schema(config(), $this->getForestApi(), $this->getConsole());
+        $this->assertFalse($schema->modelIncluded('foo'));
+        $this->assertTrue($schema->modelIncluded('foo2'));
     }
 
     /**
      * @return object
      */
-    private function getConfig()
+    private function getForestApi()
     {
-        $config = $this->prophesize(Repository::class);
-        $config
-            ->get('database.default')
-            ->willReturn('sqlite');
-        $config
-            ->get('database.connections.sqlite.driver')
-            ->willReturn('sqlite');
-        $config
-            ->get('forest.models_directory')
-            ->willReturn(__DIR__ . '/../Feature/Models');
-        $config
-            ->get('forest.json_file_path')
-            ->willReturn('.forestadmin-schema.json');
-
-        return $config->reveal();
+        return $this->prophesize(ForestApiRequester::class)->reveal();
     }
 
     /**

diff --git a/...Feature/Models/SmartCollections/Comic.php → ...s/Utils/Models/SmartCollections/Comic.php b/...Feature/Models/SmartCollections/Comic.php → ...s/Utils/Models/SmartCollections/Comic.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace ForestAdmin\LaravelForestAdmin\Tests\Feature\Models\SmartCollections;
+namespace ForestAdmin\LaravelForestAdmin\Tests\Utils\Models\SmartCollections;
 
 use ForestAdmin\LaravelForestAdmin\Services\SmartFeatures\SmartCollection;
 use ForestAdmin\LaravelForestAdmin\Services\SmartFeatures\SmartField;