feat: add triggers

Author: calebdw

README.md

@@ -300,8 +300,41 @@ class Add extends Function_
 
 <!-- #### 📤 Procedure -->
 <!---->
-<!-- #### ⚡ Trigger -->
-<!---->
+
+#### ⚡ Trigger
+
+The `Trigger` class is used to create triggers in the database.
+In addition to the options above, you can use the following options to further customize the trigger:
+
+```php
+<?php
+
+namespace Database\Entities\Triggers;
+
+use CalebDW\SqlEntities\Trigger;
+
+class AccountAuditTrigger extends Trigger
+{
+    // if the trigger is a constraint trigger
+    // PostgreSQL only
+    protected bool $constraint = false;
+
+    protected string $timing = 'AFTER';
+
+    protected array $events = ['UPDATE'];
+
+    protected string $table = 'accounts';
+
+    #[Override]
+    public function definition(): string
+    {
+        return $this->definition ?? <<<'SQL'
+            EXECUTE FUNCTION record_account_audit();
+            SQL;
+    }
+}
+```
+
 <!-- #### 🔢 Sequence -->
 <!---->
 <!-- #### 🧳 Domain -->

src/Grammars/Grammar.php

@@ -6,6 +6,7 @@
 
 use CalebDW\SqlEntities\Contracts\SqlEntity;
 use CalebDW\SqlEntities\Function_;
+use CalebDW\SqlEntities\Trigger;
 use CalebDW\SqlEntities\View;
 use Illuminate\Database\Connection;
 use Illuminate\Support\Str;
