UtilTranslationsExtract::dumpMessages() - Code Metrics - Inspection of "feat: translations extraction command" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#2045)

by Arnaud

created 2025-02-05 00:38 UTC

UtilTranslationsExtract::dumpMessages() A

↳ Parent: UtilTranslationsExtract

Complexity

Conditions	3
Paths	2

Size

Total Lines	26
Code Lines	20

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	20
nc	2
nop	1
dl	0
loc	26
rs	9.6
c	0
b	0
f	0

<?php

declare(strict_types=1);

/*
 * This file is part of Cecil.
 *
 * Copyright (c) Arnaud Ligny <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Cecil\Command;

use Cecil\Exception\RuntimeException;
use Cecil\Renderer\Extension\Core as CoreExtension;
use Symfony\Bridge\Twig\Extension\TranslationExtension;
use Symfony\Bridge\Twig\Translation\TwigExtractor;
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 Symfony\Component\Translation\Catalogue\OperationInterface;
use Symfony\Component\Translation\Catalogue\MergeOperation;
use Symfony\Component\Translation\Catalogue\TargetOperation;
use Symfony\Component\Translation\Dumper\PoFileDumper;
use Symfony\Component\Translation\Dumper\YamlFileDumper;
use Symfony\Component\Translation\MessageCatalogue;
use Symfony\Component\Translation\MessageCatalogueInterface;
use Symfony\Component\Translation\Reader\TranslationReader;
use Symfony\Component\Translation\Writer\TranslationWriter;
use Symfony\Component\Translation\Loader\PoFileLoader;
use Symfony\Component\Translation\Loader\YamlFileLoader;
use Twig\Environment;
use Twig\Loader\FilesystemLoader;

class UtilTranslationsExtract extends AbstractCommand
{
    private TranslationWriter $writer;
    private TranslationReader $reader;
    private TwigExtractor $extractor;

    protected function configure(): void
    {
        $this
            ->setName('util:translations:extract')
            ->setDescription('Extracts translations from layouts')
            ->setDefinition([
                new InputArgument('path', InputArgument::OPTIONAL, 'Use the given path as working directory'),
                new InputOption('locale', null, InputOption::VALUE_OPTIONAL, 'The locale', 'fr'),
                new InputOption('show', null, InputOption::VALUE_NONE, 'Should the messages be displayed in the console'),
                new InputOption('save', null, InputOption::VALUE_NONE, 'Should the extract be done'),
                new InputOption('format', null, InputOption::VALUE_OPTIONAL, 'Override the default output format', 'po'),
                new InputOption('theme', null, InputOption::VALUE_OPTIONAL, 'Use if you want to translate a theme layout'),
            ])
            ->setHelp(
                <<<'EOF'
The <info>%command.name%</info> command extracts translation strings from your layouts.
It can display them or merge the new ones into the translation file.
When new translation strings are found it automatically add a <info>NEW_</info> prefix to the translation message.

Example running against working directory:

  <info>php %command.full_name% --show</info>
  <info>php %command.full_name% --save --locale=en</info>

You can extract translations from a given theme with <comment>--theme</> option:

  <info>php %command.full_name% --show --save --theme=hyde</info>
EOF
            )
        ;
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $config = $this->getBuilder()->getConfig();
        $layoutsPath = $config->getLayoutsPath();
        $translationsPath = $config->getTranslationsPath();

        $format = $input->getOption('format');

        $this->initializeTranslationComponents();

        $this->checkOptions($input, $format);

        if ($input->getOption('theme')) {
            $layoutsPath = $config->getThemeDirPath($input->getOption('theme'));
        }

        $this->initializeTwigExtractor($layoutsPath);

        $output->writeln(\sprintf('Generating "<info>%s</info>" translation file', $input->getOption('locale')));

        $output->writeln('Parsing templates...');
        $extractedCatalogue = $this->extractMessages($input->getOption('locale'), $layoutsPath, 'NEW_');

        $output->writeln('Loading translation file...');
        $currentCatalogue = $this->loadCurrentMessages($input->getOption('locale'), $translationsPath);

        try {
            $operation = $input->getOption('theme') ? new MergeOperation($currentCatalogue, $extractedCatalogue) : new TargetOperation($currentCatalogue, $extractedCatalogue);
        } catch (\Exception $e) {
            throw new RuntimeException($e->getMessage());
        }

        // show compiled list of messages
        if (true === $input->getOption('show')) {
            try {
                $this->dumpMessages($operation);
            } catch (\Exception $e) {
                throw new RuntimeException('Error while displaying messages: ' . $e->getMessage());
            }
        }

        // save the file
        if (true === $input->getOption('save')) {
            try {
                $this->saveDump(
                    $operation->getResult(),
                    $format,
                    $translationsPath,
                    $config->getLanguageDefault()
                );
            } catch (\InvalidArgumentException $e) {
                throw new RuntimeException('Error while saving translation file: ' . $e->getMessage());
            }
        }

        return 0;
    }

    private function checkOptions(InputInterface $input, $format): void
    {
        if (true !== $input->getOption('save') && true !== $input->getOption('show')) {
            throw new RuntimeException('You must choose to display (`--show`) and/or save (`--save`) the translations');
        }
        if (!\in_array($format, $this->writer->getFormats(), true)) {
            throw new RuntimeException(\sprintf('Supported formats are: %s', implode(', ', $this->writer->getFormats())));
        }
    }

    private function initializeTranslationComponents(): void
    {
        // readers
        $this->reader = new TranslationReader();
        $this->reader->addLoader('po', new PoFileLoader());
        $this->reader->addLoader('yaml', new YamlFileLoader());
        // writers
        $this->writer = new TranslationWriter();
        $this->writer->addDumper('po', new PoFileDumper());
        $this->writer->addDumper('yaml', new YamlFileDumper());
    }

    private function initializeTwigExtractor(string $layoutsPath): void
    {
        $twig = new Environment(new FilesystemLoader($layoutsPath));
        $twig->addExtension(new TranslationExtension());
        $twig->addExtension(new CoreExtension($this->getBuilder()));
        $this->extractor = new TwigExtractor($twig);
    }

    private function extractMessages(string $locale, string $codePath, string $prefix): MessageCatalogue
    {
        $extractedCatalogue = new MessageCatalogue($locale);
        $this->extractor->setPrefix($prefix);
        if (is_dir($codePath) || is_file($codePath)) {
            $this->extractor->extract($codePath, $extractedCatalogue);
        }

        return $extractedCatalogue;
    }

    private function loadCurrentMessages(string $locale, string $translationsPath): MessageCatalogue
    {
        $currentCatalogue = new MessageCatalogue($locale);
        if (is_dir($translationsPath)) {
            $this->reader->read($translationsPath, $currentCatalogue);
        }

        return $currentCatalogue;
    }

    private function saveDump(MessageCatalogueInterface $messageCatalogue, string $format, string $translationsPath, string $defaultLocale): void
    {
        $this->io->writeln('Writing file...');
        $this->writer->write($messageCatalogue, $format, [
            'path' => $translationsPath,
            'default_locale' => $defaultLocale,
        ]);
        $this->io->success('Translation file have been successfully updated.');
    }

    private function dumpMessages(OperationInterface $operation): void
    {
        $messagesCount = 0;
        $this->io->newLine();
        foreach ($operation->getDomains() as $domain) {
            $newKeys = array_keys($operation->getNewMessages($domain));
            $allKeys = array_keys($operation->getMessages($domain));
            $list = array_merge(
                array_diff($allKeys, $newKeys),
                array_map(fn ($key) => \sprintf('<fg=green>%s</>', $key), $newKeys),
                array_map(
                    fn ($key) => \sprintf('<fg=red>%s</>', $key),
                    array_keys($operation->getObsoleteMessages($domain))
                )
            );
            $domainMessagesCount = \count($list);
            sort($list);
            $this->io->listing($list);
            $messagesCount += $domainMessagesCount;
        }

        $this->io->success(
            \sprintf(
                '%d message%s successfully extracted.',
                $messagesCount,
                $messagesCount > 1 ? 's were' : ' was'
            )
        );
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of Cecil.
7			*
8			* Copyright (c) Arnaud Ligny <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Cecil\Command;
15
16			use Cecil\Exception\RuntimeException;
17			use Cecil\Renderer\Extension\Core as CoreExtension;
18			use Symfony\Bridge\Twig\Extension\TranslationExtension;
19			use Symfony\Bridge\Twig\Translation\TwigExtractor;
20			use Symfony\Component\Console\Input\InputArgument;
21			use Symfony\Component\Console\Input\InputInterface;
22			use Symfony\Component\Console\Input\InputOption;
23			use Symfony\Component\Console\Output\OutputInterface;
24			use Symfony\Component\Translation\Catalogue\OperationInterface;
25			use Symfony\Component\Translation\Catalogue\MergeOperation;
26			use Symfony\Component\Translation\Catalogue\TargetOperation;
27			use Symfony\Component\Translation\Dumper\PoFileDumper;
28			use Symfony\Component\Translation\Dumper\YamlFileDumper;
29			use Symfony\Component\Translation\MessageCatalogue;
30			use Symfony\Component\Translation\MessageCatalogueInterface;
31			use Symfony\Component\Translation\Reader\TranslationReader;
32			use Symfony\Component\Translation\Writer\TranslationWriter;
33			use Symfony\Component\Translation\Loader\PoFileLoader;
34			use Symfony\Component\Translation\Loader\YamlFileLoader;
35			use Twig\Environment;
36			use Twig\Loader\FilesystemLoader;
37
38			class UtilTranslationsExtract extends AbstractCommand
39			{
40			private TranslationWriter $writer;
41			private TranslationReader $reader;
42			private TwigExtractor $extractor;
43
44			protected function configure(): void
45			{
46			$this
47			->setName('util:translations:extract')
48			->setDescription('Extracts translations from layouts')
49			->setDefinition([
50			new InputArgument('path', InputArgument::OPTIONAL, 'Use the given path as working directory'),
51			new InputOption('locale', null, InputOption::VALUE_OPTIONAL, 'The locale', 'fr'),
52			new InputOption('show', null, InputOption::VALUE_NONE, 'Should the messages be displayed in the console'),
53			new InputOption('save', null, InputOption::VALUE_NONE, 'Should the extract be done'),
54			new InputOption('format', null, InputOption::VALUE_OPTIONAL, 'Override the default output format', 'po'),
55			new InputOption('theme', null, InputOption::VALUE_OPTIONAL, 'Use if you want to translate a theme layout'),
56			])
57			->setHelp(
58			<<<'EOF'
59			The <info>%command.name%</info> command extracts translation strings from your layouts.
60			It can display them or merge the new ones into the translation file.
61			When new translation strings are found it automatically add a <info>NEW_</info> prefix to the translation message.
62
63			Example running against working directory:
64
65			<info>php %command.full_name% --show</info>
66			<info>php %command.full_name% --save --locale=en</info>
67
68			You can extract translations from a given theme with <comment>--theme</> option:
69
70			<info>php %command.full_name% --show --save --theme=hyde</info>
71			EOF
72			)
73			;
74			}
75
76			protected function execute(InputInterface $input, OutputInterface $output): int
77			{
78			$config = $this->getBuilder()->getConfig();
79			$layoutsPath = $config->getLayoutsPath();
80			$translationsPath = $config->getTranslationsPath();
81
82			$format = $input->getOption('format');
83
84			$this->initializeTranslationComponents();
85
86			$this->checkOptions($input, $format);
87
88			if ($input->getOption('theme')) {
89			$layoutsPath = $config->getThemeDirPath($input->getOption('theme'));
90			}
91
92			$this->initializeTwigExtractor($layoutsPath);
93
94			$output->writeln(\sprintf('Generating "<info>%s</info>" translation file', $input->getOption('locale')));
95
96			$output->writeln('Parsing templates...');
97			$extractedCatalogue = $this->extractMessages($input->getOption('locale'), $layoutsPath, 'NEW_');
98
99			$output->writeln('Loading translation file...');
100			$currentCatalogue = $this->loadCurrentMessages($input->getOption('locale'), $translationsPath);
101
102			try {
103			$operation = $input->getOption('theme') ? new MergeOperation($currentCatalogue, $extractedCatalogue) : new TargetOperation($currentCatalogue, $extractedCatalogue);
104			} catch (\Exception $e) {
105			throw new RuntimeException($e->getMessage());
106			}
107
108			// show compiled list of messages
109			if (true === $input->getOption('show')) {
110			try {
111			$this->dumpMessages($operation);
112			} catch (\Exception $e) {
113			throw new RuntimeException('Error while displaying messages: ' . $e->getMessage());
114			}
115			}
116
117			// save the file
118			if (true === $input->getOption('save')) {
119			try {
120			$this->saveDump(
121			$operation->getResult(),
122			$format,
123			$translationsPath,
124			$config->getLanguageDefault()
125			);
126			} catch (\InvalidArgumentException $e) {
127			throw new RuntimeException('Error while saving translation file: ' . $e->getMessage());
128			}
129			}
130
131			return 0;
132			}
133
134			private function checkOptions(InputInterface $input, $format): void
135			{
136			if (true !== $input->getOption('save') && true !== $input->getOption('show')) {
137			throw new RuntimeException('You must choose to display (`--show`) and/or save (`--save`) the translations');
138			}
139			if (!\in_array($format, $this->writer->getFormats(), true)) {
140			throw new RuntimeException(\sprintf('Supported formats are: %s', implode(', ', $this->writer->getFormats())));
141			}
142			}
143
144			private function initializeTranslationComponents(): void
145			{
146			// readers
147			$this->reader = new TranslationReader();
148			$this->reader->addLoader('po', new PoFileLoader());
149			$this->reader->addLoader('yaml', new YamlFileLoader());
150			// writers
151			$this->writer = new TranslationWriter();
152			$this->writer->addDumper('po', new PoFileDumper());
153			$this->writer->addDumper('yaml', new YamlFileDumper());
154			}
155
156			private function initializeTwigExtractor(string $layoutsPath): void
157			{
158			$twig = new Environment(new FilesystemLoader($layoutsPath));
159			$twig->addExtension(new TranslationExtension());
160			$twig->addExtension(new CoreExtension($this->getBuilder()));
161			$this->extractor = new TwigExtractor($twig);
162			}
163
164			private function extractMessages(string $locale, string $codePath, string $prefix): MessageCatalogue
165			{
166			$extractedCatalogue = new MessageCatalogue($locale);
167			$this->extractor->setPrefix($prefix);
168			if (is_dir($codePath) \|\| is_file($codePath)) {
169			$this->extractor->extract($codePath, $extractedCatalogue);
170			}
171
172			return $extractedCatalogue;
173			}
174
175			private function loadCurrentMessages(string $locale, string $translationsPath): MessageCatalogue
176			{
177			$currentCatalogue = new MessageCatalogue($locale);
178			if (is_dir($translationsPath)) {
179			$this->reader->read($translationsPath, $currentCatalogue);
180			}
181
182			return $currentCatalogue;
183			}
184
185			private function saveDump(MessageCatalogueInterface $messageCatalogue, string $format, string $translationsPath, string $defaultLocale): void
186			{
187			$this->io->writeln('Writing file...');
188			$this->writer->write($messageCatalogue, $format, [
189			'path' => $translationsPath,
190			'default_locale' => $defaultLocale,
191			]);
192			$this->io->success('Translation file have been successfully updated.');
193			}
194
195			private function dumpMessages(OperationInterface $operation): void
196			{
197			$messagesCount = 0;
198			$this->io->newLine();
199			foreach ($operation->getDomains() as $domain) {
200			$newKeys = array_keys($operation->getNewMessages($domain));
201			$allKeys = array_keys($operation->getMessages($domain));
202			$list = array_merge(
203			array_diff($allKeys, $newKeys),
204			array_map(fn ($key) => \sprintf('<fg=green>%s</>', $key), $newKeys),
205			array_map(
206			fn ($key) => \sprintf('<fg=red>%s</>', $key),
207			array_keys($operation->getObsoleteMessages($domain))
208			)
209			);
210			$domainMessagesCount = \count($list);
211			sort($list);
212			$this->io->listing($list);
213			$messagesCount += $domainMessagesCount;
214			}
215
216			$this->io->success(
217			\sprintf(
218			'%d message%s successfully extracted.',
219			$messagesCount,
220			$messagesCount > 1 ? 's were' : ' was'
221			)
222			);
223			}
224			}
225

Cecilapp / Cecil

Pull Request — master (#2045)

UtilTranslationsExtract::dumpMessages() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like