Config::normalizePath() - Code Metrics - Inspection of "Tests + refactoring" - yiisoft/composer-config-plugin - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#24)

by Dmitriy

created 2020-04-17 18:53 UTC

Config::normalizePath() A

↳ Parent: Config

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Yiisoft\Composer\Config\Config;

use ReflectionException;
use Yiisoft\Composer\Config\Builder;
use Yiisoft\Composer\Config\ContentWriter;
use Yiisoft\Composer\Config\Reader\ReaderFactory;
use Yiisoft\Composer\Config\Util\ConfigMergeHelper;
use Yiisoft\Composer\Config\Util\Helper;

/**
 * Config class represents output configuration file.
 */
class Config
{
    private const BASE_DIR_MARKER = '<<<base-dir>>>';

    /**
     * @var string config name
     */
    private string $name;

    /**
     * @var array sources - paths to config source files
     */
    private array $sources = [];

    /**
     * @var array config value
     */
    protected array $values = [];

    protected Builder $builder;

    protected ContentWriter $contentWriter;

    public function __construct(Builder $builder, string $name)
    {
        $this->builder = $builder;
        $this->name = $name;
        $this->contentWriter = new ContentWriter();
    }

    public function clone(Builder $builder): self
    {
        $config = new Config($builder, $this->name);
        $config->sources = $this->sources;
        $config->values = $this->values;

        return $config;
    }

    public function getValues(): array
    {
        return $this->values;
    }

    public function load(array $paths = []): self
    {
        $this->sources = $this->loadFiles($paths);

        return $this;
    }

    private function loadFiles(array $paths): array
    {
        switch (count($paths)) {
            case 0:
                return [];
            case 1:
                return [$this->loadFile(reset($paths))];
        }

        $configs = [];
        foreach ($paths as $path) {
            $cs = $this->loadFiles($this->glob($path));
            foreach ($cs as $config) {
                if (!empty($config)) {
                    $configs[] = $config;
                }
            }
        }

        return $configs;
    }

    private function glob(string $path): array
    {
        if (strpos($path, '*') === false) {
            return [$path];
        }

        return glob($path);

    }

    /**
     * Reads config file.
     *
     * @param string $path
     * @return array configuration read from file
     */
    protected function loadFile($path): array
    {
        $reader = ReaderFactory::get($this->builder, $path);

        return $reader->read($path);
    }

    /**
     * Merges given configs and writes at given name.
     *
     * @return Config
     */
    public function build(): self
    {
        $this->values = $this->calcValues($this->sources);

        return $this;
    }

    public function write(): self
    {
        $this->writeFile($this->getOutputPath(), $this->values);

        return $this;
    }

    protected function calcValues(array $sources): array
    {
        $values = call_user_func_array([ConfigMergeHelper::class, 'mergeConfig'], $sources);
        $values = Helper::fixConfig($values);

        return $this->substituteOutputDirs($values);
    }

    protected function writeFile(string $path, array $data): void
    {
        $depth = $this->findDepth();
        $baseDir = $depth > 0 ? "dirname(__DIR__, $depth)" : '__DIR__';

        $content = $this->replaceMarkers(implode("\n\n", array_filter([
            'header' => '<?php',
            'baseDir' => "\$baseDir = $baseDir;",
            'envs' => $this->envsRequired()
                ? "\$_ENV = array_merge((array) require __DIR__ . '/envs.php', \$_ENV);" : '',
            'constants' => $this->constantsRequired() ? $this->builder->getConfig('constants')->buildRequires() : '',
            'params' => $this->paramsRequired() ? "\$params = require __DIR__ . '/params.php';" : '',
            'content' => $this->renderVars($data),
        ])));
        $this->contentWriter->write($path, $content . "\n");
    }

    public function envsRequired(): bool
    {
        return true;
    }

    public function constantsRequired(): bool
    {
        return true;
    }

    public function paramsRequired(): bool
    {
        return true;
    }

    private function findDepth(): int
    {
        $outDir = realpath(dirname($this->normalizePath($this->getOutputPath())));
        $diff = substr($outDir, strlen(realpath($this->getBaseDir())));

        return substr_count($diff, '/');
    }

    /**
     * @param array $vars array to be exported
     * @return string
     * @throws ReflectionException
     */
    private function renderVars(array $vars): string
    {
        return 'return ' . Helper::exportVar($vars) . ';';
    }

    private function replaceMarkers(string $content): string
    {
        return str_replace(
            ["'" . self::BASE_DIR_MARKER, "'?" . self::BASE_DIR_MARKER],
            ["\$baseDir . '", "'?' . \$baseDir . '"],
            $content
        );
    }

