YamlConfigFileLoader::load() - 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-07-27 09:06 UTC

YamlConfigFileLoader::load() B

↳ Parent: YamlConfigFileLoader

Complexity

Conditions	2
Paths	2

Size

Total Lines	24
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	24
rs	8.9713
c	0
b	0
f	0
cc	2
eloc	15
nc	2
nop	1

<?php declare(strict_types=1);


namespace Shopware\Psh\Config;

use Symfony\Component\Yaml\Parser;

/**
 * Load the config data from a yaml file
 */
class YamlConfigFileLoader implements ConfigLoader
{
    const KEY_HEADER = 'header';

    const KEY_DYNAMIC_VARIABLES = 'dynamic';

    const KEY_CONST_VARIABLES = 'const';

    const KEY_COMMAND_PATHS = 'paths';

    const KEY_ENVIRONMENTS = 'environments';

    const KEY_TEMPLATES = 'templates';

    /**
     * @var Parser
     */
    private $yamlReader;

    /**
     * @var ConfigBuilder
     */
    private $configBuilder;

    /**
     * @param Parser $yamlReader
     * @param ConfigBuilder $configBuilder
     */
    public function __construct(Parser $yamlReader, ConfigBuilder $configBuilder)
    {
        $this->yamlReader = $yamlReader;
        $this->configBuilder = $configBuilder;
    }

    /**
     * @inheritdoc
     */
    public function isSupported(string $file): bool
    {
        $file = $this->removeDistExtension($file);
        return pathinfo($file, PATHINFO_EXTENSION) === 'yaml' || pathinfo($file, PATHINFO_EXTENSION) === 'yml';
    }

    /**
     * @param string $file
     * @return string
     */
    private function removeDistExtension(string $file): string
    {
        $fileInfo = pathinfo($file);
        if ($fileInfo['extension'] === 'dist') {
            $file = $fileInfo['filename'];
        }

        return $file;
    }

