feat: provides pseudo-locale command for testing (#25)

Author: ramsey

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
+- Add `pseudo-locale` console command to allow conversion of a locale to one of the supported pseudo-locales (`en-XA`, `en-XB`, `xx-AC`, `xx-HA`, and `xx-LS`).
 - Provide `--flatten` extraction option to tell the extractor to hoist selectors and flatten sentences as much as possible. For example, `I have {count, plural, one{a dog} other{many dogs}}` becomes `{count, plural, one{I have a dog} other{I have many dogs}}`. The goal is to provide as many full sentences as possible, since fragmented sentences are not translator-friendly.
 - Provide `--add-missing-ids` extraction option to update source code with auto-generated identifiers
 - Add `Util\FormatHelper` that provides `getReader()` and `getWriter()` methods
@@ -32,7 +33,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Fixed
 
-- Nothing.
+- Support rich text formatting in the [same manner as FormatJS](https://formatjs.io/docs/core-concepts/icu-syntax#rich-text-formatting). Previously, we allowed HTML tags with attributes, etc., but this limits our ability to provide pseudo-locales and validation.
 
 ## 0.2.2 - 2021-11-18
 

src/Console/Application.php

@@ -23,7 +23,9 @@
 namespace FormatPHP\Console;
 
 use FormatPHP\Console\Command\ExtractCommand;
+use FormatPHP\Console\Command\PseudoLocaleCommand;
 use Symfony\Component\Console\Application as SymfonyConsoleApplication;
+use Symfony\Component\Console\Exception\LogicException;
 
 /**
  * FormatPHP console application
@@ -32,10 +34,14 @@ class Application extends SymfonyConsoleApplication
 {
     public const NAME = 'formatphp';
 
+    /**
+     * @throws LogicException
+     */
     public function __construct()
     {
         parent::__construct(self::NAME);
 
         $this->add(new ExtractCommand());
+        $this->add(new PseudoLocaleCommand());
     }
 }

src/Console/Command/AbstractCommand.php

@@ -22,11 +22,30 @@
 
 namespace FormatPHP\Console\Command;
 
+use Psr\Log\LogLevel;
+use Psr\Log\LoggerInterface;
 use Symfony\Component\Console\Command\Command as SymfonyConsoleCommand;
+use Symfony\Component\Console\Logger\ConsoleLogger;
+use Symfony\Component\Console\Output\OutputInterface;
 
 /**
  * Common command functionality for FormatPHP console commands
  */
 abstract class AbstractCommand extends SymfonyConsoleCommand
 {
+    private const LOG_FORMAT_MAPPING = [
+        LogLevel::WARNING => ConsoleLogger::ERROR,
+        LogLevel::NOTICE => ConsoleLogger::ERROR,
+        LogLevel::INFO => ConsoleLogger::ERROR,
+        LogLevel::DEBUG => ConsoleLogger::ERROR,
+    ];
+
+    private const LOG_VERBOSITY_MAPPING = [
+        LogLevel::NOTICE => OutputInterface::VERBOSITY_NORMAL,
+    ];
+
+    protected function getConsoleLogger(OutputInterface $output): LoggerInterface
+    {
+        return new ConsoleLogger($output, self::LOG_VERBOSITY_MAPPING, self::LOG_FORMAT_MAPPING);
+    }
 }

src/Console/Command/ExtractCommand.php

@@ -33,12 +33,11 @@
 use FormatPHP\Util\FormatHelper;
 use FormatPHP\Util\Globber;
 use LogicException;
-use Psr\Log\LogLevel;
+use Ramsey\Collection\Exception\CollectionMismatchException;
 use Symfony\Component\Console\Exception\InvalidArgumentException as SymfonyInvalidArgumentException;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
-use Symfony\Component\Console\Logger\ConsoleLogger;
 use Symfony\Component\Console\Output\OutputInterface;
 
 use function array_map;
@@ -68,17 +67,6 @@ class ExtractCommand extends AbstractCommand
         'vendor',
     ];
 
-    private const LOG_FORMAT_MAPPING = [
-        LogLevel::WARNING => ConsoleLogger::ERROR,
-        LogLevel::NOTICE => ConsoleLogger::ERROR,
-        LogLevel::INFO => ConsoleLogger::ERROR,
-        LogLevel::DEBUG => ConsoleLogger::ERROR,
-    ];
-
-    private const LOG_VERBOSITY_MAPPING = [
-        LogLevel::NOTICE => OutputInterface::VERBOSITY_NORMAL,
-    ];
-
     /**
      * @throws SymfonyInvalidArgumentException
      */
@@ -194,6 +182,7 @@ protected function configure(): void
      * @throws InvalidArgumentException
      * @throws ImproperContextException
      * @throws LogicException
