feat: uuid4 generation

Author: tpetry

.github/workflows/tests.yml

@@ -42,7 +42,7 @@ jobs:
     name: MariaDB 10.10
     uses: ./.github/workflows/tests-maria.yml
     with:
-      version: 10.10
+      version: "10.10"
 
   mysql5_7:
     name: MySQL 5.7

README.md

@@ -186,7 +186,7 @@ new CondXor(string|Expression $value1, string|Expression $value2);
 
 ### Functions
 
-### Aggregates
+#### Aggregates
 
 ```php
 use Illuminate\Contracts\Database\Query\Expression;
@@ -228,7 +228,7 @@ Movie::select([
     ->get();
 ```
 
-### Conditional
+#### Conditional
 
 ```php
 use Tpetry\QueryExpressions\Function\Conditional\{
@@ -247,6 +247,21 @@ BlogArticle::select([
 ->get();
 ```
 
+#### String
+```php
+use Tpetry\QueryExpressions\Function\String\Uuid4;
+
+new Uuid4();
+
+Schema::table('users', function (Blueprint $table): void {
+    $table->uuid()->default(new Uuid4())->unique();
+});
+```
+
+> **Warning**
+> The `Uuid4` expression is not available for all database versions.
+> With PostgreSQL you need at least v13 and with MariaDB at least v10.10.
+
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

src/Function/String/Uuid4.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tpetry\QueryExpressions\Function\String;
+
+use Illuminate\Contracts\Database\Query\Expression;
+use Illuminate\Database\Grammar;
+use Tpetry\QueryExpressions\Concerns\IdentifiesDriver;
+
+class Uuid4 implements Expression
+{
+    use IdentifiesDriver;
+
+    public function getValue(Grammar $grammar)
+    {
+        // MySQL: The expression needs to be enclosed by parentheses to be used as a default value in create table statements.
+        // SQLite: The expression needs to be enclosed by parentheses to be used as a default value in create table statements.
+        // SQLite: First character in 4th group is hardcoded to 8 because the required 8, 9, A, or B can't be randomly generated.
+        return match ($this->identify($grammar)) {
+            'mysql' => "(lower(concat(hex(random_bytes(4)),'-',hex(random_bytes(2)),'-4',substr(hex(random_bytes(2)), -3),'-',hex((ascii(random_bytes(1))>>6)+8),substr(hex(random_bytes(2)),-3),'-',hex(random_bytes(6)))))",
+            'pgsql' => 'gen_random_uuid()',
+            'sqlite' => "(lower(hex(randomblob(4))||'-'||hex(randomblob(2))||'-4'||substr(hex(randomblob(2)), -3)||'-8'||substr(hex(randomblob(2)),-3)||'-'||hex(randomblob(6))))",
+            'sqlsrv' => 'lower(newid())',
+        };
+    }
+}

tests/Function/String/Uuid4Test.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+use Tpetry\QueryExpressions\Function\String\Uuid4;
+
+it('can generate UUIDv4 values')
+    ->skipOnMariaBefore('10.10')
+    ->skipOnPgsqlBefore('13')
+    ->expect(new Uuid4())
+    ->toBeExecutable()
+    ->toBeMysql("(lower(concat(hex(random_bytes(4)),'-',hex(random_bytes(2)),'-4',substr(hex(random_bytes(2)), -3),'-',hex((ascii(random_bytes(1))>>6)+8),substr(hex(random_bytes(2)),-3),'-',hex(random_bytes(6)))))")
+    ->toBePgsql('gen_random_uuid()')
+    ->toBeSqlite("(lower(hex(randomblob(4))||'-'||hex(randomblob(2))||'-4'||substr(hex(randomblob(2)), -3)||'-8'||substr(hex(randomblob(2)),-3)||'-'||hex(randomblob(6))))")
+    ->toBeSqlsrv('lower(newid())');

tests/Pest.php

@@ -60,3 +60,78 @@
 
     return $this;
 });
+
+function skipOnMariaBefore(string $version)
+{
+    /** @var \Illuminate\Database\Connection $connection */
+    $connection = DB::connection();
+
+    if ($connection->getDriverName() !== 'mysql') {
+        return;
+    }
+
+    $actual = $connection->scalar('select version()');
+    if (str_contains($actual, 'MariaDB') && version_compare($actual, $version, '<')) {
+        test()->markTestSkipped("The MariaDB version must be at least {$version}.");
+    }
+}
+
+function skipOnMysqlBefore(string $version): void
+{
+    /** @var \Illuminate\Database\Connection $connection */
+    $connection = DB::connection();
+
+    if ($connection->getDriverName() !== 'mysql') {
+        return;
+    }
+
+    $actual = $connection->scalar('select version()');
+    if (! str_contains($actual, 'MariaDB') && version_compare($actual, $version, '<')) {
+        test()->markTestSkipped("The MariaDB version must be at least {$version}.");
+    }
+}
+
+function skipOnPgsqlBefore(string $version): void
+{
+    /** @var \Illuminate\Database\Connection $connection */
+    $connection = DB::connection();
+
+    if ($connection->getDriverName() !== 'pgsql') {
+        return;
+    }
+
+    $actual = $connection->scalar('show server_version');
+    if (version_compare($actual, $version, '<')) {
+        test()->markTestSkipped("The PostgreSQL version must be at least {$version}.");
+    }
+}
+
+function skipOnSqliteBefore(string $version): void
+{
+    /** @var \Illuminate\Database\Connection $connection */
+    $connection = DB::connection();
+
+    if ($connection->getDriverName() !== 'sqlite') {
+        return;
+    }
+
+    $actual = $connection->scalar('select sqlite_version()');
+    if (version_compare($actual, $version, '<')) {
+        test()->markTestSkipped("The SQLite version must be at least {$version}.");
+    }
+}
+
+function skipOnSqlsrvBefore(string $version): void
+{
+    /** @var \Illuminate\Database\Connection $connection */
+    $connection = DB::connection();
+
+    if ($connection->getDriverName() !== 'sqlsrv') {
+        return;
+    }
+
+    $actual = $connection->scalar("select serverproperty('productversion')");
+    if (version_compare($actual, $version, '<')) {
+        test()->markTestSkipped("The SQL Server version must be at least {$version}.");
+    }
+}