Cleaned up and improved

rimi-itk · rimi-itk · commit 21152d3f776b · 2025-12-16T15:09:29.000+01:00
diff --git a/composer.json b/composer.json
@@ -12,15 +12,15 @@
     "require-dev": {
         "ergebnis/composer-normalize": "^2.48",
         "friendsofphp/php-cs-fixer": "^3.91",
+        "phpstan/phpstan": "^2.1",
         "phpunit/phpunit": "^12.5",
-        "vincentlanglet/twig-cs-fixer": "^3.11",
-        "phpstan/phpstan": "^2.1"
+        "vincentlanglet/twig-cs-fixer": "^3.11"
     },
     "autoload-dev": {
         "psr-4": {
             "Drupal\\drupal_translation_extractor\\": "src/",
-            "Drupal\\locale\\": "vendor/drupal/core/modules/locale/src/",
-            "Drupal\\drupal_translation_extractor\\Test\\": "tests/"
+            "Drupal\\drupal_translation_extractor\\Test\\": "tests/",
+            "Drupal\\locale\\": "vendor/drupal/core/modules/locale/src/"
         }
     },
     "config": {
diff --git a/drupal_translation_extractor.services.yml b/drupal_translation_extractor.services.yml
@@ -38,6 +38,8 @@ services:
 
   Drupal\drupal_translation_extractor\Translation\Dumper\PoFileDumper:
 
+  Drupal\drupal_translation_extractor\Translation\Reader\PoTranslationReader:
+
   drupal_translation_extractor.translation_writer:
     class: Symfony\Component\Translation\Writer\TranslationWriter
     calls:
@@ -48,3 +50,6 @@ services:
             '@Drupal\drupal_translation_extractor\Translation\Dumper\PoFileDumper',
           ],
         ]
+
+  drupal_translation_extractor.translation_reader:
+    class: Drupal\Component\Gettext\PoStreamReader
diff --git a/drush.services.yml b/drush.services.yml
@@ -2,10 +2,10 @@ services:
   drupal_translation_extractor.translation_extract:
     class: Drupal\drupal_translation_extractor\Command\TranslationExtractCommand
     arguments:
+      - "@drupal_translation_extractor.translation_writer"
+      - "@drupal_translation_extractor.translation_reader"
+      - "@drupal_translation_extractor.extractor"
       - "@extension.path.resolver"
       - "@locale.storage"
-      - "@drupal_translation_extractor.extractor"
-      - "@drupal_translation_extractor.translation_writer"
-      - "@Drupal\\drupal_translation_extractor\\Translation\\Dumper\\PoFileDumper"
     tags:
       - { name: console.command }
diff --git a/src/Command/TranslationExtractCommand.php b/src/Command/TranslationExtractCommand.php
@@ -4,7 +4,9 @@
 
 namespace Drupal\drupal_translation_extractor\Command;
 
+use Drupal\Component\Gettext\PoStreamReader;
 use Drupal\Core\Extension\ExtensionPathResolver;
+use Drupal\drupal_translation_extractor\Exception\InvalidArgumentException;
 use Drupal\drupal_translation_extractor\Translation\Dumper\PoItem;
 use Drupal\locale\StringStorageInterface;
 use Symfony\Component\Console\Attribute\AsCommand;
