Yiisoft\Composer\Config\Builder

Complexity

Total Complexity

37

Size/Duplication

Total Lines	235
Duplicated Lines	0 %

Test Coverage

Coverage

68.28%

Importance

Changes	6
Bugs	1	Features	0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	setOutputDir()	0	5	2
A	__construct()	0	5	1
A	rebuild()	0	12	6
A	createAlternative()	0	7	1
A	buildAbsPath()	0	3	2
A	path()	0	3	1
A	getOutputPath()	0	3	1
A	getConfig()	0	7	2
A	require()	0	3	1
A	buildUserConfigs()	0	9	2
A	setPackage()	0	3	1
A	buildSystemConfigs()	0	3	1
A	buildAllConfigs()	0	8	2
A	getBaseDir()	0	3	1
A	findOutputDir()	0	10	3
A	defaultOutputDir()	0	9	2
A	isAbsolutePath()	0	3	3
A	findBaseDir()	0	18	3
A	getVars()	0	8	2

<?php

declare(strict_types=1);

namespace Yiisoft\Composer\Config;

use function dirname;
use JsonException;
use Yiisoft\Composer\Config\Config\ConfigOutput;
use Yiisoft\Composer\Config\Config\ConfigOutputFactory;
use Yiisoft\Composer\Config\Util\Resolver;

use Yiisoft\Files\FileHelper;

/**
 * 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 ConfigOutput[] configurations
     */
    private array $configs = [];

    private ConfigOutputFactory $configFactory;

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

    public function createAlternative($name): self
    {
        $alt = new static($this->configFactory, $this->baseDir);
        $alt->setOutputDir($this->outputDir . DIRECTORY_SEPARATOR . $name);
        $alt->configs['packages'] = $this->getConfig('packages')->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 = null): void
    {
        // Ensure COMPOSER_HOME is set in case web server does not give PHP OS environment variables
        if (!(getenv('APPDATA') || getenv('HOME') || getenv('COMPOSER_HOME'))) {
            $path = sys_get_temp_dir() . '/.composer';
            if (!is_dir($path) && !mkdir($path)) {
                throw new \RuntimeException(sprintf('Directory "%s" was not created', $path));
            }
            putenv('COMPOSER_HOME=' . $path);
        }

        Plugin::buildAllConfigs($baseDir ?? self::findBaseDir());
    }

    /**
     * Returns default output dir.
     *
     * @param string|null $baseDir path to the root Composer package. When `null`,
     *
     * @throws JsonException
     *
     * @return string
     */
    private static function findOutputDir(string $baseDir = null): string
    {
        if ($baseDir === null) {
            $baseDir = static::findBaseDir();
        }
        $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 findBaseDir(): string
    {
        $candidates = [
            // normal relative path
            dirname(__DIR__, 4),
            // console
            getcwd(),
            // symlinked web
            dirname(getcwd()),
        ];

        foreach ($candidates as $baseDir) {
            if (file_exists($baseDir . DIRECTORY_SEPARATOR . 'composer.json')) {
                return $baseDir;
            }
        }

        throw new \RuntimeException('Cannot find directory that contains composer.json');
    }

    /**
     * Returns default output dir.
     *
     * @param string|null $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|null $baseDir path to base dir
     *
     * @throws JsonException
     *
     * @return string absolute path
     */
    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): bool
    {
        return strpos($path, '/') === 0 || strpos($path, ':') === 1 || strpos($path, '\\\\') === 0;
    }

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

        $this->buildUserConfigs($files);
        $this->buildSystemConfigs();
    }

    /**
     * Builds configs by given files list.
     *
     * @param 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(): void
    {
        $this->getConfig('packages')->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 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;
    }

    /**
     * Require another configuration by name.
     *
     * It will result in "require 'my-config' in the assembled configuration file.
     *
     * @param string $config config name
     *
     * @return callable
     */
    public static function require(string $config): callable
    {
        return static fn () => require $config;
    }
}