Merge pull request #27 from bald-cat/patch-1

Adding default locale hiding during URL generation

Author: andrey-helldar

helpers/functions.php

@@ -5,15 +5,24 @@
 use Illuminate\Support\Facades\Route;
 use Illuminate\Support\Str;
 use LaravelLang\Config\Facades\Config;
+use LaravelLang\Locales\Facades\Locales;
+use LaravelLang\Routes\Helpers\Route as RouteHelper;
 
 if (! function_exists('localizedRoute')) {
     function localizedRoute(string $route, array $parameters = [], bool $absolute = true): string
     {
         $locale = Config::shared()->routes->names->parameter;
         $prefix = Config::shared()->routes->namePrefix;
 
-        $name = Str::start($route, $prefix);
+        $parameters[$locale] ??= Locales::raw()->getFallback();
 
+        if (RouteHelper::hidingFallback($parameters[$locale])) {
+            unset($parameters[$locale]);
+
+            return route($route, $parameters, $absolute);
+        }
+
+        $name  = Str::start($route, $prefix);
         $route = Route::has($name) ? $name : $route;
 
         return route($route, array_merge([

src/Helpers/Route.php

@@ -5,6 +5,8 @@
 namespace LaravelLang\Routes\Helpers;
 
 use LaravelLang\Config\Facades\Config;
+use LaravelLang\Locales\Facades\Locales;
+use LaravelLang\LocaleList\Locale;
 
 class Route
 {
@@ -17,4 +19,18 @@ public static function redirect(): bool
     {
         return Config::shared()->routes->redirect;
     }
+
+    public static function hide(): bool
+    {
+        return Config::shared()->routes->hide;
+    }
+
+    public static function hidingFallback(Locale|string $locale): bool
+    {
+        if (! static::hide() || ! Locales::isInstalled($locale)) {
+            return false;
+        }
+        
+        return Locales::raw()->get($locale) === Locales::raw()->getFallback();
+    }
 }

tests/Unit/Helpers/LocalizedRouteTest.php

@@ -2,6 +2,7 @@
 
 declare(strict_types=1);
 
+use LaravelLang\Config\Enums\Name;
 use LaravelLang\Config\Facades\Config;
 use Tests\Constants\LocaleValue;
 
@@ -10,13 +11,13 @@
     $locale   = LocaleValue::LocaleMain;
     $fallback = LocaleValue::LocaleAliasParent;
 
-    expect(localizedRoute($name . 'via.group.facade', ['foo' => 'bar']))
+    expect(localizedRoute($name . 'via.group.facade', ['foo' => 'bar', 'locale' => $locale]))
         ->toEndWith("localhost/$locale/group/facade/bar");
 
     expect(localizedRoute($name . 'via.group.macro', ['foo' => 'bar', 'locale' => $fallback]))
         ->toEndWith("localhost/$fallback/group/macro/bar");
 
-    expect(localizedRoute('via.group.facade', ['foo' => 'bar']))
+    expect(localizedRoute('via.group.facade', ['foo' => 'bar', 'locale' => $locale]))
         ->toEndWith("localhost/$locale/group/facade/bar");
 
     expect(localizedRoute('via.group.macro', ['foo' => 'bar', 'locale' => $fallback]))
@@ -26,6 +27,45 @@
 test('routes without groups', function () {
     $locale = LocaleValue::LocaleMain;
 
-    expect(localizedRoute('via.model.default', ['foo' => 'bar']))
+    expect(localizedRoute('via.model.default', ['foo' => 'bar', 'locale' => $locale]))
         ->toEndWith('localhost/model/default/bar?locale=' . $locale);
 });
+
+test('routes hide fallback', function (bool $set) {
+    $locale   = LocaleValue::LocaleMain;
+    $fallback = LocaleValue::LocaleMain;
+
+    config()->set(Name::Shared() . '.routes.hide_default', true);
+    config()->set('app.fallback_locale', $fallback);
+
+    $params = $set
+        ? ['foo' => 'bar', 'locale' => $locale]
+        : ['foo' => 'bar'];
+
+    expect(localizedRoute('via.parameter', $params))
+        ->toEndWith("localhost/path/bar");
+})->with([true, false]);
+
+test('routes hide manual', function () {
+    $locale   = LocaleValue::LocaleMain;
+    $fallback = LocaleValue::LocaleAliasParent;
+
+    config()->set(Name::Shared() . '.routes.hide_default', true);
+    config()->set('app.fallback_locale', $fallback);
+
+    expect(localizedRoute('via.parameter', ['foo' => 'bar', 'locale' => $locale]))
+        ->toEndWith("localhost/path/bar/$locale");
+
+    expect(localizedRoute('via.parameter', ['foo' => 'bar', 'locale' => $fallback]))
+        ->toEndWith("localhost/path/bar");
+});
+
+test('routes does not hide', function () {
+    $fallback = LocaleValue::LocaleAliasParent;
+
+    config()->set(Name::Shared() . '.routes.hide_default', true);
+    config()->set('app.fallback_locale', $fallback);
+
+    expect(localizedRoute('via.parameter', ['foo' => 'bar']))
+        ->toEndWith("localhost/path/bar");
+});