Fix paginated routes, enhance test coverage

Author: AlexVakhovski

README.md

@@ -65,6 +65,14 @@ Route::localizedRoutes(function () {
 }, ['web']);
 ```
 
+### Checking if Route is Already Localized
+You can easily check if your route name is already localized before generating or using it.
+```php
+@if (Route::isLocalized($name))
+    // It returns TRUE if The route name is already localized (e.g., "en.blog.index")
+@endif
+```
+
 This automatically generates localized routes like:
 
 - `/en/about`
@@ -87,7 +95,7 @@ Or generate URLs with parameters:
 <a href="{{ Route::localize('blog.show', ['post' => $post]) }}">View Post</a>
 ```
 
-### Middleware: `localize.setLocale`
+### Middleware: `SetLocaleMiddleware`
 Middleware to automatically detect and set the application locale based on the first segment of the URL.
 
 Registered alias as `localize.setLocale`
@@ -132,7 +140,17 @@ Route::localizedRoutes(function () {
 ```
 This is a simpler and more compact approach, especially useful for smaller projects.
 
-### Pagination-Aware Route Generation
+### Middleware: `PaginatedMiddleware`
+Middleware that transforms paginated URLs by cleaning query parameters.
+
+Registered alias as `localize.paginated`.
+
+When a paginated route like `/page/{page?}` is used:
+
+* It ensures that the first page `blog/page/1` does not have a query string or URL segment like `/page/1`.
+* Instead, the first page URL is clean, such as `/blog`, improving SEO and URL readability.
+* If the user accesses `blog/page/2`, `blog/page/3`, etc., the page number remains in the URL.
+
 When building localized URLs with pagination, you can define your routes like this:
 ```php
 use Illuminate\Support\Facades\Route;
@@ -143,7 +161,7 @@ Route::localizedRoutes(function () {
         Route::get('/page/{page?}', [BlogController::class, 'index'])->name('paginated');
         Route::get('/{post}', [BlogController::class, 'show'])->name('show');
     });
-}, ['web', 'localize.setLocale']);
+}, ['web', 'localize.setLocale', 'localize.paginated']);
 
 ```
 
@@ -202,7 +220,7 @@ Your custom provider should implement:
 interface LanguageProviderInterface
 {
     public function getLanguages(): array;
-    public function getLocaleBySegment(string $segment): string;
+    public function getLocaleBySegment(?string $segment = null): string;
 }
 ```
 This gives you the flexibility to load languages from the database, API, or any other source.
@@ -236,7 +254,7 @@ class DatabaseLanguageProvider implements LanguageProviderInterface
         }, $languages->all());
     }
 
