Locales::protects() - Code Metrics - Inspection of "Merge pull request #84 from andrey-helldar/9.x" - andrey-helldar/laravel-lang-publisher - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 55f929...127e84 )

by Andrey

created 2021-04-14 17:49 UTC

Locales::protects() A

↳ Parent: Locales

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	4
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	7
ccs	0
cts	5
cp	0
crap	2
rs	10

<?php

namespace Helldar\LaravelLangPublisher\Support;

use Helldar\LaravelLangPublisher\Concerns\Logger;
use Helldar\LaravelLangPublisher\Constants\Locales as LocalesList;
use Helldar\LaravelLangPublisher\Exceptions\SourceLocaleDoesntExistsException;
use Helldar\LaravelLangPublisher\Facades\Arr as ArrFacade;
use Helldar\LaravelLangPublisher\Facades\Config as ConfigFacade;
use Helldar\LaravelLangPublisher\Facades\Reflection as ReflectionFacade;
use Helldar\Support\Facades\Helpers\Arr;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use Helldar\Support\Facades\Helpers\Filesystem\Directory;
use Helldar\Support\Facades\Helpers\Filesystem\File;
use Helldar\Support\Facades\Helpers\Str;

final class Locales
{
    use Logger;


    /**
     * List of available locations.
     *
     * @param  bool  $all
     *
     * @return array
     */
    public function available(bool $all = false): array
    {
        $this->log('Getting list of available locations...');

        $locales = $this->all();

        return $all ? $locales : $this->filter($locales);
    }

    /**
     * List of installed locations.
     *
     * @return array
     */
    public function installed(): array
    {
        $this->log('Getting list of installed locations...');

        $json = $this->findJsonFiles();
        $php  = $this->findPhpFiles();

        $installed = ArrFacade::unique(array_merge($json, $php));

        $sorted = Arr::sort($installed);

        return array_values($sorted);
    }

    /**
     * Retrieving a list of protected locales.
     *
     * @return array
     */
    public function protects(): array
    {
        $this->log('Retrieving a list of protected locales...');

        return ArrFacade::unique([
            $this->getDefault(),
            $this->getFallback(),
        ]);
    }

    /**
     * Checks if a language pack is installed.
     *
     * @param  string  $locale
     *
     * @return bool
     */
    public function isAvailable(string $locale): bool
    {
        $this->log('Checks if a language pack is installed...');

        return in_array($locale, $this->available(true), true);
    }

    /**
     * The checked locale protecting.
     *
     * @param  string  $locale
     *
     * @return bool
     */
    public function isProtected(string $locale): bool
    {
        $this->log('The checked locale protecting...');

        return $locale === $this->getDefault() || $locale === $this->getFallback();
    }

    /**
     * Checks whether it is possible to install the language pack.
     *
     * @param  string  $locale
     *
     * @return bool
     */
    public function isInstalled(string $locale): bool
    {
        $this->log('Checks whether it is possible to install the language pack...');

        return in_array($locale, $this->installed(), true);
    }

    /**
     * Getting the default localization name.
     *
     * @return string
     */
    public function getDefault(): string
    {
        $this->log('Getting the default localization name...');

        return ConfigFacade::defaultLocale();
    }

    /**
     * Getting the fallback localization name.
     *
     * @return string
     */
    public function getFallback(): string
    {
        $this->log('Getting the fallback localization name...');

        return ConfigFacade::fallbackLocale();
    }

    /**
     * Checking for localization existence.
     *
     * @param  string  $locale
     */
    public function validate(string $locale): void
    {
        $this->log('Checking for localization existence: ' . $locale);

        if (! $this->isAvailable($locale)) {
            throw new SourceLocaleDoesntExistsException($locale);
        }
    }

    protected function all(): array
    {
        $this->log('Getting a list of all available localizations without filtering...');

        return array_values(ReflectionFacade::getConstants(LocalesList::class));
    }

    protected function filter(array $locales): array
    {
        $this->log('Filtering localizations...');

        $unique = ArrFacade::unique($locales);
        $ignore = ConfigFacade::ignores();

        return array_values(array_filter($unique, static function ($locale) use ($ignore) {
            return ! in_array($locale, $ignore, true);
        }));
    }

    protected function findJsonFiles(): array
    {
        $this->log('Getting a list of localizations from json files...');

        $files = File::names($this->resourcesPath());

        return Arr::map($files, static function ($filename) {
            return Str::before($filename, '.');
        });
    }

    protected function findPhpFiles(): array
    {
        $this->log('Getting a list of localizations from php files...');

        return Directory::names($this->resourcesPath());
    }

    protected function resourcesPath(): string
    {
        $this->log('Getting the path to application resources...');

        return ConfigFacade::resourcesPath();
    }
}


1		<?php
2
3		namespace Helldar\LaravelLangPublisher\Support;
4
5		use Helldar\LaravelLangPublisher\Concerns\Logger;
6		use Helldar\LaravelLangPublisher\Constants\Locales as LocalesList;
7		use Helldar\LaravelLangPublisher\Exceptions\SourceLocaleDoesntExistsException;
8		use Helldar\LaravelLangPublisher\Facades\Arr as ArrFacade;
9		use Helldar\LaravelLangPublisher\Facades\Config as ConfigFacade;
10		use Helldar\LaravelLangPublisher\Facades\Reflection as ReflectionFacade;
11		use Helldar\Support\Facades\Helpers\Arr;
		0 ignored issues – show Bug introduced 2021-04-13 16:57 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `Helldar\LaravelLangPublisher\Support\Arr`. Consider defining an alias. Let?s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let?s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