    /**
     * Substitute output paths in given data array recursively with marker.
     *
     * @param array $data
     * @return array
     */
    protected function substituteOutputDirs(array $data): array
    {
        $dir = $this->normalizePath($this->getBaseDir());

        return $this->substitutePaths($data, $dir, self::BASE_DIR_MARKER);
    }

    /**
     * Normalizes given path with given directory separator.
     * Default forced to Unix directory separator for substitutePaths to work properly in Windows.
     *
     * @param string $path path to be normalized
     * @param string $ds directory separator
     * @return string
     */
    private function normalizePath($path): string
    {
        return rtrim(strtr($path, '/\\', '//'), '/');
    }

    /**
     * Substitute all paths in given array recursively with alias if applicable.
     *
     * @param array $data
     * @param string $dir
     * @param string $alias
     * @return array
     */
    private function substitutePaths($data, $dir, $alias): array
    {
        foreach ($data as &$value) {
            if (is_string($value)) {
                $value = $this->substitutePath($value, $dir, $alias);
            } elseif (is_array($value)) {
                $value = $this->substitutePaths($value, $dir, $alias);
            }
        }

        return $data;
    }

    /**
     * Substitute path with alias if applicable.
     *
     * @param string $path
     * @param string $dir
     * @param string $alias
     * @return string
     */
    private function substitutePath($path, $dir, $alias): string
    {
        $end = $dir . '/';
        $skippable = 0 === strncmp($path, '?', 1);
        if ($skippable) {
            $path = substr($path, 1);
        }
        if ($path === $dir) {
            $result = $alias;
        } elseif (strpos($path, $end) === 0) {
            $result = $alias . substr($path, strlen($end) - 1);
        } else {
            $result = $path;
        }

        return ($skippable ? '?' : '') . $result;
    }

    private function getBaseDir(): string
    {
        return $this->builder->getBaseDir();
    }

    protected function getOutputPath(string $name = null): string
    {
        return $this->builder->getOutputPath($name ?: $this->name);
    }
}


