Builder::__construct() - Code Metrics - Inspection of "Add test for rebuild" - yiisoft/composer-config-plugin - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#42)

by Dmitriy

created 2020-04-25 13:52 UTC

Builder::__construct() A

↳ Parent: Builder

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Yiisoft\Composer\Config;

use JsonException;
use Yiisoft\Composer\Config\Config\Config;
use Yiisoft\Composer\Config\Config\ConfigFactory;
use Yiisoft\Composer\Config\Util\Resolver;

use function dirname;

/**
 * Builder assembles config files.
 */
class Builder
{
    private const OUTPUT_DIR_SUFFIX = '-output';

    /**
     * @var string path to the Composer project root
     */
    private string $baseDir;

    /**
     * @var string path to output assembled configs
     */
    private string $outputDir;

    /**
     * @var Config[] configurations
     */
    private array $configs = [];

    private ConfigFactory $configFactory;

    /**
     * Builder constructor.
     *
     * @param ConfigFactory $configFactory
     * @param string $baseDir path to the Composer project root
     */
    public function __construct(ConfigFactory $configFactory, string $baseDir)
    {
        $this->configFactory = $configFactory;
        $this->baseDir = $baseDir;
        $this->outputDir = self::findOutputDir($baseDir);
    }

    public function createAlternative($name): Builder
    {
        $alt = new static($this->configFactory, $this->baseDir);
        $alt->setOutputDir($this->outputDir . DIRECTORY_SEPARATOR . $name);
        foreach (['aliases', 'packages'] as $key) {
            $alt->configs[$key] = $this->getConfig($key)->clone($alt);
        }

        return $alt;
    }

    public function setOutputDir(?string $outputDir): void
    {
        $this->outputDir = $outputDir
            ? static::buildAbsPath($this->getBaseDir(), $outputDir)
            : static::findOutputDir($this->getBaseDir());
    }

    public static function rebuild(string $baseDir): void
    {
        $builder = new self(new ConfigFactory(), $baseDir);
        $files = $builder->getConfig('__files')->load();

        $builder->buildUserConfigs($files->getValues());
    }

    /**
     * Returns default output dir.
     *
     * @param string|null $baseDir path to the root Composer package. When `null`,
     * @return string
     * @throws JsonException
     */
    private static function findOutputDir(string $baseDir = null): string
    {
        if ($baseDir === null) {
            $baseDir = static::findDirContainsComposerJsonRecursively(getcwd());
        }
        $path = $baseDir . DIRECTORY_SEPARATOR . 'composer.json';
        $data = @json_decode(file_get_contents($path), true);
        $dir = $data['extra'][Package::EXTRA_OUTPUT_DIR_OPTION_NAME] ?? null;

        return $dir ? static::buildAbsPath($baseDir, $dir) : static::defaultOutputDir($baseDir);
    }

    private static function findDirContainsComposerJsonRecursively(string $cwd): string
    {
        if (file_exists($cwd . DIRECTORY_SEPARATOR . 'composer.json')) {
            return $cwd;
        }

        $candidateDirectory = dirname($cwd);
        if ($cwd === $candidateDirectory) {
            throw new \RuntimeException('Cannot find directory contains composer.json');
        }

        return static::findDirContainsComposerJsonRecursively($candidateDirectory);
    }

    /**
     * Returns default output dir.
     *
     * @param string $baseDir path to base directory
     * @return string
     */
    private static function defaultOutputDir(string $baseDir = null): string
    {
        if ($baseDir) {
            $dir = $baseDir . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'yiisoft' . DIRECTORY_SEPARATOR . basename(dirname(__DIR__));
        } else {
            $dir = dirname(__DIR__);
        }

        return $dir . static::OUTPUT_DIR_SUFFIX;
    }

    /**
     * Returns full path to assembled config file.
     *
     * @param string $filename name of config
     * @param string $baseDir path to base dir
     * @return string absolute path
     * @throws JsonException
     */
    public static function path(string $filename, string $baseDir = null): string
    {
        return static::buildAbsPath(static::findOutputDir($baseDir), $filename . '.php');
    }

    private static function buildAbsPath(string $dir, string $file): string
    {
        return self::isAbsolutePath($file) ? $file : $dir . DIRECTORY_SEPARATOR . $file;
    }

    private static function isAbsolutePath(string $path): string
    {
        return strpos($path, '/') === 0 || strpos($path, ':') === 1 || strpos($path, '\\\\') === 0;

    }

