BeyondCode\SelfDiagnosis\Checks\LocalesAreInstalled

Complexity

Total Complexity

10

Size/Duplication

Total Lines	87
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

92.86%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	name()	0	4	1
A	message()	0	10	2
B	check()	0	31	6

<?php

namespace BeyondCode\SelfDiagnosis\Checks;

use BeyondCode\SelfDiagnosis\SystemFunctions;
use Illuminate\Support\Collection;

class LocalesAreInstalled implements Check
{
    /** @var Collection */
    protected $missingLocales;

    /** @var string|null */
    protected $message;

    /** @var SystemFunctions */
    protected $systemFunctions;

    /**
     * LocalesAreInstalled constructor.
     *
     * @param SystemFunctions $systemFunctions
     */
    public function __construct(SystemFunctions $systemFunctions)
    {
        $this->systemFunctions = $systemFunctions;
    }

    /**
     * The name of the check.
     *
     * @param array $config
     * @return string
     */
    public function name(array $config): string
    {
        return trans('self-diagnosis::checks.locales_are_installed.name');
    }

    /**
     * Perform the actual verification of this check.
     *
     * @param array $config
     * @return bool
     */
    public function check(array $config): bool
    {
        $this->missingLocales = new Collection(array_get($config, 'required_locales', []));

The function array_get() has been deprecated with message: Arr::get() should be used directly instead. Will be removed in Laravel 5.9.

        if ($this->missingLocales->isEmpty()) {
            return true;
        }

        if (!$this->systemFunctions->isFunctionAvailable('shell_exec')) {
            $this->message = trans('self-diagnosis::checks.locales_are_installed.message.shell_exec_not_available');

It seems like trans('self-diagnosis::checks.locales_are_installed.message.shell_exec_not_available') can also be of type object<Illuminate\Contracts\Translation\Translator> or array. However, the property $message is declared as type string|null. Maybe add an additional type check?

            return false;
        }

        if ($this->systemFunctions->isWindowsOperatingSystem()) {
            $this->message = trans('self-diagnosis::checks.locales_are_installed.message.cannot_run_on_windows');

It seems like trans('self-diagnosis::checks.locales_are_installed.message.cannot_run_on_windows') can also be of type object<Illuminate\Contracts\Translation\Translator> or array. However, the property $message is declared as type string|null. Maybe add an additional type check?

            return false;
        }

        $locales = $this->systemFunctions->callShellExec('locale -a');
        if ($locales === null || $locales === '') {
            $this->message = trans('self-diagnosis::checks.locales_are_installed.message.locale_command_not_available');

It seems like trans('self-diagnosis::checks.locales_are_installed.message.locale_command_not_available') can also be of type object<Illuminate\Contracts\Translation\Translator> or array. However, the property $message is declared as type string|null. Maybe add an additional type check?

            return false;
        }

        $locales = explode("\n" , $locales);

        $this->missingLocales = $this->missingLocales->reject(function ($loc) use ($locales) {
            return in_array($loc, $locales);
        });

        return $this->missingLocales->isEmpty();
    }

    /**
     * The error message to display in case the check does not pass.
     *
     * @param array $config
     * @return string
     */
    public function message(array $config): string
    {
        if ($this->message) {

The expression $this->message of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            return $this->message;
        }

        return trans('self-diagnosis::checks.locales_are_installed.message.missing_locales', [
            'locales' => $this->missingLocales->implode(PHP_EOL),
        ]);
    }
}