feat(database): add json data type (tempestphp#709)

Author: MrYamous

src/Tempest/Database/src/Exceptions/InvalidDefaultValue.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Database\Exceptions;
+
+use Exception;
+
+final class InvalidDefaultValue extends Exception
+{
+    public function __construct(string $field, string $value)
+    {
+        parent::__construct("Default value '{$value}' provided for {$field} is not valid");
+    }
+}

src/Tempest/Database/src/QueryStatements/CreateTableStatement.php

@@ -166,6 +166,20 @@ public function boolean(
         return $this;
     }
 
+    public function json(
+        string $name,
+        bool $nullable = false,
+        ?string $default = null
+    ): self {
+        $this->statements[] = new JsonStatement(
+            name: $name,
+            nullable: $nullable,
+            default: $default,
+        );
+
+        return $this;
+    }
+
     public function compile(DatabaseDialect $dialect): string
     {
         $compiled = sprintf(

src/Tempest/Database/src/QueryStatements/JsonStatement.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Database\QueryStatements;
+
+use Tempest\Database\DatabaseDialect;
+use Tempest\Database\Exceptions\InvalidDefaultValue;
+use Tempest\Database\QueryStatement;
+
+final readonly class JsonStatement implements QueryStatement
+{
+    public function __construct(
+        private string $name,
+        private bool $nullable = false,
+        private ?string $default = null,
+    ) {
+    }
+
+    public function compile(DatabaseDialect $dialect): string
+    {
+        if ($this->default && false === json_validate($this->default)) {
+            throw new InvalidDefaultValue($this->name, $this->default);
+        }
+
+        return match($dialect) {
+            DatabaseDialect::MYSQL => sprintf(
+                '`%s` JSON %s',
+                $this->name,
+                $this->nullable ? '' : 'NOT NULL',
+            ),
+            DatabaseDialect::SQLITE => sprintf(
+                '`%s` TEXT %s %s',
+                $this->name,
+                $this->default ? "DEFAULT '{$this->default}'" : '',
+                $this->nullable ? '' : 'NOT NULL',
+            ),
+            DatabaseDialect::POSTGRESQL => sprintf(
+                '`%s` JSONB %s %s',
+                $this->name,
+                $this->default ? "DEFAULT (\"{$this->default}\")" : '',
+                $this->nullable ? '' : 'NOT NULL',
+            )
+        };
+    }
+}

tests/Integration/Database/QueryStatements/CreateTableStatementTest.php

@@ -4,6 +4,7 @@
 
 namespace Tests\Tempest\Integration\Database\QueryStatements;
 
+use Tempest\Database\Exceptions\InvalidDefaultValue;
 use Tempest\Database\Migration;
 use Tempest\Database\Migrations\CreateMigrationsTable;
 use Tempest\Database\QueryStatement;
@@ -33,7 +34,8 @@ public function up(): QueryStatement|null
                     ->integer('integer', default: 1)
                     ->date('date', default: '2024-01-01')
                     ->datetime('datetime', default: '2024-01-01 00:00:00')
-                    ->boolean('is_active', default: true);
+                    ->boolean('is_active', default: true)
+                    ->json('json', default: '{"default": "foo"}');
             }
 
             public function down(): QueryStatement|null
@@ -50,4 +52,33 @@ public function down(): QueryStatement|null
         // Make sure there are no errors
         $this->assertTrue(true);
     }
+
+    public function test_invalid_json_default(): void
+    {
+        $migration = new class () implements Migration {
+            public function getName(): string
+            {
+                return '0';
+            }
+
+            public function up(): QueryStatement|null
+            {
+                return (new CreateTableStatement('table'))
+                    ->json('json', default: '{default: "invalid json"}');
+            }
+
+            public function down(): QueryStatement|null
+            {
+                return null;
+            }
+        };
+
+        $this->expectException(InvalidDefaultValue::class);
+        $this->expectExceptionMessage("Default value '{default: \"invalid json\"}' provided for json is not valid");
+
+        $this->migrate(
+            CreateMigrationsTable::class,
+            $migration
+        );
+    }
 }