BeyondCode\SelfDiagnosis\Checks\ExampleEnvironmentVariablesAreUpToDate

Complexity

Total Complexity

6

Size/Duplication

Total Lines	75
Duplicated Lines	24 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

60%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	checkForDotEnvV4()	11	11	1
A	name()	0	4	1
A	check()	7	22	3
A	message()	0	6	1

<?php

namespace BeyondCode\SelfDiagnosis\Checks;

use Dotenv\Dotenv;
use Illuminate\Support\Collection;

class ExampleEnvironmentVariablesAreUpToDate implements Check
{
    /** @var Collection */
    private $envVariables;

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

    /**
     * Perform the actual verification of this check.
     *
     * @param array $config
     * @return bool
     */
    public function check(array $config): bool
    {
        if (method_exists(Dotenv::class, 'createImmutable')) {
            return $this->checkForDotEnvV4();
        }

        if (interface_exists(\Dotenv\Environment\FactoryInterface::class)) {

This code seems to be duplicated across your project.

            $examples = Dotenv::create(base_path(), '.env.example');
            $actual = Dotenv::create(base_path(), '.env');
        } else {
            $examples = new Dotenv(base_path(), '.env.example');

base_path() is of type string, but the function expects a object<Dotenv\Loader>.

The call to Dotenv::__construct() has too many arguments starting with '.env.example'.

            $actual = new Dotenv(base_path(), '.env');

base_path() is of type string, but the function expects a object<Dotenv\Loader>.

The call to Dotenv::__construct() has too many arguments starting with '.env'.

        }

        $examples->safeLoad();
        $actual->safeLoad();

        $this->envVariables = Collection::make($actual->getEnvironmentVariableNames())
            ->diff($examples->getEnvironmentVariableNames());

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

    /**
     * Perform the verification of this check for DotEnv v4.
     *
     * @return bool
     */
    private function checkForDotEnvV4(): bool

This method seems to be duplicated in your project.

    {
        $examples = Dotenv::createImmutable(base_path(), '.env.example');

The method createImmutable() does not exist on Dotenv\Dotenv. Did you maybe mean create()?

        $actual = Dotenv::createImmutable(base_path(), '.env');

The method createImmutable() does not exist on Dotenv\Dotenv. Did you maybe mean create()?

        $this->envVariables = Collection::make($actual->safeLoad())
            ->diffKeys($examples->safeLoad())
            ->keys();

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

    /**
     * The error message to display in case the check does not pass.
     *
     * @param array $config
     * @return string
     */
    public function message(array $config): string
    {
        return trans('self-diagnosis::checks.example_environment_variables_are_up_to_date.message', [
            'variables' => $this->envVariables->implode(PHP_EOL),
        ]);
    }
}