Merge pull request #32 from Aeliot-Tm/add_transform_linter

Add transform linter

.gitignore

@@ -1,5 +1,9 @@
 .idea
 
+/report/
+!/report/**/**/.gitkeep
+/translations/*
+!/translations/.gitkeep
 /vendor
 .phpunit.result.cache
 composer.lock

CHANGELOG.md

@@ -1,13 +1,21 @@
 CHANGELOG
 =========
 
+2.5.0
+-----
+* Add linter "file_transformed" for check if file structure is normalised for all YAML files.
+* Updated parameter data type declaration.
+* Updated phpDocs.
+* Add ability to call commands in the isolated dev environment (without installing into application).
+* Add ability of services testing.
+
 2.4.0
 -----
 * Implement usage of Google Translate API to translate missed keys.
 
 2.3.2
 -----
-* Fix getting of project directory path for Symfony >=5.0
+* Fix getting of project directory path for Symfony >=5.0.
 
 2.3.1
 -----

composer.json

@@ -23,7 +23,6 @@
     "symfony/filesystem": ">=3.4",
     "symfony/finder": ">=3.4",
     "symfony/http-kernel": ">=3.4",
-    "symfony/translation": ">=3.4",
     "symfony/translation-contracts": "^v2.0.0",
     "symfony/yaml": ">=3.4"
   },
@@ -33,7 +32,9 @@
   "minimum-stability": "dev",
   "prefer-stable": true,
   "require-dev": {
-    "phpunit/phpunit": "^9.5"
+    "phpunit/phpunit": "^9.5",
+    "symfony/framework-bundle": ">=3.4",
+    "symfony/translation": "^5.3"
   },
   "scripts": {
     "test": "vendor/bin/phpunit"

docs/lint/lint_yaml_command.md

@@ -23,6 +23,11 @@ The order of passed keys has no matter.
 - **keys_duplicated** - then check if project has duplicated keys in each used locale of each domain.
 - **keys_missed** - then check if key mentioned in any locale of domain presented in all of them.
 
+#### Extend linters
+
+- **file_transformed** - then check if translation files transformed (has normalised structure).
+- **key_pattern** - then check if translation keys match configured pattern.
+
 
 ### Examples of reports
 

phpunit.xml.dist

@@ -3,11 +3,13 @@
 <!-- https://phpunit.readthedocs.io/en/latest/configuration.html -->
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="tests/bootstrap.php"
          colors="true"
 >
     <php>
         <ini name="error_reporting" value="-1" />
         <ini name="memory_limit" value="-1" />
+        <server name="KERNEL_CLASS" value="Aeliot\Bundle\TransMaintain\Test\Kernel" />
     </php>
 
     <testsuites>

src/Command/LintYamlCommand.php

@@ -17,12 +17,31 @@
 final class LintYamlCommand extends Command
 {
     private LinterRegistry $linterRegistry;
+    private ?string $yamlKeyPattern;
 
-    public function __construct(LinterRegistry $linterRegistry)
+    public function __construct(LinterRegistry $linterRegistry, ?string $yamlKeyPattern)
     {
         parent::__construct('aeliot_trans_maintain:lint:yaml');
 
         $this->linterRegistry = $linterRegistry;
+        $this->yamlKeyPattern = $yamlKeyPattern;
+    }
+
+    public function getHelp(): string
+    {
+        $presets = implode(', ', $this->linterRegistry->getExistingPresets());
+        $help = "There are available presets: $presets.\n";
+
+        $lintersKeys = implode(', ', $this->linterRegistry->getRegisteredLintersKeys());
+        $help .= "There are available linters: $lintersKeys.\n";
+
+        if ($this->yamlKeyPattern) {
+            $help .= "\nThere is configured pattern for the checking of translation keys: $this->yamlKeyPattern\n";
+        } else {
+            $help .= "\nKey pattern is not configured. You have not to use such linter.\n";
+        }
+
+        return $help;
     }
 
     protected function configure(): void

src/Command/SortFileCommand.php

@@ -31,12 +31,14 @@ protected function configure(): void
         $this->addArgument('output', InputArgument::OPTIONAL, 'Output file path');
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output): void
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $pathIn = (string) $input->getArgument('file');
         $yaml = $this->fileManipulator->parse($pathIn);
         $yaml = $this->keySorter->transform($yaml);
         $pathOut = $input->getArgument('output') ?: $pathIn;
         $this->fileManipulator->dump($pathOut, $yaml);
+
+        return 0;
     }
 }

src/Command/TransformYamlCommand.php

@@ -28,11 +28,13 @@ protected function configure(): void
         $this->addArgument('output', InputArgument::OPTIONAL, 'Output file path. Optional. Incoming file will be updated if the argument omitted.');
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output): void
+    protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $pathIn = (string) $input->getArgument('file');
         $pathOut = $input->getArgument('output') ?: $pathIn;
 
         $this->fileManager->update($pathIn, $pathOut);
+
+        return 0;
     }
 }

src/DependencyInjection/CompilerPass/DirectoryProviderCompilerPass.php

@@ -18,7 +18,7 @@ public function process(ContainerBuilder $container): void
     }
 
     /**
-     * @return array<string>
+     * @return array<int,string>
      */
     private function getDirectories(ContainerBuilder $container): array
     {

src/Model/FilesMissedLine.php

@@ -8,7 +8,7 @@ final class FilesMissedLine implements ReportLineInterface
 {
     private string $domain;
     /**
-     * @var array<string>
+     * @var array<int,string>
      */
     private array $omittedLanguages;
 
@@ -19,15 +19,15 @@ public function __construct(string $domain, array $omittedLanguages)
     }
 
     /**
-     * @var array<string>
+     * @return array<int,string>
      */
     public static function getHeaders(): array
     {
         return ['domain', 'omitted_languages'];
     }
 
     /**
-     * @var array<string>
+     * @return array<string,string>
      */
     public function jsonSerialize(): array
     {

src/Model/FilesTransformedLine.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Aeliot\Bundle\TransMaintain\Model;
+
+final class FilesTransformedLine implements ReportLineInterface
+{
+    private string $domain;
+    private string $file;
+    private string $locale;
+
+    public function __construct(string $domain, string $locale, string $file)
+    {
+        $this->domain = $domain;
+        $this->file = $file;
+        $this->locale = $locale;
+    }
+
+    /**
+     * @return array<int,string>
+     */
+    public static function getHeaders(): array
+    {
+        return ['domain', 'locale', 'file'];
+    }
+
+    /**
+     * @return array<string,string>
+     */
+    public function jsonSerialize(): array
+    {
+        return ['domain' => $this->domain, 'locale' => $this->locale, 'file' => $this->file, ];
+    }
+}

src/Model/KeysDuplicatedLine.php

@@ -18,15 +18,15 @@ public function __construct(string $domain, string $locale, string $languageId)
     }
 
     /**
-     * @var array<string>
+     * @return array<int,string>
      */
     public static function getHeaders(): array
     {
         return ['domain', 'locale', 'duplicated_language_id'];
     }
 
     /**
-     * @var array<string>
+     * @return array<string,string>
      */
     public function jsonSerialize(): array
     {

src/Model/KeysMissedLine.php

@@ -9,7 +9,7 @@ final class KeysMissedLine implements ReportLineInterface
     private string $domain;
     private string $languageId;
     /**
-     * @var array<string>
+     * @var array<int,string>
      */
     private array $omittedLanguages;
 
@@ -21,15 +21,15 @@ public function __construct(string $domain, string $languageId, array $omittedLa
     }
 
     /**
-     * @var array<string>
+     * @return array<int,string>
      */
     public static function getHeaders(): array
     {
         return ['domain', 'language_id', 'omitted_languages'];
     }
 
     /**
-     * @var array<string>
+     * @return array<string,string>
      */
     public function jsonSerialize(): array
     {

src/Model/KeysPatternLine.php

@@ -9,7 +9,7 @@ final class KeysPatternLine implements ReportLineInterface
     private string $domain;
     private string $languageId;
     /**
-     * @var array<string>
+     * @var array<int,string>
      */
     private array $locales;
 
@@ -21,15 +21,15 @@ public function __construct(string $domain, string $languageId, array $locales)
     }
 
     /**
-     * @var array<string>
+     * @return array<int,string>
      */
     public static function getHeaders(): array
     {
         return ['domain', 'invalid_language_id', 'locales'];
     }
 
     /**
-     * @var array<string>
+     * @return array<string,string>
      */
     public function jsonSerialize(): array
     {

src/Model/ReportBag.php

@@ -12,8 +12,14 @@ final class ReportBag
      */
     private array $lines = [];
 
+    /**
+     * @var class-string
+     */
     private string $reportLineClass;
 
+    /**
+     * @param class-string $reportLineClass
+     */
     public function __construct(string $reportLineClass)
     {
         $this->reportLineClass = $reportLineClass;

src/Service/DirectoryProvider.php

@@ -8,7 +8,7 @@ final class DirectoryProvider
 {
     private string $defaultPath;
     /**
-     * @var array<string>
+     * @var array<int,string>
      */
     private array $dirs;
 
@@ -21,7 +21,7 @@ public function __construct(string $defaultPath, iterable $dirs)
     }
 
     /**
-     * @return array<string>
+     * @return array<int,string>
      */
     public function getAll(): array
     {

src/Service/Yaml/FileManipulator.php

@@ -5,26 +5,23 @@
 namespace Aeliot\Bundle\TransMaintain\Service\Yaml;
 
 use Symfony\Component\Filesystem\Filesystem;
-use Symfony\Component\Yaml\Yaml;
 
 final class FileManipulator
 {
     private Filesystem $filesystem;
-    private int $yamlIndent;
+    private YamlContentHandler $yamlContentHandler;
 
-    public function __construct(Filesystem $filesystem, int $yamlIndent)
+    public function __construct(Filesystem $filesystem, YamlContentHandler $yamlContentHandler)
     {
         $this->filesystem = $filesystem;
-        $this->yamlIndent = $yamlIndent;
+        $this->yamlContentHandler = $yamlContentHandler;
     }
 
     public function dump(string $pathOut, array $yaml): void
     {
         $this->filesystem->mkdir(dirname($pathOut));
 
-        //THINK: how to escape single words?
-        $dumpFlags = Yaml::DUMP_EXCEPTION_ON_INVALID_TYPE | Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK;
-        $content = Yaml::dump($yaml, 100, $this->yamlIndent, $dumpFlags);
+        $content = $this->yamlContentHandler->dump($yaml);
         $this->filesystem->dumpFile($pathOut, $content);
     }
 
@@ -39,10 +36,6 @@ public function parse(string $pathIn): array
             throw new \InvalidArgumentException(\sprintf('Invalid path passed: "%s"', $pathIn));
         }
 
-        /**
-         * NOTE: don't use Yaml::PARSE_CONSTANT like in {@see \Symfony\Component\Translation\Loader\YamlFileLoader::loadResource()}
-         *       to leave values as is
-         */
-        return Yaml::parseFile($pathIn, Yaml::PARSE_EXCEPTION_ON_INVALID_TYPE);
+        return $this->yamlContentHandler->parseFile($pathIn) ?? [];
     }
 }