translate_url helper

Author: medilies

README.md

@@ -13,7 +13,7 @@ This package is built on top of [PHP JSON tongue](https://github.com/elaborate-c
 
 ### Requirements
 
--   PHP 8.0 or higher.
+- PHP 8.0 or higher.
 
 ### Setup
 
@@ -73,8 +73,8 @@ The output:
 
 `two or three lowercase letters` for the language code + **optionally** `a dash (-) with two uppercase letters` for the region code. For example, all the following codes `ar`, `es`, `fr-CA`, `haw-US` are considered valid.
 
--   [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) or [ISO 639-2](https://www.loc.gov/standards/iso639-2/php/English_list.php) for language codes.
--   [ISO 3166](https://www.iso.org/obp/ui/#search) for region codes.
+- [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) or [ISO 639-2](https://www.loc.gov/standards/iso639-2/php/English_list.php) for language codes.
+- [ISO 3166](https://www.iso.org/obp/ui/#search) for region codes.
 
 ## The multi folder
 
@@ -240,12 +240,20 @@ Usage example:
 </nav>
 ```
 
+### translate_url
+
+Just like the `translate_path` helper, but it prepends the `baseUrl` if set in the config.
+
+```php
+translate_url($page, $target_locale)
+```
+
 ### locale_path
 
 To avoid hard coding the `current_locale` into `paths`, input only the partial path that comes after the `locale code` part into this helper and it will handle the rest for you.
 
 ```php
-$href = locale_path($page, $partial_path)
+locale_path($page, $partial_path)
 ```
 
 | $partial_path | current_locale | href          |
@@ -260,7 +268,7 @@ $href = locale_path($page, $partial_path)
 Just like the `locale_path` helper, but it prepends the `baseUrl` if set in the config.
 
 ```php
-$href = locale_url($page, $partial_path)
+locale_url($page, $partial_path)
 ```
 
 ## Live test

src/helpers.php

@@ -66,7 +66,15 @@ function translate_path($page, ?string $target_locale = null): string
     };
 }
 
-// TODO: add translate_url helper
+/**
+ * @param  mixed  $page
+ * @param  ?string  $target_locale set to the default locale if null
+ * @return string Places $target_locale code in the current url
+ */
+function translate_url($page, ?string $target_locale = null): string
+{
+    return url(translate_path($page, $target_locale));
+}
 
 /**
  * @param  mixed  $page

tests/Pest.php

@@ -12,3 +12,4 @@
 */
 
 uses(Tests\TestCase::class)->in('unit/LocaleUrlTest.php');
+uses(Tests\TestCase::class)->in('unit/TranslateUrlTest.php');

tests/unit/TranslateUrlTest.php

@@ -0,0 +1,54 @@
+<?php
+
+use ElaborateCode\JigsawLocalization\Mocks\PageMock;
+
+test('path es => ar', function () {
+    $this->app->config = collect(['baseUrl' => 'https://elaboratecode.com/packages']);
+
+    $page = (new PageMock)->setPath('/es/blog');
+
+    expect(translate_url($page, 'ar'))->toBe('https://elaboratecode.com/packages/ar/blog');
+});
+
+test('path ar <=> fr-CA', function () {
+    $this->app->config = collect(['baseUrl' => 'https://elaboratecode.com/packages']);
+
+    expect(translate_url((new PageMock)->setPath('/ar/blog'), 'fr-CA'))->toBe('https://elaboratecode.com/packages/fr-CA/blog');
+    expect(translate_url((new PageMock)->setPath('/fr-CA/blog'), 'fr-CA'))->toBe('https://elaboratecode.com/packages/fr-CA/blog');
+});
+
+test('path ar <=> haw-US', function () {
+    $this->app->config = collect(['baseUrl' => 'https://elaboratecode.com/packages']);
+
+    expect(translate_url((new PageMock)->setPath('/ar/blog'), 'haw-US'))->toBe('https://elaboratecode.com/packages/haw-US/blog');
+    expect(translate_url((new PageMock)->setPath('/haw-US/blog'), 'haw-US'))->toBe('https://elaboratecode.com/packages/haw-US/blog');
+});
+
+test('path haw-US <=> fr-CA', function () {
+    $this->app->config = collect(['baseUrl' => 'https://elaboratecode.com/packages']);
+
+    expect(translate_url((new PageMock)->setPath('/fr-CA/blog'), 'haw-US'))->toBe('https://elaboratecode.com/packages/haw-US/blog');
+    expect(translate_url((new PageMock)->setPath('/haw-US/blog'), 'fr-CA'))->toBe('https://elaboratecode.com/packages/fr-CA/blog');
+});
+
+test('path from DEFAULT_LOCALE', function () {
+    $this->app->config = collect(['baseUrl' => 'https://elaboratecode.com/packages']);
+
+    expect(translate_url((new PageMock)->setPath('/blog'), 'ar'))->toBe('https://elaboratecode.com/packages/ar/blog');
+    expect(translate_url((new PageMock)->setPath('/blog'), 'en-UK'))->toBe('https://elaboratecode.com/packages/en-UK/blog');
+    expect(translate_url((new PageMock)->setPath('/blog'), 'haw-US'))->toBe('https://elaboratecode.com/packages/haw-US/blog');
+    expect(translate_url((new PageMock)->setPath('/blog'), packageDefaultLocale()))->toBe('https://elaboratecode.com/packages/blog');
+});
+
+test('path to DEFAULT_LOCALE', function () {
+    $this->app->config = collect(['baseUrl' => 'https://elaboratecode.com/packages']);
+
+    expect([
+        translate_url((new PageMock)->setPath('/ar/blog')),
+        translate_url((new PageMock)->setPath('/en-UK/blog')),
+        translate_url((new PageMock)->setPath('/haw-US/blog')),
+        translate_url((new PageMock)->setPath('/blog')),
+    ])
+        ->each
+        ->toBe('https://elaboratecode.com/packages/blog');
+});