feat: Laravel 12 compatibility

Author: tpetry

composer.json

@@ -16,18 +16,18 @@
     "require": {
         "php": "^8.0",
         "doctrine/dbal": "^2.6|^3.5|^4.0",
-        "illuminate/container": "^6.0|^7.0|^8.0|^9.0|^10.0|^11.0",
-        "illuminate/database": "^6.0|^7.0|^8.79|^9.0|^10.0|^11.0",
-        "illuminate/events": "^6.0|^7.0|^8.0|^9.0|^10.0|^11.0",
-        "illuminate/support": "^6.0|^7.0|^8.0|^9.0|^10.0|^11.0",
+        "illuminate/container": "^6.0|^7.0|^8.0|^9.0|^10.0|^11.0|^12.0",
+        "illuminate/database": "^6.0|^7.0|^8.79|^9.0|^10.0|^11.0|^12.0",
+        "illuminate/events": "^6.0|^7.0|^8.0|^9.0|^10.0|^11.0|^12.0",
+        "illuminate/support": "^6.0|^7.0|^8.0|^9.0|^10.0|^11.0|^12.0",
         "spatie/regex": "^2.0|^3.0"
     },
     "require-dev": {
         "composer/semver": "^3.4",
         "friendsofphp/php-cs-fixer": "^2.19.3|^3.5.0",
         "larastan/larastan": "^1.0|^2.1|^3.0",
         "nesbot/carbon": "^2.7|^3.3",
-        "orchestra/testbench": "^4.0|^5.0|^6.0|^7.0|^8.0|^9.0",
+        "orchestra/testbench": "^4.0|^5.0|^6.0|^7.0|^8.0|^9.0|^10.0",
         "phpstan/extension-installer": "^1.1",
         "phpstan/phpstan": "^1.5|^2.0",
         "phpunit/phpunit": "^8.5.23|^9.5.13|^10.5|^11.4",

phpstan-baseline.neon

@@ -36,30 +36,31 @@ parameters:
 			count: 1
 			path: src/Eloquent/Mixins/BuilderReturning.php
 
-		-
-			message: '#^Call to function method_exists\(\) with Tpetry\\PostgresqlEnhanced\\Query\\Grammar and ''setConnection'' will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: src/PostgresEnhancedConnection.php
-
-		-
-			message: '#^Call to function method_exists\(\) with Tpetry\\PostgresqlEnhanced\\Schema\\Grammars\\Grammar and ''setConnection'' will always evaluate to true\.$#'
-			identifier: function.alreadyNarrowedType
-			count: 1
-			path: src/PostgresEnhancedConnection.php
-
 		-
 			message: '#^Call to function method_exists\(\) with \$this\(Tpetry\\PostgresqlEnhanced\\Query\\Builder\) and ''applyBeforeQueryCal…'' will always evaluate to true\.$#'
 			identifier: function.alreadyNarrowedType
 			count: 7
 			path: src/Query/Builder.php
 
+		-
+			message: '#^Method Illuminate\\Database\\Schema\\Grammars\\PostgresGrammar\:\:compileChange\(\) invoked with 3 parameters, 2 required\.$#'
+			identifier: arguments.count
+			count: 1
+			path: src/Schema/Grammars/Grammar.php
+			reportUnmatched: false
+
 		-
 			message: '#^Return type \(array\<int, string\>\) of method Tpetry\\PostgresqlEnhanced\\Schema\\Grammars\\Grammar\:\:compileAdd\(\) should be compatible with return type \(string\) of method Illuminate\\Database\\Schema\\Grammars\\PostgresGrammar\:\:compileAdd\(\)$#'
 			identifier: method.childReturnType
 			count: 1
 			path: src/Schema/Grammars/Grammar.php
 
+		-
+			message: '#^Parameter \#2 \$replace of function substr_replace expects array\|string, int\|false given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/Support/Helpers/MigrationIndex.php
+
 		-
 			message: '#^Call to an undefined method Illuminate\\Database\\Migrations\\Migration\:\:timeoutDown\(\)\.$#'
 			identifier: method.notFound

src/Backports/GrammarBackportConstructor.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tpetry\PostgresqlEnhanced\Backports;
+
+use Illuminate\Database\Connection;
+
+/**
+ * To support some features these commits from laravel needed to be backported for older versions:
+ * - [12.x] Fix accessing Connection property in Grammar classes (https://github.com/laravel/framework/commit/c78fa3d0684206f721b9a3b76e8c596aa8a08cd0)
+ */
+trait GrammarBackportConstructor
+{
+    /**
+     * The connection used for escaping values.
+     *
+     * @var Connection
+     */
+    protected $connection;
+
+    /**
+     * Create a new grammar instance.
+     */
+    public function __construct(Connection $connection)
+    {
+        $this->connection = $connection;
+    }
+}

src/Backports/GrammarBackportEscape.php

@@ -4,21 +4,12 @@
 
 namespace Tpetry\PostgresqlEnhanced\Backports;
 
-use RuntimeException;
-
 /**
  * To support some features these commits from laravel needed to be backported for older versions:
  * - [10.x] Escaping functionality within the Grammar (https://github.com/laravel/framework/commit/e953137280cdf6e0fe3c3e4c49d7209ad86c92c0).
  */
 trait GrammarBackportEscape
 {
-    /**
-     * The connection used for escaping values.
-     *
-     * @var \Illuminate\Database\Connection
-     */
-    protected $connection;
-
     /**
      * Escapes a value for safe SQL embedding.
      *
@@ -27,22 +18,6 @@ trait GrammarBackportEscape
      */
     public function escape($value, $binary = false): string
     {
-        if (null === $this->connection) {
-            throw new RuntimeException("The database driver's grammar implementation does not support escaping values.");
-        }
-
         return $this->connection->escape($value, $binary);
     }
-
-    /**
-     * Set the grammar's database connection.
-     *
-     * @param \Illuminate\Database\Connection $connection
-     */
-    public function setConnection($connection): static
-    {
-        $this->connection = $connection;
-
-        return $this;
-    }
 }

src/PostgresEnhancedConnection.php

@@ -117,11 +117,8 @@ public function serverVersion(): string
      */
     protected function getDefaultQueryGrammar(): QueryGrammar
     {
-        $grammar = new QueryGrammar();
+        $grammar = new QueryGrammar($this);
         $grammar->setTablePrefix($this->tablePrefix);
-        if (method_exists($grammar, 'setConnection')) {
-            $grammar->setConnection($this);
-        }
 
         return $grammar;
     }
@@ -131,11 +128,8 @@ protected function getDefaultQueryGrammar(): QueryGrammar
      */
     protected function getDefaultSchemaGrammar(): SchemaGrammar
     {
-        $grammar = new SchemaGrammar();
+        $grammar = new SchemaGrammar($this);
         $grammar->setTablePrefix($this->tablePrefix);
-        if (method_exists($grammar, 'setConnection')) {
-            $grammar->setConnection($this);
-        }
 
         return $grammar;
     }

src/Query/Grammar.php

@@ -6,11 +6,13 @@
 
 use Illuminate\Database\Query\Builder as BaseBuilder;
 use Illuminate\Database\Query\Grammars\PostgresGrammar;
+use Tpetry\PostgresqlEnhanced\Backports\GrammarBackportConstructor;
 use Tpetry\PostgresqlEnhanced\Backports\GrammarBackportEscape;
 use Tpetry\PostgresqlEnhanced\Backports\GrammarBackportSubstituteBindings;
 
 class Grammar extends PostgresGrammar
 {
+    use GrammarBackportConstructor;
     use GrammarBackportEscape;
     use GrammarBackportSubstituteBindings;
     use GrammarCte;

src/Schema/Blueprint.php

@@ -4,12 +4,38 @@
 
 namespace Tpetry\PostgresqlEnhanced\Schema;
 
+use Closure;
+use Illuminate\Database\Connection;
 use Illuminate\Database\Schema\Blueprint as BaseBlueprint;
+use Illuminate\Database\Schema\Grammars\Grammar as BaseGrammar;
 
+// In Laravel 12.0.0 the BaseBlueprint constructor was changed so the behaviour of before/after is emulated:
+// - Laravel >=12: store($this->connection, $this->grammar, $this->table), execute($callback)
+// - Laravel <=11: store($this->table, $this->prefix), execute($callback)
 class Blueprint extends BaseBlueprint
 {
     use BlueprintIndex;
     use BlueprintTable;
     use BlueprintTrigger;
     use BlueprintTypes;
+
+    protected Connection $connection;
+    protected BaseGrammar $grammar;
+    protected $prefix;
+    protected $table;
+
+    public function __construct(
+        Connection $connection,
+        string $table,
+        ?Closure $callback = null,
+    ) {
+        $this->connection = $connection;
+        $this->grammar = $connection->getSchemaGrammar();
+        $this->table = $table;
+        $this->prefix = $connection->getTablePrefix();
+
+        if (null !== $callback) {
+            $callback($this);
+        }
+    }
 }

src/Schema/Builder.php

@@ -33,6 +33,6 @@ public function getConnection(): PostgresEnhancedConnection
      */
     protected function createBlueprint($table, ?Closure $callback = null): Blueprint
     {
-        return new Blueprint($table, $callback);
+        return new Blueprint($this->getConnection(), $table, $callback);
     }
 }

src/Schema/Grammars/Grammar.php

@@ -5,10 +5,12 @@
 namespace Tpetry\PostgresqlEnhanced\Schema\Grammars;
 
 use Illuminate\Database\Schema\Grammars\PostgresGrammar;
+use Tpetry\PostgresqlEnhanced\Backports\GrammarBackportConstructor;
 use Tpetry\PostgresqlEnhanced\Backports\GrammarBackportEscape;
 
 class Grammar extends PostgresGrammar
 {
+    use GrammarBackportConstructor;
     use GrammarBackportEscape;
     use GrammarIndex;
     use GrammarTable;

src/Schema/Grammars/GrammarIndex.php

@@ -4,15 +4,9 @@
 
 namespace Tpetry\PostgresqlEnhanced\Schema\Grammars;
 
-use Closure;
-use Illuminate\Contracts\Database\Query\Expression as ExpressionContract;
-use Illuminate\Database\Query\Expression as ExpressionClass;
 use Illuminate\Database\Schema\Blueprint;
-use Illuminate\Support\Arr;
-use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Fluent;
-use Illuminate\Support\Str;
-use Tpetry\PostgresqlEnhanced\Support\Helpers\Query;
+use Tpetry\PostgresqlEnhanced\Support\Helpers\MigrationIndex;
 
 trait GrammarIndex
 {
@@ -79,15 +73,15 @@ public function compileFulltext(Blueprint $blueprint, Fluent $command): string
     {
         $command['algorithm'] ??= 'gin';
 
-        return $this->genericCompileCreateIndex($blueprint, $command, false);
+        return (new MigrationIndex())->compileCommand($this, $blueprint->getTable(), $command, false);
     }
 
     /**
      * Compile a plain index key command.
      */
     public function compileIndex(Blueprint $blueprint, Fluent $command): string
     {
-        return $this->genericCompileCreateIndex($blueprint, $command, false);
+        return (new MigrationIndex())->compileCommand($this, $blueprint->getTable(), $command, false);
     }
 
     /**
@@ -97,87 +91,14 @@ public function compileSpatialIndex(Blueprint $blueprint, Fluent $command): stri
     {
         $command['algorithm'] = 'gist';
 
-        return $this->genericCompileCreateIndex($blueprint, $command, false);
+        return (new MigrationIndex())->compileCommand($this, $blueprint->getTable(), $command, false);
     }
 
     /**
      * Compile a unique key command.
      */
     public function compileUnique2(Blueprint $blueprint, Fluent $command): string
     {
-        return $this->genericCompileCreateIndex($blueprint, $command, true);
-    }
-
-    private function genericCompileCreateIndex(Blueprint $blueprint, Fluent $command, bool $unique): string
-    {
-        // If the index is partial index using a closure a dummy query builder is provided to the closure. The query is
-        // then transformed to a static query and the select part is removed to only keep the condition.
-        if ($command['where'] instanceof Closure) {
-            $query = ($command['where'])(DB::query());
-            $command['where'] = trim(str_replace('select * where', '', Query::toSql($query)));
-        }
-
-        // If the storage parameters for the index are provided in array form they need to be serialized to PostgreSQL's
-        // string format.
-        if (\is_array($command['with'])) {
-            $with = array_map(fn (mixed $value) => match ($value) {
-                true => 'on',
-                false => 'off',
-                default => (string) $value,
-            }, $command['with']);
-            $with = array_map(fn (string $value, string $key) => "{$key} = {$value}", $with, array_keys($with));
-            $command['with'] = implode(', ', $with);
-        }
-
-        // If the additions for column specifications are used the columns need to be columnized different to the
-        // standard laravel logic which is expecting plain references.
-        // Note: The ExpressionContract has been added with Laravel 10, older versions used the ExpressionClass.
-        $columns = array_map(function (string|ExpressionContract|ExpressionClass $column): string {
-            // Expressions generated by rawIndex() should by definition not processed anymore and used as provided
-            if ($column instanceof ExpressionClass || $column instanceof ExpressionContract) {
-                return $this->getValue($column);
-            }
-
-            // When a functional index or escaped column name  is provided the column string is already a valid raw
-            // column index string and can be used exactly as provided.
-            if (Str::startsWith($column, ['(', '"'])) {
-                return $column;
-            }
-
-            // In case index parameters are provided the column needs to escaped correctly and the rest is provided
-            // exactly as provided.
-            return $this->columnizeWithSuffix([$column]);
-        }, $command['columns']);
-
-        // A fulltext index needs special handling to wrap the columns into to_tsvector calls.
-        if ('fulltext' === $command['name']) {
-            $columns = array_map(function (string $column, int $index) use ($command): string {
-                $language = $command['language'] ?? 'english';
-
-                return match (isset($command['weight'][$index])) {
-                    true => "setweight(to_tsvector({$this->quoteString($language)}, {$column}), {$this->quoteString($command['weight'][$index])})",
-                    false => "to_tsvector({$this->quoteString($language)}, {$column})",
-                };
-            }, $columns, array_keys(array_values($columns)));
-            $columns = ['('.implode(' || ', $columns).')'];
-        }
-
-        $index = [
-            $unique ? 'create unique index' : 'create index',
-            $command['concurrently'] ? 'concurrently' : null,
-            $command['ifNotExists'] ? 'if not exists' : null,
-            $this->wrap($command['index']),
-            'on',
-            $this->wrapTable($blueprint),
-            $command['algorithm'] ? "using {$command['algorithm']}" : null,
-            '('.implode(', ', $columns).')',
-            $command['include'] ? 'include ('.implode(',', $this->wrapArray(Arr::wrap($command['include']))).')' : null,
-            $command['nullsNotDistinct'] ? 'nulls not distinct' : null,
-            $command['with'] ? "with ({$command['with']})" : null,
-            $command['where'] ? "where {$command['where']}" : null,
-        ];
-        $sql = implode(' ', array_filter($index, fn (?string $part) => filled($part)));
-
-        return $sql;
+        return (new MigrationIndex())->compileCommand($this, $blueprint->getTable(), $command, true);
     }
 }