Support Laravel 12 (#85)

u01jmg3 · shengslogar · web-flow · commit 1bfe5e29aacf · 2025-02-24T22:44:07.000-07:00
* Support Laravel 12

* Laravel 8.x and 9.x should support PHP 8.3 based on tagged constraints

* Update `orchestra/testbench` constraint

* Naively bump `phpunit` version

* Add new `&lt;source&gt;` tag for PHPUnit 11

* Attempt to remove `&lt;coverage&gt;` altogether

* Migrate primary configuration to PHPUnit 11

* Remove redundant defaults and unwanted config generated by `--generate-configuration`

* Use new coverage tag for PHPUnit 11

* Covering a specific method is deprecated; PHPUnit is (now?) smart enough to pick up on this without an annotation

* Drop PHPUnit `^9.5` to see what fails

* Deprecate Laravel 8 and 9

* Use `DataProvider` attribute

* Address deprecations and other modernizations

* Remove unused parameter

* Fix GH workflow

* Whoops

* Update upgrade guide

* Remove new line

---------

Co-authored-by: Sheng-Liang Slogar &lt;sheng@diglactic.com&gt;
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -13,32 +13,17 @@ jobs:
   phpunit:
     strategy:
       matrix:
-        php: [ 8.2, 8.1, 8.0, 7.4, 7.3 ]
-        laravel: [ 11.*, 10.*, 9.*, 8.* ]
+        php: [ 8.3, 8.2, 8.1 ]
+        laravel: [ 12.*, 11.*, 10.* ]
         os: [ ubuntu-latest, windows-latest ]
 
         # Unsupported combinations
         exclude:
-          - laravel: 11.*
+          - laravel: 12.*
             php: 8.1
+            
           - laravel: 11.*
-            php: 8.0
-          - laravel: 11.*
-            php: 7.4
-          - laravel: 11.*
-            php: 7.3
-
-          - laravel: 10.*
-            php: 8.0
-          - laravel: 10.*
-            php: 7.4
-          - laravel: 10.*
-            php: 7.3
-
-          - laravel: 9.*
-            php: 7.4
-          - laravel: 9.*
-            php: 7.3
+            php: 8.1
 
       # Continue running through matrix even if one combination fails
       fail-fast: false
diff --git a/README.md b/README.md
@@ -39,8 +39,9 @@ Compatibility Chart
 
 | Laravel | Laravel Breadcrumbs |
 |---------|---------------------|
-| 11.x    | 9.x                 |
-| 10.x    | 9.x                 |
+| 12.x    | 10.x                |
+| 11.x    | 10.x                |
+| 10.x    | 10.x                |
 | 9.x     | 9.x                 |
 | 8.x     | 9.x                 |
 | 7.x     | 8.x                 |
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,5 +1,10 @@
 # Upgrade Guide
 
+## Upgrading to 10.x from 9.x
+
+`10.x` drops support for Laravel v8 and v9 to support PHPUnit v11. If you're on Laravel v10+,
+re-run `composer require diglactic/laravel-breadcrumbs`.
+
 ## Upgrading to 9.x from 8.x
 
 `9.x` drops support for Laravel v6 and v7 to support PHPUnit v10. There are no other breaking changes. If you're on
diff --git a/composer.json b/composer.json
@@ -19,15 +19,14 @@
     ],
     "license": "MIT",
     "require": {
-        "php": "^7.3 || ^8.0",
+        "php": "^8.1",
         "facade/ignition-contracts": "^1.0",
-        "laravel/framework": "^8.0 || ^9.0 || ^10.0 || ^11.0"
+        "laravel/framework": "^10.0 || ^11.0 || ^12.0"
     },
     "require-dev": {
-        "orchestra/testbench": "^6.0 || ^7.0 || ^8.0 || ^9.0",
-        "phpunit/phpunit": "^9.5 || ^10.5",
-        "php-coveralls/php-coveralls": "^2.7",
-        "spatie/phpunit-snapshot-assertions": "^4.2 || ^5.1"
+        "orchestra/testbench": "^8.0 || ^9.0 || ^10.0",
+        "phpunit/phpunit": "^10.5 || ^11.5",
+        "spatie/phpunit-snapshot-assertions": "^5.1"
     },
     "minimum-stability": "dev",
     "prefer-stable": true,
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,33 +1,28 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
-    backupGlobals="false"
-    backupStaticAttributes="false"
+    xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
     beStrictAboutChangesToGlobalState="true"
