Merge pull request #129 from joshhanley/josh/laravel-13-support

Add Laravel 13 support

Author: joshhanley

.github/workflows/tests.yml

@@ -15,9 +15,11 @@ jobs:
       fail-fast: false
       matrix:
         php: [7.1, 7.2, 7.3, 7.4, '8.0', 8.1, 8.2, 8.3, 8.4]
-        laravel: [5.8.*, 6.*, 7.*, 8.*, 9.*, 10.*, 11.*, 12.*]
+        laravel: [5.8.*, 6.*, 7.*, 8.*, 9.*, 10.*, 11.*, 12.*, 13.*]
         os: [ubuntu-latest]
         include:
+          - laravel: 13.*
+            testbench: 11.*
           - laravel: 12.*
             testbench: 10.*
           - laravel: 11.*
@@ -127,6 +129,20 @@ jobs:
             php: '8.0'
           - laravel: 12.*
             php: '8.1'
+          - laravel: 13.*
+            php: 7.1
+          - laravel: 13.*
+            php: 7.2
+          - laravel: 13.*
+            php: 7.3
+          - laravel: 13.*
+            php: 7.4
+          - laravel: 13.*
+            php: '8.0'
+          - laravel: 13.*
+            php: '8.1'
+          - laravel: 13.*
+            php: 8.2
 
     name: PHP ${{ matrix.php }} / Laravel ${{ matrix.laravel }}
 

composer.json

@@ -12,13 +12,13 @@
         "php": "^7.1.3|^8.0",
         "ext-pdo_sqlite": "*",
         "ext-sqlite3": "*",
-        "illuminate/database": "^5.8 || ^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0 || ^12.0",
-        "illuminate/support": "^5.8 || ^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0 || ^12.0"
+        "illuminate/database": "^5.8 || ^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0 || ^12.0 || ^13.0",
+        "illuminate/support": "^5.8 || ^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0 || ^12.0 || ^13.0"
     },
     "require-dev": {
         "doctrine/dbal": "^2.9 || ^3.1.4",
-        "orchestra/testbench": "3.8.* || 3.9.* || ^4.0 || ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0",
-        "phpunit/phpunit": "^7.5 || ^8.4 || ^9.0 || ^10.0 || ^11.0"
+        "orchestra/testbench": "3.8.* || 3.9.* || ^4.0 || ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0",
+        "phpunit/phpunit": "^7.5 || ^8.4 || ^9.0 || ^10.0 || ^11.0 || ^12.5"
     },
     "autoload": {
         "psr-4": {

src/Sushi.php

@@ -57,7 +57,26 @@ protected function sushiCacheDirectory()
 
     public static function bootSushi()
     {
-        $instance = (new static);
+        // Laravel 13 (laravel/framework#55685) throws a LogicException if a new
+        // model instance is created while the model is still booting (i.e.
+        // during a boot* trait method). Since Sushi needs to create an instance
+        // to configure its SQLite connection, we defer that work until after
+        // booting has finished using the "whenBooted" method, which was added
+        // in Laravel 12.8 (laravel/framework#55286). For older Laravel versions
+        // we call it directly since there is no re-entrancy guard and the
+        // original behaviour works fine.
+        if (method_exists(static::class, 'whenBooted')) {
+            static::whenBooted(function () {
+                static::configureSushiConnection();
+            });
+        } else {
+            static::configureSushiConnection();
+        }
+    }
+
+    protected static function configureSushiConnection()
+    {
+        $instance = new static;
 
         $cachePath = $instance->sushiCachePath();
         $dataPath = $instance->sushiCacheReferencePath();

tests/SushiTest.php

@@ -39,8 +39,7 @@ public function tearDown(): void
         parent::tearDown();
     }
 
-    /** @test */
-    function basic_usage()
+    function test_basic_usage()
     {
         $this->assertEquals(3, Foo::count());
         $this->assertEquals('bar', Foo::first()->foo);
@@ -50,8 +49,7 @@ function basic_usage()
         $this->assertEquals('lob', Bar::whereBob('lob')->first()->bob);
     }
 
-    /** @test */
-    function columns_with_varying_types()
+    function test_columns_with_varying_types()
     {
         $row = ModelWithVaryingTypeColumns::first();
         $connectionBuilder = ModelWithVaryingTypeColumns::resolveConnection()->getSchemaBuilder();
@@ -65,8 +63,7 @@ function_exists('\Orchestra\Testbench\laravel_version_compare') && laravel_versi
         $this->assertEquals(null, $row->null);
     }
 
-    /** @test */
-    function model_with_custom_schema()
+    function test_model_with_custom_schema()
     {
         ModelWithCustomSchema::count();
         $connectionBuilder = ModelWithCustomSchema::resolveConnection()->getSchemaBuilder();
@@ -80,17 +77,15 @@ function_exists('\Orchestra\Testbench\laravel_version_compare') && laravel_versi
         );
     }
 
-    /** @test */
-    function models_using_the_get_rows_property_arent_cached()
+    function test_models_using_the_get_rows_property_arent_cached()
     {
         Bar::$hasBeenAccessedBefore = false;
         $this->assertEquals(2, Bar::count());
         Bar::resetStatics();
         $this->assertEquals(3, Bar::count());
     }
 
-    /** @test */
-    function uses_in_memory_if_the_cache_directory_is_not_writeable_or_not_found()
+    function test_uses_in_memory_if_the_cache_directory_is_not_writeable_or_not_found()
     {
         config(['sushi.cache-path' => $path = __DIR__ . '/non-existant-path']);
 
@@ -100,8 +95,7 @@ function uses_in_memory_if_the_cache_directory_is_not_writeable_or_not_found()
         $this->assertEquals(':memory:', (new Foo)->getConnection()->getDatabaseName());
     }
 
-    /** @test */
-    function caches_sqlite_file_if_storage_cache_folder_is_available()
+    function test_caches_sqlite_file_if_storage_cache_folder_is_available()
     {
         Foo::count();
 
@@ -112,8 +106,7 @@ function caches_sqlite_file_if_storage_cache_folder_is_available()
         );
     }
 
