Arcanedev\LaravelLang\TransChecker

Complexity

Total Complexity

15

Size/Duplication

Total Lines	192
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getDefaultLocale()	0	4	1
A	getLocales()	0	4	1
A	getIgnoredTranslations()	0	4	1
A	check()	0	17	2
A	__construct()	0	6	1
A	getTranslations()	0	13	2
A	diffMissing()	0	11	3
A	addMissing()	0	6	2
A	hasMissing()	0	7	2

<?php

declare(strict_types=1);

namespace Arcanedev\LaravelLang;

use Arcanedev\LaravelLang\Contracts\TransChecker as TransCheckerInterface;
use Arcanedev\LaravelLang\Contracts\TransManager as TransManagerInterface;
use Illuminate\Support\{Arr, Str};
use Illuminate\Translation\Translator;

/**
 * Class     TransChecker
 *
 * @author   ARCANEDEV <arcanedev.maroc@gmail.com>
 */
class TransChecker implements TransCheckerInterface
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /**
     * Config values.
     *
     * @var array
     */
    private $configs;

    /**
     * The translator instance.
     *
     * @var \Illuminate\Translation\Translator
     */
    private $translator;

    /**
     * The translator manager instance.
     *
     * @var \Arcanedev\LaravelLang\Contracts\TransManager
     */
    private $manager;

    /**
     * The missing translations.
     *
     * @var array
     */
    private $missing = [];

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * Make TransChecker instance.
     *
     * @param  \Illuminate\Translation\Translator             $translator
     * @param  \Arcanedev\LaravelLang\Contracts\TransManager  $manager
     * @param  array                                          $configs
     */
    public function __construct(Translator $translator, TransManagerInterface $manager, array $configs)
    {
        $this->translator = $translator;
        $this->manager    = $manager;
        $this->configs    = $configs;
    }

    /* -----------------------------------------------------------------
     |  Getters & Setter
     | -----------------------------------------------------------------
     */

    /**
     * Get the default locale being used.
     *
     * @return string
     */
    public function getDefaultLocale(): string
    {
        return $this->translator->getLocale();
    }

    /**
     * Get the locales to check.
     *
     * @return array
     */
    public function getLocales(): array
    {
        return Arr::get($this->configs, 'locales', []);
    }

    /**
     * Get the ignored translation attributes.
     *
     * @return array
     */
    public function getIgnoredTranslations(): array
    {
        return Arr::get($this->configs, 'check.ignore', []);
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Check the missing translations.
     *
     * @return array
     */
    public function check(): array
    {
        $this->missing = [];
        $from          = $this->getDefaultLocale();
        $locales       = $this->getLocales();
        $ignored       = $this->getIgnoredTranslations();
        $fromTrans     = $this->getTranslations($from, $ignored);

        foreach ($locales as $to) {
            $toTrans = $this->getTranslations($to, $ignored);

            $this->diffMissing($toTrans, $fromTrans, $from);
            $this->diffMissing($fromTrans, $toTrans, $to);
        }

        return $this->missing;
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Get locale translations from multiple groups.
     *
     * @param  string  $locale
     * @param  array   $ignored
     *
     * @return array
     */
    private function getTranslations(string $locale, array $ignored): array
    {
        $appLocale    = $this->manager->getFrom('app', $locale);
        $vendorLocale = $this->manager->getFrom('vendor-php', $locale);

        $translations = is_null($appLocale)
            ? $vendorLocale->mergeTranslations($appLocale, $ignored)
            : $appLocale->mergeTranslations($vendorLocale, $ignored);

        return array_filter($translations, function ($key) {
            return ! Str::startsWith($key, ['validation-inline.']);
        }, ARRAY_FILTER_USE_KEY);
    }

    /**
     * Diff the missing translations.
     *
     * @param  array   $toTranslations
     * @param  array   $fromTranslations
     * @param  string  $locale
     */
    private function diffMissing(array $toTranslations, array $fromTranslations, string $locale): void
    {
        $diff = array_diff_key($toTranslations, $fromTranslations);

        if (count($diff) === 0)
            return;

        foreach ($diff as $transKey => $transValue) {
            $this->addMissing($locale, $transKey);
        }
    }

    /**
     * Adding missing translation to collection.
     *
     * @param  string  $locale
     * @param  string  $transKey
     */
    private function addMissing(string $locale, string $transKey)
    {
        if ( ! $this->hasMissing($locale, $transKey)) {
            $this->missing[$locale][] = $transKey;
        }
    }

    /**
     * Check if a missing translation exists in collection.
     *
     * @param  string  $locale
     * @param  string  $transKey
     *
     * @return bool
     */
    private function hasMissing(string $locale, string $transKey): bool
    {
        if ( ! isset($this->missing[$locale]))
            return false;

        return in_array($transKey, $this->missing[$locale]);
    }
}