Translation\Bundle\Service\Importer

Complexity

Total Complexity

23

Size/Duplication

Total Lines	157
Duplicated Lines	9.55 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

0%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
B	extractToCatalogues()	0	28	5
A	extractToCatalogue()	0	6	1
B	convertSourceLocationsToMessages()	0	23	4
B	isValidDomain()	6	11	5
C	processConfig()	9	24	7

<?php

/*
 * This file is part of the PHP Translation package.
 *
 * (c) PHP Translation team <tobias.nyholm@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Translation\Bundle\Service;

use Symfony\Component\Finder\Finder;
use Symfony\Component\Translation\MessageCatalogue;
use Translation\Bundle\Catalogue\MetadataWriter;
use Translation\Extractor\Extractor;
use Translation\Extractor\Model\SourceCollection;
use Translation\Extractor\Model\SourceLocation;
use Translation\Bundle\Catalogue\Operation\MetadataAwareMerge;

/**
 * Use extractors to import translations to message catalogues.
 *
 * @author Tobias Nyholm <tobias.nyholm@gmail.com>
 */
final class Importer
{
    /**
     * @var Extractor
     */
    private $extractor;

    /**
     * @var array
     */
    private $config;

    /**
     * @var MetadataWriter
     */
    private $metadataWriter;

    /**
     * @param Extractor      $extractor
     * @param MetadataWriter $metadataWriter
     */
    public function __construct(Extractor $extractor, MetadataWriter $metadataWriter)
    {
        $this->extractor = $extractor;
        $this->metadataWriter = $metadataWriter;
    }

    /**
     * @param Finder             $finder
     * @param MessageCatalogue[] $catalogues
     * @param array              $config     {
     *
     *     @var array $blacklist_domains Blacklist the domains we should exclude. Cannot be used with whitelist.
     *     @var array $whitelist_domains Whitlelist the domains we should include. Cannot be used with blacklist.
     *     @var string project_root The project root will be removed from the source location.
     * }
     *
     * @param array $errors from extractor, by reference.
     *
     * @return MessageCatalogue[]
     */
    public function extractToCatalogues(Finder $finder, array $catalogues, array $config = [], &$errors = [])
    {
        $this->processConfig($config);
        $sourceCollection = $this->extractor->extract($finder);
        $errors = $sourceCollection->getErrors();
        $results = [];
        foreach ($catalogues as $catalogue) {
            $target = new MessageCatalogue($catalogue->getLocale());
            $this->convertSourceLocationsToMessages($target, $sourceCollection);

            $merge = new MetadataAwareMerge($catalogue, $target);
            $result = $merge->getResult();
            $domains = $merge->getDomains();

            // Mark new messages as new/obsolete
            foreach ($domains as $domain) {
                foreach ($merge->getNewMessages($domain) as $key => $translation) {
                    $this->metadataWriter->write($result, $key, $domain, 'notes', ['content' => 'status:new']);

$result of type object<Symfony\Component\Translation\MessageCatalogueInterface> is not a sub-type of object<Symfony\Component\Translation\MessageCatalogue>. It seems like you assume a concrete implementation of the interface Symfony\Component\Translation\MessageCatalogueInterface to be always present.

                }
                foreach ($merge->getObsoleteMessages($domain) as $key => $translation) {
                    $this->metadataWriter->write($result, $key, $domain, 'notes', ['content' => 'status:obsolete']);

$result of type object<Symfony\Component\Translation\MessageCatalogueInterface> is not a sub-type of object<Symfony\Component\Translation\MessageCatalogue>. It seems like you assume a concrete implementation of the interface Symfony\Component\Translation\MessageCatalogueInterface to be always present.

                }
            }
            $results[] = $result;
        }

        return $results;
    }

    /**
     * See docs for extractToCatalogues.
     *
     * @return MessageCatalogue
     */
    public function extractToCatalogue(Finder $finder, MessageCatalogue $catalogue, array $config = [])
    {
        $results = $this->extractToCatalogues($finder, [$catalogue], $config);

        return reset($results);

The expression reset($results); of type Symfony\Component\Translation\MessageCatalogue|false adds false to the return on line 106 which is incompatible with the return type documented by Translation\Bundle\Service\Importer::extractToCatalogue of type Symfony\Component\Translation\MessageCatalogue. It seems like you forgot to handle an error condition.

    }

    /**
     * @param MessageCatalogue $catalogue
     * @param SourceCollection $collection
     */
    private function convertSourceLocationsToMessages(MessageCatalogue $catalogue, SourceCollection $collection)
    {
        /** @var SourceLocation $sourceLocation */
        foreach ($collection as $sourceLocation) {
            $context = $sourceLocation->getContext();
            $domain = isset($context['domain']) ? $context['domain'] : 'messages';
            // Check with white/black list
            if (!$this->isValidDomain($domain)) {
                continue;
            }

            $catalogue->set($sourceLocation->getMessage(), null, $domain);
            $trimLength = 1 + strlen($this->config['project_root']);

            $this->metadataWriter->write(
                $catalogue,
                $sourceLocation->getMessage(),
                $domain,
                'notes',
                ['from' => sprintf('%s:%s', substr($sourceLocation->getPath(), $trimLength), $sourceLocation->getLine()), 'content' => 'file-source']
            );
        }
    }

    /**
     * @param string $domain
     *
     * @return bool
     */
    private function isValidDomain($domain)
    {
        if (!empty($this->config['blacklist_domains']) && in_array($domain, $this->config['blacklist_domains'])) {

This code seems to be duplicated across your project.

            return false;
        }
        if (!empty($this->config['whitelist_domains']) && !in_array($domain, $this->config['whitelist_domains'])) {

This code seems to be duplicated across your project.

            return false;
        }

        return true;
    }

    /**
     * Make sure the configuration is valid.
     *
     * @param array $config
     */
    private function processConfig($config)
    {
        $default = [
            'project_root' => '',
            'blacklist_domains' => [],
            'whitelist_domains' => [],
        ];

        $config = array_merge($default, $config);

        if (!empty($config['blacklist_domains']) && !empty($config['whitelist_domains'])) {

This code seems to be duplicated across your project.

            throw new \InvalidArgumentException('Cannot use "blacklist_domains" and "whitelist_domains" at the same time');
        }

        if (!empty($config['blacklist_domains']) && !is_array($config['blacklist_domains'])) {

This code seems to be duplicated across your project.

            throw new \InvalidArgumentException('Config parameter "blacklist_domains" must be an array');
        }

        if (!empty($config['whitelist_domains']) && !is_array($config['whitelist_domains'])) {

This code seems to be duplicated across your project.

            throw new \InvalidArgumentException('Config parameter "whitelist_domains" must be an array');
        }

        $this->config = $config;
    }
}