Add RouteActionDetector (#11)

Author: ivanvermeyen

README.md

@@ -87,18 +87,22 @@ Add any locales you wish to support to your published `config/localizer.php` fil
 
 By default, the middleware will use the following detectors to check for a supported locale in:
 
-1. The URL slug
-2. A main omitted locale
-3. The authenticated user model
-4. The session
-5. A cookie
-6. The browser
-7. The app's default locale
+1. A custom route action
+2. The URL slug
+3. A main omitted locale
+4. The authenticated user model
+5. The session
+6. A cookie
+7. The browser
+8. The app's default locale
+
+You can set a custom attribute or "action" on a route group.
+This is especially useful in combination with the [codezero/laravel-localized-routes](https://github.com/codezero-be/laravel-localized-routes) package.
 
 If you set an omitted locale, no additional detectors will run after the `OmittedLocaleDetector`.
 This makes sense, because the locale will always be determined by the URL in this scenario.
 
-You can configure the session key, cookie name and the attribute on the user model that holds the locale.
+You can configure the route action, session key, cookie name and the attribute on the user model that holds the locale.
 By default this is all set to `locale`. If the user model does not have this attribute, it will skip this check.
 
 You can also choose which detectors to run and in what order.

config/localizer.php

@@ -20,6 +20,7 @@
      * These will be executed in the order that they are added to the array!
      */
     'detectors' => [
+        CodeZero\Localizer\Detectors\RouteActionDetector::class,
         CodeZero\Localizer\Detectors\UrlDetector::class,
         CodeZero\Localizer\Detectors\OmittedLocaleDetector::class,
         CodeZero\Localizer\Detectors\UserDetector::class,
@@ -44,6 +45,12 @@
      */
     'url-segment' => 1,
 
+    /**
+     * The attribute or "action" on the route that holds the locale,
+     * when using the RouteActionDetector.
+     */
+    'route-action' => 'locale',
+
     /**
      * The attribute on the user model that holds the locale,
      * when using the UserDetector.

src/Detectors/RouteActionDetector.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace CodeZero\Localizer\Detectors;
+
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Config;
+
+class RouteActionDetector implements Detector
+{
+    /**
+     * The current request.
+     *
+     * @var \Illuminate\Http\Request
+     */
+    protected $request;
+
+    /**
+     * Create a new Detector instance.
+     *
+     * @param \Illuminate\Http\Request $request
+     */
+    public function __construct(Request $request)
+    {
+        $this->request = $request;
+    }
+
+    /**
+     * Detect the locale.
+     *
+     * @return string|array|null
+     */
+    public function detect()
+    {
+        $action = Config::get('localizer.route-action');
+
+        return $this->request->route()->getAction($action);
+    }
+}

tests/Feature/SetLocaleTest.php

@@ -32,7 +32,31 @@ protected function setUp(): void
     }
 
     /** @test */
-    public function it_looks_for_a_locale_in_the_url_first()
+    public function it_looks_for_a_locale_in_a_custom_route_action()
+    {
+        $this->setSupportedLocales(['en', 'nl', 'fr', 'de', 'es', 'it']);
+        $this->setSessionLocale('fr');
+        $this->setBrowserLocales('it');
+        $this->setAppLocale('en');
+        $cookie = 'de';
+
+        Route::group([
+            'locale' => 'nl',
+        ], function () {
+            Route::get('some/route', function () {
+                return App::getLocale();
+            })->middleware(['web', SetLocale::class]);
+        });
+
+        $response = $this->getWithCookie('some/route', $cookie);
+
+        $response->assertSessionHas($this->sessionKey, 'nl');
+        $response->assertCookie($this->cookieName, 'nl');
+        $this->assertEquals('nl', $response->original);
+    }
+
+    /** @test */
+    public function it_looks_for_a_locale_in_the_url()
     {
         $this->setSupportedLocales(['en', 'nl', 'fr', 'de', 'es', 'it']);
         $this->setSessionLocale('fr');