1			<?php
2
3			namespace Yiisoft\Composer\Config\Config;
4
5			use ReflectionException;
6			use Yiisoft\Composer\Config\Builder;
7			use Yiisoft\Composer\Config\ContentWriter;
8			use Yiisoft\Composer\Config\Reader\ReaderFactory;
9			use Yiisoft\Composer\Config\Util\ConfigMergeHelper;
10			use Yiisoft\Composer\Config\Util\Helper;
11
12			/**
13			* Config class represents output configuration file.
14			*/
15			class Config
16			{
17			private const BASE_DIR_MARKER = '<<<base-dir>>>';
18
19			/**
20			* @var string config name
21			*/
22			private string $name;
23
24			/**
25			* @var array sources - paths to config source files
26			*/
27			private array $sources = [];
28
29			/**
30			* @var array config value
31			*/
32			protected array $values = [];
33
34			protected Builder $builder;
35
36			protected ContentWriter $contentWriter;
37
38			public function __construct(Builder $builder, string $name)
39			{
40			$this->builder = $builder;
41			$this->name = $name;
42			$this->contentWriter = new ContentWriter();
43			}
44
45			public function clone(Builder $builder): self
46			{
47			$config = new Config($builder, $this->name);
48			$config->sources = $this->sources;
49			$config->values = $this->values;
50
51			return $config;
52			}
53
54			public function getValues(): array
55			{
56			return $this->values;
57			}
58
59			public function load(array $paths = []): self
60			{
61			$this->sources = $this->loadFiles($paths);
62
63			return $this;
64			}
65
66			private function loadFiles(array $paths): array
67			{
68			switch (count($paths)) {
69			case 0:
70			return [];
71			case 1:
72			return [$this->loadFile(reset($paths))];
73			}
74
75			$configs = [];
76			foreach ($paths as $path) {
77			$cs = $this->loadFiles($this->glob($path));
78			foreach ($cs as $config) {
79			if (!empty($config)) {
80			$configs[] = $config;
81			}
82			}
83			}
84
85			return $configs;
86			}
87
88			private function glob(string $path): array
89			{
90			if (strpos($path, '*') === false) {
91			return [$path];
92			}
93
94			return glob($path);
			0 ignored issues – show Bug Best Practice introduced 2020-03-22 10:14 UTC by Report Bug Copy Issue Report The expression `return glob($path)` could return the type `false` which is incompatible with the type-hinted return `array`. Consider adding an additional type-check to rule them out. Loading history...
95			}
96
97			/**
98			* Reads config file.
99			*
100			* @param string $path
101			* @return array configuration read from file
102			*/
103			protected function loadFile($path): array
104			{
105			$reader = ReaderFactory::get($this->builder, $path);
106
107			return $reader->read($path);
108			}
109
110			/**
111			* Merges given configs and writes at given name.
112			*
113			* @return Config
114			*/
115			public function build(): self
116			{
117			$this->values = $this->calcValues($this->sources);
118
119			return $this;
120			}
121
122			public function write(): self
123			{
124			$this->writeFile($this->getOutputPath(), $this->values);
125
126			return $this;
127			}
128
129			protected function calcValues(array $sources): array
130			{
131			$values = call_user_func_array([ConfigMergeHelper::class, 'mergeConfig'], $sources);
132			$values = Helper::fixConfig($values);
133
134			return $this->substituteOutputDirs($values);
135			}
136
137			protected function writeFile(string $path, array $data): void
138			{
139			$depth = $this->findDepth();
140			$baseDir = $depth > 0 ? "dirname(__DIR__, $depth)" : '__DIR__';
141
142			$content = $this->replaceMarkers(implode("\n\n", array_filter([
143			'header' => '<?php',
144			'baseDir' => "\$baseDir = $baseDir;",
145			'envs' => $this->envsRequired()
146			? "\$_ENV = array_merge((array) require __DIR__ . '/envs.php', \$_ENV);" : '',
147			'constants' => $this->constantsRequired() ? $this->builder->getConfig('constants')->buildRequires() : '',
148			'params' => $this->paramsRequired() ? "\$params = require __DIR__ . '/params.php';" : '',
149			'content' => $this->renderVars($data),
150			])));
151			$this->contentWriter->write($path, $content . "\n");
152			}
153
154			public function envsRequired(): bool
155			{
156			return true;
157			}
158
159			public function constantsRequired(): bool
160			{
161			return true;
162			}
163
164			public function paramsRequired(): bool
165			{
166			return true;
167			}
168
169			private function findDepth(): int
170			{
171			$outDir = realpath(dirname($this->normalizePath($this->getOutputPath())));
172			$diff = substr($outDir, strlen(realpath($this->getBaseDir())));
173
174			return substr_count($diff, '/');
175			}
176
177			/**
178			* @param array $vars array to be exported
179			* @return string
180			* @throws ReflectionException
181			*/
182			private function renderVars(array $vars): string
183			{
184			return 'return ' . Helper::exportVar($vars) . ';';
185			}
186
187			private function replaceMarkers(string $content): string
188			{
189			return str_replace(
190			["'" . self::BASE_DIR_MARKER, "'?" . self::BASE_DIR_MARKER],
191			["\$baseDir . '", "'?' . \$baseDir . '"],
192			$content
193			);
194			}
195
196			/**
197			* Substitute output paths in given data array recursively with marker.
198			*
199			* @param array $data
200			* @return array
201			*/
202			protected function substituteOutputDirs(array $data): array
203			{
204			$dir = $this->normalizePath($this->getBaseDir());
205
206			return $this->substitutePaths($data, $dir, self::BASE_DIR_MARKER);
207			}
208
209			/**
210			* Normalizes given path with given directory separator.
211			* Default forced to Unix directory separator for substitutePaths to work properly in Windows.
212			*
213			* @param string $path path to be normalized
214			* @param string $ds directory separator
215			* @return string
216			*/
217			private function normalizePath($path): string
218			{
219			return rtrim(strtr($path, '/\\', '//'), '/');
220			}
221
222			/**
223			* Substitute all paths in given array recursively with alias if applicable.
224			*
225			* @param array $data
226			* @param string $dir
227			* @param string $alias
228			* @return array
229			*/
230			private function substitutePaths($data, $dir, $alias): array
231			{
232			foreach ($data as &$value) {
233			if (is_string($value)) {
234			$value = $this->substitutePath($value, $dir, $alias);
235			} elseif (is_array($value)) {
236			$value = $this->substitutePaths($value, $dir, $alias);
237			}
238			}
239
240			return $data;
241			}
242
243			/**
244			* Substitute path with alias if applicable.
245			*
246			* @param string $path
247			* @param string $dir
248			* @param string $alias
249			* @return string
250			*/
251			private function substitutePath($path, $dir, $alias): string
252			{
253			$end = $dir . '/';
254			$skippable = 0 === strncmp($path, '?', 1);
255			if ($skippable) {
256			$path = substr($path, 1);
257			}
258			if ($path === $dir) {
259			$result = $alias;
260			} elseif (strpos($path, $end) === 0) {
261			$result = $alias . substr($path, strlen($end) - 1);
262			} else {
263			$result = $path;
264			}
265
266			return ($skippable ? '?' : '') . $result;
267			}
268
269			private function getBaseDir(): string
270			{
271			return $this->builder->getBaseDir();
272			}
273
274			protected function getOutputPath(string $name = null): string
275			{
276			return $this->builder->getOutputPath($name ?: $this->name);
277			}
278			}
279

yiisoft / composer-config-plugin

Pull Request — master (#24)

Config::normalizePath() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like