feat: ḁdd xx-ŽA (#39)

add xx-ZA pseudo-locale as Zalgo commands

Author: ramsey

composer.json

@@ -20,6 +20,7 @@
         "ext-intl": "*",
         "ext-json": "*",
         "ext-mbstring": "*",
+        "mdwheele/zalgo": "^0.3.1",
         "myclabs/php-enum": "^1.8",
         "nikic/php-parser": "^4.13",
         "psr/log": "^1 || ^2",

src/PseudoLocale/Converter.php

@@ -35,6 +35,7 @@
 use FormatPHP\PseudoLocale\Locale\XxAc;
 use FormatPHP\PseudoLocale\Locale\XxHa;
 use FormatPHP\PseudoLocale\Locale\XxLs;
+use FormatPHP\PseudoLocale\Locale\XxZa;
 use FormatPHP\Util\FileSystemHelper;
 use FormatPHP\Util\FormatHelper;
 use Psr\Log\LoggerInterface;
@@ -58,6 +59,7 @@ class Converter
         PseudoLocale::XX_AC => XxAc::class,
         PseudoLocale::XX_HA => XxHa::class,
         PseudoLocale::XX_LS => XxLs::class,
+        PseudoLocale::XX_ZA => XxZa::class,
     ];
 
     private ConverterOptions $options;

src/PseudoLocale/Locale/XxZa.php

@@ -0,0 +1,68 @@
+<?php
+
+/**
+ * This file is part of skillshare/formatphp
+ *
+ * skillshare/formatphp is open source software: you can distribute
+ * it and/or modify it under the terms of the MIT License
+ * (the "License"). You may not use this file except in
+ * compliance with the License.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ * implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ *
+ * @copyright Copyright (c) Skillshare, Inc. <https://www.skillshare.com>
+ * @license https://opensource.org/licenses/MIT MIT License
+ */
+
+declare(strict_types=1);
+
+namespace FormatPHP\PseudoLocale\Locale;
+
+use FormatPHP\Icu\MessageFormat\Parser;
+use Zalgo\Mood;
+use Zalgo\Soul;
+use Zalgo\Zalgo;
+
+/**
+ * T̫̺̳o̬̜ ì̬͎̲̟nv̖̗̻̣̹̕o͖̗̠̜̤k͍͚̹͖̼e̦̗̪͍̪͍ ̬ͅt̕h̠͙̮͕͓e̱̜̗͙̭ ̥͔̫͙̪͍̣͝ḥi̼̦͈̼v҉̩̟͚̞͎e͈̟̻͙̦̤-m̷̘̝̱í͚̞̦̳n̝̲̯̙̮͞d̴̺̦͕̫ ̗̭̘͎͖r̞͎̜̜͖͎̫͢ep͇r̝̯̝͖͉͎̺e̴s̥e̵̖̳͉͍̩̗n̢͓̪͕̜̰̠̦t̺̞̰i͟n҉̮̦̖̟g̮͍̱̻͍̜̳ ̳c̖̮̙̣̰̠̩h̷̗͍̖͙̭͇͈a̧͎̯̹̲̺̫ó̭̞̜̣̯͕s̶̤̮̩̘.̨̻̪̖͔
+ * ̳̭̦̭̭̦̞́I̠͍̮n͇̹̪̬v̴͖̭̗̖o̸k҉̬̤͓͚̠͍i͜n̛̩̹͉̘̹g͙ ̠̥ͅt̰͖͞h̫̼̪e̟̩̝ ̭̠̲̫͔fe̤͇̝̱e͖̮̠̹̭͖͕l͖̲̘͖̠̪i̢̖͎̮̗̯͓̩n̸̰g̙̱̘̗͚̬ͅ ͍o͍͍̩̮͢f̖͓̦̥ ̘͘c̵̫̱̗͚͓̦h͝a̝͍͍̳̣͖͉o͙̟s̤̞.̙̝̭̣̳̼͟
+ * ̢̻͖͓̬̞̰̦W̮̲̝̼̩̝͖i͖͖͡ͅt̘̯͘h̷̬̖̞̙̰̭̳ ̭̪̕o̥̤̺̝̼̰̯͟ṳ̞̭̤t̨͚̥̗ ̟̺̫̩̤̳̩o̟̰̩̖ͅr̞̘̫̩̼d̡͍̬͎̪̺͚͔e͓͖̝̙r̰͖̲̲̻̠.̺̝̺̟͈
+ * ̣̭T̪̩̼h̥̫̪͔̀e̫̯͜ ̨N̟e҉͔̤zp̮̭͈̟é͉͈ṛ̹̜̺̭͕d̺̪̜͇͓i̞á͕̹̣̻n͉͘ ̗͔̭͡h̲͖̣̺̺i͔̣̖̤͎̯v̠̯̘͖̭̱̯e̡̥͕-m͖̭̣̬̦͈i͖n̞̩͕̟̼̺͜d̘͉ ̯o̷͇̹͕̦f̰̱ ̝͓͉̱̪̪c͈̲̜̺h̘͚a̞͔̭̰̯̗̝o̙͍s͍͇̱͓.̵͕̰͙͈ͅ ̯̞͈̞̱̖Z̯̮̺̤̥̪̕a͏̺̗̼̬̗ḻg͢o̥̱̼.̺̜͇͡ͅ ̴͓͖̭̩͎̗
+ * ̧̪͈̱̹̳͖͙H̵̰̤̰͕̖e̛ ͚͉̗̼̞w̶̩̥͉̮h̩̺̪̩͘ͅọ͎͉̟ ̜̩͔̦̘ͅW̪̫̩̣̲͔̳a͏͔̳͖i͖͜t͓̤̠͓͙s̘̰̩̥̙̝ͅ ̲̠̬̥Be̡̙̫̦h̰̩i̛̫͙͔̭̤̗̲n̳͞d̸ ͎̻͘T̛͇̝̲̹̠̗ͅh̫̦̝ͅe̩̫͟ ͓͖̼W͕̳͎͚̙̥ą̙l̘͚̺͔͞ͅl̳͍̙̤̤̮̳.̢
+ * ̟̺̜̙͉Z̤̲̙̙͎̥̝A͎̣͔̙͘L̥̻̗̳̻̳̳͢G͉̖̯͓̞̩̦O̹̹̺!̙͈͎̞̬ *
+ */
+class XxZa extends AbstractLocale
+{
+    private Zalgo $zalgo;
+
+    public function __construct()
+    {
+        /** @var Mood $mood */
+        $mood = Mood::soothed();
+
+        $this->zalgo = new Zalgo(new Soul(), $mood);
+    }
+
+    protected function generate(Parser\Type\ElementCollection $elementCollection): Parser\Type\ElementCollection
+    {
+        foreach ($elementCollection as $element) {
+            if ($element instanceof Parser\Type\LiteralElement) {
+                /** @var string $theWordOfZalgo */
+                $theWordOfZalgo = $this->zalgo->speaks($element->value);
+                $element->value = $theWordOfZalgo;
+            } elseif ($element instanceof Parser\Type\PluralElement || $element instanceof Parser\Type\SelectElement) {
+                foreach ($element->options as $option) {
+                    $this->generate($option->value);
+                }
+            } elseif ($element instanceof Parser\Type\TagElement) {
+                $this->generate($element->children);
+            }
+        }
+
+        return $elementCollection;
+    }
+}

