TransChecker::diffMissing() - Code Metrics - Inspection of "Using GitHub Actions for testing" - ARCANEDEV/LaravelLang - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#33)

by ARCANEDEV

created 2020-02-09 08:13 UTC

TransChecker::diffMissing() A

↳ Parent: TransChecker

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3.0261

Importance

Changes

Metric	Value
dl	0
loc	11
ccs	6
cts	7
cp	0.8571
rs	9.9
c	0
b	0
f	0
cc	3
nc	3
nop	3
crap	3.0261

<?php namespace Arcanedev\LaravelLang;

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

/**
 * Class     TransChecker
 *
 * @package  Arcanedev\LaravelLang
 * @author   ARCANEDEV <[email protected]>
 */
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()
    {
        return $this->translator->getLocale();
    }

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

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

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

    /**
     * Check the missing translations.
     *
     * @return array
     */
    public function check()
    {
        $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($locale, array $ignored)
    {
        $appLocale    = $this->manager->getFrom('app', $locale);
        $vendorLocale = $this->manager->getFrom('vendor', $locale);

        return is_null($appLocale)
            ? $vendorLocale->mergeTranslations($appLocale, $ignored)
            : $appLocale->mergeTranslations($vendorLocale, $ignored);
    }

    /**
     * Diff the missing translations.
     *
     * @param  array   $toTranslations
     * @param  array   $fromTranslations
     * @param  string  $locale
     */
    private function diffMissing(array $toTranslations, array $fromTranslations, $locale)
    {
        $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($locale, $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($locale, $transKey)
    {
        if ( ! isset($this->missing[$locale]))
            return false;

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


1		<?php namespace Arcanedev\LaravelLang;
2
3		use Arcanedev\LaravelLang\Contracts\TransChecker as TransCheckerInterface;
4		use Arcanedev\LaravelLang\Contracts\TransManager as TransManagerInterface;
5		use Illuminate\Support\Arr;
6		use Illuminate\Translation\Translator;
7
8		/**
9		* Class TransChecker
10		*
11		* @package Arcanedev\LaravelLang
12		* @author ARCANEDEV <[email protected]>
13		*/
14		class TransChecker implements TransCheckerInterface
15		{
16		/* -----------------------------------------------------------------
17		\| Properties
18		\| -----------------------------------------------------------------
19		*/
20
21		/**
22		* Config values.
23		*
24		* @var array
25		*/
26		private $configs;
27
28		/**
29		* The translator instance.
30		*
31		* @var \Illuminate\Translation\Translator
32		*/
33		private $translator;
34
35		/**
36		* The translator manager instance.
37		*
38		* @var \Arcanedev\LaravelLang\Contracts\TransManager
39		*/
40		private $manager;
41
42		/**
43		* The missing translations.
44		*
45		* @var array
46		*/
47		private $missing = [];
48
49		/* -----------------------------------------------------------------
50		\| Constructor
51		\| -----------------------------------------------------------------
52		*/
53
54		/**
55		* Make TransChecker instance.
56		*
57		* @param \Illuminate\Translation\Translator $translator
58		* @param \Arcanedev\LaravelLang\Contracts\TransManager $manager
59		* @param array $configs
60		*/
61	12	public function __construct(
62		Translator $translator,
63		TransManagerInterface $manager,
64		array $configs
65		) {
66	12	$this->translator = $translator;
67	12	$this->manager = $manager;
68	12	$this->configs = $configs;
69	12	}
70
71		/* -----------------------------------------------------------------
72		\| Getters & Setter
73		\| -----------------------------------------------------------------
74		*/
75
76		/**
77		* Get the default locale being used.
78		*
79		* @return string
80		*/
81	2	public function getDefaultLocale()
82		{
83	2	return $this->translator->getLocale();
84		}
85
86		/**
87		* Get the locales to check.
88		*
89		* @return array
90		*/
91	2	public function getLocales()
92		{
93	2	return Arr::get($this->configs, 'locales', []);
94		}
95
96		/**
97		* Get the ignored translation attributes.
98		*
99		* @return array
100		*/
101	2	public function getIgnoredTranslations()
102		{
103	2	return Arr::get($this->configs, 'check.ignore', []);
104		}
105
106		/* -----------------------------------------------------------------
107		\| Main Methods
108		\| -----------------------------------------------------------------
109		*/
110
111		/**
112		* Check the missing translations.
113		*
114		* @return array
115		*/
116	2	public function check()
117		{
118	2	$this->missing = [];
119	2	$from = $this->getDefaultLocale();
120	2	$locales = $this->getLocales();
121	2	$ignored = $this->getIgnoredTranslations();
122	2	$fromTrans = $this->getTranslations($from, $ignored);
123
124	2	foreach ($locales as $to) {
125	2	$toTrans = $this->getTranslations($to, $ignored);
126
127	2	$this->diffMissing($toTrans, $fromTrans, $from);
128	2	$this->diffMissing($fromTrans, $toTrans, $to);
129		}
130
131	2	return $this->missing;
132		}
133
134		/* -----------------------------------------------------------------
135		\| Other Methods
136		\| -----------------------------------------------------------------
137		*/
138
139		/**
140		* Get locale translations from multiple groups.
141		*
142		* @param string $locale
143		* @param array $ignored
144		*
145		* @return array
146		*/
147	2	private function getTranslations($locale, array $ignored)
148		{
149	2	$appLocale = $this->manager->getFrom('app', $locale);
150	2	$vendorLocale = $this->manager->getFrom('vendor', $locale);
151
152	2	return is_null($appLocale)
153	2	? $vendorLocale->mergeTranslations($appLocale, $ignored)
154	2	: $appLocale->mergeTranslations($vendorLocale, $ignored);
155		}
156
157		/**
158		* Diff the missing translations.
159		*
160		* @param array $toTranslations
161		* @param array $fromTranslations
162		* @param string $locale
163		*/
164	2	private function diffMissing(array $toTranslations, array $fromTranslations, $locale)
165		{
166	2	$diff = array_diff_key($toTranslations, $fromTranslations);
167
168	2	if (count($diff) === 0)
169		return;
170
171	2	foreach ($diff as $transKey => $transValue) {
172	2	$this->addMissing($locale, $transKey);
173		}
174	2	}
175
176		/**
177		* Adding missing translation to collection.
178		*
179		* @param string $locale
180		* @param string $transKey
181		*/
182	2	private function addMissing($locale, $transKey)
183		{
184	2	if ( ! $this->hasMissing($locale, $transKey)) {
185	2	$this->missing[$locale][] = $transKey;
186		}
187	2	}
188
189		/**
190		* Check if a missing translation exists in collection.
191		*
192		* @param string $locale
193		* @param string $transKey
194		*
195		* @return bool
196		*/
197	2	private function hasMissing($locale, $transKey)
198		{
199	2	if ( ! isset($this->missing[$locale]))
200	2	return false;
201
202	2	return in_array($transKey, $this->missing[$locale]);
203		}
204		}
205

ARCANEDEV / LaravelLang

Pull Request — master (#33)

TransChecker::diffMissing() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like