Inject Request instead of using the facade (#91)

Author: ivanvermeyen

src/LocalizedUrlGenerator.php

@@ -4,16 +4,22 @@
 
 use CodeZero\LocalizedRoutes\Facades\LocaleConfig;
 use CodeZero\UrlBuilder\UrlBuilder;
+use Illuminate\Http\Request;
 use Illuminate\Support\Facades\URL;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\App;
-use Illuminate\Support\Facades\Route;
-use Illuminate\Support\Facades\Request;
 use Illuminate\Contracts\Routing\UrlRoutable;
 use Symfony\Component\Routing\Exception\RouteNotFoundException;
 
 class LocalizedUrlGenerator
 {
+    /**
+     * The current Request.
+     *
+     * @var \Illuminate\Http\Request
+     */
+    protected $request;
+
     /**
      * The current Route.
      *
@@ -23,10 +29,13 @@ class LocalizedUrlGenerator
 
     /**
      * Create a new LocalizedUrlGenerator instance.
+     *
+     * @param \Illuminate\Http\Request $request
      */
-    public function __construct()
+    public function __construct(Request $request)
     {
-        $this->route = Route::current();
+        $this->request = $request;
+        $this->route = $request->route();
     }
 
     /**
@@ -41,7 +50,7 @@ public function __construct()
      */
     public function generateFromRequest(string $locale = null, $parameters = null, bool $absolute = true, bool $keepQuery = true): string
     {
-        $urlBuilder = UrlBuilder::make(Request::fullUrl());
+        $urlBuilder = UrlBuilder::make($this->request->fullUrl());
         $requestQueryString = $urlBuilder->getQuery();
 
         $currentDomain = $urlBuilder->getHost();

src/Macros/Route/HasLocalizedMacro.php

@@ -2,6 +2,7 @@
 
 namespace CodeZero\LocalizedRoutes\Macros\Route;
 
+use CodeZero\LocalizedRoutes\RouteHelper;
 use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Route;
 
@@ -14,10 +15,8 @@ class HasLocalizedMacro
      */
     public static function register()
     {
-        Route::macro('hasLocalized', function ($name, $locale = null) {
-            $locale = $locale ?: App::getLocale();
-
-            return $this->routes->hasNamedRoute("{$locale}.{$name}");
+        Route::macro('hasLocalized', function (string $name, ?string $locale = null) {
+            return App::make(RouteHelper::class)->hasLocalized($name, $locale);
         });
     }
 }

src/Macros/Route/IsFallbackMacro.php

@@ -2,6 +2,8 @@
 
 namespace CodeZero\LocalizedRoutes\Macros\Route;
 
+use CodeZero\LocalizedRoutes\RouteHelper;
+use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Route;
 
 class IsFallbackMacro
@@ -14,7 +16,7 @@ class IsFallbackMacro
     public static function register()
     {
         Route::macro('isFallback', function () {
-            return Route::current() && Route::current()->isFallback;
+            return App::make(RouteHelper::class)->isFallback();
         });
     }
 }

src/Macros/Route/IsLocalizedMacro.php

@@ -2,8 +2,8 @@
 
 namespace CodeZero\LocalizedRoutes\Macros\Route;
 
-use CodeZero\LocalizedRoutes\Facades\LocaleConfig;
-use Illuminate\Support\Collection;
+use CodeZero\LocalizedRoutes\RouteHelper;
+use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\Route;
 
 class IsLocalizedMacro
@@ -16,23 +16,7 @@ class IsLocalizedMacro
     public static function register()
     {
         Route::macro('isLocalized', function ($patterns = null, $locales = '*') {
-            if ($patterns === null) {
-                $routeAction = LocaleConfig::getRouteAction();
-                $route = Route::current();
-
-                return $route && $route->getAction($routeAction) !== null;
-            }
-
-            $locales = Collection::make($locales);
-            $names = Collection::make();
-
-            Collection::make($patterns)->each(function ($name) use ($locales, $names) {
-                $locales->each(function ($locale) use ($name, $names) {
-                    $names->push($locale . '.' . $name);
-                });
-            });
-
-            return Route::is($names->all());
+            return App::make(RouteHelper::class)->isLocalized($patterns, $locales);
         });
     }
 }

src/Middleware/Detectors/RouteActionDetector.php

@@ -2,11 +2,28 @@
 
 namespace CodeZero\LocalizedRoutes\Middleware\Detectors;
 
+use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Config;
-use Illuminate\Support\Facades\Request;
 
 class RouteActionDetector implements Detector
 {
+    /**
+     * The current Route.
+     *
+     * @var \Illuminate\Routing\Route
+     */
+    protected $route;
+
+    /**
+     * Create a new RouteActionDetector instance.
+     *
+     * @param \Illuminate\Http\Request $request
+     */
+    public function __construct(Request $request)
+    {
+        $this->route = $request->route();
+    }
+
     /**
      * Detect the locale.
      *
@@ -16,6 +33,6 @@ public function detect()
     {
         $action = Config::get('localized-routes.route_action');
 
-        return Request::route()->getAction($action);
+        return $this->route->getAction($action);
     }
 }

src/Middleware/Detectors/UrlDetector.php

@@ -3,18 +3,35 @@
 namespace CodeZero\LocalizedRoutes\Middleware\Detectors;
 
 use CodeZero\LocalizedRoutes\Facades\LocaleConfig;
-use Illuminate\Support\Facades\Request;
+use Illuminate\Http\Request;
 
 class UrlDetector implements Detector
 {
+    /**
+     * The current Request.
+     *
+     * @var \Illuminate\Http\Request
+     */
+    protected $request;
+
+    /**
+     * Create a new UrlDetector instance.
+     *
+     * @param \Illuminate\Http\Request $request
+     */
+    public function __construct(Request $request)
+    {
+        $this->request = $request;
+    }
+
     /**
      * Detect the locale.
      *
      * @return string|array|null
      */
     public function detect()
     {
-        $slug = Request::segment(1);
+        $slug = $this->request->segment(1);
 
         // If supported locales is a simple array like ['en', 'nl']
         // just return the slug and let the calling code check if it is supported.
@@ -25,7 +42,7 @@ public function detect()
         // Find the locale that belongs to the custom domain or slug.
         // Return the original slug as fallback.
         // The calling code should validate and handle it.
-        $domain = Request::getHttpHost();
+        $domain = $this->request->getHttpHost();
         $locale = LocaleConfig::findLocaleByDomain($domain) ?? LocaleConfig::findLocaleBySlug($slug) ?? $slug;
 
         return $locale;

src/RouteHelper.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace CodeZero\LocalizedRoutes;
+
+use CodeZero\LocalizedRoutes\Facades\LocaleConfig;
+use Illuminate\Http\Request;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\App;
+use Illuminate\Support\Facades\Route;
+
+class RouteHelper
+{
+    /**
+     * The current Route.
+     *
+     * @var \Illuminate\Routing\Route
+     */
+    protected $route;
+
+    /**
+     * Create a new RouteHelper instance.
+     *
+     * @param \Illuminate\Http\Request $request
+     */
+    public function __construct(Request $request)
+    {
+        $this->route = $request->route();
+    }
+
+    /**
+     * Check if the current route is a fallback route.
+     *
+     * @return bool
+     */
+    public function isFallback(): bool
+    {
+        return $this->route && $this->route->isFallback;
+    }
+
+    /**
+     * Check if the current route is localized.
+     *
+     * @param string|array $patterns
+     * @param string|array $locales
+     *
+     * @return bool
+     */
+    public function isLocalized($patterns = null, $locales = '*'): bool
+    {
+        return $patterns === null
+            ? $this->isCurrentRouteLocalized()
+            : $this->isCurrentRouteLocalizedWithNamePattern($patterns, $locales);
+    }
+
+    /**
+     * Check if a localized route exists.
+     *
+     * @param string $name
+     * @param string|null $locale
+     *
+     * @return bool
+     */
+    public function hasLocalized(string $name, ?string $locale = null): bool
+    {
+        $locale = $locale ?: App::getLocale();
+
+        return Route::has("{$locale}.{$name}");
+    }
+
+    /**
+     * Check if the current route is localized.
+     *
+     * @return bool
+     */
+    protected function isCurrentRouteLocalized(): bool
+    {
+        $routeAction = LocaleConfig::getRouteAction();
+
+        return $this->route && $this->route->getAction($routeAction) !== null;
+    }
+
+    /**
+     * Check if the current route is localized and has a specific name.
+     *
+     * @param string|array $patterns
+     * @param string|array $locales
+     *
+     * @return bool
+     */
+    protected function isCurrentRouteLocalizedWithNamePattern($patterns = null, $locales = '*'): bool
+    {
+        $locales = Collection::make($locales);
+        $names = Collection::make();
+
+        Collection::make($patterns)->each(function ($name) use ($locales, $names) {
+            $locales->each(function ($locale) use ($name, $names) {
+                $names->push($locale . '.' . $name);
+            });
+        });
+
+        return Route::is($names->all());
+    }
+}