+     * @throws CollectionMismatchException
      */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
@@ -204,7 +193,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $extractor = new MessageExtractor(
             $options,
-            new ConsoleLogger($output, self::LOG_VERBOSITY_MAPPING, self::LOG_FORMAT_MAPPING),
+            $this->getConsoleLogger($output),
             new Globber($fileSystemHelper),
             $fileSystemHelper,
             new FormatHelper($fileSystemHelper),

src/Console/Command/PseudoLocaleCommand.php

@@ -0,0 +1,139 @@
+<?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\Console\Command;
+
+use FormatPHP\Exception;
+use FormatPHP\PseudoLocale\Converter;
+use FormatPHP\PseudoLocale\ConverterOptions;
+use FormatPHP\PseudoLocale\PseudoLocale;
+use FormatPHP\Util\FileSystemHelper;
+use FormatPHP\Util\FormatHelper;
+use Symfony\Component\Console\Exception\InvalidArgumentException as SymfonyInvalidArgumentException;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+use function implode;
+
+use const PHP_EOL;
+
+/**
+ * Provides the `formatphp pseudo-locale` command
+ */
+class PseudoLocaleCommand extends AbstractCommand
+{
+    /**
+     * @throws SymfonyInvalidArgumentException
+     */
+    protected function configure(): void
+    {
+        $this
+            ->setName('pseudo-locale')
+            ->setDescription('Convert a locale file into a pseudo locale, for testing')
+            ->addArgument(
+                'file',
+                InputArgument::REQUIRED,
+                'The locale file to convert.',
+            )
+            ->addArgument(
+                'pseudo-locale',
+                InputArgument::REQUIRED,
+                'The pseudo-locale tag.' . PHP_EOL
+                    . 'One of: ' . implode(', ', PseudoLocale::LOCALES),
+            )
+            ->addOption(
+                'in-format',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'Formatter name or path to a formatter script that' . PHP_EOL
+                    . 'controls the shape of the JSON read from `file`.' . PHP_EOL
+                    . 'Defaults to "formatphp".',
+            )
+            ->addOption(
+                'out-format',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'Formatter name or path to a formatter script that' . PHP_EOL
+                    . 'controls the shape of the JSON produced as output.',
+            )
+            ->addOption(
+                'out-file',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'Target file path to save the JSON output.',
+            );
+    }
+
+    /**
+     * @throws Exception\InvalidArgumentException
+     * @throws Exception\UnableToWriteFileException
+     * @throws Exception\UnableToProcessFileException
+     * @throws Exception\ImproperContextException
+     * @throws SymfonyInvalidArgumentException
+     */
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        /** @var string $file */
+        $file = $input->getArgument('file');
+
+        /** @var string $pseudoLocale */
+        $pseudoLocale = $input->getArgument('pseudo-locale');
+
+        $options = $this->buildOptions($input);
+        $fileSystemHelper = new FileSystemHelper();
+
+        $converter = new Converter(
+            $options,
+            $fileSystemHelper,
+            new FormatHelper($fileSystemHelper),
+            $this->getConsoleLogger($output),
+        );
+
+        $converter->convert($file, $pseudoLocale);
+
+        return self::SUCCESS;
+    }
+
+    /**
+     * @throws SymfonyInvalidArgumentException
+     */
+    private function buildOptions(InputInterface $input): ConverterOptions
+    {
+        $options = new ConverterOptions();
+
+        /** @var string | null $inFormat */
+        $inFormat = $input->getOption('in-format');
+        $options->inFormat = $inFormat;
+
+        /** @var string | null $outFormat */
+        $outFormat = $input->getOption('out-format');
+        $options->outFormat = $outFormat;
+
+        /** @var string | null $outFile */
+        $outFile = $input->getOption('out-file');
+        $options->outFile = $outFile;
+
+        return $options;
+    }
+}

src/Format/Format.php

@@ -25,18 +25,9 @@
 /**
  * Constant values for formats
  */
-final class Format
+class Format
 {
     public const FORMATPHP = 'formatphp';
     public const SIMPLE = 'simple';
     public const SMARTLING = 'smartling';
-
-    /**
-     * Disallow instantiation of this class.
-     *
-     * @codeCoverageIgnore This is reported as uncovered in code coverage reports, so let's ignore it.
-     */
-    private function __construct()
-    {
-    }
 }

src/MessageLoader.php

@@ -41,7 +41,7 @@
 /**
  * Loads messages for a given locale from the file system or cache
  */
-final class MessageLoader
+class MessageLoader
 {
     private ConfigInterface $config;
     private FileSystemHelper $fileSystemHelper;