Support redirects to localized routes (#35) (#18)

Author: ivanvermeyen

README.md

@@ -254,7 +254,23 @@ If you set `omit_url_prefix_for_locale` to `'en'` in the configuration file, the
 You can't have a localized `/about` route and also register a non-localized `/about` route in this case.
 The same idea applies to the `/` (root) route! Also note that the route names still have the locale prefix.
 
-### 🔦 Localized `404` Pages
+### 🔦 Localized `404` Pages and Redirecting to Localized URL's
+
+To use these 2 features, you need to register the fallback route **at the end** of your `routes/web.php` file:
+
+```php
+Route::fallback(\CodeZero\LocalizedRoutes\Controller\FallbackController::class)
+    ->middleware(\CodeZero\LocalizedRoutes\Middleware\SetLocale::class);
+```
+
+##### 404 - Not Found
+
+After registering the fallback route the provided controller will look for a 404 error view at `resources/views/errors/404.blade.php`.
+If this view does not exist, a normal `NotFoundHttpException` will be thrown.
+You can configure which view to use by changing the `404_view` entry in the config file.
+
+<details>
+<summary>**Some background info...**</summary>
 
 By default, Laravel's `404` pages don't go trough the middleware and have no `Route::current()` associated with it.
 Not even when you create your custom `errors.404` view.
@@ -264,12 +280,6 @@ To enable localized `404` pages, you need to register a `fallback` route
 and make sure it has the `SetLocale` middleware.
 This is basically a catch all route that will trigger for all non existing URL's.
 
-```php
-Route::fallback(function () {
-    return response()->view('errors.404', [], 404);
-})->middleware(\CodeZero\LocalizedRoutes\Middleware\SetLocale::class);
-```
-
 Another thing to keep in mind is that a `fallback` route returns a `200` status by default.
 So to make it a real `404` you need to return a `404` response yourself.
 
@@ -283,6 +293,23 @@ Because those routes are in fact registered, the `404` page will have the correc
 
 [Here is a good read about fallback routes](https://themsaid.com/laravel-55-better-404-response-20170921).
 
+</details>
+
+##### Redirecting to Localized URL's
+
+After registering the fallback route, you can update the config option `redirect_to_localized_urls` to `true`.
+The provided `FallbackController` will then try to redirect routes that have not been registered, to their localized version.
+If it does not have a localized version, a `404` will be thrown.
+
+> So the home page `/` would be redirected to `/en` if the active locale is `en` and the `/en` route exists.
+And `/about` would redirect to `/en/about`.
+
+If you configured the app to omit the main locale slug, then the former redirection will obviously not happen, because the unprefixed routes exist.
+Instead, accessing a prefixed route with the main locale will redirect to an unprefixed URL.
+
+> So if the main locale is `en`, visiting `/en` would redirect to the home page `/` (unless `/` is a registered route).
+Also `/en/about` would redirect to `/about`.
+
 ### 🚕 Generate Route URL's
 
 You can get the URL of your named routes as usual, using the `route()` helper.

config/localized-routes.php

@@ -15,6 +15,28 @@
      */
     'omit_url_prefix_for_locale' => null,
 
+    /**
+     * Set this option to true if you want to redirect
+     * unlocalized URL's to their localized version.
+     * You need to register the fallback route for this to work.
+     */
+    'redirect_to_localized_urls' => false,
+
+    /**
+     * The status code when redirecting to localized URL's.
+     * 301 - permanently
+     * 302 - temporary
+     */
+    'redirect_status_code' => 301,
+
+    /**
+     * Set your custom 404 view.
+     * This view is localized.
+     * If the view does not exist, a normal 404 will be thrown.
+     * You need to register the fallback route for this to work.
+     */
+    '404_view' => 'errors.404',
+
     /**
      * If you want to automatically set the locale
      * for localized routes set this to true.

src/Controller/FallbackController.php

@@ -0,0 +1,66 @@
+<?php
+
+namespace CodeZero\LocalizedRoutes\Controller;
+
+use Illuminate\Http\Request;
+use Illuminate\Routing\Controller;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Config;
+use Illuminate\Support\Facades\Redirect;
+use Illuminate\Support\Facades\Response;
+use Illuminate\Support\Facades\Route;
+use Illuminate\Support\Facades\View;
+
+class FallbackController extends Controller
+{
+    /**
+     * Handle the fallback route.
+     *
+     * @return \Illuminate\Http\RedirectResponse|\Illuminate\Http\Response
+     */
+    public function __invoke()
+    {
+        $shouldRedirect = Config::get('localized-routes.redirect_to_localized_urls', false);
+
+        if ($shouldRedirect) {
+            $localizedUrl = Route::localizedUrl();
+            $route = $this->findRouteByUrl($localizedUrl);
+
+            if ( ! $route->isFallback) {
+                return Redirect::to($localizedUrl, Config::get('localized-routes.redirect_status_code', 301));
+            }
+        }
+
+        return $this->NotFoundResponse();
+    }
+
+    /**
+     * Find a Route by its URL.
+     *
+     * @param string $url
+     *
+     * @return \Illuminate\Routing\Route
+     */
+    protected function findRouteByUrl($url)
+    {
+        return Collection::make(Route::getRoutes())->first(function ($route) use ($url) {
+            return $route->matches(Request::create($url));
+        });
+    }
+
+    /**
+     * Return a 404 view or throw a 404 error if the view doesn't exist.
+     *
+     * @return \Illuminate\Http\Response
+     */
+    protected function NotFoundResponse()
+    {
+        $view = Config::get('localized-routes.404_view');
+
+        if (View::exists($view)) {
+            return Response::view($view, [], 404);
+        }
+
+        abort(404);
+    }
+}

tests/TestCase.php

@@ -79,6 +79,18 @@ protected function setOmitUrlPrefixForLocale($value)
         Config::set('localized-routes.omit_url_prefix_for_locale', $value);
     }
 
