refactoring the TableCell Url generator

Author: athphane

src/Contracts/Translatable.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Database\Eloquent\Casts\Attribute;
 use Javaabu\Translatable\Exceptions\LanguageNotAllowedException;
+use Javaabu\Translatable\Models\Language;
 
 interface Translatable
 {
@@ -114,9 +115,9 @@ public function deleteTranslation(string $locale): void;
      */
     public function localeDirection(): Attribute;
 
-    public function getRouteName(): ?string;
+    public function languageSwitcherRouteName(): ?string;
 
-    public function getRouteParams(): array;
+    public function url(string $action = 'show', Language|string|null $locale = null, ?string $portal = null): string;
 
-    public function languageSwitcherRouteName(): ?string;
+    public function routeKeyForPortal(?string $portal): string;
 }

src/Traits/IsTranslatable.php

@@ -14,6 +14,8 @@
 
 trait IsTranslatable
 {
+    use TranslatedUrlGenerator;
+
     private bool $skipTranslation = false;
 
     public function getNonTranslatablePivots(): array

src/Traits/TranslatedUrlGenerator.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Javaabu\Translatable\Traits;
+
+use Javaabu\Translatable\Models\Language;
+use Request;
+
+trait TranslatedUrlGenerator
+{
+    public function url(string $action = 'show', Language|string|null $locale = null, ?string $portal = null): string
+    {
+        if ( ! $portal) {
+            $portal = Request::portal();
+        }
+
+        // Figure out route name based on namespace and action
+        $model_route_name = str(class_basename($this))->plural()->snake('-')->toString();
+
+        $route_name = $portal ? "{$portal}.{$model_route_name}.{$action}" : "{$model_route_name}.{$action}";
+
+        $params = [];
+
+        if ( ! in_array($action, ['index', 'store', 'create', 'trash'])) {
+            $params[] = $this->routeKeyForPortal($portal);
+        }
+
+        return translate_route(name: $route_name, parameters: $params, locale: $locale);
+    }
+
+    public function routeKeyForPortal(?string $portal): string
+    {
+        return (string) $this->id;
+    }
+}

src/TranslatableServiceProvider.php

@@ -65,7 +65,7 @@ public function boot(): void
             return redirect()->to($url, $status, $headers);
         });
 
-        Request::macro('portal', function (): string {
+        Request::macro('portal', function (): ?string {
             $req = request();
             $adminDomain = config('app.admin_domain');          // e.g. 'admin.ncs.test' or null
             $adminPrefix = config('app.admin_prefix', 'admin'); // e.g. 'admin'
@@ -81,7 +81,7 @@ public function boot(): void
             }
 
             // pattern: ncs.test/{locale}/{portal}
-            return $req->segment(2) ?? 'web';
+            return $req->segment(2) ?? null;
         });
 
         Request::macro('isPortal', function (string $portal): bool {

src/Views/Components/TableCells.php

@@ -15,33 +15,20 @@ class TableCells extends Component
 
     public function __construct(
         public Translatable $model,
-        public string $route_name = '',
-        public array $route_params = [],
-        public string $create_url = '',
     ) {
         $this->languages = Languages::allExceptCurrent();
     }
 
     public function getUrl(string $action, string $locale): string
     {
-        $params = filled($this->route_params) ? $this->route_params : $this->model->getRouteParams();
-
-        // A big assumption here is that the last parameter in the route params is the model ID.
-        // If the action is 'create', we don't need the last parameter (usually the ID)
-        if ($action === 'create') {
-            $params = array_slice($params, 0, -1); // Remove the last parameter if it exists
-        }
+        $url = $this->model->url($action, $locale);
 
         // If the model is we need to add "lang_parent" to the params
         if ($this->isModelDbTranslatable()) {
-            $params['lang_parent'] = $this->model->id;
+            $url = add_query_arg('lang_parent', $this->model->id, $url);
         }
 
-        return translate_route(
-            filled($this->route_name) ? $this->route_name : $this->model->getRouteName() . '.' . $action,
-            $params,
-            locale: $locale,
-        );
+        return $url;
     }
 
     public function isModelDbTranslatable(): bool

tests/TestSupport/Models/Article.php

@@ -47,14 +47,4 @@ public function getNonTranslatablePivots(): array
             'author_id',
         ];
     }
-
-    public function getRouteName(): string
-    {
-        return 'articles';
-    }
-
-    public function getRouteParams(): array
-    {
-        return ['article' => $this->id];
-    }
 }

tests/Unit/TableCellTranslatedUrlGenerationTest.php

@@ -66,7 +66,7 @@ public function it_can_generate_show_url_for_json_translatable_record(): void
         ]);
 
         Languages::setCurrentLocale('en');
-        $tableCellComponent = new TableCells($article, create_url: 'articles/create');
+        $tableCellComponent = new TableCells($article);
 
         $en_url = $tableCellComponent->getUrl('show', 'en');
         $this->assertTrue(str($en_url)->contains('/en/articles/' . $article->id), 'English URL does not contain expected path.');