support dot inside php keys

Author: QuentinGab

src/Collections/PhpTranslations.php

@@ -6,6 +6,7 @@
 
 use Elegantly\Translator\Drivers\PhpDriver;
 use Illuminate\Support\Arr;
+use Illuminate\Support\Collection;
 use Illuminate\Support\Enumerable;
 use Illuminate\Support\Str;
 
@@ -14,11 +15,13 @@ class PhpTranslations extends Translations
     public string $driver = PhpDriver::class;
 
     /**
-     * Should mimic the laravel __ method
+     * Should then mimic the laravel __ method
+     *
+     * ! $this->items are dotted !
      *
      * $items = ['foo.bar' => 'baz']
      * - $this->get('foo.bar') === 'baz'
-     * - $this->get('foo') === 'baz'
+     * - $this->get('foo') === [ 'bar' => 'baz']
      * - $this->get('bar') === null
      */
     public function get($key, $default = null)
@@ -54,15 +57,15 @@ public function get($key, $default = null)
      * - 'auth.user.email' === 'auth.user.email.label' // false
      * - 'auth.user.email' === 'auth.admin' // false
      */
-    public static function areTranslationKeysEqual(
+    public static function isSubTranslationKey(
         int|string $translationKey,
         int|string $key
     ): bool {
         if ($translationKey === $key) {
             return true;
         }
 
-        return str((string) $translationKey)->startsWith("{$key}.");
+        return Str::startsWith((string) $translationKey, "{$key}.");
     }
 
     /**
@@ -74,7 +77,7 @@ public static function hasTranslationKey(
     ): bool {
 
         foreach ($translations as $translationKey => $translationValue) {
-            if (static::areTranslationKeysEqual($translationKey, $key)) {
+            if (static::isSubTranslationKey($translationKey, $key)) {
                 return true;
             }
         }
@@ -93,7 +96,7 @@ public static function hasTranslationKey(
     public function has($key)
     {
         /** @var array<int, array-key> */
-        $keys = is_array($key) ? $key : func_get_args();
+        $keys = Arr::wrap($key);
 
         foreach ($keys as $value) {
             if (! static::hasTranslationKey(
@@ -128,7 +131,7 @@ public function except($keys)
         return $this->filter(function ($translationValue, $translationKey) use ($keys) {
 
             foreach ($keys as $key) {
-                if (static::areTranslationKeysEqual($translationKey, $key)) {
+                if (static::isSubTranslationKey($translationKey, $key)) {
                     return false;
                 }
             }
@@ -160,12 +163,85 @@ public function only($keys)
         return $this->filter(function ($translationValue, $translationKey) use ($keys) {
 
             foreach ($keys as $key) {
-                if (static::areTranslationKeysEqual($translationKey, $key)) {
+                if (static::isSubTranslationKey($translationKey, $key)) {
                     return true;
                 }
             }
 
             return false;
         });
     }
+
+    /**
+     * @param  array<array-key, mixed>  $values
+     */
+    public static function toDot(array $values): static
+    {
+        $translations = collect($values)
+            ->mapWithKeys(fn ($value, $key) => [static::prepareTranslations($key) => static::prepareTranslations($value)])
+            ->dot();
+
+        return new static($translations);
+    }
+
+    /**
+     * @param  array<array-key, mixed>|Translations  $translations
+     * @return Collection<string, mixed>
+     */
+    public static function toUndot(Translations|array $translations): Collection
+    {
+        return collect($translations)
+            ->undot()
+            ->mapWithKeys(fn ($value, $key) => [static::unprepareTranslations($key) => static::unprepareTranslations($value)]);
+    }
+
+    /**
+     * Dot in translations keys might break the initial array structure
+     * To prevent that, we encode the dots in unicode
+     */
+    public static function prepareTranslations(mixed $values): mixed
+    {
+        if (is_string($values)) {
+            return Str::replace('.', '&#46;', $values);
+        }
+
+        if (! is_array($values)) {
+            return $values;
+        }
+
+        if (empty($values)) {
+            return null;
+        }
+
+        return collect($values)
+            ->mapWithKeys(fn ($value, $key) => [
+                static::prepareTranslations($key) => static::prepareTranslations($value),
+            ])
+            ->all();
+    }
+
+    /**
+     * Dot in translations keys might break the initial array structure
+     * To prevent that, we encode the dots in unicode
+     */
+    public static function unprepareTranslations(mixed $values): mixed
+    {
+        if (is_string($values)) {
+            return Str::replace('&#46;', '.', $values);
+        }
+
+        if (! is_array($values)) {
+            return $values;
+        }
+
+        if (empty($values)) {
+            return null;
+        }
+
+        return collect($values)
+            ->mapWithKeys(fn ($value, $key) => [
+                static::unprepareTranslations($key) => static::unprepareTranslations($value),
+            ])
+            ->all();
+    }
 }

src/Drivers/PhpDriver.php

@@ -41,7 +41,7 @@ public function getLocales(): array
         return collect($this->storage->directories())
             ->sort(SORT_NATURAL)
             ->values()
-            ->toArray();
+            ->all();
     }
 
     /**
@@ -54,26 +54,18 @@ public function getNamespaces(string $locale): array
             ->map(fn (string $file) => File::name($file))
             ->sort(SORT_NATURAL)
             ->values()
-            ->toArray();
+            ->all();
     }
 
     public function getTranslations(string $locale): PhpTranslations
     {
-        $translations = collect($this->getNamespaces($locale))
+        $values = collect($this->getNamespaces($locale))
             ->mapWithKeys(function ($namespace) use ($locale) {
                 return [$namespace => $this->getTranslationsInNamespace($locale, $namespace)];
             })
-            ->dot()
-            ->map(function ($value) {
-                if (empty($value)) {
-                    return null;
-                }
-
-                return $value;
-            })
-            ->toArray();
+            ->all();
 
-        return new PhpTranslations($translations);
+        return PhpTranslations::toDot($values);
     }
 
     /**
@@ -105,7 +97,7 @@ public function getTranslationsInNamespace(string $locale, string $namespace): a
 
     public function saveTranslations(string $locale, Translations $translations): Translations
     {
-        $undot = $translations->undot()->toArray();
+        $undot = PhpTranslations::toUndot($translations)->all();
 
         foreach ($undot as $namespace => $values) {
 

tests/Feature/PhpDriverTest.php

@@ -118,3 +118,31 @@
     ]);
 
 });
+
+it('replaces dot with unicode', function () {
+    $translator = new Translator(
+        driver: $this->getPhpDriver(),
+    );
+
+    $translations = $translator->getTranslations('fr_CA');
+
+    expect($translations->toArray())->toBe([
+        'dotted.This key contains a dot. In the middle.And it.has children.' => 'And it has children.',
+    ]);
+
+});
+
+it('doesn\' break keys with dot', function () {
+    $translator = new Translator(
+        driver: $this->getPhpDriver(),
+    );
+
+    $translations = $translator->getTranslations('fr_CA');
+
+    $translator->saveTranslations('fr_CA', $translations);
+
+    expect($translator->getTranslations('fr_CA')->toArray())->toBe([
+        'dotted.This key contains a dot. In the middle.And it.has children.' => 'And it has children.',
+    ]);
+
+});

tests/Unit/PhpTranslationsTest.php

@@ -42,7 +42,7 @@
 
 it('compare two translation keys', function ($a, $b, $expected) {
 
-    expect(PhpTranslations::areTranslationKeysEqual($a, $b))->toBe($expected);
+    expect(PhpTranslations::isSubTranslationKey($a, $b))->toBe($expected);
 
 })->with([
     ['a', 'a', true],
@@ -52,14 +52,17 @@
     ['a.b', 'a', true],
     ['a.b', 'a.b.c', false],
     ['a.bcd', 'a.bc', false],
+    ['a.bc', 'a.bc', true],
     ['a.bc.d', 'a.bc', true],
+    ['a.bc', 'a.bc.d', false],
 ]);
 
-it('check existance of translation value', function ($has, $expected) {
+it('check existence of translation value', function ($has, $expected) {
 
     $translations = new PhpTranslations([
         'a.b' => 'b_value',
         'c' => 'c_value',
+        'a.bc.d' => 'd_value',
     ]);
 
     expect($translations->has($has))->toBe($expected);
@@ -71,6 +74,9 @@
     ['a.b.c', false],
     ['a.b.c.d', false],
     ['e', false],
+    ['a.bcd', false],
+    ['a.bc', true],
+    ['a.bc.d', true],
 ]);
 
 it('retreives values except for some translation keys', function ($except, $expected) {
@@ -131,3 +137,31 @@
         [],
     ],
 ]);
+
+it('encodes dot to unicode', function () {
+
+    $translations = PhpTranslations::toDot([
+        'This key contains a dot. In the middle' => [
+            'And it.has children.' => 'And it has children.',
+        ],
+    ]);
+
+    expect($translations->toArray())->toBe([
+        'This key contains a dot. In the middle.And it.has children.' => 'And it has children.',
+    ]);
+
+});
+
+it('decodes dot from unicode', function () {
+
+    $translations = PhpTranslations::toUndot([
+        'This key contains a dot. In the middle.And it.has children.' => 'And it has children.',
+    ]);
+
+    expect($translations->toArray())->toBe([
+        'This key contains a dot. In the middle' => [
+            'And it.has children.' => 'And it has children.',
+        ],
+    ]);
+
+});

tests/src/lang/fr_CA/dotted.php

@@ -3,25 +3,7 @@
 declare(strict_types=1);
 
 return [
-    'hello' => 'Bonjour',
-    'add' => 'Ajouter',
-    'home' => [
-        'title' => 'Titre',
-        'end' => 'Fin',
-        'missing' => 'Absent',
+    'This key contains a dot. In the middle' => [
+        'And it.has children.' => 'And it has children.',
     ],
-    'empty' => 'Vide',
-    'missing' => 'Absent',
-    'dummy' => [
-        'class' => 'class factice',
-        'component' => 'composant factice',
-        'view' => 'vue factice',
-        'nested' => [
-            'used',
-            'as',
-            'array',
-        ],
-    ],
-    'register' => 'S\'inscrire',
-    'registered' => 'Inscrit?',
 ];