Add unit tests

Author: AlexVakhovski

composer.json

@@ -21,9 +21,10 @@
     "illuminate/routing": "^10.0|^11.0|^12.0"
   },
   "require-dev": {
-    "pestphp/pest": "^2.28|^3.5",
-    "phpstan/extension-installer": "^1.3",
-    "laravel/pint": "^1.22"
+    "laravel/pint": "^1.22",
+    "mockery/mockery": "^1.6",
+    "pestphp/pest": "^3.8",
+    "phpstan/extension-installer": "^1.3"
   },
   "conflict": {
     "symfony/console": "<6.4"

src/LocalizeUrlGenerator.php

@@ -12,24 +12,20 @@
 
 namespace Alexwaha\Localize;
 
-use Illuminate\Contracts\Config\Repository as Config;
+use Illuminate\Contracts\Config\Repository as ConfigContract;
 use Illuminate\Contracts\Routing\UrlGenerator as UrlGeneratorContract;
-use Illuminate\Routing\UrlGenerator;
 use Illuminate\Support\Str;
 
 class LocalizeUrlGenerator
 {
-    public Config $config;
-
-    /**
-     * @var UrlGenerator
-     */
     public UrlGeneratorContract $urlGenerator;
 
-    public function __construct(Config $config, UrlGeneratorContract $urlGenerator)
+    public ConfigContract $config;
+
+    public function __construct(UrlGeneratorContract $urlGenerator, ConfigContract $config)
     {
-        $this->config = $config;
         $this->urlGenerator = $urlGenerator;
+        $this->config = $config;
     }
 
     public function generate(string $name, array $parameters = [], bool $paginated = false): string

src/Middleware/PaginatedMiddleware.php

@@ -54,6 +54,7 @@ public function handle(Request $request, Closure $next): Response
             unset($routeParams['page']);
 
             $queryParams = $request->query();
+            unset($queryParams['page']);
 
             $url = $this->urlGenerator->route($canonicalRouteName, $routeParams);
 

tests/Pest.php

@@ -0,0 +1,47 @@
+<?php
+
+/*
+|--------------------------------------------------------------------------
+| Test Case
+|--------------------------------------------------------------------------
+|
+| The closure you provide to your test functions is always bound to a specific PHPUnit test
+| case class. By default, that class is "PHPUnit\Framework\TestCase". Of course, you may
+| need to change it using the "pest()" function to bind a different classes or traits.
+|
+*/
+
+// pest()->extend(Tests\TestCase::class)
+// ->use(Illuminate\Foundation\Testing\RefreshDatabase::class)
+//   ->in('Feature');
+
+/*
+|--------------------------------------------------------------------------
+| Expectations
+|--------------------------------------------------------------------------
+|
+| When you're writing tests, you often need to check that values meet certain conditions. The
+| "expect()" function gives you access to a set of "expectations" methods that you can use
+| to assert different things. Of course, you may extend the Expectation API at any time.
+|
+*/
+
+expect()->extend('toBeOne', function () {
+    return $this->toBe(1);
+});
+
+/*
+|--------------------------------------------------------------------------
+| Functions
+|--------------------------------------------------------------------------
+|
+| While Pest is very powerful out-of-the-box, you may have some testing code specific to your
+| project that you don't want to repeat in every file. Here you can also expose helpers as
+| global functions to help you to reduce the number of lines of code in your test files.
+|
+*/
+
+function something()
+{
+    // ..
+}

tests/TestCase.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Tests;
+
+use PHPUnit\Framework\TestCase as BaseTestCase;
+
+abstract class TestCase extends BaseTestCase
+{
+    // Nothing extra needed
+}

tests/Unit/LanguageProviderTest.php

@@ -0,0 +1,28 @@
+<?php
+
+use Alexwaha\Localize\LanguageProvider;
+use Illuminate\Config\Repository as Config;
+
+it('can instantiate LanguageProvider and return languages', function () {
+    $config = new Config([
+        'app' => [
+            'fallback_locale' => 'en',
+        ],
+    ]);
+
+    $languages = [
+        ['locale' => 'en', 'slug' => 'en'],
+        ['locale' => 'es', 'slug' => 'es'],
+    ];
+
+    $provider = new LanguageProvider($config, $languages);
+
+    $langs = $provider->getLanguages();
+
+    expect($langs)
+        ->toHaveCount(2)
+        ->and($langs[0]->getLocale())
+        ->toBe('en')
+        ->and($langs[1]->getSlug())
+        ->toBe('es');
+});

tests/Unit/LocalizeUrlGeneratorTest.php

@@ -0,0 +1,52 @@
+<?php
+
+use Alexwaha\Localize\LocalizeUrlGenerator;
+use Illuminate\Config\Repository;
+use Illuminate\Http\Request;
+use Illuminate\Routing\Route;
+use Illuminate\Routing\RouteCollection;
+use Illuminate\Routing\UrlGenerator;
+
+it('can generate a localized URL for non-paginated route', function () {
+    $routes = new RouteCollection;
+
+    $request = Request::create('/');
+    $urlGenerator = new UrlGenerator($routes, $request);
+
+    $config = new Repository([
+        'app' => [
+            'locale' => 'en',
+        ],
+    ]);
+
+    $route = new Route(['GET'], '/en/home', ['as' => 'en.home']);
+    $routes->add($route);
+
+    $localizer = new LocalizeUrlGenerator($urlGenerator, $config);
+
+    $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;
+
+    $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']));
+
+    $localizer = new LocalizeUrlGenerator($urlGenerator, $config);
+
+    $url = $localizer->generate('blog.index', ['page' => 2]);
+
+    expect($url)->toBe('http://localhost/en/blog/page/2');
+});

tests/Unit/PaginatedMiddlewareTest.php

@@ -0,0 +1,59 @@
+<?php
+
+use Alexwaha\Localize\Middleware\PaginatedMiddleware;
+use Illuminate\Http\Request;
+use Illuminate\Routing\Redirector;
+use Illuminate\Routing\Route;
+use Illuminate\Routing\RouteCollection;
+use Illuminate\Routing\UrlGenerator;
+use Symfony\Component\HttpFoundation\Response;
+
+it('redirects to index route if page is 1 on paginated route', function () {
+    $routes = new RouteCollection;
+
+    $routes->add(new Route(['GET'], '/blog', ['as' => 'blog.index']));
+    $routes->add($paginatedRoute = new Route(['GET'], '/blog/page/{page?}', ['as' => 'blog.paginated']));
+
+    $request = Request::create('/blog/page/1', 'GET', ['page' => 1]);
+
+    $paginatedRoute->bind($request);
+    $request->setRouteResolver(fn () => $paginatedRoute);
+
+    $urlGenerator = new UrlGenerator($routes, $request);
+    $redirector = new Redirector($urlGenerator);
+
+    $middleware = new PaginatedMiddleware($urlGenerator, $redirector);
+
+    $response = $middleware->handle($request, function () {
+        return new Response('HTTP_OK');
+    });
+
+    expect($response->isRedirect())
+        ->toBeTrue()
+        ->and($response->getTargetUrl())
+        ->toBe('http://localhost/blog');
+});
+
+it('does not redirect when page is greater than 1', function () {
+
+    $routes = new RouteCollection;
+
+    $routes->add(new Route(['GET'], '/blog', ['as' => 'blog.index']));
+    $routes->add($paginatedRoute = new Route(['GET'], '/blog/page/{page?}', ['as' => 'blog.paginated']));
+
+    $request = Request::create('/blog/page/2', 'GET', ['page' => 2]);
+
+    $urlGenerator = new UrlGenerator($routes, $request);
+    $redirector = new Redirector($urlGenerator);
+
+    $paginatedRoute->bind($request);
+    $request->setRouteResolver(fn () => $paginatedRoute);
+
+    $middleware = new PaginatedMiddleware($urlGenerator, $redirector);
+
+    $response = $middleware->handle($request, function () {
+        return new Response('HTTP_OK');
+    });
+
+    expect($response->isOk())->toBeTrue();
+});

tests/Unit/SetLocaleMiddlewareTest.php

@@ -0,0 +1,50 @@
+<?php
+
+use Alexwaha\Localize\LanguageProvider;
+use Alexwaha\Localize\Middleware\SetLocaleMiddleware;
+use Illuminate\Config\Repository;
+use Illuminate\Foundation\Application;
+use Illuminate\Http\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+it('sets the locale based on URL segment using real Application', function () {
+    $app = new Application(__DIR__);
+
+    $configArray = [
+        'app' => [
+            'fallback_locale' => 'en',
+            'locale' => 'en',
+        ],
+    ];
+
+    $config = new Repository($configArray);
+
+    $app->instance('config', $config);
+
+    $app->instance('translator', new class
+    {
+        public function setLocale($locale) {}
+
+        public function getLocale(): string
+        {
+            return 'en';
+        }
+    });
+
+    $languages = [
+        ['locale' => 'en', 'slug' => 'en'],
+        ['locale' => 'es', 'slug' => 'es'],
+    ];
+
+    $languageProvider = new LanguageProvider($config, $languages);
+
+    $middleware = new SetLocaleMiddleware($app, $languageProvider);
+
+    $request = Request::create('/es/some-page', 'GET');
+
+    $middleware->handle($request, function () {
+        return new Response('HTTP_OK');
+    });
+
+    expect($app->getLocale())->toBe('es');
+});