    /**
     * Builds all (user and system) configs by given files list.
     *
     * @param null|array $files files to process: config name => list of files
     */
    public function buildAllConfigs(array $files): void
    {
        $this->buildUserConfigs($files);
        $this->buildSystemConfigs($files);
    }

    /**
     * Builds configs by given files list.
     *
     * @param null|array $files files to process: config name => list of files
     * @return array
     */
    private function buildUserConfigs(array $files): array
    {
        $resolver = new Resolver($files);
        $files = $resolver->get();
        foreach ($files as $name => $paths) {
            $this->getConfig($name)->load($paths)->build()->write();
        }

        return $files;
    }

    private function buildSystemConfigs(array $files): void
    {
        $this->getConfig('__files')->setValues($files);
        foreach (['__files', 'aliases', 'packages'] as $name) {
            $this->getConfig($name)->build()->write();
        }
    }

    public function getOutputPath(string $name): string
    {
        return $this->outputDir . DIRECTORY_SEPARATOR . $name . '.php';
    }

    public function getConfig(string $name)
    {
        if (!array_key_exists($name, $this->configs)) {
            $this->configs[$name] = $this->configFactory->create($this, $name);
        }

        return $this->configs[$name];
    }

    public function getVars(): array
    {
        $vars = [];
        foreach ($this->configs as $name => $config) {
            $vars[$name] = $config->getValues();
        }

        return $vars;
    }

    public function mergeAliases(array $aliases): void
    {
        $this->getConfig('aliases')->mergeValues($aliases);
    }

    public function setPackage(string $name, array $data): void
    {
        $this->getConfig('packages')->setValue($name, $data);
    }

    /**
     * @return string a full path to the project root
     */
    public function getBaseDir(): string
    {
        return $this->baseDir;
    }
}


