DownloadCommand::cleanParameters() - Code Metrics - Inspection of "Add support for arbitrary options to StorageInterf..." - php-translation/symfony-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6a0e64...33e708 )

by Tobias

created 2020-01-18 11:46 UTC

DownloadCommand::cleanParameters() A

↳ Parent: DownloadCommand

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	12
Ratio	100 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	12
loc	12
ccs	0
cts	9
cp	0
rs	9.8666
c	0
b	0
f	0
cc	2
nc	2
nop	1
crap	6

<?php

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

namespace Translation\Bundle\Command;

use Symfony\Component\Console\Command\Command;
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\Console\Style\SymfonyStyle;
use Symfony\Component\Finder\Finder;
use Translation\Bundle\Catalogue\CatalogueWriter;
use Translation\Bundle\Service\CacheClearer;
use Translation\Bundle\Service\ConfigurationManager;
use Translation\Bundle\Service\StorageManager;

/**
 * @author Tobias Nyholm <[email protected]>
 */
class DownloadCommand extends Command
{
    use BundleTrait;
    use StorageTrait;

    protected static $defaultName = 'translation:download';

    private $configurationManager;
    private $cacheCleaner;
    private $catalogueWriter;

    public function __construct(
        StorageManager $storageManager,
        ConfigurationManager $configurationManager,
        CacheClearer $cacheCleaner,
        CatalogueWriter $catalogueWriter
    ) {
        $this->storageManager = $storageManager;
        $this->configurationManager = $configurationManager;
        $this->cacheCleaner = $cacheCleaner;
        $this->catalogueWriter = $catalogueWriter;

        parent::__construct();
    }

    protected function configure(): void

