Add support Laravel 11 and PHPUnit 10 (#20)

* Bump PHPUnit dependencies
* Ignore PHPUnit cache folder
* Adopt PHP attributes in test classes
* Add return types to test methods
* Define test classes as `final`
* Only support Laravel 10 and 11
* Migrate PHPUnit XML
* Don't use Kernel to test middleware
* Update UPGRADE.md
* Add Laravel 11 middleware instructions to README

---------

Co-authored-by: Shift <[email protected]>

Author: ivanvermeyen

.github/workflows/run-tests.yml

@@ -8,28 +8,17 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [ 8.0, 8.1 ]
-        laravel: [ 8.*, 9.*, 10.* ]
+        php: [ 8.1, 8.2, 8.3 ]
+        laravel: [ 10.*, 11.* ]
         dependency-version: [ prefer-stable ]
         exclude:
-          - laravel: 10.*
-            php: 8.0
+          - laravel: 11.*
+            php: 8.1
         include:
-          - laravel: 7.*
-            php: 7.2
-            testbench: 5.*
-          - laravel: 7.*
-            php: 8.0
-            testbench: 5.*
-          - laravel: 8.*
-            php: 7.3
-            testbench: 6.*
-          - laravel: 8.*
-            testbench: 6.*
-          - laravel: 9.*
-            testbench: 7.*
           - laravel: 10.*
             testbench: 8.*
+          - laravel: 11.*
+            testbench: 9.*
 
     name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.dependency-version }}
 

.gitignore

@@ -1,4 +1,5 @@
 /vendor
 /phpunit.xml
 composer.lock
+/.phpunit.cache
 /.phpunit.result.cache

README.md

@@ -1,7 +1,7 @@
 # Laravel Localizer
 
 [![GitHub release](https://img.shields.io/github/release/codezero-be/laravel-localizer.svg?style=flat-square)](https://github.com/codezero-be/laravel-localizer/releases)
-[![Laravel](https://img.shields.io/badge/laravel-10-red?style=flat-square&logo=laravel&logoColor=white)](https://laravel.com)
+[![Laravel](https://img.shields.io/badge/laravel-11-red?style=flat-square&logo=laravel&logoColor=white)](https://laravel.com)
 [![License](https://img.shields.io/packagist/l/codezero/laravel-localizer.svg?style=flat-square)](LICENSE.md)
 [![Build Status](https://img.shields.io/github/actions/workflow/status/codezero-be/laravel-localizer/run-tests.yml?style=flat-square&logo=github&logoColor=white&label=tests)](https://github.com/codezero-be/laravel-localizer/actions)
 [![Code Coverage](https://img.shields.io/codacy/coverage/ad6fcea152b449d380a187a375d0f7d7/master?style=flat-square)](https://app.codacy.com/gh/codezero-be/laravel-localizer)
@@ -19,8 +19,8 @@ Automatically detect and set an app locale that matches your visitor's preferenc
 
 ## ✅ Requirements
 
-- PHP >= 7.2.5
-- Laravel >= 7.0
+- PHP >= 8.1
+- Laravel >= 10.0
 
 ## ⬆ Upgrade
 
@@ -39,13 +39,36 @@ Laravel will automatically register the ServiceProvider.
 
 ## 🧩 Add Middleware
 
-Add the middleware to the `web` middleware group in `app/Http/Kernel.php`.
+By default, the app locale will always be what you configured in `config/app.php`.
+To automatically update the app locale, you need to register the middleware in the `web` middleware group.
 Make sure to add it after `StartSession` and before `SubstituteBindings`.
 
 The order of the middleware is important if you are using localized route keys (translated slugs)!
 The session needs to be active when setting the locale, and the locale needs to be set when substituting the route bindings.
 
+### Laravel 11 and newer:
+
+Add the middleware to the `web` middleware group in `bootstrap/app.php`.
+
+```php
+// bootstrap/app.php
+->withMiddleware(function (Middleware $middleware) {
+    $middleware->web(remove: [
+        \Illuminate\Routing\Middleware\SubstituteBindings::class,
+    ]);
+    $middleware->web(append: [
+        \CodeZero\Localizer\Middleware\SetLocale::class,
+        \Illuminate\Routing\Middleware\SubstituteBindings::class,
+    ]);
+})
+```
+
+### Laravel 10:
+
+Add the middleware to the `web` middleware group in `app/Http/Kernel.php`.
+
 ```php
+// app/Http/Kernel.php
 protected $middlewareGroups = [
     'web' => [
         //...

UPGRADE.md

@@ -1,5 +1,25 @@
 # Upgrade Guide
 
+## Upgrading To 3.0 From 2.x
+
+### ➡ Minimum Requirements Updated
+
+Due to PHP and PHPUnit version constraints with Laravel 11, we dropped support for Laravel 7.x, 8.x and 9.x.
+
+- The minimum PHP version required is now 8.1
+- The minimum Laravel version required is now 10.0
+
+---
+
+### ➡ Re-register Middleware
+
+Laravel 11 no longer has a `app/Http/Kernel.php` to register middleware.
+This is now handled in `bootstrap/app.php`.
+
+🔸 **Actions Required**
+
+If you use Laravel 11, register the middleware in `bootstrap/app.php` as described in the README.
+
 ## Upgrading To 2.0 From 1.x
 
 ### ➡ Minimum Requirements Updated

composer.json

@@ -21,14 +21,14 @@
         }
     ],
     "require": {
-        "php": "^7.2.5|^8.0",
+        "php": "^8.1",
         "codezero/browser-locale": "^3.0",
-        "illuminate/support": "^7.0|^8.0|^9.0|^10.0"
+        "illuminate/support": "^10.0|^11.0"
     },
     "require-dev": {
         "mockery/mockery": "^1.3.3",
-        "orchestra/testbench": "^5.0|^6.0|^7.0|^8.0",
-        "phpunit/phpunit": "^8.0|^9.0"
+        "orchestra/testbench": "^8.0|^9.0",
+        "phpunit/phpunit": "^10.5"
     },
     "scripts": {
         "test": "phpunit"
@@ -53,10 +53,7 @@
     "config": {
         "preferred-install": "dist",
         "sort-packages": true,
-        "optimize-autoloader": true,
-        "allow-plugins": {
-            "kylekatarnls/update-helper": true
-        }
+        "optimize-autoloader": true
     },
     "minimum-stability": "dev",
     "prefer-stable": true

phpunit.xml.dist

@@ -1,13 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit backupGlobals="false"
-         backupStaticAttributes="false"
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         backupGlobals="false"
          bootstrap="vendor/autoload.php"
          colors="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
          processIsolation="false"
-         stopOnFailure="false">
+         stopOnFailure="false"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
+         cacheDirectory=".phpunit.cache"
+         backupStaticProperties="false">
     <testsuites>
         <testsuite name="Unit">
             <directory suffix="Test.php">./tests/Unit</directory>
@@ -16,15 +16,15 @@
             <directory suffix="Test.php">./tests/Feature</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">./src</directory>
-        </whitelist>
-    </filter>
     <php>
         <env name="APP_ENV" value="testing"/>
         <env name="CACHE_DRIVER" value="array"/>
         <env name="SESSION_DRIVER" value="array"/>
         <env name="QUEUE_DRIVER" value="sync"/>
     </php>
+    <source>
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </source>
 </phpunit>