Config::hasConstants() - Code Metrics - Inspection of "Readers and configs refactoring" - yiisoft/composer-config-plugin - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#5)

by Dmitriy

created 2020-04-09 16:38 UTC

Config::hasConstants() A

↳ Parent: Config

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Yiisoft\Composer\Config\Configs;

use ReflectionException;
use Yiisoft\Composer\Config\Builder;
use Yiisoft\Composer\Config\ContentWriter;
use Yiisoft\Composer\Config\Readers\ReaderFactory;
use Yiisoft\Composer\Config\Utils\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([Helper::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;",
            'dotenv' => $this->hasEnv()
                ? "\$_ENV = array_merge((array) require __DIR__ . '/dotenv.php', (array) \$_ENV);" : '',
            'defines' => $this->hasConstants() ? $this->builder->getConfig('defines')->buildRequires() : '',
            'params' => $this->hasParams() ? "\$params = require __DIR__ . '/params.php';" : '',
            'content' => $this->renderVars($data),
        ])));
        $this->contentWriter->write($path, $content . "\n");
    }

    public function hasEnv(): bool
    {
        return false;
    }

    public function hasConstants(): bool
    {
        return false;
    }

    public function hasParams(): bool
    {
        return false;
    }

    private function findDepth(): int
    {
        $outDir = dirname($this->normalizePath($this->getOutputPath()));
        $diff = substr($outDir, strlen($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 dirname(__DIR__, 5);
    }

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


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

yiisoft / composer-config-plugin

Pull Request — master (#5)

Config::hasConstants() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like