Config::substitutePath() - Code Metrics - Inspection of "Singularize folders names" - yiisoft/composer-config-plugin - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#22)

by Dmitriy

created 2020-04-19 19:11 UTC

Config::substitutePath() A

↳ Parent: Config

Complexity

Conditions	5
Paths	12

Size

Total Lines	16
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	11
dl	0
loc	16
c	0
b	0
f	0
rs	9.6111
cc	5
nc	12
nop	3

<?php

namespace Yiisoft\Composer\Config\Config;

use Yiisoft\Arrays\ArrayHelper;
use Yiisoft\Composer\Config\Builder;
use Yiisoft\Composer\Config\ContentWriter;
use Yiisoft\Composer\Config\Reader\ReaderFactory;
use Yiisoft\Composer\Config\Util\Helper;
use Yiisoft\Composer\Config\Util\PathHelper;

/**
 * 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 = ArrayHelper::merge(...$sources);

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

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

        $params = $this->paramsRequired() ? "(array) require __DIR__ . '/params.php'" : '[]';
        $constants = $this->constantsRequired() ? $this->builder->getConfig('constants')->buildRequires() : '';
        $envs = $this->envsRequired() ? "\$_ENV = array_merge((array) require __DIR__ . '/envs.php', \$_ENV);" : '';
        $variables = Helper::exportVar($data);

        $content = <<<PHP
<?php
\$baseDir = {$baseDir};
\$params = {$params};
{$constants}
{$envs}
return {$variables};
PHP;

        $this->contentWriter->write($path, $this->replaceMarkers($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 = PathHelper::realpath(dirname($this->getOutputPath()));
        $diff = substr($outDir, strlen(PathHelper::realpath($this->getBaseDir())));

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

    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 = PathHelper::normalize($this->getBaseDir());

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

    /**
     * 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 Yiisoft\Arrays\ArrayHelper;
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\Helper;
10			use Yiisoft\Composer\Config\Util\PathHelper;
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 = ArrayHelper::merge(...$sources);
132
133			return $this->substituteOutputDirs($values);
134			}
135
136			protected function writeFile(string $path, array $data): void
137			{
138			$depth = $this->findDepth();
139			$baseDir = $depth > 0 ? "dirname(__DIR__, $depth)" : '__DIR__';
140
141			$params = $this->paramsRequired() ? "(array) require __DIR__ . '/params.php'" : '[]';
142			$constants = $this->constantsRequired() ? $this->builder->getConfig('constants')->buildRequires() : '';
143			$envs = $this->envsRequired() ? "\$_ENV = array_merge((array) require __DIR__ . '/envs.php', \$_ENV);" : '';
144			$variables = Helper::exportVar($data);
145
146			$content = <<<PHP
147			<?php
148			\$baseDir = {$baseDir};
149			\$params = {$params};
150			{$constants}
151			{$envs}
152			return {$variables};
153			PHP;
154
155			$this->contentWriter->write($path, $this->replaceMarkers($content) . "\n");
156			}
157
158			public function envsRequired(): bool
159			{
160			return true;
161			}
162
163			public function constantsRequired(): bool
164			{
165			return true;
166			}
167
168			public function paramsRequired(): bool
169			{
170			return true;
171			}
172
173			private function findDepth(): int
174			{
175			$outDir = PathHelper::realpath(dirname($this->getOutputPath()));
176			$diff = substr($outDir, strlen(PathHelper::realpath($this->getBaseDir())));
177
178			return substr_count($diff, '/');
179			}
180
181			private function replaceMarkers(string $content): string
182			{
183			return str_replace(
184			["'" . self::BASE_DIR_MARKER, "'?" . self::BASE_DIR_MARKER],
185			["\$baseDir . '", "'?' . \$baseDir . '"],
186			$content
187			);
188			}
189
190			/**
191			* Substitute output paths in given data array recursively with marker.
192			*
193			* @param array $data
194			* @return array
195			*/
196			protected function substituteOutputDirs(array $data): array
197			{
198			$dir = PathHelper::normalize($this->getBaseDir());
199
200			return $this->substitutePaths($data, $dir, self::BASE_DIR_MARKER);
201			}
202
203			/**
204			* Substitute all paths in given array recursively with alias if applicable.
205			*
206			* @param array $data
207			* @param string $dir
208			* @param string $alias
209			* @return array
210			*/
211			private function substitutePaths($data, $dir, $alias): array
212			{
213			foreach ($data as &$value) {
214			if (is_string($value)) {
215			$value = $this->substitutePath($value, $dir, $alias);
216			} elseif (is_array($value)) {
217			$value = $this->substitutePaths($value, $dir, $alias);
218			}
219			}
220
221			return $data;
222			}
223
224			/**
225			* Substitute path with alias if applicable.
226			*
227			* @param string $path
228			* @param string $dir
229			* @param string $alias
230			* @return string
231			*/
232			private function substitutePath($path, $dir, $alias): string
233			{
234			$end = $dir . '/';
235			$skippable = 0 === strncmp($path, '?', 1);
236			if ($skippable) {
237			$path = substr($path, 1);
238			}
239			if ($path === $dir) {
240			$result = $alias;
241			} elseif (strpos($path, $end) === 0) {
242			$result = $alias . substr($path, strlen($end) - 1);
243			} else {
244			$result = $path;
245			}
246
247			return ($skippable ? '?' : '') . $result;
248			}
249
250			private function getBaseDir(): string
251			{
252			return $this->builder->getBaseDir();
253			}
254
255			protected function getOutputPath(string $name = null): string
256			{
257			return $this->builder->getOutputPath($name ?: $this->name);
258			}
259			}
260

yiisoft / composer-config-plugin

Pull Request — master (#22)

Config::substitutePath() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like