src/PseudoLocale/PseudoLocale.php

@@ -32,12 +32,14 @@ class PseudoLocale
     public const XX_AC = 'xx-AC';
     public const XX_HA = 'xx-HA';
     public const XX_LS = 'xx-LS';
+    public const XX_ZA = 'xx-ZA';
 
     public const LOCALES = [
         self::EN_XA,
         self::EN_XB,
         self::XX_AC,
         self::XX_HA,
         self::XX_LS,
+        self::XX_ZA,
     ];
 }

tests/PseudoLocale/ConverterTest.php

@@ -143,4 +143,35 @@ public function testConvertThrowsExceptionForUnknownPseudoLocale(): void
 
         $converter->convert(__DIR__ . '/../fixtures/locales/en.json', 'en');
     }
+
+    /**
+     * Zalgo is non-deterministic, so we can't use snapshot testing for it.
+     */
+    public function testZalgo(): void
+    {
+        $outFile = 'php://output';
+
+        $fileSystemHelper = $this->mockery(FileSystemHelper::class)->makePartial();
+        $fileSystemHelper->shouldReceive('writeContents')->withArgs(
+            function (string $file, string $contents) use ($outFile): bool {
+                $this->assertSame($outFile, $file);
+
+                // We're unable to deterministically test the $contents, since
+                // Zalgo text changes each time it's generated.
+
+                return true;
+            },
+        );
+
+        $logger = $this->mockery(LoggerInterface::class);
+
+        $converter = new Converter(
+            new ConverterOptions(),
+            $fileSystemHelper,
+            new FormatHelper($fileSystemHelper),
+            $logger,
+        );
+
+        $converter->convert(__DIR__ . '/../fixtures/locales/en.json', 'xx-ZA');
+    }
 }

tests/PseudoLocale/Locale/AbstractLocaleTest.php

@@ -11,6 +11,7 @@
 use FormatPHP\PseudoLocale\Locale\XxAc;
 use FormatPHP\PseudoLocale\Locale\XxHa;
 use FormatPHP\PseudoLocale\Locale\XxLs;
+use FormatPHP\PseudoLocale\Locale\XxZa;
 use FormatPHP\Test\TestCase;
 
 class AbstractLocaleTest extends TestCase
@@ -36,6 +37,7 @@ public function provideLocales(): array
             'xx-AC' => ['locale' => new XxAc()],
             'xx-HA' => ['locale' => new XxHa()],
             'xx-LS' => ['locale' => new XxLs()],
+            'xx-ZA' => ['locale' => new XxZa()],
         ];
     }
 }