Zikula\Bundle\CoreBundle\Command\TranslationKeyToValueCommand

Complexity

Total Complexity

13

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	configure()	0	7	1
C	execute()	0	49	11

<?php

declare(strict_types=1);

/*
 * This file is part of the Zikula package.
 *
 * Copyright Zikula - https://ziku.la/
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Zikula\Bundle\CoreBundle\Command;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Exception\InvalidArgumentException;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Finder\Finder;
use Symfony\Component\HttpKernel\KernelInterface;
use Symfony\Component\Yaml\Yaml;

class TranslationKeyToValueCommand extends Command
{
    protected static $defaultName = 'zikula:translation:keytovalue';

    private $defaultTransPath;

    public function __construct(string $defaultTransPath = null)
    {
        parent::__construct();
        $this->defaultTransPath = $defaultTransPath;
    }

    protected function configure()
    {
        $this
            ->setDescription('update translation files to remove null values and replace them with the key')
            ->addArgument('bundle', InputArgument::OPTIONAL, 'The bundle name or directory where to load the messages')
            ->setHelp(
                <<<'EOF'
The <info>%command.name%</info> command transforms translation strings of a given
bundle or the default translations directory. It sets null messages to the value of the key.

It is recommended to run <info>php bin/console translation:extract</info> first.

Example running against a Bundle (AcmeBundle)

  <info>php %command.full_name% AcmeBundle</info>

Example running against default messages directory

  <info>php %command.full_name%</info>
EOF
            )
        ;
    }

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

        /** @var KernelInterface $kernel */
        $kernel = $this->getApplication()->getKernel();

The method getKernel() does not exist on Symfony\Component\Console\Application. It seems like you code against a sub-type of Symfony\Component\Console\Application such as Symfony\Bundle\FrameworkBundle\Console\Application.

        $transPaths = [];
        if ($this->defaultTransPath) {
            $transPaths[] = $this->defaultTransPath;
        }
        $currentName = 'default directory';
        // Override with provided Bundle info (this section copied from symfony's translation:update command)
        if (null !== $input->getArgument('bundle')) {
            try {
                $foundBundle = $kernel->getBundle($input->getArgument('bundle'));

It seems like $input->getArgument('bundle') can also be of type null and string[]; however, parameter $name of Symfony\Component\HttpKernel\KernelInterface::getBundle() does only seem to accept string, maybe add an additional type check?

                $bundleDir = $foundBundle->getPath();
                $transPaths = [is_dir($bundleDir . '/Resources/translations') ? $bundleDir . '/Resources/translations' : $bundleDir . '/translations'];
                if ($this->defaultTransPath) {
                    $transPaths[] = $this->defaultTransPath;
                }
                $currentName = $foundBundle->getName();
            } catch (\InvalidArgumentException $e) {
                // such a bundle does not exist, so treat the argument as path
                $path = $input->getArgument('bundle');
                $transPaths = [$path . '/translations'];

Are you sure $path of type null|string|string[] can be used in concatenation?

                if (!is_dir($transPaths[0]) && !isset($transPaths[1])) {
                    throw new InvalidArgumentException(sprintf('"%s" is neither an enabled bundle nor a directory.', $transPaths[0]));
                }
            }
        }
        $io->title('Translation Messages Key to Value Transformer');
        $io->comment(sprintf('Transforming translation files for "<info>%s</info>"', $currentName));
        $finder = new Finder();
        $fs = new Filesystem();
        foreach ($finder->files()->in($transPaths)->name(['*.yaml', '*.yml']) as $file) {
            $io->text(sprintf('<comment>Parsing %s</comment>', $file->getBasename()));
            $messages = Yaml::parseFile($file->getRealPath());
            foreach ($messages as $key => $message) {
                if (null === $message) {
                    $messages[$key] = $key;
                }
            }
            $io->text(sprintf('<info>Dumping %s</info>', $file->getBasename()));
            $fs->dumpFile($file->getRealPath(), Yaml::dump($messages));
        }

        $io->success('Success!');

        return Command::SUCCESS;
    }
}