-    /** @test */
-    function avoids_error_when_creating_database_concurrently()
+    function test_avoids_error_when_creating_database_concurrently()
     {
         $actualFactory = app(ConnectionFactory::class);
         $actualConnection = $actualFactory->make([
@@ -144,30 +137,26 @@ function avoids_error_when_creating_database_concurrently()
     }
 
     /**
-     * @test
      * @group skipped
-     * */
-    function uses_same_cache_between_requests()
+     */
+    function test_uses_same_cache_between_requests()
     {
         $this->markTestSkipped("I can't find a good way to test this right now.");
     }
 
-    /** @test */
-    function adds_primary_key_if_needed()
+    function test_adds_primary_key_if_needed()
     {
         $this->assertEquals([5,6], ModelWithNonStandardKeys::orderBy('id')->pluck('id')->toArray());
         $this->assertEquals(1, Foo::find(1)->getKey());
     }
 
 
-    /** @test */
-    function it_returns_an_empty_collection()
+    function test_it_returns_an_empty_collection()
     {
         $this->assertEquals(0, Blank::count());
     }
 
-    /** @test */
-    function can_use_exists_validation_rule()
+    function test_can_use_exists_validation_rule()
     {
         ModelWithNonStandardKeys::all();
         Foo::all();
@@ -185,22 +174,15 @@ function can_use_exists_validation_rule()
             : $this->assertFalse(Validator::make(['bob' => 'ble'], ['bob' => 'exists:'.ModelWithNonStandardKeys::class.'.model_with_non_standard_keys'])->passes());
     }
 
-    /** @test */
-    public function it_runs_method_after_migration_when_defined()
+    public function test_it_runs_method_after_migration_when_defined()
     {
         $model = ModelWithAddedTableOperations::all();
         $this->assertEquals('columnWasAdded', $model->first()->columnAdded, 'The runAfterMigrating method was not triggered.');
     }
 
-    /**
-     * @test
-     * @define-env usesSqliteConnection
-     * */
-    function sushi_models_can_relate_to_models_in_regular_sqlite_databases()
+    function test_sushi_models_can_relate_to_models_in_regular_sqlite_databases()
     {
-        if (! trait_exists('\Orchestra\Testbench\Concerns\HandlesAnnotations')) {
-            $this->markTestSkipped('Requires HandlesAnnotation trait to define sqlite connection using PHPUnit annotation');
-        }
+        $this->usesSqliteConnection($this->app);
 
         $this->loadMigrationsFrom(__DIR__ . '/database/migrations');
         $this->artisan('migrate', ['--database' => 'testbench-sqlite'])->run();