Merge pull request #17 from verbanent/update/laravel-12

Update compatibility to Laravel 12

Author: radek-ziemniewicz

.github/workflows/sonarcloud.yml

@@ -0,0 +1,23 @@
+name: sonarcloud
+on:
+    push:
+        branches: [ main ]
+    pull_request:
+
+jobs:
+    sonarcloud:
+        runs-on: ubuntu-latest
+        steps:
+            -   uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5
+                with:
+                    fetch-depth: 0
+            -   uses: shivammathur/setup-php@44454db4f0199b8b9685a5d763dc37cbf79108e1
+                with:
+                    php-version: '8.2'
+                    coverage: xdebug
+            -   run: composer install --no-interaction --no-progress --prefer-dist
+            -   run: php -d xdebug.mode=coverage vendor/bin/phpunit --coverage-clover coverage.xml
+            -   uses: SonarSource/sonarcloud-github-action@e44258b109568baa0df60ed515909fc6c72cba92
+                env:
+                    SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+                    GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}

.gitignore

@@ -4,8 +4,9 @@ coverage
 .phpunit.result.cache
 .idea
 .scannerwork
-sonar-project.properties
 vendor
 composer.lock
 .scannerwork/
 phpunit.*.xml
+coverage.xml
+.phpunit.cache

composer.json

@@ -40,7 +40,7 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^9",
-        "laravel/framework": "^6.20.26|^7|^8|^9|^10",
+        "laravel/framework": "^6.20.26|^7|^8|^9|^10.48.29|^11|^12",
         "mockery/mockery": "^1"
     },
     "type": "library"

phpunit.xml

@@ -1,16 +1,21 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" backupStaticAttributes="false" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
-  <coverage>
-    <include>
-      <directory suffix=".php">src/</directory>
-    </include>
-  </coverage>
-  <testsuites>
-    <testsuite name="Ordered binary UUID in Laravel / Eloquent Test Suite">
-      <directory>tests</directory>
-    </testsuite>
-  </testsuites>
-  <php>
-    <env name="APP_ENV" value="testing"/>
-  </php>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false"
+         backupStaticAttributes="false" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+    <coverage>
+        <include>
+            <directory suffix=".php">src/</directory>
+        </include>
+    </coverage>
+    <testsuites>
+        <testsuite name="Ordered binary UUID in Laravel / Eloquent Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <php>
+        <env name="APP_ENV" value="testing"/>
+        <ini name="xdebug.log" value="/tmp/xdebug.log"/>
+        <ini name="xdebug.log_level" value="0"/>
+    </php>
 </phpunit>

sonar-project.properties

@@ -0,0 +1,6 @@
+sonar.organization=verbanent
+sonar.projectKey=verbanent_eloquent-binary-uuid
+sonar.sources=src
+sonar.tests=tests
+sonar.php.coverage.reportPaths=coverage.xml
+sonar.exclusions=vendor/**

src/Providers/BinaryUuidServiceProvider.php

@@ -5,6 +5,7 @@
 namespace Verbanent\Uuid\Providers;
 
 use Illuminate\Support\ServiceProvider;
+use ReflectionClass;
 use Verbanent\Uuid\Grammars\MySqlGrammar;
 
 /**
@@ -23,10 +24,22 @@ public function boot(): void
 
     private function createGrammar($connection): MySqlGrammar
     {
-        $queryGrammar = $connection->getQueryGrammar();
+        if ($this->doesGrammarRequireConnection()) {
+            return new MySqlGrammar($connection);
+        }
+
+        $prefix = $connection->getTablePrefix();
         $grammar = new MySqlGrammar();
-        $grammar->setTablePrefix($queryGrammar->getTablePrefix());
+        $grammar->setTablePrefix($prefix);
 
         return $grammar;
     }
+
+    private function doesGrammarRequireConnection(): bool
+    {
+        $reflection = new ReflectionClass(MySqlGrammar::class);
+        $constructor = $reflection->getConstructor();
+
+        return $constructor !== null && $constructor->getNumberOfRequiredParameters() > 0;
+    }
 }

tests/Fixtures/MySqlGrammarNoConnection.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Verbanent\Uuid\Test\Fixtures;
+
+final class MySqlGrammarNoConnection
+{
+    private $tablePrefix = '';
+
+    public function setTablePrefix(string $prefix): void
+    {
+        $this->tablePrefix = $prefix;
+    }
+
+    public function getTablePrefix(): string
+    {
+        return $this->tablePrefix;
+    }
+}

tests/Grammars/MySqlGrammarTest.php

@@ -4,6 +4,8 @@
 
 namespace Verbanent\Uuid\Test\Grammars;
 
+use Illuminate\Database\Connection;
+use Mockery;
 use PHPUnit\Framework\TestCase;
 use ReflectionException;
 use ReflectionMethod;
@@ -14,6 +16,8 @@
  */
 class MySqlGrammarTest extends TestCase
 {
+    private $connection;
+
     /**
      * Allows to test private and protected methods.
      *
@@ -31,14 +35,24 @@ protected static function getMethod(string $name): ReflectionMethod
         return $method;
     }
 
+    public function setUp(): void
+    {
+        $this->connection = Mockery::mock(Connection::class);
+    }
+
+    protected function tearDown(): void
+    {
+        Mockery::close();
+    }
+
     /**
      * Test for MySqlGrammar::typeUuid.
      *
      * @throws ReflectionException
      */
     public function testTypeUuid(): void
     {
-        $mySqlGrammar = new MySqlGrammar();
+        $mySqlGrammar = new MySqlGrammar($this->connection);
         $typeUuid = self::getMethod('typeUuid');
         $uuidMySqlType = $typeUuid->invokeArgs($mySqlGrammar, [new \Illuminate\Support\Fluent()]);
 

tests/Providers/BinaryUuidServiceProviderLegacyGrammarTest.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Verbanent\Uuid\Test\Providers;
+
+use Illuminate\Contracts\Foundation\Application;
+use Mockery;
+use PHPUnit\Framework\TestCase;
+use ReflectionMethod;
+use Verbanent\Uuid\Providers\BinaryUuidServiceProvider;
+use Verbanent\Uuid\Test\Fixtures\MySqlGrammarNoConnection;
+
+class BinaryUuidServiceProviderLegacyGrammarTest extends TestCase
+{
+    /**
+     * @runInSeparateProcess
+     * @preserveGlobalState disabled
+     */
+    public function testCreateGrammarWithoutConnectionRequirementUsesTablePrefix(): void
+    {
+        // Simulate older Illuminate grammar with no required constructor params.
+        class_alias(
+            MySqlGrammarNoConnection::class,
+            'Verbanent\\Uuid\\Grammars\\MySqlGrammar'
+        );
+
+        $provider = new BinaryUuidServiceProvider(Mockery::mock(Application::class));
+        $connection = new class () {
+            public function getTablePrefix(): string
+            {
+                return 'legacy_';
+            }
+        };
+
+        $method = new ReflectionMethod(BinaryUuidServiceProvider::class, 'createGrammar');
+        $method->setAccessible(true);
+
+        $grammar = $method->invoke($provider, $connection);
+
+        $this->assertInstanceOf(MySqlGrammarNoConnection::class, $grammar);
+        $this->assertSame('legacy_', $grammar->getTablePrefix());
+    }
+}