Config::getDefaultCacheDir() - Code Metrics - Inspection of "Merge pull request #322 from gacela-project/feat/d..." - gacela-project/gacela - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 7210a8...a042a1 )

by Chema

created 2024-12-01 11:46 UTC

Config::getDefaultCacheDir() A

↳ Parent: Config

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	5
dl	0
loc	9
ccs	0
cts	0
cp	0
rs	10
c	1
b	0
f	0
cc	2
nc	2
nop	0
crap	6

<?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;

    }

    /**
     * @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;

    }

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

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

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

        return $this->getAppRootDir()
            . DIRECTORY_SEPARATOR
            . ltrim($this->setup->getFileCacheDirectory(), DIRECTORY_SEPARATOR);
    }

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


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Gacela\Framework\Config;
6
7		use Gacela\Framework\Bootstrap\SetupGacelaInterface;
8		use Gacela\Framework\Event\Dispatcher\EventDispatcherInterface;
9		use Gacela\Framework\Exception\ConfigException;
10		use RuntimeException;
11
12		use function array_key_exists;
13
14		final class Config implements ConfigInterface
15		{
16		private static ?self $instance = null;
17
18		private static ?EventDispatcherInterface $eventDispatcher = null;
19
20		private ?ConfigFactory $configFactory = null;
21
22		private ?string $appRootDir = null;
23
24		/** @var array<string,mixed> */
25		private array $config = [];
26
27	106	private ?string $cacheDir = null;
28
29		private function __construct(
30	106	private readonly SetupGacelaInterface $setup,
31		) {
32	106	}
33
34	106	public static function createWithSetup(SetupGacelaInterface $setup): self
35		{
36	106	self::$instance = new self($setup);
37
38		return self::$instance;
39	89	}
40
41	89	public static function getInstance(): self
42		{
43		if (!self::$instance instanceof self) {
44		throw new RuntimeException('You have to call createWithSetup() first. Have you forgot to bootstrap Gacela?');
45	89	}
46
47		return self::$instance;
48		}
49
50		/**
51	58	* @internal
52		*/
53	58	public static function resetInstance(): void
54	58	{
55		self::$instance = null;
56		self::$eventDispatcher = null;
57	89	}
58
59	89	public static function getEventDispatcher(): EventDispatcherInterface
60	55	{
61	55	if (!self::$eventDispatcher instanceof EventDispatcherInterface) {
62	55	self::$eventDispatcher = self::getInstance()
63		->getSetupGacela()
64		->getEventDispatcher();
65	89	}
66
67		return self::$eventDispatcher;
		0 ignored issues – show Bug Best Practice introduced 2022-11-01 17:52 UTC by Report Bug Copy Issue Report The expression `return self::eventDispatcher` could return the type `null` which is incompatible with the type-hinted return `Gacela\Framework\Event\D...ventDispatcherInterface`. Consider adding an additional type-check to rule them out. Loading history...
68		}
69
70		/**
71	24	* @throws ConfigException
72		*/
73	24	public function get(string $key, mixed $default = self::DEFAULT_CONFIG_VALUE): mixed
74	3	{
75		if ($this->config === []) {
76		$this->init();
77	24	}
78	2
79		if ($default !== self::DEFAULT_CONFIG_VALUE && !$this->hasKey($key)) {
80		return $default;
81	22	}
82	1
83		if (!$this->hasKey($key)) {
84		throw ConfigException::keyNotFound($key, self::class);
85	21	}
86
87		return $this->config[$key];
88		}
89
90		/**
91		* Force loading all config values in memory.
92		*
93	106	* @throws ConfigException
94		*/
95	106	public function init(): void
96	106	{
97	106	$this->configFactory = null;
98
99		/** @psalm-suppress DuplicateArrayKey */
100	106	$this->config = [
101		...$this->loadAllConfigValues(),
102	106	...$this->setup->getConfigKeyValues(),
103		];
104	106	}
105
106		public function setAppRootDir(string $dir): self
107		{
108	106	$this->appRootDir = rtrim($dir, DIRECTORY_SEPARATOR);
109
110		if ($this->appRootDir === '' \|\| $this->appRootDir === '0') {
111	106	$this->appRootDir = getcwd() ?: ''; // @codeCoverageIgnore
112		}
113	106
114		return $this;
115		}
116	5
117		public function getAppRootDir(): string
118	5	{
119	5	return $this->appRootDir ?? getcwd() ?: '';
120	5	}
121
122		public function getCacheDir(): string
123		{
124		if ($this->cacheDir !== null) {
125		return $this->cacheDir;
126	106	}
127
128	106	$this->cacheDir = getenv('GACELA_CACHE_DIR') ?: $this->getDefaultCacheDir();
129	106
130	106	return rtrim($this->cacheDir, DIRECTORY_SEPARATOR);
131	106	}
132	106
133		/**
134		* @internal
135	106	*/
136		public function getFactory(): ConfigFactory
137		{
138	106	if (!$this->configFactory instanceof ConfigFactory) {
139		$this->configFactory = new ConfigFactory(
140	106	$this->getAppRootDir(),
141		$this->setup,
142		);
143	57	}
144
145	57	return $this->configFactory;
		0 ignored issues – show Bug Best Practice introduced 2022-03-26 14:55 UTC by Report Bug Copy Issue Report 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. Loading history...
146		}
147
148		public function getSetupGacela(): SetupGacelaInterface
149		{
150		return $this->setup;
151	106	}
152
153	106	public function hasKey(string $key): bool
154	106	{
155	106	return array_key_exists($key, $this->config);
156		}
157
158		private function getDefaultCacheDir(): string
159		{
160		if ($this->setup->getFileCacheDirectory() === '') {
161		return sys_get_temp_dir();
162		}
163
164		return $this->getAppRootDir()
165		. DIRECTORY_SEPARATOR
166		. ltrim($this->setup->getFileCacheDirectory(), DIRECTORY_SEPARATOR);
167		}
168
169		/**
170		* @return array<string,mixed>
171		*/
172		private function loadAllConfigValues(): array
173		{
174		return $this->getFactory()
175		->createConfigLoader()
176		->loadAll();
177		}
178		}
179

gacela-project / gacela

Push — main ( 7210a8...a042a1 )

Config::getDefaultCacheDir() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like