ConfigBuilder::setWorkingDirectory() - Code Metrics - Inspection of "Next minor" - shopwareLabs/psh - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#111)

by Jan Philipp

created 2021-06-08 11:10 UTC

ConfigBuilder::setWorkingDirectory() A

↳ Parent: ConfigBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php declare(strict_types=1);

namespace Shopware\Psh\Config;

use Shopware\Psh\Application\RuntimeParameters;
use function pathinfo;

/**
 * Builder pattern
 *
 * Create a config from a more complicated proto format by representing a stateful representation of config read so far.
 */
class ConfigBuilder
{
    private const DEFAULT_ENV = '##default##';

    private $header = '';

    private $environments = [];

    /**
     * @var string|null
     */
    private $currentEnvironment;

    private $currentCommandPaths;

    private $currentDotenvPaths;

    private $currentDynamicVariables;

    private $templates;

    private $currentConstants;

    private $hidden;

    private $currentRequiredVariables;

    private $imports;

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

    public function setHeader(?string $header = null): ConfigBuilder
    {
        $this->header = $header;

        return $this;
    }

    public function setWorkingDirectory(string $workingDirectory): ConfigBuilder
    {
        $this->workingDirectory = $workingDirectory;

        return $this;
    }

    public function start(?string $environment = null): ConfigBuilder
    {
        $this->reset();
        if ($environment === null) {
            $environment = self::DEFAULT_ENV;
        }

        $this->currentEnvironment = $environment;

        return $this;
    }

    public function setHidden(bool $set): ConfigBuilder
    {
        $this->hidden = $set;

        return $this;
    }

    public function setCommandPaths(array $commandPaths): ConfigBuilder
    {
        $this->currentCommandPaths = [];

        foreach ($commandPaths as $path) {
            $env = $this->currentEnvironment;

            if ($env === self::DEFAULT_ENV) {
                $env = null;
            }

            $this->currentCommandPaths[] = new ScriptsPath($path, $this->workingDirectory, $this->hidden, $env);
        }

        return $this;
    }

    /**
     * @deprecated only used by yaml builder
     */
    public function setDotenvPaths(array $dotenvPaths): ConfigBuilder
    {
        $this->currentDotenvPaths = [];

        foreach ($dotenvPaths as $dotenvPath) {
            $this->addDotenvPath($dotenvPath);
        }

        return $this;
    }

    public function addDotenvPath(string $dotenvPath): ConfigBuilder
    {
        $this->currentDotenvPaths[pathinfo($dotenvPath, PATHINFO_BASENAME)] = $dotenvPath;

        return $this;
    }

    public function addRequirePlaceholder(string $name, ?string $description = null): ConfigBuilder
    {
        $this->currentRequiredVariables[$name] = $description;

        return $this;
    }

    /**
     * @deprecated only used by yaml builder
     */
    public function setDynamicVariables(array $dynamicVariables): ConfigBuilder
    {
        $this->currentDynamicVariables = $dynamicVariables;

        return $this;
    }

    public function addDynamicVariable(string $key, string $value): ConfigBuilder
    {
        $this->currentDynamicVariables[$key] = $value;

        return $this;
    }

    /**
     * @deprecated only used by yaml builder
     */
    public function setConstants(array $constants): ConfigBuilder
    {
        $this->currentConstants = $constants;

        return $this;
    }

    public function addConstVariable(string $key, string $value): ConfigBuilder
    {
        $this->currentConstants[$key] = $value;

        return $this;
    }

    public function addImport(string $path): self
    {
        $this->imports[] = $path;

        return $this;
    }

    public function setTemplates(array $templates, string $baseFile): ConfigBuilder
    {
        $this->templates = [];

        foreach ($templates as $template) {
            $this->templates[] = new Template($template['source'], $template['destination'], $baseFile);
        }

        return $this;
    }

    public function create(RuntimeParameters $runtimeParameters): Config
    {
        $this->reset();

        return new Config(new EnvironmentResolver(), self::DEFAULT_ENV, $this->environments, $runtimeParameters, $this->header);
    }

    private function reset(): void
    {
        if ($this->currentEnvironment) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->environments[$this->currentEnvironment] = new ConfigEnvironment(
                $this->hidden,
                $this->currentCommandPaths,
                $this->currentDynamicVariables,
                $this->currentConstants,
                $this->templates,
                $this->currentDotenvPaths,
                $this->currentRequiredVariables,
                $this->imports
            );
        }

        $this->currentCommandPaths = [];
        $this->currentDotenvPaths = [];
        $this->currentDynamicVariables = [];
        $this->currentConstants = [];
        $this->templates = [];
        $this->hidden = false;
        $this->currentRequiredVariables = [];
        $this->imports = [];
    }
}


