Gacela\Framework\Config\Config

Complexity

Total Complexity

32

Size/Duplication

Total Lines	178
Duplicated Lines	0 %

Test Coverage

Coverage

98.18%

Importance

Changes	4
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	getAppRootDir()	0	3	2
A	resetInstance()	0	4	1
A	getEventDispatcher()	0	9	2
A	__construct()	0	3	1
A	setAppRootDir()	0	9	4
A	createWithSetup()	0	5	1
A	get()	0	15	5
A	init()	0	8	1
A	getInstance()	0	7	2
A	getSetupGacela()	0	3	1
A	getFactory()	0	10	2
A	hasKey()	0	3	1
A	getCacheDir()	0	9	3
A	getDefaultCacheDir()	0	24	5
A	loadAllConfigValues()	0	5	1

<?php

declare(strict_types=1);

namespace Gacela\Framework\Config;

use Gacela\Framework\Bootstrap\SetupGacelaInterface;
use Gacela\Framework\Event\Dispatcher\EventDispatcherInterface;
use Gacela\Framework\Exception\ConfigException;
use RuntimeException;

use function array_key_exists;

final class Config implements ConfigInterface
{
    private static ?self $instance = null;

    private static ?EventDispatcherInterface $eventDispatcher = null;

    private ?ConfigFactory $configFactory = null;

    private ?string $appRootDir = null;

    /** @var array<string,mixed> */
    private array $config = [];

    private ?string $cacheDir = null;

    private function __construct(
        private readonly SetupGacelaInterface $setup,
    ) {
    }

    public static function createWithSetup(SetupGacelaInterface $setup): self
    {
        self::$instance = new self($setup);

        return self::$instance;
    }

    public static function getInstance(): self
    {
        if (!self::$instance instanceof self) {
            throw new RuntimeException('You have to call createWithSetup() first. Have you forgot to bootstrap Gacela?');
        }

        return self::$instance;
    }

    /**
     * @internal
     */
    public static function resetInstance(): void
    {
        self::$instance = null;
        self::$eventDispatcher = null;
    }

    public static function getEventDispatcher(): EventDispatcherInterface
    {
        if (!self::$eventDispatcher instanceof EventDispatcherInterface) {
            self::$eventDispatcher = self::getInstance()
                ->getSetupGacela()
                ->getEventDispatcher();
        }

        return self::$eventDispatcher;

The expression return self::eventDispatcher could return the type null which is incompatible with the type-hinted return Gacela\Framework\Event\Dispatcher\EventDispatcherInterface. Consider adding an additional type-check to rule them out.

    }

    /**
     * @throws ConfigException
     */
    public function get(string $key, mixed $default = self::DEFAULT_CONFIG_VALUE): mixed
    {
        if ($this->config === []) {
            $this->init();
        }

        if ($default !== self::DEFAULT_CONFIG_VALUE && !$this->hasKey($key)) {
            return $default;
        }

        if (!$this->hasKey($key)) {
            throw ConfigException::keyNotFound($key, self::class);
        }

        return $this->config[$key];
    }

    /**
     * Force loading all config values in memory.
     *
     * @throws ConfigException
     */
    public function init(): void
    {
        $this->configFactory = null;

        /** @psalm-suppress DuplicateArrayKey */
        $this->config = [
            ...$this->loadAllConfigValues(),
            ...$this->setup->getConfigKeyValues(),
        ];
    }

    public function setAppRootDir(string $dir): self
    {
        $this->appRootDir = rtrim($dir, DIRECTORY_SEPARATOR);

        if ($this->appRootDir === '' || $this->appRootDir === '0') {
            $this->appRootDir = getcwd() ?: ''; // @codeCoverageIgnore
        }

        return $this;
    }

    public function getAppRootDir(): string
    {
        return $this->appRootDir ?? getcwd() ?: '';
    }

    public function getCacheDir(): string
    {
        if ($this->cacheDir !== null) {
            return $this->cacheDir;
        }

        $this->cacheDir = getenv('GACELA_CACHE_DIR') ?: $this->getDefaultCacheDir();

        return rtrim($this->cacheDir, DIRECTORY_SEPARATOR);
    }

    /**
     * @internal
     */
    public function getFactory(): ConfigFactory
    {
        if (!$this->configFactory instanceof ConfigFactory) {
            $this->configFactory = new ConfigFactory(
                $this->getAppRootDir(),
                $this->setup,
            );
        }

        return $this->configFactory;

The expression return $this->configFactory could return the type null which is incompatible with the type-hinted return Gacela\Framework\Config\ConfigFactory. Consider adding an additional type-check to rule them out.

    }

    public function getSetupGacela(): SetupGacelaInterface
    {
        return $this->setup;
    }

    public function hasKey(string $key): bool
    {
        return array_key_exists($key, $this->config);
    }

    private function getDefaultCacheDir(): string
    {
        $cacheDir = $this->setup->getFileCacheDirectory();
        if ($cacheDir === '') {
            return sys_get_temp_dir();
        }

        $appRoot = $this->getAppRootDir();

        if (preg_match('#^[A-Za-z]:[\\/]#', $cacheDir) === 1) {
            return $cacheDir;
        }

        if ($cacheDir[0] === DIRECTORY_SEPARATOR) {
            if (str_starts_with($cacheDir, $appRoot . DIRECTORY_SEPARATOR)) {
                return $cacheDir;
            }

            return $appRoot . $cacheDir;
        }

        return $appRoot
            . DIRECTORY_SEPARATOR
            . ltrim($cacheDir, DIRECTORY_SEPARATOR);
    }

    /**
     * @return array<string,mixed>
     */
    private function loadAllConfigValues(): array
    {
        return $this->getFactory()
            ->createConfigLoader()
            ->loadAll();
    }
}