ExampleEnvironmentVariablesAreSet::checkForDotEnvV4() - Code Metrics - Inspection of "Merge pull request #91 from rodrigopedra/master" - beyondcode/laravel-self-diagnosis - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 14cb57...fc663d )

by Marcel

created 2020-05-29 21:48 UTC

checkForDotEnvV4() A

↳ Parent: ExampleEnvironmentVariablesAreSet

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	11
Ratio	100 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	11
loc	11
ccs	0
cts	7
cp	0
rs	9.9
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	2

<?php

namespace BeyondCode\SelfDiagnosis\Checks;

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

class ExampleEnvironmentVariablesAreSet 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_set.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)) {
            $examples = Dotenv::create(base_path(), '.env.example');
            $actual = Dotenv::create(base_path(), '.env');
        } else {
            $examples = new Dotenv(base_path(), '.env.example');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $actual = new Dotenv(base_path(), '.env');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }

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

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

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

    /**
     * Perform the verification of this check for DotEnv v4.
     *
     * @return bool
     */
    private function checkForDotEnvV4(): bool
    {
        $examples = Dotenv::createImmutable(base_path(), '.env.example');

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


        $this->envVariables = Collection::make($examples->safeLoad())
            ->diffKeys($actual->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_set.message', [
            'variables' => $this->envVariables->implode(PHP_EOL),
        ]);
    }
}


1			<?php
2
3			namespace BeyondCode\SelfDiagnosis\Checks;
4
5			use Dotenv\Dotenv;
6			use Illuminate\Support\Collection;
7
8		View Code Duplication	class ExampleEnvironmentVariablesAreSet implements Check
			0 ignored issues – show Duplication introduced 2018-07-24 13:25 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
9			{
10			/** @var Collection */
11			private $envVariables;
12
13			/**
14			* The name of the check.
15			*
16			* @param array $config
17			* @return string
18			*/
19			public function name(array $config): string
20			{
21			return trans('self-diagnosis::checks.example_environment_variables_are_set.name');
22			}
23
24			/**
25			* Perform the actual verification of this check.
26			*
27			* @param array $config
28			* @return bool
29			*/
30	4		public function check(array $config): bool
31			{
32	4		if (method_exists(Dotenv::class, 'createImmutable')) {
33			return $this->checkForDotEnvV4();
34			}
35
36	4		if (interface_exists(\Dotenv\Environment\FactoryInterface::class)) {
37	2		$examples = Dotenv::create(base_path(), '.env.example');
38	2		$actual = Dotenv::create(base_path(), '.env');
39			} else {
40	2		$examples = new Dotenv(base_path(), '.env.example');
			0 ignored issues – show Documentation introduced 2019-02-27 01:13 UTC by Report Bug Copy Issue Report `base_path()` is of type `string`, but the function expects a `object<Dotenv\Loader>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Unused Code introduced 2019-02-27 01:13 UTC by Report Bug Copy Issue Report The call to `Dotenv::__construct()` has too many arguments starting with `'.env.example'`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
41	2		$actual = new Dotenv(base_path(), '.env');
			0 ignored issues – show Documentation introduced 2019-02-27 01:13 UTC by Report Bug Copy Issue Report `base_path()` is of type `string`, but the function expects a `object<Dotenv\Loader>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Unused Code introduced 2019-02-27 01:13 UTC by Report Bug Copy Issue Report The call to `Dotenv::__construct()` has too many arguments starting with `'.env'`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
42			}
43
44	4		$examples->safeLoad();
45	4		$actual->safeLoad();
46
47	4		$this->envVariables = Collection::make($examples->getEnvironmentVariableNames())
48	4		->diff($actual->getEnvironmentVariableNames());
49
50	4		return $this->envVariables->isEmpty();
51			}
52
53			/**
54			* Perform the verification of this check for DotEnv v4.
55			*
56			* @return bool
57			*/
58			private function checkForDotEnvV4(): bool
59			{
60			$examples = Dotenv::createImmutable(base_path(), '.env.example');
			0 ignored issues – show Bug introduced 2020-03-12 13:34 UTC by Report Bug Copy Issue Report The method `createImmutable()` does not exist on `Dotenv\Dotenv`. Did you maybe mean `create()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
61			$actual = Dotenv::createImmutable(base_path(), '.env');
			0 ignored issues – show Bug introduced 2020-03-12 13:34 UTC by Report Bug Copy Issue Report The method `createImmutable()` does not exist on `Dotenv\Dotenv`. Did you maybe mean `create()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
62
63			$this->envVariables = Collection::make($examples->safeLoad())
64			->diffKeys($actual->safeLoad())
65			->keys();
66
67			return $this->envVariables->isEmpty();
68			}
69
70			/**
71			* The error message to display in case the check does not pass.
72			*
73			* @param array $config
74			* @return string
75			*/
76	4		public function message(array $config): string
77			{
78	4		return trans('self-diagnosis::checks.example_environment_variables_are_set.message', [
79	4		'variables' => $this->envVariables->implode(PHP_EOL),
80			]);
81			}
82			}
83

beyondcode / laravel-self-diagnosis

Push — master ( 14cb57...fc663d )

checkForDotEnvV4() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like