feat: allow skipping entity creation and dropping

Author: calebdw

src/Entities/Entity.php

@@ -22,19 +22,29 @@ public function connectionName(): ?string
         return null;
     }
 
-    /** Hook before creating the entity. */
-    public function creating(Connection $connection): void
+    /**
+     * Hook before creating the entity.
+     *
+     * @return bool true to create the entity, false to skip.
+     */
+    public function creating(Connection $connection): bool
     {
+        return true;
     }
 
     /** Hook after creating the entity. */
     public function created(Connection $connection): void
     {
     }
 
-    /** Hook before dropping the entity. */
-    public function dropping(Connection $connection): void
+    /**
+     * Hook before dropping the entity.
+     *
+     * @return bool true to drop the entity, false to skip.
+     */
+    public function dropping(Connection $connection): bool
     {
+        return true;
     }
 
     /** Hook after dropping the entity. */

src/EntityManager.php

@@ -53,9 +53,13 @@ public function create(Entity|string $entity): void
         }
 
         $connection = $this->connection($entity);
-        $grammar    = $this->grammar($connection);
 
-        $entity->creating($connection);
+        if (! $entity->creating($connection)) {
+            return;
+        }
+
+        $grammar = $this->grammar($connection);
+
         $connection->statement($grammar->compileCreate($entity));
         $entity->created($connection);
     }
@@ -68,9 +72,13 @@ public function drop(Entity|string $entity): void
         }
 
         $connection = $this->connection($entity);
-        $grammar    = $this->grammar($connection);
 
-        $entity->dropping($connection);
+        if (! $entity->dropping($connection)) {
+            return;
+        }
+
+        $grammar = $this->grammar($connection);
+
         $connection->statement($grammar->compileDrop($entity));
         $entity->dropped($connection);
     }

tests/Feature/EntityManagerTest.php

@@ -48,31 +48,57 @@
     })->throws(InvalidArgumentException::class, 'Entity [unknown] not found.');
 });
 
-it('creates an entity', function (string|Entity $entity) {
-    test()->connection
-        ->shouldReceive('getDriverName')->once()->andReturn('sqlite')
-        ->shouldReceive('statement')
-        ->once()
-        ->withArgs(fn ($sql) => str_contains($sql, 'CREATE VIEW'));
-
-    test()->manager->create($entity);
-})->with([
-    'name'   => 'users_view',
-    'entity' => new UserView(),
-]);
-
-it('drops an entity', function (string|Entity $entity) {
-    test()->connection
-        ->shouldReceive('getDriverName')->once()->andReturn('pgsql')
-        ->shouldReceive('statement')
-        ->once()
-        ->withArgs(fn ($sql) => str_contains($sql, 'DROP VIEW'));
+describe('create', function () {
+    it('creates an entity', function (string|Entity $entity) {
+        test()->connection
+            ->shouldReceive('getDriverName')->once()->andReturn('sqlite')
+            ->shouldReceive('statement')
+            ->once()
+            ->withArgs(fn ($sql) => str_contains($sql, 'CREATE VIEW'));
+
+        test()->manager->create($entity);
+    })->with([
+        'name'   => 'users_view',
+        'entity' => new UserView(),
+    ]);
+
+    it('can skip creation', function () {
+        $entity = new UserView();
+
+        test()->connection
+            ->shouldNotReceive('getDriverName')
+            ->shouldNotReceive('statement');
+
+        $entity->shouldCreate = false;
+        test()->manager->create($entity);
+    });
+});
 
-    test()->manager->drop($entity);
-})->with([
-    'name'   => 'users_view',
-    'entity' => new UserView(),
-]);
+describe('drop', function () {
+    it('drops an entity', function (string|Entity $entity) {
+        test()->connection
+            ->shouldReceive('getDriverName')->once()->andReturn('pgsql')
+            ->shouldReceive('statement')
+            ->once()
+            ->withArgs(fn ($sql) => str_contains($sql, 'DROP VIEW'));
+
+        test()->manager->drop($entity);
+    })->with([
+        'name'   => 'users_view',
+        'entity' => new UserView(),
+    ]);
+
+    it('can skip dropping', function () {
+        $entity = new UserView();
+
+        test()->connection
+            ->shouldNotReceive('getDriverName')
+            ->shouldNotReceive('statement');
+
+        $entity->shouldDrop = false;
+        test()->manager->drop($entity);
+    });
+});
 
 it('creates entities by type and connection', function () {
     test()->connection

workbench/database/entities/views/UserView.php

@@ -5,10 +5,15 @@
 namespace Workbench\Database\Entities\views;
 
 use CalebDW\SqlEntities\Entities\View;
+use Illuminate\Database\Connection;
 use Override;
 
 class UserView extends View
 {
+    public bool $shouldCreate = true;
+
+    public bool $shouldDrop = true;
+
     #[Override]
     public function name(): string
     {
@@ -20,4 +25,16 @@ public function definition(): string
     {
         return 'SELECT id, name FROM users';
     }
+
+    #[Override]
+    public function creating(Connection $connection): bool
+    {
+        return $this->shouldCreate;
+    }
+
+    #[Override]
+    public function dropping(Connection $connection): bool
+    {
+        return $this->shouldDrop;
+    }
 }