Merge pull request #148 from laravel-shift/l13-compatibility

Laravel 13.x Compatibility

Author: tonysm

.github/workflows/tests.yml

@@ -12,7 +12,7 @@ jobs:
       fail-fast: true
       matrix:
         php: [8.1, 8.2, 8.3]
-        laravel: ["10.*", "11.*", "12.*"]
+        laravel: ['10.*', '11.*', '12.*', '13.*']
         dependency-version: [prefer-stable]
         include:
           - laravel: 10.*
@@ -21,13 +21,19 @@ jobs:
             testbench: 9.*
           - laravel: 12.*
             testbench: 10.*
+          - laravel: 13.*
+            testbench: 11.*
         exclude:
           - laravel: 9.*
             php: 8.3
           - laravel: 11.*
             php: 8.1
           - laravel: 12.*
             php: 8.1
+          - laravel: 13.*
+            php: 8.1
+          - laravel: 13.*
+            php: 8.2
 
     name: PHP ${{ matrix.php }} - LARAVEL ${{ matrix.laravel }} - ${{ matrix.dependency-version }}
 

composer.json

@@ -18,12 +18,12 @@
     ],
     "require": {
         "php": "^8.1",
-        "illuminate/database": "^10.0||^11.0||^12.0",
-        "illuminate/events": "^10.0||^11.0||^12.0"
+        "illuminate/database": "^10.0||^11.0||^12.0||^13.0",
+        "illuminate/events": "^10.0||^11.0||^12.0||^13.0"
     },
     "require-dev": {
-        "orchestra/testbench": "^8.0||^9.0||^10.0",
-        "phpunit/phpunit": "^10.5||^11.5.3",
+        "orchestra/testbench": "^8.0||^9.0||^10.0||^11.0",
+        "phpunit/phpunit": "^10.5||^11.5.3||^12.5.12",
         "tightenco/duster": "^3.1"
     },
     "autoload": {

src/HasChildren.php

@@ -16,11 +16,6 @@
  */
 trait HasChildren
 {
-    /**
-     * @var bool
-     */
-    protected static $parentBootMethods;
-
     /**
      * @var bool
      */
@@ -46,38 +41,39 @@ protected static function registerModelEvent($event, $callback): void
     {
         parent::registerModelEvent($event, $callback);
 
+        // Only the parent class should forward events to children. When called
+        // from a child class, the child already received this event via the
+        // parent::registerModelEvent call above, so we'll skip for that.
+        if (static::class !== self::class) {
+            return;
+        }
+
+        // Don't forward events to children models during the parent's boot
+        // lifecycle, as the children will also be booting and will also
+        // register these events themselves via their boot lifecycle.
+        if (self::parentIsBooting()) {
+            return;
+        }
+
         $childTypes = (new static)->getChildTypes();
 
-        if (static::class === self::class && $childTypes !== []) {
-            // We don't want to register the callbacks that happen in the boot method of the parent, as they'll be called
-            // from the child's boot method as well.
-            if (! self::parentIsBooting()) {
-                foreach ($childTypes as $childClass) {
-                    if ($childClass !== self::class) {
-                        $childClass::registerModelEvent($event, $callback);
-                    }
-                }
+        foreach ($childTypes as $childClass) {
+            if ($childClass !== self::class) {
+                $childClass::registerModelEvent($event, $callback);
             }
         }
     }
 
+    /**
+     * Determine if the parent model is currently in its boot lifecycle.
+     *
+     * This checks whether bootIfNotBooted is in the call stack, which covers
+     * the entire boot lifecycle including boot(), booted(), and whenBooted() callbacks.
+     */
     protected static function parentIsBooting(): bool
     {
-        if (! isset(self::$parentBootMethods)) {
-            self::$parentBootMethods[] = 'boot';
-
-            foreach (class_uses_recursive(self::class) as $trait) {
-                self::$parentBootMethods[] = 'boot' . class_basename($trait);
-            }
-
-            self::$parentBootMethods = array_flip(self::$parentBootMethods);
-        }
-
         foreach (debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS) as $trace) {
-            $class = isset($trace['class']) ? $trace['class'] : null;
-            $function = isset($trace['function']) ? $trace['function'] : '';
-
-            if ($class === self::class && isset(self::$parentBootMethods[$function])) {
+            if (($trace['function'] ?? '') === 'bootIfNotBooted') {
                 return true;
             }
         }

src/HasParent.php

@@ -19,6 +19,17 @@ trait HasParent
      * @throws ReflectionException
      */
     public static function bootHasParent(): void
+    {
+        if (method_exists(static::class, 'whenBooted')) {
+            static::whenBooted(function () {
+                static::configureHasParentModels();
+            });
+        } else {
+            static::configureHasParentModels();
+        }
+    }
+
+    protected static function configureHasParentModels(): void
     {
         // This adds support for using Parental with standalone Eloquent, outside a normal Laravel app.
         if (static::getEventDispatcher() === null) {

tests/Features/AuthUserMethodReturnsChildModel.php

@@ -3,10 +3,11 @@
 namespace Parental\Tests\Features;
 
 use Parental\Tests\TestCase;
+use PHPUnit\Framework\Attributes\Test;
 
 class AuthUserMethodReturnsChildModel extends TestCase
 {
-    /** @test */
+    #[Test]
     public function auth_user_returns_child_model_if_it_exists()
     {
         Admin::create();

tests/Features/ChildModelFillablesMergeWithParentModelFillablesTest.php

@@ -5,10 +5,11 @@
 use Parental\Tests\Models\Event;
 use Parental\Tests\Models\Workshop;
 use Parental\Tests\TestCase;
+use PHPUnit\Framework\Attributes\Test;
 
 class ChildModelFillablesMergeWithParentModelFillablesTest extends TestCase
 {
-    /** @test */
+    #[Test]
     public function child_fillables_are_merged_with_parent_fillables()
     {
         $workshop = Workshop::create([

tests/Features/ChildModelsActLikeParentModelsTest.php

@@ -7,10 +7,11 @@
 use Parental\Tests\Models\Passenger;
 use Parental\Tests\Models\Vehicle;
 use Parental\Tests\TestCase;
+use PHPUnit\Framework\Attributes\Test;
 
 class ChildModelsActLikeParentModelsTest extends TestCase
 {
-    /** @test */
+    #[Test]
     public function vehicle_can_access_belongs_to_relationship_on_car_model()
     {
         $car = Car::create([
@@ -22,7 +23,7 @@ public function vehicle_can_access_belongs_to_relationship_on_car_model()
         $this->assertEquals($vehicle->driver->id, $car->driver->id);
     }
 
-    /** @test */
+    #[Test]
     public function vehicle_can_access_has_many_relationship_on_car_model()
     {
         $car = Car::create();
@@ -35,7 +36,7 @@ public function vehicle_can_access_has_many_relationship_on_car_model()
         $this->assertEquals($vehicle->passengers->pluck('id'), $car->passengers->pluck('id'));
     }
 
-    /** @test */
+    #[Test]
     public function vehicle_can_access_many_to_many_relationship_on_car_model()
     {
         $car = Car::create();
@@ -47,7 +48,7 @@ public function vehicle_can_access_many_to_many_relationship_on_car_model()
         $this->assertEquals($vehicle->fresh()->trips->pluck('id'), $car->fresh()->trips->pluck('id'));
     }
 
-    /** @test */
+    #[Test]
     public function guarded_or_fillable_models_have_raw_attributes_like_timestamps()
     {
         $vehicle = Vehicle::create()->fresh();

tests/Features/ChildModelsAreAutomaticallyScopedTest.php

@@ -13,10 +13,11 @@
 use Parental\Tests\Models\User;
 use Parental\Tests\Models\Vehicle;
 use Parental\Tests\TestCase;
+use PHPUnit\Framework\Attributes\Test;
 
 class ChildModelsAreAutomaticallyScopedTest extends TestCase
 {
-    /** @test */
+    #[Test]
     public function child_is_scoped_based_on_type_column()
     {
         Car::create();
@@ -26,7 +27,7 @@ public function child_is_scoped_based_on_type_column()
         $this->assertCount(1, Car::all());
     }
 
-    /** @test */
+    #[Test]
     public function child_without_type_column_isnt_scoped()
     {
         Admin::create();
@@ -36,7 +37,7 @@ public function child_without_type_column_isnt_scoped()
         $this->assertCount(2, Admin::all());
     }
 
-    /** @test */
+    #[Test]
     public function child_is_scoped_when_accessed_from_belongs_to()
     {
         $car = Car::create();
@@ -52,7 +53,7 @@ public function child_is_scoped_when_accessed_from_belongs_to()
         $this->assertNotNull($passenger->fresh()->vehicle);
     }
 
-    /** @test */
+    #[Test]
     public function child_is_scoped_when_accessed_from_has_many()
     {
         $driver = Driver::create(['name' => 'joe']);
@@ -63,7 +64,7 @@ public function child_is_scoped_when_accessed_from_has_many()
         $this->assertCount(1, $driver->cars);
     }
 
-    /** @test */
+    #[Test]
     public function child_is_scoped_when_accessed_from_belongs_to_many()
     {
         $car = Car::create();
@@ -75,7 +76,7 @@ public function child_is_scoped_when_accessed_from_belongs_to_many()
         $this->assertCount(2, $trip->vehicles);
     }
 
-    /** @test */
+    #[Test]
     public function child_is_scoped_when_accessed_from_has_one_through()
     {
         // Create root with children
@@ -96,7 +97,7 @@ public function child_is_scoped_when_accessed_from_has_one_through()
         $this->assertFalse(ChildNode::whereId($childC->id)->whereHas('parent')->exists());
     }
 
-    /** @test */
+    #[Test]
     public function child_is_scoped_when_accessed_from_has_many_through()
     {
         // Create root with children

tests/Features/EagerLoadingOnOlderLaravelTest.php

@@ -7,6 +7,8 @@
 use Parental\Tests\Models\Video;
 use Parental\Tests\Models\VideoMessage;
 use Parental\Tests\TestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Test;
 use RuntimeException;
 
 class EagerLoadingOnOlderLaravelTest extends TestCase
@@ -132,11 +134,8 @@ function () {
         ];
     }
 
-    /**
-     * @test
-     *
-     * @dataProvider eagerLoadingScenarios
-     */
+    #[Test]
+    #[DataProvider('eagerLoadingScenarios')]
     public function throws_exception_when_eager_loading_on_older_laravel_versions($scenario): void
     {
         $this->expectException(RuntimeException::class);

tests/Features/EagerLoadingTest.php

@@ -8,6 +8,7 @@
 use Parental\Tests\Models\Video;
 use Parental\Tests\Models\VideoMessage;
 use Parental\Tests\TestCase;
+use PHPUnit\Framework\Attributes\Test;
 
 class EagerLoadingTest extends TestCase
 {
@@ -20,7 +21,7 @@ protected function setUp(): void
         }
     }
 
-    /** @test */
+    #[Test]
     public function eager_load_children_on_collection(): void
     {
         $textMessage = TextMessage::create();
@@ -39,7 +40,7 @@ public function eager_load_children_on_collection(): void
         $this->assertTrue($messages->whereInstanceOf(VideoMessage::class)->every->relationLoaded('video'));
     }
 
-    /** @test */
+    #[Test]
     public function eager_load_children_count_on_collection(): void
     {
         $textMessage = TextMessage::create();
@@ -56,7 +57,7 @@ public function eager_load_children_count_on_collection(): void
         $this->assertEquals($messages->firstWhere(fn ($message) => $message instanceof TextMessage)->images_count, 1);
     }
 
-    /** @test */
+    #[Test]
     public function eager_load_children_on_paginator(): void
     {
         $textMessage = TextMessage::create();
@@ -77,7 +78,7 @@ public function eager_load_children_on_paginator(): void
         $this->assertEquals($messages->firstWhere(fn ($message) => $message instanceof TextMessage)->images_count, 1);
     }
 
-    /** @test */
+    #[Test]
     public function eager_load_from_model(): void
     {
         $textMessage = TextMessage::create();
@@ -93,7 +94,7 @@ public function eager_load_from_model(): void
         $this->assertTrue($message->relationLoaded('images'));
     }
 
-    /** @test */
+    #[Test]
     public function eager_load_counts_on_model(): void
     {
         $textMessage = TextMessage::create();
@@ -109,7 +110,7 @@ public function eager_load_counts_on_model(): void
         $this->assertEquals(1, $message->images_count);
     }
 
-    /** @test */
+    #[Test]
     public function eager_load_children_from_query(): void
     {
         $textMessage = TextMessage::create();
@@ -128,7 +129,7 @@ public function eager_load_children_from_query(): void
         $this->assertTrue($messages->whereInstanceOf(VideoMessage::class)->every->relationLoaded('video'));
     }
 
-    /** @test */
+    #[Test]
     public function eager_load_children_count_from_query(): void
     {
         $textMessage = TextMessage::create();
@@ -146,7 +147,7 @@ public function eager_load_children_count_from_query(): void
         $this->assertNull($messages->firstWhere(fn ($message) => $message instanceof VideoMessage)->images_count);
     }
 
-    /** @test */
+    #[Test]
     public function eager_load_children_from_relationship_query(): void
     {
         $room = Room::create(['name' => 'General']);
@@ -167,7 +168,7 @@ public function eager_load_children_from_relationship_query(): void
         $this->assertTrue($messages->whereInstanceOf(VideoMessage::class)->every->relationLoaded('video'));
     }
 
-    /** @test */
+    #[Test]
     public function eager_load_children_count_from_relationship_query(): void
     {
         $room = Room::create(['name' => 'General']);