@@ -42,10 +44,11 @@ final class TranslationExtractCommand extends Command
     private const NO_FILL_PREFIX = "\0NoFill\0";
 
     public function __construct(
+        private readonly TranslationWriterInterface $writer,
+        private PoStreamReader $reader,
+        private readonly ExtractorInterface $extractor,
         private readonly ExtensionPathResolver $extensionPathResolver,
         private readonly StringStorageInterface $stringStorage,
-        private readonly ExtractorInterface $extractor,
-        private readonly TranslationWriterInterface $writer,
     ) {
         parent::__construct();
 
@@ -59,7 +62,6 @@ protected function configure(): void
         $this
           ->setDefinition([
               new InputArgument('locale', InputArgument::REQUIRED, 'The locale'),
-              // new InputArgument('bundle', InputArgument::OPTIONAL, 'The bundle name or directory where to load the messages'),
               new InputOption('prefix', null, InputOption::VALUE_REQUIRED, 'Override the default prefix', '__'),
               new InputOption('no-fill', null, InputOption::VALUE_NONE, 'Extract translation keys without filling in values'),
               new InputOption('format', null, InputOption::VALUE_REQUIRED, 'Override the default output format', 'po'),
@@ -70,36 +72,33 @@ protected function configure(): void
               new InputOption('sort', null, InputOption::VALUE_REQUIRED, 'Return list of messages sorted alphabetically'),
               new InputOption('as-tree', null, InputOption::VALUE_REQUIRED, 'Dump the messages as a tree-like structure: The given value defines the level where to switch to inline YAML'),
 
-              new InputOption('source', null, InputOption::VALUE_REQUIRED, 'Source path.'),
+              new InputArgument('source', InputArgument::REQUIRED, 'Source path.'),
               new InputOption('output', null, InputOption::VALUE_REQUIRED, 'Output path. Required if --force is specified.'),
+              new InputOption('fill-from-string-storage', null, InputOption::VALUE_NONE, 'Fill translations with values from string storage.'),
           ])
           ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command extracts translation strings from templates
-of a given bundle or the default translations directory. It can display them or merge
+of a given module or theme or another path. It can display them or merge
 the new ones into the translation files.
 
 When new translation strings are found it can automatically add a prefix to the translation
 message. However, if the <comment>--no-fill</comment> option is used, the <comment>--prefix</comment>
 option has no effect, since the translation values are left empty.
 
-Example running against a Bundle (AcmeBundle)
+Example running against a module (my_module)
 
-  <info>php %command.full_name% --dump-messages en AcmeBundle</info>
-  <info>php %command.full_name% --force --prefix="new_" fr AcmeBundle</info>
+  <info>php %command.full_name% --dump-messages en module:my_module</info>
+  <info>php %command.full_name% --force --prefix="new_" fr module:my_module</info>
 
-Example running against default messages directory
+Example running against a theme (my_theme)
 
-  <info>php %command.full_name% --dump-messages en</info>
-  <info>php %command.full_name% --force --prefix="new_" fr</info>
+  <info>php %command.full_name% --dump-messages en theme:my_theme</info>
+  <info>php %command.full_name% --force --prefix="new_" fr theme:my_theme</info>
 
 You can sort the output with the <comment>--sort</> flag:
 
-    <info>php %command.full_name% --dump-messages --sort=asc en AcmeBundle</info>
-    <info>php %command.full_name% --force --sort=desc fr</info>
-
-You can dump a tree-like structure using the yaml format with <comment>--as-tree</> flag:
-
-    <info>php %command.full_name% --force --format=yaml --as-tree=3 en AcmeBundle</info>
+    <info>php %command.full_name% --dump-messages --sort=asc en …</info>
+    <info>php %command.full_name% --force --sort=desc fr …</info>
 
 EOF
           )
@@ -152,9 +151,17 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $extractedCatalogue = $this->extractMessages($input->getArgument('locale'), $codePaths, $prefix);
 
         $io->comment('Loading translated messages...');
-        $currentCatalogue = true === $input->getOption('no-fill')
-          ? $extractedCatalogue
-          : $this->loadTranslatedMessages($extractedCatalogue);
+        $outputPath = $this->getOutputPath($input, $sourceInfo + [
+            'locale' => $input->getArgument('locale'),
+        ]);
+
+        $currentCatalogue = $this->loadCurrentMessages($input->getArgument('locale'), $outputPath);
+        if (true === $input->getOption('fill-from-string-storage')) {
+            // Merge in translations from string storage.
+            $currentCatalogue = new MergeOperation(
+                $this->loadTranslatedMessages($extractedCatalogue),
+                $currentCatalogue)->getResult();
+        }
 
         if (null !== $domain = $input->getOption('domain')) {
             if ('' === $domain) {
@@ -211,7 +218,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                     sort($list);
                 }
 
-                $io->section(\sprintf('Messages extracted for domain "<info>%s</info>" (%d message%s)', $domain, $domainMessagesCount, $domainMessagesCount > 1 ? 's' : ''));
+                $io->section(\sprintf('Messages extracted for context "<info>%s</info>" (%d message%s)', PoItem::formatContext($domain), $domainMessagesCount, $domainMessagesCount > 1 ? 's' : ''));
                 $io->listing($list);
 
                 $extractedMessagesCount += $domainMessagesCount;
@@ -238,9 +245,6 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $this->removeNoFillTranslations($operationResult);
             }
 
-            $outputPath = $this->getOutputPath($input, $sourceInfo + [
-                'locale' => $operationResult->getLocale(),
-            ]);
             $dumperOptions = [
                 'path' => dirname($outputPath),
                 'output_name' => basename($outputPath),
@@ -379,27 +383,53 @@ private function filterDuplicateTransPaths(array $transPaths): array
         return $filteredPaths;
     }
 
+    /**
+     * Load current messages from po file.
+     */
+    private function loadCurrentMessages(string $locale, string $path): MessageCatalogue
+    {
+        if (!is_file($path)) {
+            throw new InvalidArgumentException(sprintf('Message file "%s" does not exist.', $path));
+        }
+
+        $currentCatalogue = new MessageCatalogue($locale);
+        $this->reader->setURI($path);
+        $this->reader->open();
+        while ($item = $this->reader->readItem()) {
+            if (!empty($item->getTranslation())) {
+                $currentCatalogue->set(
+                    PoItem::joinStrings((array) $item->getSource()),
+                    PoItem::joinStrings((array) $item->getTranslation()),
+                    PoItem::fromContext($item->getContext()),
+                );
+            }
+        }
+        $this->reader->close();
+
+        return $currentCatalogue;
+    }
+
     private function loadTranslatedMessages(MessageCatalogue $extractedCatalogue): MessageCatalogue
     {
-        $currentCatalogue = new MessageCatalogue($extractedCatalogue->getLocale());
+        $translatedMessages = new MessageCatalogue($extractedCatalogue->getLocale());
 
         foreach ($extractedCatalogue->getDomains() as $domain) {
             $translations = $this->stringStorage->getTranslations([
-                'language' => $currentCatalogue->getLocale(),
+                'language' => $translatedMessages->getLocale(),
                 'context' => PoItem::formatContext($domain),
             ]);
             // Index by source
             $translations = array_column($translations, null, 'source');
             foreach ($extractedCatalogue->all($domain) as $source => $_) {
                 if ($translation = ($translations[$source] ?? null)) {
                     if ($string = $translation->getString()) {
-                        $currentCatalogue->set($source, $string, $domain);
+                        $translatedMessages->set($source, $string, $domain);
                     }
                 }
             }
         }
 
-        return $currentCatalogue;
+        return $translatedMessages;
     }
 
     private function removeNoFillTranslations(MessageCatalogueInterface $operation): void