+    /**
+     * Set the 'redirect_to_localized_urls' config option.
+     *
+     * @param bool $value
+     *
+     * @return void
+     */
+    protected function setRedirectToLocalizedUrls($value)
+    {
+        Config::set('localized-routes.redirect_to_localized_urls', $value);
+    }
+
     /**
      * Set the use_locale_middleware config option
      *

tests/Unit/RedirectToLocalizedTest.php

@@ -0,0 +1,77 @@
+<?php
+
+namespace CodeZero\LocalizedRoutes\Tests\Unit;
+
+use CodeZero\LocalizedRoutes\Tests\TestCase;
+use Illuminate\Support\Facades\Route;
+
+class RedirectToLocalizedTest extends TestCase
+{
+    /** @test */
+    public function it_redirects_to_the_localized_url()
+    {
+        $this->withoutExceptionHandling();
+        $this->setSupportedLocales(['en', 'nl']);
+        $this->setUseLocaleMiddleware(false);
+        $this->setRedirectToLocalizedUrls(true);
+
+        Route::localized(function () {
+            Route::get('/', function () {});
+            Route::get('about', function () {});
+        });
+
+        Route::fallback(\CodeZero\LocalizedRoutes\Controller\FallbackController::class);
+
+        $this->setAppLocale('en');
+        $this->get('/')->assertRedirect('en');
+        $this->get('en')->assertOk();
+        $this->get('about')->assertRedirect('en/about');
+        $this->get('en/about')->assertOk();
+
+        $this->setAppLocale('nl');
+        $this->get('/')->assertRedirect('nl');
+        $this->get('nl')->assertOk();
+        $this->get('about')->assertRedirect('nl/about');
+        $this->get('nl/about')->assertOk();
+    }
+
+    /** @test */
+    public function it_redirects_when_default_locale_slug_is_omitted()
+    {
+        $this->withoutExceptionHandling();
+        $this->setSupportedLocales(['en', 'nl']);
+        $this->setUseLocaleMiddleware(false);
+        $this->setOmitUrlPrefixForLocale('en');
+        $this->setRedirectToLocalizedUrls(true);
+
+        Route::localized(function () {
+            Route::get('/', function () {});
+            Route::get('about', function () {});
+        });
+
+        Route::fallback(\CodeZero\LocalizedRoutes\Controller\FallbackController::class);
+
+        $this->setAppLocale('en');
+        $this->get('en')->assertRedirect('/');
+        $this->get('/')->assertOk();
+        $this->get('en/about')->assertRedirect('about');
+        $this->get('about')->assertOk();
+
+        $this->setAppLocale('nl');
+        $this->get('nl')->assertOk();
+        $this->get('nl/about')->assertOk();
+    }
+
+    /** @test */
+    public function it_throws_404_and_does_not_redirect_if_no_localized_route_is_registered()
+    {
+        $this->setSupportedLocales(['en', 'nl']);
+        $this->setUseLocaleMiddleware(false);
+        $this->setRedirectToLocalizedUrls(true);
+
+        Route::fallback(\CodeZero\LocalizedRoutes\Controller\FallbackController::class);
+
+        $this->setAppLocale('en');
+        $this->get('missing')->assertNotFound();
+    }
+}