ExtractCommand::execute() - Code Metrics - Inspection of "Merge pull request #355 from ker0x/get-configurati..." - php-translation/symfony-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 082c1c...ceccbd )

by Olivier

created 2019-12-03 08:58 UTC

ExtractCommand::execute() A

↳ Parent: ExtractCommand

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
dl	0
loc	47
ccs	0
cts	35
cp	0
rs	9.1563
c	0
b	0
f	0
cc	4
nc	4
nop	2
crap	20

<?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\CatalogueCounter;
use Translation\Bundle\Catalogue\CatalogueFetcher;
use Translation\Bundle\Catalogue\CatalogueWriter;
use Translation\Bundle\Model\Configuration;
use Translation\Bundle\Service\ConfigurationManager;
use Translation\Bundle\Service\Importer;
use Translation\Extractor\Model\Error;

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

    protected static $defaultName = 'translation:extract';

    /**
     * @var CatalogueFetcher
     */
    private $catalogueFetcher;

    /**
     * @var CatalogueWriter
     */
    private $catalogueWriter;

    /**
     * @var CatalogueCounter
     */
    private $catalogueCounter;

    /**
     * @var Importer
     */
    private $importer;

    /**
     * @var ConfigurationManager
     */
    private $configurationManager;

    public function __construct(
        CatalogueFetcher $catalogueFetcher,
        CatalogueWriter $catalogueWriter,
        CatalogueCounter $catalogueCounter,
        Importer $importer,
        ConfigurationManager $configurationManager
    ) {
        $this->catalogueFetcher = $catalogueFetcher;
        $this->catalogueWriter = $catalogueWriter;
        $this->catalogueCounter = $catalogueCounter;
        $this->importer = $importer;
        $this->configurationManager = $configurationManager;

        parent::__construct();
    }

    protected function configure(): void

    {
        $this
            ->setName(self::$defaultName)
            ->setDescription('Extract translations from source code.')
            ->addArgument('configuration', InputArgument::OPTIONAL, 'The configuration to use', 'default')
            ->addArgument('locale', InputArgument::OPTIONAL, 'The locale to use. If omitted, we use all configured locales.', false)
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->addOption('hide-errors', null, InputOption::VALUE_NONE, 'If we should print error or not')
            ->addOption('bundle', 'b', InputOption::VALUE_REQUIRED, 'The bundle you want extract translations from.')
        ;
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $configName = $input->getArgument('configuration');
        $config = $this->configurationManager->getConfiguration($configName);

        $locales = [];
        if ($inputLocale = $input->getArgument('locale')) {
            $locales = [$inputLocale];
        }

        $catalogues = $this->catalogueFetcher->getCatalogues($config, $locales);
        $this->configureBundleDirs($input, $config);
        $finder = $this->getConfiguredFinder($config);

        $result = $this->importer->extractToCatalogues($finder, $catalogues, [
            'blacklist_domains' => $config->getBlacklistDomains(),
            'whitelist_domains' => $config->getWhitelistDomains(),
            'project_root' => $config->getProjectRoot(),
        ]);
        $errors = $result->getErrors();

        $this->catalogueWriter->writeCatalogues($config, $result->getMessageCatalogues());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $definedBefore = $this->catalogueCounter->getNumberOfDefinedMessages($catalogues[0]);
        $definedAfter = $this->catalogueCounter->getNumberOfDefinedMessages($result->getMessageCatalogues()[0]);

        /*
         * Print results
         */
        $io = new SymfonyStyle($input, $output);
        $io->table(['Type', 'Count'], [
            ['Total defined messages', $definedAfter],
            ['New messages', $definedAfter - $definedBefore],
            ['Errors', \count($errors)],
        ]);

        if (!$input->getOption('hide-errors')) {
            /** @var Error $error */
            foreach ($errors as $error) {
                $io->error(
                    \sprintf("%s\nLine: %s\nMessage: %s", $error->getPath(), $error->getLine(), $error->getMessage())
                );
            }
        }

        return 0;
    }

    private function getConfiguredFinder(Configuration $config): Finder
    {
        $finder = new Finder();
        $finder->in($config->getDirs());

        foreach ($config->getExcludedDirs() as $exclude) {
            $finder->notPath($exclude);
        }

        foreach ($config->getExcludedNames() as $exclude) {
            $finder->notName($exclude);
        }

        return $finder;
    }
}


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\CatalogueCounter;
22		use Translation\Bundle\Catalogue\CatalogueFetcher;
23		use Translation\Bundle\Catalogue\CatalogueWriter;
24		use Translation\Bundle\Model\Configuration;
25		use Translation\Bundle\Service\ConfigurationManager;
26		use Translation\Bundle\Service\Importer;
27		use Translation\Extractor\Model\Error;
28
29		/**
30		* @author Tobias Nyholm <[email protected]>
31		*/
32		class ExtractCommand extends Command
33		{
34		use BundleTrait;
35
36		protected static $defaultName = 'translation:extract';
37
38		/**
39		* @var CatalogueFetcher
40		*/
41		private $catalogueFetcher;
42
43		/**
44		* @var CatalogueWriter
45		*/
46		private $catalogueWriter;
47
48		/**
49		* @var CatalogueCounter
50		*/
51		private $catalogueCounter;
52
53		/**
54		* @var Importer
55		*/
56		private $importer;
57
58		/**
59		* @var ConfigurationManager
60		*/
61		private $configurationManager;
62
63		public function __construct(
64		CatalogueFetcher $catalogueFetcher,
65		CatalogueWriter $catalogueWriter,
66		CatalogueCounter $catalogueCounter,
67		Importer $importer,
68		ConfigurationManager $configurationManager
69		) {
70		$this->catalogueFetcher = $catalogueFetcher;
71		$this->catalogueWriter = $catalogueWriter;
72		$this->catalogueCounter = $catalogueCounter;
73		$this->importer = $importer;
74		$this->configurationManager = $configurationManager;
75
76		parent::__construct();
77		}
78
79	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...
80		{
81		$this
82		->setName(self::$defaultName)
83		->setDescription('Extract translations from source code.')
84		->addArgument('configuration', InputArgument::OPTIONAL, 'The configuration to use', 'default')
85		->addArgument('locale', InputArgument::OPTIONAL, 'The locale to use. If omitted, we use all configured locales.', false)
		0 ignored issues – show Documentation introduced 2018-12-27 08:00 UTC by Report Bug Copy Issue Report `false` is of type `boolean`, but the function expects a `string\|array<integer,string>\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
86		->addOption('hide-errors', null, InputOption::VALUE_NONE, 'If we should print error or not')
87		->addOption('bundle', 'b', InputOption::VALUE_REQUIRED, 'The bundle you want extract translations from.')
88		;
89		}
90
91		protected function execute(InputInterface $input, OutputInterface $output): int
92		{
93		$configName = $input->getArgument('configuration');
94		$config = $this->configurationManager->getConfiguration($configName);
95
96		$locales = [];
97		if ($inputLocale = $input->getArgument('locale')) {
98		$locales = [$inputLocale];
99		}
100
101		$catalogues = $this->catalogueFetcher->getCatalogues($config, $locales);
102		$this->configureBundleDirs($input, $config);
103		$finder = $this->getConfiguredFinder($config);
104
105		$result = $this->importer->extractToCatalogues($finder, $catalogues, [
106		'blacklist_domains' => $config->getBlacklistDomains(),
107		'whitelist_domains' => $config->getWhitelistDomains(),
108		'project_root' => $config->getProjectRoot(),
109		]);
110		$errors = $result->getErrors();
111
112		$this->catalogueWriter->writeCatalogues($config, $result->getMessageCatalogues());
		0 ignored issues – show Documentation introduced 2018-02-12 10:44 UTC by Report Bug Copy Issue Report `$result->getMessageCatalogues()` is of type `array<integer,object<Sym...ageCatalogueInterface>>`, but the function expects a `array<integer,object<Sym...tion\MessageCatalogue>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
113
114		$definedBefore = $this->catalogueCounter->getNumberOfDefinedMessages($catalogues[0]);
115		$definedAfter = $this->catalogueCounter->getNumberOfDefinedMessages($result->getMessageCatalogues()[0]);
116
117		/*
118		* Print results
119		*/
120		$io = new SymfonyStyle($input, $output);
121		$io->table(['Type', 'Count'], [
122		['Total defined messages', $definedAfter],
123		['New messages', $definedAfter - $definedBefore],
124		['Errors', \count($errors)],
125		]);
126
127		if (!$input->getOption('hide-errors')) {
128		/** @var Error $error */
129		foreach ($errors as $error) {
130		$io->error(
131		\sprintf("%s\nLine: %s\nMessage: %s", $error->getPath(), $error->getLine(), $error->getMessage())
132		);
133		}
134		}
135
136		return 0;
137		}
138
139		private function getConfiguredFinder(Configuration $config): Finder
140		{
141		$finder = new Finder();
142		$finder->in($config->getDirs());
143
144		foreach ($config->getExcludedDirs() as $exclude) {
145		$finder->notPath($exclude);
146		}
147
148		foreach ($config->getExcludedNames() as $exclude) {
149		$finder->notName($exclude);
150		}
151
152		return $finder;
153		}
154		}
155

php-translation / symfony-bundle

Push — master ( 082c1c...ceccbd )

ExtractCommand::execute() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like