12		use Helldar\Support\Facades\Helpers\Filesystem\Directory;
13		use Helldar\Support\Facades\Helpers\Filesystem\File;
14		use Helldar\Support\Facades\Helpers\Str;
15
16		final class Locales
17		{
18		use Logger;
		0 ignored issues – show Bug introduced 2021-04-14 18:41 UTC by Report Bug Copy Issue Report The trait `Helldar\LaravelLangPublisher\Concerns\Logger` requires the property `$output` which is not provided by `Helldar\LaravelLangPublisher\Support\Locales`. Loading history...
19
20		/**
21		* List of available locations.
22		*
23		* @param bool $all
24		*
25		* @return array
26		*/
27	16	public function available(bool $all = false): array
28		{
29	16	$this->log('Getting list of available locations...');
30
31	16	$locales = $this->all();
32
33	16	return $all ? $locales : $this->filter($locales);
34		}
35
36		/**
37		* List of installed locations.
38		*
39		* @return array
40		*/
41	7	public function installed(): array
42		{
43	7	$this->log('Getting list of installed locations...');
44
45	7	$json = $this->findJsonFiles();
46	7	$php = $this->findPhpFiles();
47
48	7	$installed = ArrFacade::unique(array_merge($json, $php));
49
50	7	$sorted = Arr::sort($installed);
51
52	7	return array_values($sorted);
53		}
54
55		/**
56		* Retrieving a list of protected locales.
57		*
58		* @return array
59		*/
60		public function protects(): array
61		{
62		$this->log('Retrieving a list of protected locales...');
63
64		return ArrFacade::unique([
65		$this->getDefault(),
66		$this->getFallback(),
67		]);
68		}
69
70		/**
71		* Checks if a language pack is installed.
72		*
73		* @param string $locale
74		*
75		* @return bool
76		*/
77	13	public function isAvailable(string $locale): bool
78		{
79	13	$this->log('Checks if a language pack is installed...');
80
81	13	return in_array($locale, $this->available(true), true);
82		}
83
84		/**
85		* The checked locale protecting.
86		*
87		* @param string $locale
88		*
89		* @return bool
90		*/
91	4	public function isProtected(string $locale): bool
92		{
93	4	$this->log('The checked locale protecting...');
94
95	4	return $locale === $this->getDefault() \|\| $locale === $this->getFallback();
96		}
97
98		/**
99		* Checks whether it is possible to install the language pack.
100		*
101		* @param string $locale
102		*
103		* @return bool
104		*/
105		public function isInstalled(string $locale): bool
106		{
107		$this->log('Checks whether it is possible to install the language pack...');
108
109		return in_array($locale, $this->installed(), true);
110		}
111
112		/**
113		* Getting the default localization name.
114		*
115		* @return string
116		*/
117	4	public function getDefault(): string
118		{
119	4	$this->log('Getting the default localization name...');
120
121	4	return ConfigFacade::defaultLocale();
122		}
123
124		/**
125		* Getting the fallback localization name.
126		*
127		* @return string
128		*/
129	3	public function getFallback(): string
130		{
131	3	$this->log('Getting the fallback localization name...');
132
133	3	return ConfigFacade::fallbackLocale();
134		}
135
136		/**
137		* Checking for localization existence.
138		*
139		* @param string $locale
140		*/
141	13	public function validate(string $locale): void
142		{
143	13	$this->log('Checking for localization existence: ' . $locale);
144
145	13	if (! $this->isAvailable($locale)) {
146	1	throw new SourceLocaleDoesntExistsException($locale);
147		}
148	12	}
149
150	16	protected function all(): array
151		{
152	16	$this->log('Getting a list of all available localizations without filtering...');
153
154	16	return array_values(ReflectionFacade::getConstants(LocalesList::class));
155		}
156
157	10	protected function filter(array $locales): array
158		{
159	10	$this->log('Filtering localizations...');
160
161	10	$unique = ArrFacade::unique($locales);
162	10	$ignore = ConfigFacade::ignores();
163
164	10	return array_values(array_filter($unique, static function ($locale) use ($ignore) {
165	10	return ! in_array($locale, $ignore, true);
166	10	}));
167		}
168
169	7	protected function findJsonFiles(): array
170		{
171	7	$this->log('Getting a list of localizations from json files...');
172
173	7	$files = File::names($this->resourcesPath());
174
175	7	return Arr::map($files, static function ($filename) {
176	7	return Str::before($filename, '.');
177	7	});
178		}
179
180	7	protected function findPhpFiles(): array
181		{
182	7	$this->log('Getting a list of localizations from php files...');
183
184	7	return Directory::names($this->resourcesPath());
185		}
186
187	7	protected function resourcesPath(): string
188		{
189	7	$this->log('Getting the path to application resources...');
190
191	7	return ConfigFacade::resourcesPath();
192		}
193		}
194

andrey-helldar / laravel-lang-publisher

Push — main ( 55f929...127e84 )

Locales::protects() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like