+    beStrictAboutCoverageMetadata="true"
     beStrictAboutOutputDuringTests="true"
-    beStrictAboutTestsThatDoNotTestAnything="true"
     bootstrap="vendor/autoload.php"
-    cacheResult="true"
     colors="true"
-    convertErrorsToExceptions="true"
-    convertNoticesToExceptions="true"
-    convertWarningsToExceptions="true"
-    processIsolation="false"
-    stopOnFailure="false"
-    verbose="true"
+    displayDetailsOnPhpunitDeprecations="true"
+    failOnNotice="true"
+    failOnRisky="true"
+    failOnWarning="true"
 >
     <!-- List of files with tests inside -->
     <testsuites>
         <testsuite name="Package Test Suite">
-            <directory suffix="Test.php">tests/</directory>
+            <directory>tests</directory>
         </testsuite>
     </testsuites>
-    
+
     <!-- List of source files for code coverage checker -->
-    <coverage processUncoveredFiles="true">
+    <source>
         <include>
-            <directory suffix=".php">src/</directory>
+            <directory>src</directory>
         </include>
-    </coverage>
+    </source>
 </phpunit>
diff --git a/tests/BasicFunctionalityTest.php b/tests/BasicFunctionalityTest.php
@@ -9,8 +9,7 @@
 
 class BasicFunctionalityTest extends TestCase
 {
-    /** @var object */
-    private $post;
+    private object $post;
 
     protected function setUp(): void
     {
diff --git a/tests/CustomGeneratorTest.php b/tests/CustomGeneratorTest.php
@@ -4,16 +4,19 @@
 
 use Diglactic\Breadcrumbs\Breadcrumbs;
 use Diglactic\Breadcrumbs\Generator;
+use Illuminate\Config\Repository;
 use Illuminate\Support\Collection;
 
 class CustomGeneratorTest extends TestCase
 {
-    protected function resolveApplicationConfiguration($app): void
+    protected function defineEnvironment($app): void
     {
-        parent::resolveApplicationConfiguration($app);
+        parent::defineEnvironment($app);
 
         // Need to inject this early, before the package is loaded, to simulate it being set in the config file
-        $app['config']['breadcrumbs.generator-class'] = CustomGenerator::class;
+        tap($app['config'], function (Repository $config) {
+            $config->set('breadcrumbs.generator-class', CustomGenerator::class);
+        });
     }
 
     public function testCustomGenerator()
diff --git a/tests/DeferredLoadingTest.php b/tests/DeferredLoadingTest.php
@@ -4,13 +4,12 @@
 
 use Diglactic\Breadcrumbs\Breadcrumbs;
 use Illuminate\Contracts\Console\Kernel;
-use LogicException;
 
 class DeferredLoadingTest extends TestCase
 {
     protected function getEnvironmentSetUp($app): void
     {
-        parent::getEnvironmentSetUp($app);
+        parent::defineEnvironment($app);
 
         // If the service provider is loaded before the test starts, this file
         // will throw an exception.
@@ -26,7 +25,7 @@ protected function resolveApplicationConsoleKernel($app): void
 
     public function testDeferredLoading()
     {
-        $this->expectException(LogicException::class);
+        $this->expectException(\LogicException::class);
 
         // This triggers the service provider boot, which loads the breadcrumbs,
         // which throws an exception, which is caught by PHPUnit.
diff --git a/tests/FacadePhpDocTest.php b/tests/FacadePhpDocTest.php
@@ -30,7 +30,6 @@ public static function tags(): Generator
 
         preg_match_all($pattern, $code, $matches, PREG_SET_ORDER);
 
-        $tags = [];
         foreach ($matches as $match) {
             foreach (explode('|', $match[1]) as $class) {
                 // Return the whole line too so it can be seen in the error message
diff --git a/tests/Http/Controllers/PostController.php b/tests/Http/Controllers/PostController.php
@@ -4,10 +4,11 @@
 
 use Diglactic\Breadcrumbs\Breadcrumbs;
 use Diglactic\Breadcrumbs\Tests\Models\Post;
+use Illuminate\View\View;
 
 class PostController
 {
-    public function edit(Post $post)
+    public function edit(Post $post): View
     {
         return Breadcrumbs::render();
     }
diff --git a/tests/IgnitionTest.php b/tests/IgnitionTest.php
@@ -11,10 +11,11 @@
 use Facade\IgnitionContracts\ProvidesSolution;
 use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\Route;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 class IgnitionTest extends TestCase
 {
-    private function assertSolutionMatchesSnapshot(ProvidesSolution $exception)
+    private function assertSolutionMatchesSnapshot(ProvidesSolution $exception): void
     {
         $solution = $exception->getSolution();
 
@@ -33,7 +34,7 @@ public static function dataOneOrManyConfigFiles(): array
         ];
     }
 
-    /** @dataProvider dataOneOrManyConfigFiles */
+    #[DataProvider('dataOneOrManyConfigFiles')]
     public function testDuplicateBreadcrumbSolution(array $files)
     {
         Config::set('breadcrumbs.files', $files);
@@ -50,7 +51,7 @@ public function testDuplicateBreadcrumbSolution(array $files)
         }
     }
 
-    /** @dataProvider dataOneOrManyConfigFiles */
+    #[DataProvider('dataOneOrManyConfigFiles')]
     public function testInvalidBreadcrumbSolution(array $files)
     {
         Config::set('breadcrumbs.files', $files);
@@ -63,7 +64,7 @@ public function testInvalidBreadcrumbSolution(array $files)
         }
     }
 
-    /** @dataProvider dataOneOrManyConfigFiles */
+    #[DataProvider('dataOneOrManyConfigFiles')]
     public function testMissingRouteBoundBreadcrumbSolution(array $files)
     {
         Config::set('breadcrumbs.files', $files);
diff --git a/tests/Models/Post.php b/tests/Models/Post.php
@@ -13,13 +13,13 @@ public function __construct($id = null)
     }
 
     // Manual loading
-    public static function findOrFail($id)
+    public static function findOrFail($id): static
     {
         return new static($id);
     }
 
     // Route model binding
-    public function where($column, $value)
+    public function where($column, $value): object
     {
         return new class($value) {
             public function __construct($id)
@@ -28,13 +28,13 @@ public function __construct($id)
             }
 
             // Explicit route model binding
-            public function first()
+            public function first(): Post
             {
                 return new Post($this->id);
             }
 
             // Implicit route model binding
-            public function firstOrFail()
+            public function firstOrFail(): Post
             {
                 return new Post($this->id);
             }
diff --git a/tests/MultipleFileLoadingTest.php b/tests/MultipleFileLoadingTest.php
@@ -8,7 +8,7 @@ class MultipleFileLoadingTest extends TestCase
 {
     protected function getEnvironmentSetUp($app): void
     {
-        parent::getEnvironmentSetUp($app);
+        parent::defineEnvironment($app);
 
         $app->config->set('breadcrumbs.files', glob(__DIR__ . '/breadcrumbs/*.php'));
     }
diff --git a/tests/OutputTest.php b/tests/OutputTest.php
@@ -6,11 +6,9 @@
 
 class OutputTest extends TestCase
 {
-    /** @var object */
-    private $category;
+    private object $category;
 
-    /** @var string */
-    private $expectedHtml;
+    private string $expectedHtml;
 
     protected function setUp(): void
     {
diff --git a/tests/RecursionTest.php b/tests/RecursionTest.php
@@ -6,14 +6,11 @@
 
 class RecursionTest extends TestCase
 {
-    /** @var object */
-    private $category1;
+    private object $category1;
 
-    /** @var object */
-    private $category2;
+    private object $category2;
 
-    /** @var object */
-    private $category3;
+    private object $category3;
 
     protected function setUp(): void
     {
diff --git a/tests/SingleFileLoadingTest.php b/tests/SingleFileLoadingTest.php
@@ -8,7 +8,7 @@ class SingleFileLoadingTest extends TestCase
 {
     protected function getEnvironmentSetUp($app): void
     {
-        parent::getEnvironmentSetUp($app);
+        parent::defineEnvironment($app);
 
         $app->config->set('breadcrumbs.files', __DIR__ . '/routes/breadcrumbs.php');
     }
diff --git a/tests/SkipFileLoadingTest.php b/tests/SkipFileLoadingTest.php
@@ -6,12 +6,11 @@ class SkipFileLoadingTest extends TestCase
 {
     protected function getEnvironmentSetUp($app): void
     {
-        parent::getEnvironmentSetUp($app);
+        parent::defineEnvironment($app);
 
         $app->config->set('breadcrumbs.files', []);
     }
 
-    /** @covers \Diglactic\Breadcrumbs\ServiceProvider::registerBreadcrumbs */
     public function testLoading()
     {
         // I can't think of a way to actually test this since nothing is loaded -
diff --git a/tests/TemplatesTest.php b/tests/TemplatesTest.php
@@ -4,11 +4,11 @@
 
 use Diglactic\Breadcrumbs\Breadcrumbs;
 use Generator;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 class TemplatesTest extends TestCase
 {
-    /** @var object */
-    private $category;
+    private object $category;
 
     protected function setUp(): void
     {
@@ -45,7 +45,7 @@ public static function viewProvider(): Generator
         }
     }
 
-    /** @dataProvider viewProvider */
+    #[DataProvider('viewProvider')]
     public function testView($view)
     {
         $html = Breadcrumbs::view("breadcrumbs::{$view}", 'category', $this->category)->toHtml();
diff --git a/tests/TestCase.php b/tests/TestCase.php

Original file line number	Diff line number	Diff line change
`@@ -9,8 +9,7 @@`
`9`	`9`
`10`	`10`	`class BasicFunctionalityTest extends TestCase`
`11`	`11`	`{`
`12`		`- /** @var object */`
`13`		`- private $post;`
	`12`	`+ private object $post;`
`14`	`13`
`15`	`14`	`protected function setUp(): void`
`16`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -4,16 +4,19 @@`
`4`	`4`
`5`	`5`	`use Diglactic\Breadcrumbs\Breadcrumbs;`
`6`	`6`	`use Diglactic\Breadcrumbs\Generator;`
	`7`	`+use Illuminate\Config\Repository;`
`7`	`8`	`use Illuminate\Support\Collection;`
`8`	`9`
`9`	`10`	`class CustomGeneratorTest extends TestCase`
`10`	`11`	`{`
`11`		`- protected function resolveApplicationConfiguration($app): void`
	`12`	`+ protected function defineEnvironment($app): void`
`12`	`13`	`{`
`13`		`- parent::resolveApplicationConfiguration($app);`
	`14`	`+ parent::defineEnvironment($app);`
`14`	`15`
`15`	`16`	`// Need to inject this early, before the package is loaded, to simulate it being set in the config file`
`16`		`- $app['config']['breadcrumbs.generator-class'] = CustomGenerator::class;`
	`17`	`+ tap($app['config'], function (Repository $config) {`
	`18`	`+ $config->set('breadcrumbs.generator-class', CustomGenerator::class);`
	`19`	`+ });`
`17`	`20`	`}`
`18`	`21`
`19`	`22`	`public function testCustomGenerator()`
Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,12 @@`
`4`	`4`
`5`	`5`	`use Diglactic\Breadcrumbs\Breadcrumbs;`
`6`	`6`	`use Illuminate\Contracts\Console\Kernel;`
`7`		`-use LogicException;`
`8`	`7`
`9`	`8`	`class DeferredLoadingTest extends TestCase`
`10`	`9`	`{`
`11`	`10`	`protected function getEnvironmentSetUp($app): void`
`12`	`11`	`{`
`13`		`- parent::getEnvironmentSetUp($app);`
	`12`	`+ parent::defineEnvironment($app);`
`14`	`13`
`15`	`14`	`// If the service provider is loaded before the test starts, this file`
`16`	`15`	`// will throw an exception.`
`@@ -26,7 +25,7 @@ protected function resolveApplicationConsoleKernel($app): void`
`26`	`25`
`27`	`26`	`public function testDeferredLoading()`
`28`	`27`	`{`
`29`		`- $this->expectException(LogicException::class);`
	`28`	`+ $this->expectException(\LogicException::class);`
`30`	`29`
`31`	`30`	`// This triggers the service provider boot, which loads the breadcrumbs,`
`32`	`31`	`// which throws an exception, which is caught by PHPUnit.`
Original file line number	Diff line number	Diff line change
`@@ -4,10 +4,11 @@`
`4`	`4`
`5`	`5`	`use Diglactic\Breadcrumbs\Breadcrumbs;`
`6`	`6`	`use Diglactic\Breadcrumbs\Tests\Models\Post;`
	`7`	`+use Illuminate\View\View;`
`7`	`8`
`8`	`9`	`class PostController`
`9`	`10`	`{`
`10`		`- public function edit(Post $post)`
	`11`	`+ public function edit(Post $post): View`
`11`	`12`	`{`
`12`	`13`	`return Breadcrumbs::render();`
`13`	`14`	`}`