Use Localizer package to detect and set locales

Author: ivanvermeyen

composer.json

@@ -22,9 +22,11 @@
     "require": {
         "php": "^7.1",
         "0.0.0/composer-include-files": "^1.5",
+        "codezero/laravel-localizer": "^1.1",
         "illuminate/support": ">=5.6"
     },
     "require-dev": {
+        "mockery/mockery": "^1.3",
         "orchestra/testbench": ">=3.6",
         "phpunit/phpunit": "^7.0|^8.0"
     },

src/Macros/LocalizedRoutesMacro.php

@@ -2,7 +2,7 @@
 
 namespace CodeZero\LocalizedRoutes\Macros;
 
-use CodeZero\LocalizedRoutes\Middleware\LocalizedRouteLocaleHandler;
+use CodeZero\LocalizedRoutes\Middleware\SetLocale;
 use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\Route;
@@ -63,7 +63,7 @@ public static function register()
                 }
 
                 if ($setMiddleware) {
-                    $attributes['middleware'] = [LocalizedRouteLocaleHandler::class];
+                    $attributes['middleware'] = [SetLocale::class];
                 }
 
                 // Execute the callback inside route group

src/Middleware/LocalizedRouteLocaleHandler.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace CodeZero\LocalizedRoutes\Middleware;
+
+use Closure;
+use CodeZero\Localizer\Localizer;
+use Illuminate\Support\Facades\Config;
+
+class SetLocale
+{
+    /**
+     * Localizer.
+     *
+     * @var \CodeZero\Localizer\Localizer
+     */
+    protected $localizer;
+
+    /**
+     * Create a new SetLocale instance.
+     *
+     * @param \CodeZero\Localizer\Localizer $localizer
+     */
+    public function __construct(Localizer $localizer)
+    {
+        $this->localizer = $localizer;
+    }
+
+    /**
+     * Handle an incoming request.
+     *
+     * @param \Illuminate\Http\Request $request
+     * @param \Closure $next
+     *
+     * @return mixed
+     */
+    public function handle($request, Closure $next)
+    {
+        // This package sets a custom route attribute for the locale.
+        // If it is present, set it as the locale with 'codezero/laravel-localizer'.
+        // If not, auto-detect the locale with 'codezero/laravel-localizer'
+        $locale = $request->route()->getAction('localized-routes-locale') ?: $this->detectLocales();
+
+        if ($locale) {
+            $this->localizer->store($locale);
+        }
+
+        return $next($request);
+    }
+
+    /**
+     * Detect locales.
+     *
+     * @return string|false
+     */
+    public function detectLocales()
+    {
+        $supportedLocales = Config::get('localized-routes.supported-locales', []);
+
+        $this->localizer->setSupportedLocales($supportedLocales);
+
+        return $this->localizer->detect();
+    }
+}

src/Middleware/SetLocale.php

@@ -52,7 +52,7 @@ class Kernel extends HttpKernel
         \App\Http\Middleware\Authenticate::class,
         \Illuminate\Routing\Middleware\ThrottleRequests::class,
         \Illuminate\Session\Middleware\AuthenticateSession::class,
-        \CodeZero\LocalizedRoutes\Middleware\LocalizedRouteLocaleHandler::class, // <== Added Middleware Here
+        \CodeZero\LocalizedRoutes\Middleware\SetLocale::class, // <== Added Middleware Here
         \Illuminate\Routing\Middleware\SubstituteBindings::class,
         \Illuminate\Auth\Middleware\Authorize::class,
     ];

tests/Stubs/Kernel.php

@@ -3,6 +3,7 @@
 namespace CodeZero\LocalizedRoutes\Tests;
 
 use CodeZero\LocalizedRoutes\LocalizedRoutesServiceProvider;
+use CodeZero\Localizer\LocalizerServiceProvider;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\Route;
@@ -87,6 +88,7 @@ protected function resolveApplicationHttpKernel($app)
     protected function getPackageProviders($app)
     {
         return [
+            LocalizerServiceProvider::class,
             LocalizedRoutesServiceProvider::class,
         ];
     }

tests/TestCase.php

@@ -2,13 +2,15 @@
 
 namespace CodeZero\LocalizedRoutes\Tests\Unit\Macros;
 
-use CodeZero\LocalizedRoutes\Middleware\LocalizedRouteLocaleHandler;
+use CodeZero\LocalizedRoutes\Middleware\SetLocale;
 use CodeZero\LocalizedRoutes\Tests\Stubs\Model;
 use CodeZero\LocalizedRoutes\Tests\TestCase;
+use CodeZero\Localizer\Localizer;
 use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Route;
+use Mockery;
 
-class LocalizedRouteLocaleHandlerTest extends TestCase
+class SetLocaleTest extends TestCase
 {
     /** @test */
     public function it_sets_the_right_locale_when_accessing_localized_routes()
@@ -65,7 +67,7 @@ public function it_sets_the_locale_for_localized_routes_within_route_groups()
             Route::localized(function () {
                 Route::get('route', function () {
                     return App::getLocale();
-                })->name('route.name')->middleware(['web', LocalizedRouteLocaleHandler::class]);
+                })->name('route.name')->middleware(['web', SetLocale::class]);
             });
         });
 
@@ -86,12 +88,52 @@ public function it_allows_for_localized_route_model_binding()
         Route::localized(function () {
             Route::get('route/{model}', function (Model $model) {
                 return App::getLocale();
-            })->name('route.name')->middleware(['web', LocalizedRouteLocaleHandler::class]);
+            })->name('route.name')->middleware(['web', SetLocale::class]);
         });
 
         $this->call('GET', '/en/route/en-slug')->assertOk();
         $this->call('GET', '/nl/route/nl-slug')->assertOk();
         $this->call('GET', '/en/route/nl-slug')->assertNotFound();
         $this->call('GET', '/nl/route/en-slug')->assertNotFound();
     }
+
+    /** @test */
+    public function it_does_not_auto_detect_the_preferred_locale_with_localizer_for_localized_routes()
+    {
+        $this->setSupportedLocales(['en', 'nl']);
+
+        $localizer = Mockery::mock(Localizer::class);
+        $localizer->shouldReceive('setSupportedLocales')->with(['en', 'nl']);
+        $localizer->shouldNotReceive('detect');
+        $localizer->shouldReceive('store')->with('en');
+
+        App::instance(Localizer::class, $localizer);
+
+        Route::localized(function () {
+            Route::get('localized-route', function () {})
+                ->name('localized.route')
+                ->middleware(['web', SetLocale::class]);
+        });
+
+        $this->call('GET', '/en/localized-route')->assertOk();
+    }
+
+    /** @test */
+    public function it_auto_detects_the_preferred_locale_with_localizer_for_non_localized_routes()
+    {
+        $this->setSupportedLocales(['en', 'nl']);
+
+        $localizer = Mockery::mock(Localizer::class);
+        $localizer->shouldReceive('setSupportedLocales')->with(['en', 'nl']);
+        $localizer->shouldReceive('detect')->andReturn('en');
+        $localizer->shouldReceive('store')->with('en');
+
+        App::instance(Localizer::class, $localizer);
+
+        Route::get('non-localized-route', function () {})
+            ->name('non-localized.route')
+            ->middleware(['web', SetLocale::class]);
+
+        $this->call('GET', '/non-localized-route')->assertOk();
+    }
 }