Config::getDefaultEnvironment() - Code Metrics - Inspection of "[WIP] Implement acceptance test for psh.yml.overri..." - shopwareLabs/psh - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#42)

by Simon

created 2017-08-04 11:53 UTC

Config::getDefaultEnvironment() A

↳ Parent: Config

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php declare(strict_types=1);

namespace Shopware\Psh\Config;

/**
 * Represents the global configuration consisting of multiple environments
 */
class Config
{
    /**
     * @var string
     */
    private $header;

    /**
     * @var string
     */
    private $defaultEnvironment;

    /**
     * @var ConfigEnvironment[]
     */
    private $environments;

    /**
     * @param string|null $header
     * @param string $defaultEnvironment
     * @param ConfigEnvironment[] $environments
     */
    public function __construct(
        string $header = null,
        string $defaultEnvironment,
        array $environments
    ) {
        $this->header = $header;
        $this->defaultEnvironment = $defaultEnvironment;
        $this->environments = $environments;
    }

    /**
     * @return ScriptPath[]
     */
    public function getAllScriptPaths(): array
    {
        $paths = [];

        foreach ($this->environments as $name => $environmentConfig) {
            foreach ($environmentConfig->getAllScriptPaths() as $path) {
                if ($name !== $this->defaultEnvironment) {

                    $paths[] = new ScriptPath($path, $name);
                } else {
                    $paths[] = new ScriptPath($path);
                }
            }
        }

        return $paths;
    }

    /**
     * @param string|null $environment
     * @return array
     */
    public function getTemplates(string $environment = null): array
    {
        return $this->createResult(
            [$this->getEnvironment(), 'getTemplates'],
            [$this->getEnvironment($environment), 'getTemplates']
        );
    }

    /**
     * @param string|null $environment
     * @return array
     */
    public function getDynamicVariables(string $environment = null): array
    {
        return $this->createResult(
            [$this->getEnvironment(), 'getDynamicVariables'],
            [$this->getEnvironment($environment), 'getDynamicVariables']
        );
    }


    /**
     * @param string|null $environment
     * @return array
     */
    public function getConstants(string $environment = null): array
    {
        return $this->createResult(
            [$this->getEnvironment(), 'getConstants'],
            [$this->getEnvironment($environment), 'getConstants']
        );
    }

    /**
     * @return string
     */
    public function getHeader()
    {
        return $this->header;
    }

    /**
     * @return ConfigEnvironment[]
     */
    public function getEnvironments(): array
    {
        return $this->environments;
    }

    /**
     * @return string
     */
    public function getDefaultEnvironment(): string
    {
        return $this->defaultEnvironment;
    }

    /**
     * @param callable $defaultValues
     * @param callable $specificValues
     * @return array
     */
    private function createResult(callable $defaultValues, callable $specificValues): array
    {
        $mergedKeyValues = [];

        foreach ($defaultValues() as $key => $value) {
            $mergedKeyValues[$key] = $value;
        }

        foreach ($specificValues() as $key => $value) {
            $mergedKeyValues[$key] = $value;
        }

        return $mergedKeyValues;
    }

    /**
     * @param string|null $name
     * @return ConfigEnvironment
     */
    private function getEnvironment(string $name = null): ConfigEnvironment
    {
        if (!$name) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            return $this->environments[$this->defaultEnvironment];
        }

        return $this->environments[$name];
    }
}


1			<?php declare(strict_types=1);
2
3			namespace Shopware\Psh\Config;
4
5			/**
6			* Represents the global configuration consisting of multiple environments
7			*/
8			class Config
9			{
10			/**
11			* @var string
12			*/
13			private $header;
14
15			/**
16			* @var string
17			*/
18			private $defaultEnvironment;
19
20			/**
21			* @var ConfigEnvironment[]
22			*/
23			private $environments;
24
25			/**
26			* @param string\|null $header
27			* @param string $defaultEnvironment
28			* @param ConfigEnvironment[] $environments
29			*/
30			public function __construct(
31			string $header = null,
32			string $defaultEnvironment,
33			array $environments
34			) {
35			$this->header = $header;
36			$this->defaultEnvironment = $defaultEnvironment;
37			$this->environments = $environments;
38			}
39
40			/**
41			* @return ScriptPath[]
42			*/
43			public function getAllScriptPaths(): array
44			{
45			$paths = [];
46
47			foreach ($this->environments as $name => $environmentConfig) {
48			foreach ($environmentConfig->getAllScriptPaths() as $path) {
49			if ($name !== $this->defaultEnvironment) {
			0 ignored issues – show Unused Code Bug introduced 2016-11-08 08:33 UTC by Report Bug Copy Issue Report The strict comparison `!==` seems to always evaluate to `true` as the types of `$name` (`integer`) and `$this->defaultEnvironment` (`string`) can never be identical. Maybe you want to use a loose comparison `!=` instead? Loading history...
50			$paths[] = new ScriptPath($path, $name);
51			} else {
52			$paths[] = new ScriptPath($path);
53			}
54			}
55			}
56
57			return $paths;
58			}
59
60			/**
61			* @param string\|null $environment
62			* @return array
63			*/
64			public function getTemplates(string $environment = null): array
65			{
66			return $this->createResult(
67			[$this->getEnvironment(), 'getTemplates'],
68			[$this->getEnvironment($environment), 'getTemplates']
69			);
70			}
71
72			/**
73			* @param string\|null $environment
74			* @return array
75			*/
76			public function getDynamicVariables(string $environment = null): array
77			{
78			return $this->createResult(
79			[$this->getEnvironment(), 'getDynamicVariables'],
80			[$this->getEnvironment($environment), 'getDynamicVariables']
81			);
82			}
83
84
85			/**
86			* @param string\|null $environment
87			* @return array
88			*/
89			public function getConstants(string $environment = null): array
90			{
91			return $this->createResult(
92			[$this->getEnvironment(), 'getConstants'],
93			[$this->getEnvironment($environment), 'getConstants']
94			);
95			}
96
97			/**
98			* @return string
99			*/
100			public function getHeader()
101			{
102			return $this->header;
103			}
104
105			/**
106			* @return ConfigEnvironment[]
107			*/
108			public function getEnvironments(): array
109			{
110			return $this->environments;
111			}
112
113			/**
114			* @return string
115			*/
116			public function getDefaultEnvironment(): string
117			{
118			return $this->defaultEnvironment;
119			}
120
121			/**
122			* @param callable $defaultValues
123			* @param callable $specificValues
124			* @return array
125			*/
126			private function createResult(callable $defaultValues, callable $specificValues): array
127			{
128			$mergedKeyValues = [];
129
130			foreach ($defaultValues() as $key => $value) {
131			$mergedKeyValues[$key] = $value;
132			}
133
134			foreach ($specificValues() as $key => $value) {
135			$mergedKeyValues[$key] = $value;
136			}
137
138			return $mergedKeyValues;
139			}
140
141			/**
142			* @param string\|null $name
143			* @return ConfigEnvironment
144			*/
145			private function getEnvironment(string $name = null): ConfigEnvironment
146			{
147			if (!$name) {
			0 ignored issues – show Bug Best Practice introduced 2016-11-08 08:33 UTC by Report Bug Copy Issue Report The expression `$name` of type `null\|string` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
148			return $this->environments[$this->defaultEnvironment];
149			}
150
151			return $this->environments[$name];
152			}
153			}
154

shopwareLabs / psh

Pull Request — master (#42)

Config::getDefaultEnvironment() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like