1			<?php declare(strict_types=1);
2
3			namespace Shopware\Psh\Config;
4
5			use Shopware\Psh\Application\RuntimeParameters;
6			use function pathinfo;
7
8			/**
9			* Builder pattern
10			*
11			* Create a config from a more complicated proto format by representing a stateful representation of config read so far.
12			*/
13			class ConfigBuilder
14			{
15			private const DEFAULT_ENV = '##default##';
16
17			private $header = '';
18
19			private $environments = [];
20
21			/**
22			* @var string\|null
23			*/
24			private $currentEnvironment;
25
26			private $currentCommandPaths;
27
28			private $currentDotenvPaths;
29
30			private $currentDynamicVariables;
31
32			private $templates;
33
34			private $currentConstants;
35
36			private $hidden;
37
38			private $currentRequiredVariables;
39
40			private $imports;
41
42			/**
43			* @var string
44			*/
45			private $workingDirectory;
46
47			public function setHeader(?string $header = null): ConfigBuilder
48			{
49			$this->header = $header;
50
51			return $this;
52			}
53
54			public function setWorkingDirectory(string $workingDirectory): ConfigBuilder
55			{
56			$this->workingDirectory = $workingDirectory;
57
58			return $this;
59			}
60
61			public function start(?string $environment = null): ConfigBuilder
62			{
63			$this->reset();
64			if ($environment === null) {
65			$environment = self::DEFAULT_ENV;
66			}
67
68			$this->currentEnvironment = $environment;
69
70			return $this;
71			}
72
73			public function setHidden(bool $set): ConfigBuilder
74			{
75			$this->hidden = $set;
76
77			return $this;
78			}
79
80			public function setCommandPaths(array $commandPaths): ConfigBuilder
81			{
82			$this->currentCommandPaths = [];
83
84			foreach ($commandPaths as $path) {
85			$env = $this->currentEnvironment;
86
87			if ($env === self::DEFAULT_ENV) {
88			$env = null;
89			}
90
91			$this->currentCommandPaths[] = new ScriptsPath($path, $this->workingDirectory, $this->hidden, $env);
92			}
93
94			return $this;
95			}
96
97			/**
98			* @deprecated only used by yaml builder
99			*/
100			public function setDotenvPaths(array $dotenvPaths): ConfigBuilder
101			{
102			$this->currentDotenvPaths = [];
103
104			foreach ($dotenvPaths as $dotenvPath) {
105			$this->addDotenvPath($dotenvPath);
106			}
107
108			return $this;
109			}
110
111			public function addDotenvPath(string $dotenvPath): ConfigBuilder
112			{
113			$this->currentDotenvPaths[pathinfo($dotenvPath, PATHINFO_BASENAME)] = $dotenvPath;
114
115			return $this;
116			}
117
118			public function addRequirePlaceholder(string $name, ?string $description = null): ConfigBuilder
119			{
120			$this->currentRequiredVariables[$name] = $description;
121
122			return $this;
123			}
124
125			/**
126			* @deprecated only used by yaml builder
127			*/
128			public function setDynamicVariables(array $dynamicVariables): ConfigBuilder
129			{
130			$this->currentDynamicVariables = $dynamicVariables;
131
132			return $this;
133			}
134
135			public function addDynamicVariable(string $key, string $value): ConfigBuilder
136			{
137			$this->currentDynamicVariables[$key] = $value;
138
139			return $this;
140			}
141
142			/**
143			* @deprecated only used by yaml builder
144			*/
145			public function setConstants(array $constants): ConfigBuilder
146			{
147			$this->currentConstants = $constants;
148
149			return $this;
150			}
151
152			public function addConstVariable(string $key, string $value): ConfigBuilder
153			{
154			$this->currentConstants[$key] = $value;
155
156			return $this;
157			}
158
159			public function addImport(string $path): self
160			{
161			$this->imports[] = $path;
162
163			return $this;
164			}
165
166			public function setTemplates(array $templates, string $baseFile): ConfigBuilder
167			{
168			$this->templates = [];
169
170			foreach ($templates as $template) {
171			$this->templates[] = new Template($template['source'], $template['destination'], $baseFile);
172			}
173
174			return $this;
175			}
176
177			public function create(RuntimeParameters $runtimeParameters): Config
178			{
179			$this->reset();
180
181			return new Config(new EnvironmentResolver(), self::DEFAULT_ENV, $this->environments, $runtimeParameters, $this->header);
182			}
183
184			private function reset(): void
185			{
186			if ($this->currentEnvironment) {
			0 ignored issues – show Bug Best Practice introduced 2020-11-24 09:58 UTC by Report Bug Copy Issue Report The expression `$this->currentEnvironment` 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. 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...
187			$this->environments[$this->currentEnvironment] = new ConfigEnvironment(
188			$this->hidden,
189			$this->currentCommandPaths,
190			$this->currentDynamicVariables,
191			$this->currentConstants,
192			$this->templates,
193			$this->currentDotenvPaths,
194			$this->currentRequiredVariables,
195			$this->imports
196			);
197			}
198
199			$this->currentCommandPaths = [];
200			$this->currentDotenvPaths = [];
201			$this->currentDynamicVariables = [];
202			$this->currentConstants = [];
203			$this->templates = [];
204			$this->hidden = false;
205			$this->currentRequiredVariables = [];
206			$this->imports = [];
207			}
208			}
209

shopwareLabs / psh

Pull Request — master (#111)

ConfigBuilder::setWorkingDirectory() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like