-    public function getLocaleBySegment(string $segment): string
+    public function getLocaleBySegment(?string $segment = null): string
     {
         $language = Language::where('slug', $segment)->first();
 

src/LocalizeServiceProvider.php

@@ -52,15 +52,14 @@ public function boot(Application $app, Router $router, Redirector $redirector, L
             ->aliasMiddleware('localize.setLocale', SetLocaleMiddleware::class)
             ->aliasMiddleware('localize.paginated', PaginatedMiddleware::class);
 
-        $router->macro('localize', function (string $name, array $parameters = [], bool $paginated = false) use ($app) {
+        $router->macro('localize', function (string $name, array $parameters = []) use ($app) {
             return $app->make(LocalizeUrlGenerator::class)
-                ->generate($name, $parameters, $paginated);
+                ->generate($name, $parameters);
         });
 
-        $router->macro('hasLocalize', function (string $name) use ($router, $app): bool {
-            $localizedName = $app->getLocale().'.'.$name;
-
-            return $router->has($localizedName) || $router->has($name);
+        $router->macro('isLocalized', function (string $name) use ($app): bool {
+            return $app->make(LocalizeUrlGenerator::class)
+                ->isLocalized($name);
         });
 
         $router->macro('localizedRoutes', function (Closure $callback, array $middleware = []) {

src/LocalizeUrlGenerator.php

@@ -12,25 +12,38 @@
 
 namespace Alexwaha\Localize;
 
-use Illuminate\Contracts\Config\Repository as ConfigContract;
+use Illuminate\Contracts\Config\Repository as Config;
 use Illuminate\Contracts\Routing\UrlGenerator as UrlGeneratorContract;
+use Illuminate\Routing\Router;
+use Illuminate\Routing\UrlGenerator;
 use Illuminate\Support\Str;
 
 class LocalizeUrlGenerator
 {
-    public UrlGeneratorContract $urlGenerator;
+    public Router $router;
+
+    public Config $config;
 
-    public ConfigContract $config;
+    public string $locale;
+
+    /**
+     * @var UrlGenerator
+     */
+    public UrlGeneratorContract $urlGenerator;
 
-    public function __construct(UrlGeneratorContract $urlGenerator, ConfigContract $config)
+    public function __construct(Router $router, Config $config, UrlGeneratorContract $urlGenerator)
     {
-        $this->urlGenerator = $urlGenerator;
+        $this->router = $router;
         $this->config = $config;
+        $this->locale = $this->config->get('app.locale');
+        $this->urlGenerator = $urlGenerator;
     }
 
-    public function generate(string $name, array $parameters = [], bool $paginated = false): string
+    public function generate(string $name, array $parameters = []): string
     {
-        $locale = $this->config->get('app.locale');
+        if (! $this->isLocalized($name)) {
+            $name = $this->locale.'.'.$name;
+        }
 
         if (isset($parameters['page'])) {
             $page = (int) $parameters['page'];
@@ -39,22 +52,22 @@ public function generate(string $name, array $parameters = [], bool $paginated =
                 unset($parameters['page']);
 
                 if (Str::endsWith($name, '.paginated')) {
-                    $name = Str::replace('.paginated', '.index', $name);
-                }
-            } else {
-                if (Str::endsWith($name, '.index')) {
-                    $name = Str::replaceLast('.index', '.paginated', $name);
+                    $name = Str::replaceLast('.paginated', '.index', $name);
                 }
             }
 
+            if ($page > 1 && Str::endsWith($name, '.index')) {
+                $name = Str::replaceLast('.index', '.paginated', $name);
+            }
         }
 
-        if (! $paginated) {
-            $name = $locale.'.'.$name;
-        }
-
-        $this->urlGenerator->defaults(['locale' => $locale]);
+        $this->urlGenerator->defaults(['locale' => $this->locale]);
 
         return $this->urlGenerator->route($name, $parameters);
     }
+
+    public function isLocalized(string $name): bool
+    {
+        return Str::startsWith($name, $this->locale.'.');
+    }
 }

src/Middleware/PaginatedMiddleware.php

@@ -17,6 +17,7 @@
 use Illuminate\Http\Request;
 use Illuminate\Routing\Redirector;
 use Illuminate\Routing\UrlGenerator;
+use Illuminate\Support\Str;
 use Symfony\Component\HttpFoundation\Response;
 
 /**
@@ -47,7 +48,7 @@ public function handle(Request $request, Closure $next): Response
 
         $currentRouteName = $request->route()->getName();
 
-        if ($page == 1 && str_ends_with($currentRouteName, 'paginated')) {
+        if ($page == 1 && Str::endsWith($currentRouteName, 'paginated')) {
             $canonicalRouteName = substr($currentRouteName, 0, -strlen('paginated')).'index';
 
             $routeParams = $request->route()->parameters();

tests/Unit/LocalizeUrlGeneratorTest.php

@@ -2,15 +2,19 @@
 
 use Alexwaha\Localize\LocalizeUrlGenerator;
 use Illuminate\Config\Repository;
+use Illuminate\Events\Dispatcher;
 use Illuminate\Http\Request;
 use Illuminate\Routing\Route;
 use Illuminate\Routing\RouteCollection;
+use Illuminate\Routing\Router;
 use Illuminate\Routing\UrlGenerator;
 
-it('can generate a localized URL for non-paginated route', function () {
+it('can generate a localized URL', function () {
     $routes = new RouteCollection;
 
     $request = Request::create('/');
+    $events = new Dispatcher;
+    $router = new Router($events);
     $urlGenerator = new UrlGenerator($routes, $request);
 
     $config = new Repository([
@@ -22,31 +26,61 @@
     $route = new Route(['GET'], '/en/home', ['as' => 'en.home']);
     $routes->add($route);
 
-    $localizer = new LocalizeUrlGenerator($urlGenerator, $config);
+    $localizer = new LocalizeUrlGenerator($router, $config, $urlGenerator);
 
     $url = $localizer->generate('home');
 
     expect($url)->toBe('http://localhost/en/home');
 });
 
-it('can generate a localized paginated URL when page > 1', function () {
-    $routes = new RouteCollection;
+it('can generate a localized paginated URL with route names using index/paginated', function () {
+    $events = new Dispatcher;
+    $router = new Router($events);
 
     $request = Request::create('/');
-    $urlGenerator = new UrlGenerator($routes, $request);
 
     $config = new Repository([
         'app' => [
             'locale' => 'en',
         ],
     ]);
 
-    $routes->add(new Route(['GET'], '/en/blog', ['as' => 'en.blog.index']));
-    $routes->add(new Route(['GET'], '/en/blog/page/{page}', ['as' => 'en.blog.paginated']));
+    $routes = $router->getRoutes();
+
+    $routes->add((new Route(['GET'], '/en/blog', ['as' => 'en.blog.index']))
+        ->middleware(['localize.setLocale', 'localize.paginated']));
+
+    $routes->add((new Route(['GET'], '/en/blog/page/{page?}', ['as' => 'en.blog.paginated']))
+        ->middleware(['localize.setLocale', 'localize.paginated']));
+
+    $urlGenerator = new UrlGenerator($routes, $request);
 
-    $localizer = new LocalizeUrlGenerator($urlGenerator, $config);
+    $localizer = new LocalizeUrlGenerator($router, $config, $urlGenerator);
 
     $url = $localizer->generate('blog.index', ['page' => 2]);
 
     expect($url)->toBe('http://localhost/en/blog/page/2');
 });
+
+it('can generate a localized paginated URL without route names index/paginated', function () {
+    $routes = new RouteCollection;
+
+    $request = Request::create('/');
+    $events = new Dispatcher;
+    $router = new Router($events);
+    $urlGenerator = new UrlGenerator($routes, $request);
+
+    $config = new Repository([
+        'app' => [
+            'locale' => 'en',
+        ],
+    ]);
+
+    $routes->add(new Route(['GET'], '/en/blog', ['as' => 'en.blog']));
+
+    $localizer = new LocalizeUrlGenerator($router, $config, $urlGenerator);
+
+    $url = $localizer->generate('blog', ['page' => 2]);
+
+    expect($url)->toBe('http://localhost/en/blog?page=2');
+});