    {
        $this
            ->setName(self::$defaultName)
            ->setDescription('Replace local messages with messages from remote')
            ->setHelp(<<<EOT
The <info>%command.name%</info> will erase all your local translations and replace them with translations downloaded from the remote.
EOT
            )
            ->addArgument('configuration', InputArgument::OPTIONAL, 'The configuration to use', 'default')
            ->addOption('cache', null, InputOption::VALUE_NONE, '[DEPRECATED] Cache is now automatically cleared when translations have changed.')
            ->addOption('bundle', 'b', InputOption::VALUE_REQUIRED, 'The bundle you want update translations from.')
            ->addOption('export-config', 'exconf', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_OPTIONAL, 'Options to send to the StorageInterface::export() function. Ie, when downloading. Example: --export-config foo:bar', [])
        ;
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $io = new SymfonyStyle($input, $output);

        if ($input->getOption('cache')) {
            $message = 'The --cache option is deprecated as it\'s now the default behaviour of this command.';

            $io->note($message);
            @\trigger_error($message, E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        }

        $configName = $input->getArgument('configuration');
        $config = $this->configurationManager->getConfiguration($configName);
        $storage = $this->getStorage($configName);

        $this->configureBundleDirs($input, $config);

        $translationsDirectory = $config->getOutputDir();
        $md5BeforeDownload = $this->hashDirectory($translationsDirectory);

        $exportOptions = $this->cleanParameters($input->getOption('export-config'));
        $catalogues = $storage->download($exportOptions);
        $this->catalogueWriter->writeCatalogues($config, $catalogues);

        $translationsCount = 0;
        foreach ($catalogues as $locale => $catalogue) {
            foreach ($catalogue->all() as $domain => $messages) {
                $translationsCount += \count($messages);
            }
        }

        $io->text("<info>$translationsCount</info> translations have been downloaded.");

        $md5AfterDownload = $this->hashDirectory($translationsDirectory);

        if ($md5BeforeDownload !== $md5AfterDownload) {
            $io->success('Translations updated successfully!');
            $this->cacheCleaner->clearAndWarmUp();
        } else {
            $io->success('All translations were up to date.');
        }

        return 0;
    }

    /**
     * @return bool|string
     */
    private function hashDirectory(string $directory)
    {
        if (!\is_dir($directory)) {
            return false;
        }

        $finder = new Finder();
        $finder->files()->in($directory)->notName('/~$/')->sortByName();

        $hash = \hash_init('md5');
        foreach ($finder as $file) {
            \hash_update_file($hash, $file->getRealPath());
        }

        return \hash_final($hash);
    }

    public function cleanParameters(array $raw)

    {
        $config = [];

        foreach ($raw as $string) {
            // Assert $string looks like "foo:bar"
            list($key, $value) = \explode(':', $string, 2);
            $config[$key][] = $value;
        }

        return $config;
    }
}


1		<?php
2
3		/*
4		* This file is part of the PHP Translation package.
5		*
6		* (c) PHP Translation team <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Translation\Bundle\Command;
13
14		use Symfony\Component\Console\Command\Command;
15		use Symfony\Component\Console\Input\InputArgument;
16		use Symfony\Component\Console\Input\InputInterface;
17		use Symfony\Component\Console\Input\InputOption;
18		use Symfony\Component\Console\Output\OutputInterface;
19		use Symfony\Component\Console\Style\SymfonyStyle;
20		use Symfony\Component\Finder\Finder;
21		use Translation\Bundle\Catalogue\CatalogueWriter;
22		use Translation\Bundle\Service\CacheClearer;
23		use Translation\Bundle\Service\ConfigurationManager;
24		use Translation\Bundle\Service\StorageManager;
25
26		/**
27		* @author Tobias Nyholm <[email protected]>
28		*/
29		class DownloadCommand extends Command
30		{
31		use BundleTrait;
32		use StorageTrait;
33
34		protected static $defaultName = 'translation:download';
35
36		private $configurationManager;
37		private $cacheCleaner;
38		private $catalogueWriter;
39
40		public function __construct(
41		StorageManager $storageManager,
42		ConfigurationManager $configurationManager,
43		CacheClearer $cacheCleaner,
44		CatalogueWriter $catalogueWriter
45		) {
46		$this->storageManager = $storageManager;
47		$this->configurationManager = $configurationManager;
48		$this->cacheCleaner = $cacheCleaner;
49		$this->catalogueWriter = $catalogueWriter;
50
51		parent::__construct();
52		}
53
54	View Code Duplication	protected function configure(): void
		0 ignored issues – show Duplication introduced 2018-02-12 10:44 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
55		{
56		$this
57		->setName(self::$defaultName)
58		->setDescription('Replace local messages with messages from remote')
59		->setHelp(<<<EOT
60		The <info>%command.name%</info> will erase all your local translations and replace them with translations downloaded from the remote.
61		EOT
62		)
63		->addArgument('configuration', InputArgument::OPTIONAL, 'The configuration to use', 'default')
64		->addOption('cache', null, InputOption::VALUE_NONE, '[DEPRECATED] Cache is now automatically cleared when translations have changed.')
65		->addOption('bundle', 'b', InputOption::VALUE_REQUIRED, 'The bundle you want update translations from.')
66		->addOption('export-config', 'exconf', InputOption::VALUE_IS_ARRAY \| InputOption::VALUE_OPTIONAL, 'Options to send to the StorageInterface::export() function. Ie, when downloading. Example: --export-config foo:bar', [])
67		;
68		}
69
70		protected function execute(InputInterface $input, OutputInterface $output): int
71		{
72		$io = new SymfonyStyle($input, $output);
73
74		if ($input->getOption('cache')) {
75		$message = 'The --cache option is deprecated as it\'s now the default behaviour of this command.';
76
77		$io->note($message);
78		@\trigger_error($message, E_USER_DEPRECATED);
		0 ignored issues – show Security Best Practice introduced 2019-12-29 10:57 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
79		}
80
81		$configName = $input->getArgument('configuration');
82		$config = $this->configurationManager->getConfiguration($configName);
83		$storage = $this->getStorage($configName);
84
85		$this->configureBundleDirs($input, $config);
86
87		$translationsDirectory = $config->getOutputDir();
88		$md5BeforeDownload = $this->hashDirectory($translationsDirectory);
89
90		$exportOptions = $this->cleanParameters($input->getOption('export-config'));
91		$catalogues = $storage->download($exportOptions);
92		$this->catalogueWriter->writeCatalogues($config, $catalogues);
93
94		$translationsCount = 0;
95		foreach ($catalogues as $locale => $catalogue) {
96		foreach ($catalogue->all() as $domain => $messages) {
97		$translationsCount += \count($messages);
98		}
99		}
100
101		$io->text("<info>$translationsCount</info> translations have been downloaded.");
102
103		$md5AfterDownload = $this->hashDirectory($translationsDirectory);
104
105		if ($md5BeforeDownload !== $md5AfterDownload) {
106		$io->success('Translations updated successfully!');
107		$this->cacheCleaner->clearAndWarmUp();
108		} else {
109		$io->success('All translations were up to date.');
110		}
111
112		return 0;
113		}
114
115		/**
116		* @return bool\|string
117		*/
118		private function hashDirectory(string $directory)
119		{
120		if (!\is_dir($directory)) {
121		return false;
122		}
123
124		$finder = new Finder();
125		$finder->files()->in($directory)->notName('/~$/')->sortByName();
126
127		$hash = \hash_init('md5');
128		foreach ($finder as $file) {
129		\hash_update_file($hash, $file->getRealPath());
130		}
131
132		return \hash_final($hash);
133		}
134
135	View Code Duplication	public function cleanParameters(array $raw)
		0 ignored issues – show Duplication introduced 2020-01-18 11:50 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
136		{
137		$config = [];
138
139		foreach ($raw as $string) {
140		// Assert $string looks like "foo:bar"
141		list($key, $value) = \explode(':', $string, 2);
142		$config[$key][] = $value;
143		}
144
145		return $config;
146		}
147		}
148

php-translation / symfony-bundle

Push — master ( 6a0e64...33e708 )

DownloadCommand::cleanParameters() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like