hiqdev\composer\config\Package

Complexity

Total Complexity

45

Size/Duplication

Total Lines	336
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	0

22 Methods

Rating	Name	Duplication	Size	Complexity
A	preparePath()	0	19	6
A	getOutputDir()	0	3	1
A	getVendorDir()	0	3	1
A	__construct()	0	8	1
A	getAutoload()	0	3	1
A	getDevAutoload()	0	3	1
A	isComplete()	0	3	1
A	getRequires()	0	3	1
A	getFiles()	0	3	1
A	isRoot()	0	3	1
A	getSourceReference()	0	3	1
A	getDevFiles()	0	3	1
A	readRawData()	0	8	2
A	getBaseDir()	0	3	1
A	getVersion()	0	3	1
A	getDistReference()	0	3	1
A	getDevRequires()	0	3	1
A	getRawValue()	0	3	1
A	getPrettyName()	0	3	1
A	getExtraValue()	0	3	1
A	getExtra()	0	3	1
A	getAlternatives()	0	3	1

<?php

namespace Yiisoft\Composer\Config;

use Composer\Package\CompletePackageInterface;
use Composer\Package\PackageInterface;
use Composer\Package\RootPackageInterface;
use Composer\Util\Filesystem;

/**
 * Class Package.
 */
class Package
{
    public const EXTRA_FILES_OPTION_NAME = 'config-plugin';
    public const EXTRA_DEV_FILES_OPTION_NAME = 'config-plugin-dev';
    public const EXTRA_OUTPUT_DIR_OPTION_NAME = 'config-plugin-output-dir';
    public const EXTRA_ALTERNATIVES_OPTION_NAME = 'config-plugin-alternatives';

    private PackageInterface $package;

    /**
     * @var array composer.json raw data array
     */
    private array $data;

    /**
     * @var string absolute path to the root base directory
     */
    private string $baseDir;

    /**
     * @var string absolute path to vendor directory
     */
    private string $vendorDir;

    /**
     * @var Filesystem utility
     */
    private Filesystem $filesystem;

    public function __construct(PackageInterface $package, string $vendorDir)
    {
        $this->package = $package;
        $this->filesystem = new Filesystem();

        $this->vendorDir = $this->filesystem->normalizePath($vendorDir);
        $this->baseDir = dirname($this->vendorDir);
        $this->data = $this->readRawData();
    }

    /**
     * @return string package pretty name, like: vendor/name
     */
    public function getPrettyName(): string
    {
        return $this->package->getPrettyName();
    }

    /**
     * @return string package version, like: 3.0.16.0, 9999999-dev
     */
    public function getVersion(): string
    {
        return $this->package->getVersion();
    }

    /**
     * @return string package CVS revision, like: 3a4654ac9655f32888efc82fb7edf0da517d8995
     */
    public function getSourceReference(): ?string
    {
        return $this->package->getSourceReference();
    }

    /**
     * @return string package dist revision, like: 3a4654ac9655f32888efc82fb7edf0da517d8995
     */
    public function getDistReference(): ?string
    {
        return $this->package->getDistReference();
    }

    /**
     * @return bool is package complete
     */
    public function isComplete(): bool
    {
        return $this->package instanceof CompletePackageInterface;
    }

    /**
     * @return bool is this a root package
     */
    public function isRoot(): bool
    {
        return $this->package instanceof RootPackageInterface;
    }

    /**
     * @return array autoload configuration array
     */
    public function getAutoload(): array
    {
        return $this->getRawValue('autoload') ?? $this->package->getAutoload();
    }

    /**
     * @return array autoload-dev configuration array
     */
    public function getDevAutoload(): array
    {
        return $this->getRawValue('autoload-dev') ?? $this->package->getDevAutoload();
    }

    /**
     * @return array require configuration array
     */
    public function getRequires(): array
    {
        return $this->getRawValue('require') ?? $this->package->getRequires();
    }

    /**
     * @return array requre-dev configuration array
     */
    public function getDevRequires(): array
    {
        return $this->getRawValue('require-dev') ?? $this->package->getDevRequires();
    }

    /**
     * @return array files array
     */
    public function getFiles(): array
    {
        return $this->getExtraValue(self::EXTRA_FILES_OPTION_NAME, []);
    }

    /**
     * @return array dev-files array
     */
    public function getDevFiles(): array
    {
        return $this->getExtraValue(self::EXTRA_DEV_FILES_OPTION_NAME, []);
    }

    /**
     * @return array output-dir option
     */
    public function getOutputDir(): ?string
    {
        return $this->getExtraValue(self::EXTRA_OUTPUT_DIR_OPTION_NAME);

The expression return $this->getExtraValue(self::EXTRA_OUTPUT_DIR_OPTION_NAME) returns the type array which is incompatible with the type-hinted return null|string.

    }

    /**
     * @return mixed alternatives array or path to config
     */
    public function getAlternatives()
    {
        return $this->getExtraValue(self::EXTRA_ALTERNATIVES_OPTION_NAME);
    }

    /**
     * @return array alternatives array
     */
    private function getExtraValue($key, $default = null)
    {
        return $this->getExtra()[$key] ?? $default;
    }

    /**
     * @return array extra configuration array
     */
    private function getExtra(): array
    {
        return $this->getRawValue('extra') ?? $this->package->getExtra();
    }

    /**
     * @param string $name option name
     * @return mixed raw value from composer.json if available
     */
    private function getRawValue(string $name)
    {
        return $this->data[$name] ?? null;
    }

    /**
     * @return array composer.json contents as array
     * @throws \JsonException
     */
    private function readRawData(): array
    {
        $path = $this->preparePath('composer.json');
        if (file_exists($path)) {
            return json_decode(file_get_contents($path), true, 512, JSON_THROW_ON_ERROR);
        }

        return [];
    }

    /**
     * Builds path inside of a package.
     *
     * @param string $file
     * @return string absolute paths will stay untouched
     */
    public function preparePath(string $file): string
    {
        if (0 === strncmp($file, '$', 1)) {
            return $file;
        }

        $skippable = 0 === strncmp($file, '?', 1) ? '?' : '';
        if ($skippable) {
            $file = substr($file, 1);
        }

        if (!$this->filesystem->isAbsolutePath($file)) {
            $prefix = $this->isRoot()
                ? $this->baseDir
                : $this->vendorDir . '/' . $this->getPrettyName();
            $file = $prefix . '/' . $file;
        }

        return $skippable . $this->filesystem->normalizePath($file);
    }

    public function getVendorDir(): string
    {
        return $this->vendorDir;
    }

    public function getBaseDir(): string
    {
        return $this->baseDir;
    }
}