@@ -23,6 +24,7 @@ public function compileCreate(SqlEntity $entity): string
     {
         $statement = match (true) {
             $entity instanceof Function_ => $this->compileFunctionCreate($entity),
+            $entity instanceof Trigger   => $this->compileTriggerCreate($entity),
             $entity instanceof View      => $this->compileViewCreate($entity),
 
             default => throw new InvalidArgumentException(
@@ -38,6 +40,7 @@ public function compileDrop(SqlEntity $entity): string
     {
         $statement = match (true) {
             $entity instanceof Function_ => $this->compileFunctionDrop($entity),
+            $entity instanceof Trigger   => $this->compileTriggerDrop($entity),
             $entity instanceof View      => $this->compileViewDrop($entity),
 
             default => throw new InvalidArgumentException(
@@ -53,6 +56,7 @@ public function supportsEntity(SqlEntity $entity): bool
     {
         return match (true) {
             $entity instanceof Function_ => true,
+            $entity instanceof Trigger   => true,
             $entity instanceof View      => true,
             default                      => false,
         };
@@ -67,6 +71,15 @@ protected function compileFunctionDrop(Function_ $entity): string
             SQL;
     }
 
+    abstract protected function compileTriggerCreate(Trigger $entity): string;
+
+    protected function compileTriggerDrop(Trigger $entity): string
+    {
+        return <<<SQL
+            DROP TRIGGER IF EXISTS {$entity->name()}
+            SQL;
+    }
+
     abstract protected function compileViewCreate(View $entity): string;
 
     protected function compileViewDrop(View $entity): string

src/Grammars/MariaDbGrammar.php

@@ -5,6 +5,7 @@
 namespace CalebDW\SqlEntities\Grammars;
 
 use CalebDW\SqlEntities\Function_;
+use CalebDW\SqlEntities\Trigger;
 use CalebDW\SqlEntities\View;
 use Override;
 
@@ -31,6 +32,20 @@ protected function compileFunctionCreate(Function_ $entity): string
             SQL;
     }
 
+    #[Override]
+    protected function compileTriggerCreate(Trigger $entity): string
+    {
+        $characteristics = implode("\n", $entity->characteristics());
+
+        return <<<SQL
+            CREATE OR REPLACE TRIGGER {$entity->name()}
+            {$entity->timing()} {$entity->events()[0]}
+            ON {$entity->table()} FOR EACH ROW
+            {$characteristics}
+            {$entity->toString()}
+            SQL;
+    }
+
     #[Override]
     protected function compileViewCreate(View $entity): string
     {

src/Grammars/MySqlGrammar.php

@@ -5,6 +5,7 @@
 namespace CalebDW\SqlEntities\Grammars;
 
 use CalebDW\SqlEntities\Function_;
+use CalebDW\SqlEntities\Trigger;
 use CalebDW\SqlEntities\View;
 use Override;
 
@@ -32,6 +33,20 @@ protected function compileFunctionCreate(Function_ $entity): string
             SQL;
     }
 
+    #[Override]
+    protected function compileTriggerCreate(Trigger $entity): string
+    {
+        $characteristics = implode("\n", $entity->characteristics());
+
+        return <<<SQL
+            CREATE TRIGGER IF NOT EXISTS {$entity->name()}
+            {$entity->timing()} {$entity->events()[0]}
+            ON {$entity->table()} FOR EACH ROW
+            {$characteristics}
+            {$entity->toString()}
+            SQL;
+    }
+
     #[Override]
     protected function compileViewCreate(View $entity): string
     {

src/Grammars/PostgresGrammar.php

@@ -5,6 +5,7 @@
 namespace CalebDW\SqlEntities\Grammars;
 
 use CalebDW\SqlEntities\Function_;
+use CalebDW\SqlEntities\Trigger;
 use CalebDW\SqlEntities\View;
 use Override;
 
@@ -43,6 +44,30 @@ protected function compileFunctionDrop(Function_ $entity): string
             SQL;
     }
 
+    #[Override]
+    protected function compileTriggerCreate(Trigger $entity): string
+    {
+        $contraint       = $entity->constraint() ? 'CONSTRAINT' : '';
+        $events          = implode(' OR ', $entity->events());
+        $characteristics = implode("\n", $entity->characteristics());
+
+        return <<<SQL
+            CREATE OR REPLACE {$contraint} TRIGGER {$entity->name()}
+            {$entity->timing()} {$events}
+            ON {$entity->table()}
+            {$characteristics}
+            {$entity->toString()}
+            SQL;
+    }
+
+    #[Override]
+    protected function compileTriggerDrop(Trigger $entity): string
+    {
+        return <<<SQL
+            DROP TRIGGER IF EXISTS {$entity->name()} ON {$entity->table()}
+            SQL;
+    }
+
     #[Override]
     protected function compileViewCreate(View $entity): string
     {

src/Grammars/SQLiteGrammar.php

@@ -6,6 +6,7 @@
 
 use CalebDW\SqlEntities\Contracts\SqlEntity;
 use CalebDW\SqlEntities\Function_;
+use CalebDW\SqlEntities\Trigger;
 use CalebDW\SqlEntities\View;
 use Override;
 use RuntimeException;
@@ -28,6 +29,20 @@ protected function compileFunctionCreate(Function_ $entity): string
         throw new RuntimeException('SQLite does not support user-defined functions.');
     }
 
+    #[Override]
+    protected function compileTriggerCreate(Trigger $entity): string
+    {
+        $characteristics = implode("\n", $entity->characteristics());
+
+        return <<<SQL
+            CREATE TRIGGER IF NOT EXISTS {$entity->name()}
+            {$entity->timing()} {$entity->events()[0]}
+            ON {$entity->table()}
+            {$characteristics}
+            {$entity->toString()}
+            SQL;
+    }
+
     #[Override]
     protected function compileViewCreate(View $entity): string
     {

src/Grammars/SqlServerGrammar.php

@@ -5,6 +5,7 @@
 namespace CalebDW\SqlEntities\Grammars;
 
 use CalebDW\SqlEntities\Function_;
+use CalebDW\SqlEntities\Trigger;
 use CalebDW\SqlEntities\View;
 use Override;
 
@@ -29,6 +30,21 @@ protected function compileFunctionCreate(Function_ $entity): string
             SQL;
     }
 
+    #[Override]
+    protected function compileTriggerCreate(Trigger $entity): string
+    {
+        $events          = implode(', ', $entity->events());
+        $characteristics = implode("\n", $entity->characteristics());
+
+        return <<<SQL
+            CREATE OR ALTER TRIGGER {$entity->name()}
+            ON {$entity->table()}
+            {$entity->timing()} {$events}
+            {$characteristics}
+            {$entity->toString()}
+            SQL;
+    }
+
     #[Override]
     protected function compileViewCreate(View $entity): string
     {

src/Trigger.php

@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CalebDW\SqlEntities;
+
+use CalebDW\SqlEntities\Concerns\DefaultSqlEntityBehaviour;
+use CalebDW\SqlEntities\Contracts\SqlEntity;
+
+abstract class Trigger implements SqlEntity
+{
+    use DefaultSqlEntityBehaviour;
+
+    /**
+     * The trigger characteristics.
+     *
+     * @var list<string>
+     */
+    protected array $characteristics = [];
+
+    /** If the trigger is a constraint trigger. */
+    protected bool $constraint = false;
+
+    /**
+     * The trigger events.
+     *
+     * @var list<string>
+     */
+    protected array $events;
+
+    /** The table the trigger is associated with. */
+    protected string $table;
+
+    /** The trigger timing. */
+    protected string $timing;
+
+    /**
+     * The function characteristics.
+     *
+     * @return list<string>
+     */
+    public function characteristics(): array
+    {
+        return $this->characteristics;
+    }
+
+    /** If the trigger is a constraint trigger. */
+    public function constraint(): bool
+    {
+        return $this->constraint;
+    }
+
+    /**
+     * The trigger events.
+     *
+     * @return list<string>
+     */
+    public function events(): array
+    {
+        return $this->events;
+    }
+
+    /** The table the trigger is associated with. */
+    public function table(): string
+    {
+        return $this->table;
+    }
+
+    /** The trigger timing. */
+    public function timing(): string
+    {
+        return $this->timing;
+    }
+}

tests/Feature/SqlEntityManagerTest.php

@@ -23,10 +23,10 @@
 ]);
 
 dataset('typesAndConnections', [
-    'default args'         => ['types' => null, 'connections' => null, 'times' => 4],
+    'default args'         => ['types' => null, 'connections' => null, 'times' => 5],
     'single specific type' => ['types' => UserView::class, 'connections' => null, 'times' => 1],
-    'single connection'    => ['types' => null, 'connections' => 'default', 'times' => 3],
-    'multiple connections' => ['types' => null, 'connections' => ['default', 'foo'], 'times' => 4],
+    'single connection'    => ['types' => null, 'connections' => 'default', 'times' => 4],
+    'multiple connections' => ['types' => null, 'connections' => ['default', 'foo'], 'times' => 5],
     'single abstract type' => ['types' => View::class, 'connections' => null, 'times' => 3],
     'multiple types'       => ['types' => [UserView::class, FooConnectionUserView::class], 'connections' => null, 'times' => 2],
 ]);

tests/Unit/Grammars/GrammarTest.php

@@ -6,10 +6,12 @@
 use CalebDW\SqlEntities\Contracts\SqlEntity;
 use CalebDW\SqlEntities\Function_;
 use CalebDW\SqlEntities\Grammars\Grammar;
+use CalebDW\SqlEntities\Trigger;
 use CalebDW\SqlEntities\View;
 use Illuminate\Database\Connection;
 use Illuminate\Database\Query\Builder;
 use Workbench\Database\Entities\functions\AddFunction;
+use Workbench\Database\Entities\triggers\AccountAuditTrigger;
 use Workbench\Database\Entities\views\UserView;
 
 beforeEach(function () {
@@ -38,6 +40,14 @@
         SQL);
 });
 
+it('compiles trigger drop', function () {
+    $sql = test()->grammar->compileDrop(new AccountAuditTrigger());
+
+    expect($sql)->toBe(<<<'SQL'
+        DROP TRIGGER IF EXISTS account_audit_trigger
+        SQL);
+});
+
 it('compiles view drop', function () {
     $sql = test()->grammar->compileDrop(new UserView());
 
@@ -57,6 +67,11 @@ protected function compileFunctionCreate(Function_ $entity): string
     {
         return '';
     }
+
+    protected function compileTriggerCreate(Trigger $entity): string
+    {
+        return '';
+    }
 }
 
 class UnknownSqlEntity implements SqlEntity