annotate vendor/symfony/translation/Resources/bin/translation-status.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents af1871eacc83
children
rev   line source
Chris@18 1 <?php
Chris@18 2
Chris@18 3 /*
Chris@18 4 * This file is part of the Symfony package.
Chris@18 5 *
Chris@18 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@18 7 *
Chris@18 8 * For the full copyright and license information, please view the LICENSE
Chris@18 9 * file that was distributed with this source code.
Chris@18 10 */
Chris@18 11
Chris@18 12 $usageInstructions = <<<END
Chris@18 13
Chris@18 14 Usage instructions
Chris@18 15 -------------------------------------------------------------------------------
Chris@18 16
Chris@18 17 $ cd symfony-code-root-directory/
Chris@18 18
Chris@18 19 # show the translation status of all locales
Chris@18 20 $ php translation-status.php
Chris@18 21
Chris@18 22 # show the translation status of all locales and all their missing translations
Chris@18 23 $ php translation-status.php -v
Chris@18 24
Chris@18 25 # show the status of a single locale
Chris@18 26 $ php translation-status.php fr
Chris@18 27
Chris@18 28 # show the status of a single locale and all its missing translations
Chris@18 29 $ php translation-status.php fr -v
Chris@18 30
Chris@18 31 END;
Chris@18 32
Chris@18 33 $config = [
Chris@18 34 // if TRUE, the full list of missing translations is displayed
Chris@18 35 'verbose_output' => false,
Chris@18 36 // NULL = analyze all locales
Chris@18 37 'locale_to_analyze' => null,
Chris@18 38 // the reference files all the other translations are compared to
Chris@18 39 'original_files' => [
Chris@18 40 'src/Symfony/Component/Form/Resources/translations/validators.en.xlf',
Chris@18 41 'src/Symfony/Component/Security/Core/Resources/translations/security.en.xlf',
Chris@18 42 'src/Symfony/Component/Validator/Resources/translations/validators.en.xlf',
Chris@18 43 ],
Chris@18 44 ];
Chris@18 45
Chris@18 46 $argc = $_SERVER['argc'];
Chris@18 47 $argv = $_SERVER['argv'];
Chris@18 48
Chris@18 49 if ($argc > 3) {
Chris@18 50 echo str_replace('translation-status.php', $argv[0], $usageInstructions);
Chris@18 51 exit(1);
Chris@18 52 }
Chris@18 53
Chris@18 54 foreach (array_slice($argv, 1) as $argumentOrOption) {
Chris@18 55 if (0 === strpos($argumentOrOption, '-')) {
Chris@18 56 $config['verbose_output'] = true;
Chris@18 57 } else {
Chris@18 58 $config['locale_to_analyze'] = $argumentOrOption;
Chris@18 59 }
Chris@18 60 }
Chris@18 61
Chris@18 62 foreach ($config['original_files'] as $originalFilePath) {
Chris@18 63 if (!file_exists($originalFilePath)) {
Chris@18 64 echo sprintf('The following file does not exist. Make sure that you execute this command at the root dir of the Symfony code repository.%s %s', PHP_EOL, $originalFilePath);
Chris@18 65 exit(1);
Chris@18 66 }
Chris@18 67 }
Chris@18 68
Chris@18 69 $totalMissingTranslations = 0;
Chris@18 70
Chris@18 71 foreach ($config['original_files'] as $originalFilePath) {
Chris@18 72 $translationFilePaths = findTranslationFiles($originalFilePath, $config['locale_to_analyze']);
Chris@18 73 $translationStatus = calculateTranslationStatus($originalFilePath, $translationFilePaths);
Chris@18 74
Chris@18 75 $totalMissingTranslations += array_sum(array_map(function ($translation) {
Chris@18 76 return \count($translation['missingKeys']);
Chris@18 77 }, array_values($translationStatus)));
Chris@18 78
Chris@18 79 printTranslationStatus($originalFilePath, $translationStatus, $config['verbose_output']);
Chris@18 80 }
Chris@18 81
Chris@18 82 exit($totalMissingTranslations > 0 ? 1 : 0);
Chris@18 83
Chris@18 84 function findTranslationFiles($originalFilePath, $localeToAnalyze)
Chris@18 85 {
Chris@18 86 $translations = [];
Chris@18 87
Chris@18 88 $translationsDir = dirname($originalFilePath);
Chris@18 89 $originalFileName = basename($originalFilePath);
Chris@18 90 $translationFileNamePattern = str_replace('.en.', '.*.', $originalFileName);
Chris@18 91
Chris@18 92 $translationFiles = glob($translationsDir.'/'.$translationFileNamePattern);
Chris@18 93 foreach ($translationFiles as $filePath) {
Chris@18 94 $locale = extractLocaleFromFilePath($filePath);
Chris@18 95
Chris@18 96 if (null !== $localeToAnalyze && $locale !== $localeToAnalyze) {
Chris@18 97 continue;
Chris@18 98 }
Chris@18 99
Chris@18 100 $translations[$locale] = $filePath;
Chris@18 101 }
Chris@18 102
Chris@18 103 return $translations;
Chris@18 104 }
Chris@18 105
Chris@18 106 function calculateTranslationStatus($originalFilePath, $translationFilePaths)
Chris@18 107 {
Chris@18 108 $translationStatus = [];
Chris@18 109 $allTranslationKeys = extractTranslationKeys($originalFilePath);
Chris@18 110
Chris@18 111 foreach ($translationFilePaths as $locale => $translationPath) {
Chris@18 112 $translatedKeys = extractTranslationKeys($translationPath);
Chris@18 113 $missingKeys = array_diff_key($allTranslationKeys, $translatedKeys);
Chris@18 114
Chris@18 115 $translationStatus[$locale] = [
Chris@18 116 'total' => \count($allTranslationKeys),
Chris@18 117 'translated' => \count($translatedKeys),
Chris@18 118 'missingKeys' => $missingKeys,
Chris@18 119 ];
Chris@18 120 }
Chris@18 121
Chris@18 122 return $translationStatus;
Chris@18 123 }
Chris@18 124
Chris@18 125 function printTranslationStatus($originalFilePath, $translationStatus, $verboseOutput)
Chris@18 126 {
Chris@18 127 printTitle($originalFilePath);
Chris@18 128 printTable($translationStatus, $verboseOutput);
Chris@18 129 echo PHP_EOL.PHP_EOL;
Chris@18 130 }
Chris@18 131
Chris@18 132 function extractLocaleFromFilePath($filePath)
Chris@18 133 {
Chris@18 134 $parts = explode('.', $filePath);
Chris@18 135
Chris@18 136 return $parts[count($parts) - 2];
Chris@18 137 }
Chris@18 138
Chris@18 139 function extractTranslationKeys($filePath)
Chris@18 140 {
Chris@18 141 $translationKeys = [];
Chris@18 142 $contents = new \SimpleXMLElement(file_get_contents($filePath));
Chris@18 143
Chris@18 144 foreach ($contents->file->body->{'trans-unit'} as $translationKey) {
Chris@18 145 $translationId = (string) $translationKey['id'];
Chris@18 146 $translationKey = (string) $translationKey->source;
Chris@18 147
Chris@18 148 $translationKeys[$translationId] = $translationKey;
Chris@18 149 }
Chris@18 150
Chris@18 151 return $translationKeys;
Chris@18 152 }
Chris@18 153
Chris@18 154 function printTitle($title)
Chris@18 155 {
Chris@18 156 echo $title.PHP_EOL;
Chris@18 157 echo str_repeat('=', strlen($title)).PHP_EOL.PHP_EOL;
Chris@18 158 }
Chris@18 159
Chris@18 160 function printTable($translations, $verboseOutput)
Chris@18 161 {
Chris@18 162 if (0 === count($translations)) {
Chris@18 163 echo 'No translations found';
Chris@18 164
Chris@18 165 return;
Chris@18 166 }
Chris@18 167 $longestLocaleNameLength = max(array_map('strlen', array_keys($translations)));
Chris@18 168
Chris@18 169 foreach ($translations as $locale => $translation) {
Chris@18 170 $isTranslationCompleted = $translation['translated'] === $translation['total'];
Chris@18 171 if ($isTranslationCompleted) {
Chris@18 172 textColorGreen();
Chris@18 173 }
Chris@18 174
Chris@18 175 echo sprintf('| Locale: %-'.$longestLocaleNameLength.'s | Translated: %d/%d', $locale, $translation['translated'], $translation['total']).PHP_EOL;
Chris@18 176
Chris@18 177 textColorNormal();
Chris@18 178
Chris@18 179 if (true === $verboseOutput && \count($translation['missingKeys']) > 0) {
Chris@18 180 echo str_repeat('-', 80).PHP_EOL;
Chris@18 181 echo '| Missing Translations:'.PHP_EOL;
Chris@18 182
Chris@18 183 foreach ($translation['missingKeys'] as $id => $content) {
Chris@18 184 echo sprintf('| (id=%s) %s', $id, $content).PHP_EOL;
Chris@18 185 }
Chris@18 186
Chris@18 187 echo str_repeat('-', 80).PHP_EOL;
Chris@18 188 }
Chris@18 189 }
Chris@18 190 }
Chris@18 191
Chris@18 192 function textColorGreen()
Chris@18 193 {
Chris@18 194 echo "\033[32m";
Chris@18 195 }
Chris@18 196
Chris@18 197 function textColorNormal()
Chris@18 198 {
Chris@18 199 echo "\033[0m";
Chris@18 200 }