1			<?php
2
3			namespace Yiisoft\Composer\Config;
4
5			use JsonException;
6			use Yiisoft\Composer\Config\Config\Config;
7			use Yiisoft\Composer\Config\Config\ConfigFactory;
8			use Yiisoft\Composer\Config\Util\Resolver;
9
10			use function dirname;
11
12			/**
13			* Builder assembles config files.
14			*/
15			class Builder
16			{
17			private const OUTPUT_DIR_SUFFIX = '-output';
18
19			/**
20			* @var string path to the Composer project root
21			*/
22			private string $baseDir;
23
24			/**
25			* @var string path to output assembled configs
26			*/
27			private string $outputDir;
28
29			/**
30			* @var Config[] configurations
31			*/
32			private array $configs = [];
33
34			private ConfigFactory $configFactory;
35
36			/**
37			* Builder constructor.
38			*
39			* @param ConfigFactory $configFactory
40			* @param string $baseDir path to the Composer project root
41			*/
42			public function __construct(ConfigFactory $configFactory, string $baseDir)
43			{
44			$this->configFactory = $configFactory;
45			$this->baseDir = $baseDir;
46			$this->outputDir = self::findOutputDir($baseDir);
47			}
48
49			public function createAlternative($name): Builder
50			{
51			$alt = new static($this->configFactory, $this->baseDir);
52			$alt->setOutputDir($this->outputDir . DIRECTORY_SEPARATOR . $name);
53			foreach (['aliases', 'packages'] as $key) {
54			$alt->configs[$key] = $this->getConfig($key)->clone($alt);
55			}
56
57			return $alt;
58			}
59
60			public function setOutputDir(?string $outputDir): void
61			{
62			$this->outputDir = $outputDir
63			? static::buildAbsPath($this->getBaseDir(), $outputDir)
64			: static::findOutputDir($this->getBaseDir());
65			}
66
67			public static function rebuild(string $baseDir): void
68			{
69			$builder = new self(new ConfigFactory(), $baseDir);
70			$files = $builder->getConfig('__files')->load();
71
72			$builder->buildUserConfigs($files->getValues());
73			}
74
75			/**
76			* Returns default output dir.
77			*
78			* @param string\|null $baseDir path to the root Composer package. When `null`,
79			* @return string
80			* @throws JsonException
81			*/
82			private static function findOutputDir(string $baseDir = null): string
83			{
84			if ($baseDir === null) {
85			$baseDir = static::findDirContainsComposerJsonRecursively(getcwd());
86			}
87			$path = $baseDir . DIRECTORY_SEPARATOR . 'composer.json';
88			$data = @json_decode(file_get_contents($path), true);
89			$dir = $data['extra'][Package::EXTRA_OUTPUT_DIR_OPTION_NAME] ?? null;
90
91			return $dir ? static::buildAbsPath($baseDir, $dir) : static::defaultOutputDir($baseDir);
92			}
93
94			private static function findDirContainsComposerJsonRecursively(string $cwd): string
95			{
96			if (file_exists($cwd . DIRECTORY_SEPARATOR . 'composer.json')) {
97			return $cwd;
98			}
99
100			$candidateDirectory = dirname($cwd);
101			if ($cwd === $candidateDirectory) {
102			throw new \RuntimeException('Cannot find directory contains composer.json');
103			}
104
105			return static::findDirContainsComposerJsonRecursively($candidateDirectory);
106			}
107
108			/**
109			* Returns default output dir.
110			*
111			* @param string $baseDir path to base directory
112			* @return string
113			*/
114			private static function defaultOutputDir(string $baseDir = null): string
115			{
116			if ($baseDir) {
117			$dir = $baseDir . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'yiisoft' . DIRECTORY_SEPARATOR . basename(dirname(__DIR__));
118			} else {
119			$dir = dirname(__DIR__);
120			}
121
122			return $dir . static::OUTPUT_DIR_SUFFIX;
123			}
124
125			/**
126			* Returns full path to assembled config file.
127			*
128			* @param string $filename name of config
129			* @param string $baseDir path to base dir
130			* @return string absolute path
131			* @throws JsonException
132			*/
133			public static function path(string $filename, string $baseDir = null): string
134			{
135			return static::buildAbsPath(static::findOutputDir($baseDir), $filename . '.php');
136			}
137
138			private static function buildAbsPath(string $dir, string $file): string
139			{
140			return self::isAbsolutePath($file) ? $file : $dir . DIRECTORY_SEPARATOR . $file;
141			}
142
143			private static function isAbsolutePath(string $path): string
144			{
145			return strpos($path, '/') === 0 \|\| strpos($path, ':') === 1 \|\| strpos($path, '\\\\') === 0;
			0 ignored issues – show Bug Best Practice introduced 2020-04-21 16:52 UTC by Report Bug Copy Issue Report The expression `return strpos($path, '/'...rpos($path, '\\') === 0` returns the type `boolean` which is incompatible with the type-hinted return `string`. Loading history...
146			}
147
148			/**
149			* Builds all (user and system) configs by given files list.
150			*
151			* @param null\|array $files files to process: config name => list of files
152			*/
153			public function buildAllConfigs(array $files): void
154			{
155			$this->buildUserConfigs($files);
156			$this->buildSystemConfigs($files);
157			}
158
159			/**
160			* Builds configs by given files list.
161			*
162			* @param null\|array $files files to process: config name => list of files
163			* @return array
164			*/
165			private function buildUserConfigs(array $files): array
166			{
167			$resolver = new Resolver($files);
168			$files = $resolver->get();
169			foreach ($files as $name => $paths) {
170			$this->getConfig($name)->load($paths)->build()->write();
171			}
172
173			return $files;
174			}
175
176			private function buildSystemConfigs(array $files): void
177			{
178			$this->getConfig('__files')->setValues($files);
179			foreach (['__files', 'aliases', 'packages'] as $name) {
180			$this->getConfig($name)->build()->write();
181			}
182			}
183
184			public function getOutputPath(string $name): string
185			{
186			return $this->outputDir . DIRECTORY_SEPARATOR . $name . '.php';
187			}
188
189			public function getConfig(string $name)
190			{
191			if (!array_key_exists($name, $this->configs)) {
192			$this->configs[$name] = $this->configFactory->create($this, $name);
193			}
194
195			return $this->configs[$name];
196			}
197
198			public function getVars(): array
199			{
200			$vars = [];
201			foreach ($this->configs as $name => $config) {
202			$vars[$name] = $config->getValues();
203			}
204
205			return $vars;
206			}
207
208			public function mergeAliases(array $aliases): void
209			{
210			$this->getConfig('aliases')->mergeValues($aliases);
211			}
212
213			public function setPackage(string $name, array $data): void
214			{
215			$this->getConfig('packages')->setValue($name, $data);
216			}
217
218			/**
219			* @return string a full path to the project root
220			*/
221			public function getBaseDir(): string
222			{
223			return $this->baseDir;
224			}
225			}
226

yiisoft / composer-config-plugin

Pull Request — master (#42)

Builder::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like