    /**
     * @inheritdoc
     */
    public function load(array $files): Config
    {
        $file = $files[0];
        $contents = $this->loadFileContents($file);
        $rawConfigData = $this->parseFileContents($contents);

        $this->configBuilder->start();

        $this->configBuilder
            ->setHeader(
                $this->extractData(self::KEY_HEADER, $rawConfigData, '')
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        $this->setConfigData($file, $rawConfigData);

        $environments = $this->extractData(self::KEY_ENVIRONMENTS, $rawConfigData, []);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        foreach ($environments as $name => $data) {
            $this->configBuilder->start($name);
            $this->setConfigData($file, $data);
        }

        return $this->configBuilder
            ->create();
    }

    /**
     * @param string $file
     * @param array $rawConfigData
     */
    private function setConfigData(string $file, array $rawConfigData)
    {
        $this->configBuilder->setCommandPaths(
            $this->extractCommandPaths($file, $rawConfigData)
        );

        $this->configBuilder->setDynamicVariables(
            $this->extractData(self::KEY_DYNAMIC_VARIABLES, $rawConfigData, [])
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        $this->configBuilder->setConstants(
            $this->extractData(self::KEY_CONST_VARIABLES, $rawConfigData, [])
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        $this->configBuilder->setTemplates(
            array_map(function ($template) use ($file) {
                $template['source'] = $this->fixPath($template['source'], $file);
                $template['destination'] = $this->fixPath($template['destination'], $file);

                return $template;
            }, $this->extractData(self::KEY_TEMPLATES, $rawConfigData, []))
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

    /**
     * @param string $key
     * @param array $rawConfig
     * @param bool $default
     * @return mixed|null
     */
    private function extractData(string $key, array $rawConfig, $default = false)
    {
        if (!array_key_exists($key, $rawConfig)) {
            return $default;
        }

        return $rawConfig[$key];
    }

    /**
     * @param string $file
     * @return string
     */
    private function loadFileContents(string $file): string
    {
        return file_get_contents($file);
    }

    /**
     * @param string $contents
     * @return array
     */
    private function parseFileContents(string $contents): array
    {
        return $this->yamlReader->parse($contents);
    }

    /**
     * @param string $file
     * @param $rawConfigData
     * @return array
     */
    private function extractCommandPaths(string $file, array $rawConfigData): array
    {
        $paths = $this->extractData(self::KEY_COMMAND_PATHS, $rawConfigData, []);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return array_map(function ($path) use ($file) {
            return $this->fixPath($path, $file);
        }, $paths);
    }

    /**
     * @param string $absoluteOrRelativePath
     * @param string $baseFile
     * @return string
     */
    private function fixPath(string $absoluteOrRelativePath, string $baseFile): string
    {
        if (file_exists($absoluteOrRelativePath)) {
            return $absoluteOrRelativePath;
        }

        return pathinfo($baseFile, PATHINFO_DIRNAME) . '/' . $absoluteOrRelativePath;
    }
}


1			<?php declare(strict_types=1);
2
3
4			namespace Shopware\Psh\Config;
5
6			use Symfony\Component\Yaml\Parser;
7
8			/**
9			* Load the config data from a yaml file
10			*/
11			class YamlConfigFileLoader implements ConfigLoader
12			{
13			const KEY_HEADER = 'header';
14
15			const KEY_DYNAMIC_VARIABLES = 'dynamic';
16
17			const KEY_CONST_VARIABLES = 'const';
18
19			const KEY_COMMAND_PATHS = 'paths';
20
21			const KEY_ENVIRONMENTS = 'environments';
22
23			const KEY_TEMPLATES = 'templates';
24
25			/**
26			* @var Parser
27			*/
28			private $yamlReader;
29
30			/**
31			* @var ConfigBuilder
32			*/
33			private $configBuilder;
34
35			/**
36			* @param Parser $yamlReader
37			* @param ConfigBuilder $configBuilder
38			*/
39			public function __construct(Parser $yamlReader, ConfigBuilder $configBuilder)
40			{
41			$this->yamlReader = $yamlReader;
42			$this->configBuilder = $configBuilder;
43			}
44
45			/**
46			* @inheritdoc
47			*/
48			public function isSupported(string $file): bool
49			{
50			$file = $this->removeDistExtension($file);
51			return pathinfo($file, PATHINFO_EXTENSION) === 'yaml' \|\| pathinfo($file, PATHINFO_EXTENSION) === 'yml';
52			}
53
54			/**
55			* @param string $file
56			* @return string
57			*/
58			private function removeDistExtension(string $file): string
59			{
60			$fileInfo = pathinfo($file);
61			if ($fileInfo['extension'] === 'dist') {
62			$file = $fileInfo['filename'];
63			}
64
65			return $file;
66			}
67
68			/**
69			* @inheritdoc
70			*/
71			public function load(array $files): Config
72			{
73			$file = $files[0];
74			$contents = $this->loadFileContents($file);
75			$rawConfigData = $this->parseFileContents($contents);
76
77			$this->configBuilder->start();
78
79			$this->configBuilder
80			->setHeader(
81			$this->extractData(self::KEY_HEADER, $rawConfigData, '')
			0 ignored issues – show Documentation introduced 2016-11-08 08:33 UTC by Report Bug Copy Issue Report `''` is of type `string`, but the function expects a `boolean`. 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...
82			);
83
84			$this->setConfigData($file, $rawConfigData);
85
86			$environments = $this->extractData(self::KEY_ENVIRONMENTS, $rawConfigData, []);
			0 ignored issues – show Documentation introduced 2016-11-08 08:33 UTC by Report Bug Copy Issue Report `array()` is of type `array`, but the function expects a `boolean`. 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...
87			foreach ($environments as $name => $data) {
88			$this->configBuilder->start($name);
89			$this->setConfigData($file, $data);
90			}
91
92			return $this->configBuilder
93			->create();
94			}
95
96			/**
97			* @param string $file
98			* @param array $rawConfigData
99			*/
100			private function setConfigData(string $file, array $rawConfigData)
101			{
102			$this->configBuilder->setCommandPaths(
103			$this->extractCommandPaths($file, $rawConfigData)
104			);
105
106			$this->configBuilder->setDynamicVariables(
107			$this->extractData(self::KEY_DYNAMIC_VARIABLES, $rawConfigData, [])
			0 ignored issues – show Documentation introduced 2016-11-08 08:33 UTC by Report Bug Copy Issue Report `array()` is of type `array`, but the function expects a `boolean`. 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...
108			);
109
110			$this->configBuilder->setConstants(
111			$this->extractData(self::KEY_CONST_VARIABLES, $rawConfigData, [])
			0 ignored issues – show Documentation introduced 2016-11-08 08:33 UTC by Report Bug Copy Issue Report `array()` is of type `array`, but the function expects a `boolean`. 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...
112			);
113
114			$this->configBuilder->setTemplates(
115			array_map(function ($template) use ($file) {
116			$template['source'] = $this->fixPath($template['source'], $file);
117			$template['destination'] = $this->fixPath($template['destination'], $file);
118
119			return $template;
120			}, $this->extractData(self::KEY_TEMPLATES, $rawConfigData, []))
			0 ignored issues – show Documentation introduced 2016-11-08 08:33 UTC by Report Bug Copy Issue Report `array()` is of type `array`, but the function expects a `boolean`. 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...
121			);
122			}
123
124			/**
125			* @param string $key
126			* @param array $rawConfig
127			* @param bool $default
128			* @return mixed\|null
129			*/
130			private function extractData(string $key, array $rawConfig, $default = false)
131			{
132			if (!array_key_exists($key, $rawConfig)) {
133			return $default;
134			}
135
136			return $rawConfig[$key];
137			}
138
139			/**
140			* @param string $file
141			* @return string
142			*/
143			private function loadFileContents(string $file): string
144			{
145			return file_get_contents($file);
146			}
147
148			/**
149			* @param string $contents
150			* @return array
151			*/
152			private function parseFileContents(string $contents): array
153			{
154			return $this->yamlReader->parse($contents);
155			}
156
157			/**
158			* @param string $file
159			* @param $rawConfigData
160			* @return array
161			*/
162			private function extractCommandPaths(string $file, array $rawConfigData): array
163			{
164			$paths = $this->extractData(self::KEY_COMMAND_PATHS, $rawConfigData, []);
			0 ignored issues – show Documentation introduced 2016-11-08 08:33 UTC by Report Bug Copy Issue Report `array()` is of type `array`, but the function expects a `boolean`. 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...
165
166			return array_map(function ($path) use ($file) {
167			return $this->fixPath($path, $file);
168			}, $paths);
169			}
170
171			/**
172			* @param string $absoluteOrRelativePath
173			* @param string $baseFile
174			* @return string
175			*/
176			private function fixPath(string $absoluteOrRelativePath, string $baseFile): string
177			{
178			if (file_exists($absoluteOrRelativePath)) {
179			return $absoluteOrRelativePath;
180			}
181
182			return pathinfo($baseFile, PATHINFO_DIRNAME) . '/' . $absoluteOrRelativePath;
183			}
184			}
185

shopwareLabs / psh

Pull Request — master (#42)

YamlConfigFileLoader::load() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like