Make Localizer optional

Author: ivanvermeyen

config/localized-routes.php

@@ -21,4 +21,29 @@
      */
     'use_locale_middleware' => false,
 
+    /**
+     * If true, this package will use 'codezero/laravel-localizer'
+     * to detect and set the preferred supported locale.
+     *
+     * For non-localized routes, it will look for a locale in the URL,
+     * in the session, in a cookie, in the browser or in the app config.
+     * This can be very useful if you have a generic home page.
+     *
+     * If a locale is detected, it will be stored in the session,
+     * in a cookie and as the app locale.
+     *
+     * If you disable this option, only localized routes will have a locale
+     * and only the app locale will be set (so not in the session or cookie).
+     *
+     * You can publish its config file and tweak it for your needs.
+     * This package will only override its 'supported-locales' option
+     * with the 'supported-locales' option in this file.
+     *
+     * For more info, visit:
+     * https://github.com/codezero-be/laravel-localizer
+     *
+     * This option has no effect if 'use_locale_middleware' is false.
+     */
+    'use_localizer' => true,
+
 ];

src/Middleware/SetLocale.php

@@ -4,6 +4,7 @@
 
 use Closure;
 use CodeZero\Localizer\Localizer;
+use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Config;
 
 class SetLocale
@@ -36,14 +37,21 @@ public function __construct(Localizer $localizer)
     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 it is present, use this as the locale.
+        $locale = $request->route()->getAction('localized-routes-locale');
 
-        if ($locale) {
+        if ( ! $locale && $this->shouldUseLocalizer()) {
+            $locale = $this->detectLocales();
+        }
+
+        if ($locale && $this->shouldUseLocalizer()) {
             $this->localizer->store($locale);
         }
 
+        if ($locale && ! $this->shouldUseLocalizer()) {
+            App::setLocale($locale);
+        }
+
         return $next($request);
     }
 
@@ -60,4 +68,14 @@ public function detectLocales()
 
         return $this->localizer->detect();
     }
+
+    /**
+     * Check if the 'use_localizer' option is enabled.
+     *
+     * @return bool
+     */
+    protected function shouldUseLocalizer()
+    {
+        return Config::get('localized-routes.use_localizer', false);
+    }
 }

tests/TestCase.php

@@ -47,6 +47,18 @@ protected function setUseLocaleMiddleware($value)
         Config::set('localized-routes.use_locale_middleware', $value);
     }
 
+    /**
+     * Set the use_localizer config option
+     *
+     * @param boolean $value
+     *
+     * @return void
+     */
+    protected function setUseLocalizer($value)
+    {
+        Config::set('localized-routes.use_localizer', $value);
+    }
+
     /**
      * Get the currently registered routes.
      *

tests/Unit/Middleware/SetLocaleTest.php

@@ -101,6 +101,7 @@ public function it_allows_for_localized_route_model_binding()
     public function it_does_not_detect_the_preferred_locale_with_localizer_for_localized_routes()
     {
         $this->setSupportedLocales(['en', 'nl']);
+        $this->setUseLocalizer(true);
 
         $localizer = Mockery::mock(Localizer::class);
         $localizer->shouldReceive('setSupportedLocales')->with(['en', 'nl']);
@@ -122,6 +123,7 @@ public function it_does_not_detect_the_preferred_locale_with_localizer_for_local
     public function it_detects_the_preferred_locale_with_localizer_for_non_localized_routes()
     {
         $this->setSupportedLocales(['en', 'nl']);
+        $this->setUseLocalizer(true);
 
         $localizer = Mockery::mock(Localizer::class);
         $localizer->shouldReceive('setSupportedLocales')->with(['en', 'nl']);
@@ -136,4 +138,67 @@ public function it_detects_the_preferred_locale_with_localizer_for_non_localized
 
         $this->call('GET', '/non-localized-route')->assertOk();
     }
+
+    /** @test */
+    public function it_does_not_use_localizer_when_disabled()
+    {
+        $this->setSupportedLocales(['en', 'nl']);
+        $this->setUseLocalizer(false);
+
+        $localizer = Mockery::mock(Localizer::class);
+        $localizer->shouldNotReceive('setSupportedLocales');
+        $localizer->shouldNotReceive('detect');
+        $localizer->shouldNotReceive('store');
+
+        App::instance(Localizer::class, $localizer);
+
+        Route::localized(function () {
+            Route::get('localized-route', function () {})
+                ->name('localized.route')
+                ->middleware(['web', SetLocale::class]);
+        });
+
+        Route::get('/non-localized-route', function () {})
+            ->name('non-localized.route')
+            ->middleware(['web', SetLocale::class]);
+
+        $this->call('GET', '/non-localized-route')->assertOk();
+        $this->call('GET', '/en/localized-route')->assertOk();
+    }
+
+    /** @test */
+    public function it_still_sets_the_app_locale_for_localized_routes_if_localizer_is_disabled()
+    {
+        $this->setSupportedLocales(['en']);
+        $this->setUseLocalizer(false);
+
+        App::setLocale('fr');
+
+        Route::localized(function () {
+            Route::get('localized-route', function () {
+                return App::getLocale();
+            })->name('localized.route')->middleware(['web', SetLocale::class]);
+        });
+
+        $response = $this->call('GET', '/en/localized-route');
+
+        $this->assertEquals('en', $response->original);
+    }
+
+    /** @test */
+    public function it_does_not_set_the_app_locale_for_non_localized_routes_if_localizer_is_disabled()
+    {
+        $this->setSupportedLocales(['en', 'nl']);
+        $this->setUseLocalizer(false);
+
+        App::setLocale('fr');
+
+        Route::get('/non-localized-route', function () {
+            return App::getLocale();
+        })->name('non-localized.route')->middleware(['web', SetLocale::class]);
+
+        $response = $this->call('GET', '/non-localized-route');
+
+        $this->assertEquals('fr', $response->original);
+    }
 }