feat!: add characteristics to SqlEntity contract

Author: calebdw

README.md

@@ -251,8 +251,6 @@ class Add extends Function_
     /** The language the function is written in. */
     protected string $language = 'SQL';
 
-    protected array $characteristics = [];
-
     /** The function return type. */
     protected string $returns = 'integer';
 

src/Concerns/DefaultSqlEntityBehaviour.php

@@ -15,8 +15,12 @@ trait DefaultSqlEntityBehaviour
     /** The connection name. */
     protected ?string $connection = null;
 
-    /** The entity name. */
-    protected ?string $name = null;
+    /**
+     * Any additional characteristics for the entity.
+     *
+     * @var list<string>
+     */
+    protected array $characteristics = [];
 
     /**
      * Any dependencies that need to be handled before this entity.
@@ -25,6 +29,9 @@ trait DefaultSqlEntityBehaviour
      */
     protected array $dependencies = [];
 
+    /** The entity name. */
+    protected ?string $name = null;
+
     #[Override]
     public function name(): string
     {
@@ -37,6 +44,12 @@ public function connectionName(): ?string
         return $this->connection;
     }
 
+    #[Override]
+    public function characteristics(): array
+    {
+        return $this->characteristics;
+    }
+
     #[Override]
     public function dependencies(): array
     {

src/Contracts/SqlEntity.php

@@ -19,6 +19,13 @@ public function name(): string;
     /** The entity connection name. */
     public function connectionName(): ?string;
 
+    /**
+     * Any additional characteristics for the entity.
+     *
+     * @return list<string>
+     */
+    public function characteristics(): array;
+
     /**
      * Any dependencies that need to be handled before this entity.
      *

src/Function_.php

@@ -27,13 +27,6 @@ abstract class Function_ implements SqlEntity
     /** If the function is loadable. */
     protected bool $loadable = false;
 
-    /**
-     * The function characteristics.
-     *
-     * @var list<string>
-     */
-    protected array $characteristics = [];
-
     /** The function return type. */
     protected string $returns;
 
@@ -53,16 +46,6 @@ public function arguments(): array
         return $this->arguments;
     }
 
-    /**
-     * The function characteristics.
-     *
-     * @return list<string>
-     */
-    public function characteristics(): array
-    {
-        return $this->characteristics;
-    }
-
     /** The language the function is written in. */
     public function language(): string
     {

src/Grammars/PostgresGrammar.php

@@ -71,13 +71,15 @@ protected function compileTriggerDrop(Trigger $entity): string
     #[Override]
     protected function compileViewCreate(View $entity): string
     {
-        $checkOption = $this->compileCheckOption($entity->checkOption());
-        $columns     = $this->compileList($entity->columns());
-        $recursive   = $entity->isRecursive() ? ' RECURSIVE' : '';
+        $checkOption     = $this->compileCheckOption($entity->checkOption());
+        $columns         = $this->compileList($entity->columns());
+        $recursive       = $entity->isRecursive() ? ' RECURSIVE' : '';
+        $characteristics = implode("\n", $entity->characteristics());
 
         return <<<SQL
-            CREATE OR REPLACE {$recursive} VIEW {$entity->name()} {$columns} AS
-            {$entity->toString()}
+            CREATE OR REPLACE {$recursive} VIEW {$entity->name()} {$columns}
+            {$characteristics}
+            AS {$entity->toString()}
             {$checkOption}
             SQL;
     }

src/Grammars/SqlServerGrammar.php

@@ -48,12 +48,14 @@ protected function compileTriggerCreate(Trigger $entity): string
     #[Override]
     protected function compileViewCreate(View $entity): string
     {
-        $checkOption = $this->compileCheckOption($entity->checkOption());
-        $columns     = $this->compileList($entity->columns());
+        $checkOption     = $this->compileCheckOption($entity->checkOption());
+        $columns         = $this->compileList($entity->columns());
+        $characteristics = implode("\n", $entity->characteristics());
 
         return <<<SQL
-            CREATE OR ALTER VIEW {$entity->name()} {$columns} AS
-            {$entity->toString()}
+            CREATE OR ALTER VIEW {$entity->name()} {$columns}
+            {$characteristics}
+            AS {$entity->toString()}
             {$checkOption}
             SQL;
     }

src/Trigger.php

@@ -11,13 +11,6 @@ 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;
 
@@ -34,16 +27,6 @@ abstract class Trigger implements SqlEntity
     /** 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
     {

tests/Unit/Grammars/PostgresGrammarTest.php

@@ -171,8 +171,8 @@
         $sql = test()->grammar->compileCreate(test()->entity);
 
         expect($sql)->toBe(<<<'SQL'
-            CREATE OR REPLACE VIEW user_view AS
-            SELECT id, name FROM users
+            CREATE OR REPLACE VIEW user_view
+            AS SELECT id, name FROM users
             SQL);
     });
 
@@ -182,8 +182,8 @@
         $sql = test()->grammar->compileCreate(test()->entity);
 
         expect($sql)->toBe(<<<'SQL'
-            CREATE OR REPLACE RECURSIVE VIEW user_view AS
-            SELECT id, name FROM users
+            CREATE OR REPLACE RECURSIVE VIEW user_view
+            AS SELECT id, name FROM users
             SQL);
     });
 
@@ -193,8 +193,8 @@
         $sql = test()->grammar->compileCreate(test()->entity);
 
         expect($sql)->toBe(<<<SQL
-            CREATE OR REPLACE VIEW user_view{$expected} AS
-            SELECT id, name FROM users
+            CREATE OR REPLACE VIEW user_view{$expected}
+            AS SELECT id, name FROM users
             SQL);
     })->with([
         'one column'  => [['id'], ' (id)'],
@@ -207,8 +207,8 @@
         $sql = test()->grammar->compileCreate(test()->entity);
 
         expect($sql)->toBe(<<<SQL
-            CREATE OR REPLACE VIEW user_view AS
-            SELECT id, name FROM users
+            CREATE OR REPLACE VIEW user_view
+            AS SELECT id, name FROM users
             {$expected}
             SQL);
     })->with([

tests/Unit/Grammars/SqlServerGrammarTest.php

@@ -124,8 +124,8 @@
         $sql = test()->grammar->compileCreate(test()->entity);
 
         expect($sql)->toBe(<<<'SQL'
-            CREATE OR ALTER VIEW user_view AS
-            SELECT id, name FROM users
+            CREATE OR ALTER VIEW user_view
+            AS SELECT id, name FROM users
             SQL);
     });
 
@@ -135,8 +135,8 @@
         $sql = test()->grammar->compileCreate(test()->entity);
 
         expect($sql)->toBe(<<<SQL
-            CREATE OR ALTER VIEW user_view{$expected} AS
-            SELECT id, name FROM users
+            CREATE OR ALTER VIEW user_view{$expected}
+            AS SELECT id, name FROM users
             SQL);
     })->with([
         'one column'  => [['id'], ' (id)'],
@@ -149,8 +149,8 @@
         $sql = test()->grammar->compileCreate(test()->entity);
 
         expect($sql)->toBe(<<<SQL
-            CREATE OR ALTER VIEW user_view AS
-            SELECT id, name FROM users
+            CREATE OR ALTER VIEW user_view
+            AS SELECT id, name FROM users
             {$expected}
             SQL);
     })->with([