@@ -421,15 +451,25 @@ private function removeNoFillTranslations(MessageCatalogueInterface $operation):
     private function getRootCodePaths(InputInterface $input): array
     {
         $info = [];
-        $source = $input->getOption('source');
+        $source = $input->getArgument('source');
+
+        if (empty($source)) {
+            throw new InvalidArgumentException('Argument "source" is required.');
+        }
 
         // Expand module and theme paths.
         $source = preg_replace_callback(
             '/(module|theme):([a-z0-9_]+)/i',
             function (array $matches) use (&$info): string {
                 $info[$matches[1]] = $matches[2];
 
-                return $this->extensionPathResolver->getPath($matches[1], $matches[2]);
+                $path = $this->extensionPathResolver->getPath($matches[1], $matches[2]);
+
+                if (empty($path)) {
+                    throw new InvalidArgumentException(sprintf('Invalid %s: %s', $matches[1], $matches[2]));
+                }
+
+                return $path;
             },
             $source,
         );
diff --git a/src/Translation/Dumper/PoItem.php b/src/Translation/Dumper/PoItem.php
@@ -19,9 +19,13 @@ public function __toString()
     {
         $string = parent::__toString();
 
+        $flags = [];
         if ($this->fuzzy) {
+            $flags[] = 'fuzzy';
+        }
+        if (!empty($flags)) {
             // https://www.gnu.org/savannah-checkouts/gnu/gettext/manual/gettext.html#Fuzzy-Entries
-            $string = '#, fuzzy'."\n".$string;
+            $string = '#, '.implode(',', $flags)."\n".$string;
         }
 
         return $string;
@@ -45,6 +49,11 @@ public static function splitStrings(string $string, int $numberOfStrings = 1): a
         return $strings;
     }
 
+    public static function fromContext(?string $context): string
+    {
+        return $context ?: self::NO_CONTEXT;
+    }
+
     public static function formatContext(?string $domain): string
     {
         return (null === $domain || self::NO_CONTEXT === $domain) ? '' : $domain;
diff --git a/src/Translation/Reader/PoTranslationReader.php b/src/Translation/Reader/PoTranslationReader.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace Drupal\drupal_translation_extractor\Translation\Reader;
+
+use Symfony\Component\Translation\Loader\PoFileLoader;
+use Symfony\Component\Translation\MessageCatalogue;
+use Symfony\Component\Translation\Reader\TranslationReaderInterface;
+
+class PoTranslationReader implements TranslationReaderInterface
+{
+    public function read(string $directory, MessageCatalogue $catalogue): void
+    {
+        $loader = new PoFileLoader();
+        $loader->load($directory, $catalogue->getLocale());
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -19,9 +19,13 @@ public function __toString()`
`19`	`19`	`{`
`20`	`20`	`$string = parent::__toString();`
`21`	`21`
	`22`	`+ $flags = [];`
`22`	`23`	`if ($this->fuzzy) {`
	`24`	`+ $flags[] = 'fuzzy';`
	`25`	`+ }`
	`26`	`+ if (!empty($flags)) {`
`23`	`27`	`// https://www.gnu.org/savannah-checkouts/gnu/gettext/manual/gettext.html#Fuzzy-Entries`
`24`		`- $string = '#, fuzzy'."\n".$string;`
	`28`	`+ $string = '#, '.implode(',', $flags)."\n".$string;`
`25`	`29`	`}`
`26`	`30`
`27`	`31`	`return $string;`
`@@ -45,6 +49,11 @@ public static function splitStrings(string $string, int $numberOfStrings = 1): a`
`45`	`49`	`return $strings;`
`46`	`50`	`}`
`47`	`51`
	`52`	`+ public static function fromContext(?string $context): string`
	`53`	`+ {`
	`54`	`+ return $context ?: self::NO_CONTEXT;`
	`55`	`+ }`
	`56`	`+`
`48`	`57`	`public static function formatContext(?string $domain): string`
`49`	`58`	`{`
`50`	`59`	`return (null === $domain \|\| self::NO_CONTEXT === $domain) ? '' : $domain;`