SetupGacela::__construct() - Code Metrics - Inspection of "Remove the profiler feature" - gacela-project/gacela - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#212)

by Chema

created 2022-10-23 17:29 UTC

SetupGacela::__construct() A

↳ Parent: SetupGacela

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	3
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	7
ccs	4
cts	4
cp	1
crap	1
rs	10

<?php

declare(strict_types=1);

namespace Gacela\Framework\Bootstrap;

use Gacela\Framework\ClassResolver\Cache\GacelaFileCache;
use Gacela\Framework\Config\GacelaConfigBuilder\ConfigBuilder;
use Gacela\Framework\Config\GacelaConfigBuilder\MappingInterfacesBuilder;
use Gacela\Framework\Config\GacelaConfigBuilder\SuffixTypesBuilder;
use RuntimeException;

use function is_callable;

final class SetupGacela extends AbstractSetupGacela
{
    /** @var callable(ConfigBuilder):void */
    private $configFn;

    /** @var callable(MappingInterfacesBuilder,array<string,mixed>):void */
    private $mappingInterfacesFn;

    /** @var callable(SuffixTypesBuilder):void */
    private $suffixTypesFn;

    /** @var array<string,class-string|object|callable> */

    private array $externalServices = [];

    private ?ConfigBuilder $configBuilder = null;

    private ?SuffixTypesBuilder $suffixTypesBuilder = null;

    private ?MappingInterfacesBuilder $mappingInterfacesBuilder = null;

    private bool $shouldResetInMemoryCache = false;

    private bool $fileCacheEnabled = GacelaFileCache::DEFAULT_ENABLED_VALUE;

    private string $fileCacheDirectory = GacelaFileCache::DEFAULT_DIRECTORY_VALUE;

    /** @var list<string> */
    private array $projectNamespaces = [];

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

    public function __construct()
    {
        $this->configFn = static function (): void {
        };
        $this->mappingInterfacesFn = static function (): void {
        };
        $this->suffixTypesFn = static function (): void {
        };
    }

    public static function fromFile(string $gacelaFilePath): self
    {
        if (!is_file($gacelaFilePath)) {
            throw new RuntimeException("Invalid file path: '{$gacelaFilePath}'");
        }

        /** @var callable(GacelaConfig):void|null $setupGacelaFileFn */
        $setupGacelaFileFn = include $gacelaFilePath;
        if (!is_callable($setupGacelaFileFn)) {
            return new self();
        }

        return self::fromCallable($setupGacelaFileFn);
    }

    /**
     * @param callable(GacelaConfig):void $setupGacelaFileFn
     */
    public static function fromCallable(callable $setupGacelaFileFn): self
    {
        $gacelaConfig = new GacelaConfig();
        $setupGacelaFileFn($gacelaConfig);

        return self::fromGacelaConfig($gacelaConfig);
    }

    public static function fromGacelaConfig(GacelaConfig $gacelaConfig): self
    {
        $build = $gacelaConfig->build();

        return (new self())
            ->setConfigBuilder($build['config-builder'])
            ->setSuffixTypesBuilder($build['suffix-types-builder'])
            ->setMappingInterfacesBuilder($build['mapping-interfaces-builder'])
            ->setExternalServices($build['external-services'])
            ->setShouldResetInMemoryCache($build['should-reset-in-memory-cache'])
            ->setFileCacheEnabled($build['file-cache-enabled'])
            ->setFileCacheDirectory($build['file-cache-directory'])
            ->setProjectNamespaces($build['project-namespaces'])
            ->setConfigKeyValues($build['config-key-values']);
    }

    public function setMappingInterfacesBuilder(MappingInterfacesBuilder $builder): self
    {
        $this->mappingInterfacesBuilder = $builder;

        return $this;
    }

    public function setSuffixTypesBuilder(SuffixTypesBuilder $builder): self
    {
        $this->suffixTypesBuilder = $builder;

        return $this;
    }

    public function setConfigBuilder(ConfigBuilder $builder): self
    {
        $this->configBuilder = $builder;

        return $this;
    }

    /**
     * @param callable(ConfigBuilder):void $callable
     */
    public function setConfigFn(callable $callable): self
    {
        $this->configFn = $callable;

        return $this;
    }

    public function buildConfig(ConfigBuilder $builder): ConfigBuilder
    {
        if ($this->configBuilder) {
            $builder = $this->configBuilder;
        }

        ($this->configFn)($builder);

        return $builder;
    }

    /**
     * @param callable(MappingInterfacesBuilder,array<string,mixed>):void $callable
     */
    public function setMappingInterfacesFn(callable $callable): self
    {
        $this->mappingInterfacesFn = $callable;

        return $this;
    }

    /**
     * Define the mapping between interfaces and concretions, so Gacela services will auto-resolve them automatically.
     *
     * @param array<string,class-string|object|callable> $externalServices

     */
    public function buildMappingInterfaces(
        MappingInterfacesBuilder $builder,
        array $externalServices
    ): MappingInterfacesBuilder {
        if ($this->mappingInterfacesBuilder) {
            $builder = $this->mappingInterfacesBuilder;
        }

        ($this->mappingInterfacesFn)(
            $builder,
            array_merge($this->externalServices, $externalServices)
        );

        return $builder;
    }

    /**
     * @param callable(SuffixTypesBuilder):void $callable
     */
    public function setSuffixTypesFn(callable $callable): self
    {
        $this->suffixTypesFn = $callable;

        return $this;
    }

    /**
     * Allow overriding gacela resolvable types.
     */
    public function buildSuffixTypes(SuffixTypesBuilder $builder): SuffixTypesBuilder
    {
        if ($this->suffixTypesBuilder) {
            $builder = $this->suffixTypesBuilder;
        }

        ($this->suffixTypesFn)($builder);

        return $builder;
    }

    /**
     * @param array<string,class-string|object|callable> $array

     */
    public function setExternalServices(array $array): self
    {
        $this->externalServices = $array;

        return $this;
    }

    /**
     * @return array<string,class-string|object|callable>

     */
    public function externalServices(): array
    {
        return $this->externalServices;
    }

    public function setShouldResetInMemoryCache(bool $flag): self
    {
        $this->shouldResetInMemoryCache = $flag;

        return $this;
    }

    public function shouldResetInMemoryCache(): bool
    {
        return $this->shouldResetInMemoryCache;
    }

    public function setFileCacheEnabled(bool $flag): self
    {
        $this->fileCacheEnabled = $flag;

        return $this;
    }

    public function isFileCacheEnabled(): bool
    {
        return $this->fileCacheEnabled;
    }

    public function getFileCacheDirectory(): string
    {
        return $this->fileCacheDirectory;
    }

    public function setFileCacheDirectory(string $dir): self
    {
        $this->fileCacheDirectory = $dir;

        return $this;
    }

    /**
     * @param list<string> $list
     */
    public function setProjectNamespaces(array $list): self
    {
        $this->projectNamespaces = $list;


        return $this;
    }

    /**
     * @return list<string>
     */
    public function getProjectNamespaces(): array
    {
        return $this->projectNamespaces;
    }

    /**
     * @return array<string,mixed>
     */
    public function getConfigKeyValues(): array
    {
        return $this->configKeyValues;
    }

    /**
     * @param array<string,mixed> $configKeyValues
     */
    private function setConfigKeyValues(array $configKeyValues): self
    {
        $this->configKeyValues = $configKeyValues;

        return $this;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Gacela\Framework\Bootstrap;
6
7		use Gacela\Framework\ClassResolver\Cache\GacelaFileCache;
8		use Gacela\Framework\Config\GacelaConfigBuilder\ConfigBuilder;
9		use Gacela\Framework\Config\GacelaConfigBuilder\MappingInterfacesBuilder;
10		use Gacela\Framework\Config\GacelaConfigBuilder\SuffixTypesBuilder;
11		use RuntimeException;
12
13		use function is_callable;
14
15		final class SetupGacela extends AbstractSetupGacela
16		{
17		/** @var callable(ConfigBuilder):void */
18		private $configFn;
19
20		/** @var callable(MappingInterfacesBuilder,array<string,mixed>):void */
21		private $mappingInterfacesFn;
22
23		/** @var callable(SuffixTypesBuilder):void */
24		private $suffixTypesFn;
25
26		/** @var array<string,class-string\|object\|callable> */
		1 ignored issue – show Documentation Bug introduced 2022-05-14 18:03 UTC by Report Bug Copy Issue Report The doc comment `array<string,class-string\|object\|callable>` at position `4` could not be parsed: Unknown type name 'class-string' at position 4 in array<string,class-string\|object\|callable>. Loading history...
27		private array $externalServices = [];
28
29		private ?ConfigBuilder $configBuilder = null;
30
31		private ?SuffixTypesBuilder $suffixTypesBuilder = null;
32
33		private ?MappingInterfacesBuilder $mappingInterfacesBuilder = null;
34
35		private bool $shouldResetInMemoryCache = false;
36
37		private bool $fileCacheEnabled = GacelaFileCache::DEFAULT_ENABLED_VALUE;
38
39		private string $fileCacheDirectory = GacelaFileCache::DEFAULT_DIRECTORY_VALUE;
40
41		/** @var list<string> */
42		private array $projectNamespaces = [];
43
44		/** @var array<string,mixed> */
45		private array $configKeyValues = [];
46
47	77	public function __construct()
48		{
49	77	$this->configFn = static function (): void {
50		};
51	77	$this->mappingInterfacesFn = static function (): void {
52		};
53	77	$this->suffixTypesFn = static function (): void {
54		};
55		}
56
57	10	public static function fromFile(string $gacelaFilePath): self
58		{
59	10	if (!is_file($gacelaFilePath)) {
60		throw new RuntimeException("Invalid file path: '{$gacelaFilePath}'");
61		}
62
63		/** @var callable(GacelaConfig):void\|null $setupGacelaFileFn */
64	10	$setupGacelaFileFn = include $gacelaFilePath;
65	10	if (!is_callable($setupGacelaFileFn)) {
66		return new self();
67		}
68
69	10	return self::fromCallable($setupGacelaFileFn);
70		}
71
72		/**
73		* @param callable(GacelaConfig):void $setupGacelaFileFn
74		*/
75	41	public static function fromCallable(callable $setupGacelaFileFn): self
76		{
77	41	$gacelaConfig = new GacelaConfig();
78	41	$setupGacelaFileFn($gacelaConfig);
79
80	41	return self::fromGacelaConfig($gacelaConfig);
81		}
82
83	47	public static function fromGacelaConfig(GacelaConfig $gacelaConfig): self
84		{
85	47	$build = $gacelaConfig->build();
86
87	47	return (new self())
88	47	->setConfigBuilder($build['config-builder'])
89	47	->setSuffixTypesBuilder($build['suffix-types-builder'])
90	47	->setMappingInterfacesBuilder($build['mapping-interfaces-builder'])
91	47	->setExternalServices($build['external-services'])
92	47	->setShouldResetInMemoryCache($build['should-reset-in-memory-cache'])
93	47	->setFileCacheEnabled($build['file-cache-enabled'])
94	47	->setFileCacheDirectory($build['file-cache-directory'])
95	47	->setProjectNamespaces($build['project-namespaces'])
96	47	->setConfigKeyValues($build['config-key-values']);
97		}
98
99	47	public function setMappingInterfacesBuilder(MappingInterfacesBuilder $builder): self
100		{
101	47	$this->mappingInterfacesBuilder = $builder;
102
103	47	return $this;
104		}
105
106	47	public function setSuffixTypesBuilder(SuffixTypesBuilder $builder): self
107		{
108	47	$this->suffixTypesBuilder = $builder;
109
110	47	return $this;
111		}
112
113	47	public function setConfigBuilder(ConfigBuilder $builder): self
114		{
115	47	$this->configBuilder = $builder;
116
117	47	return $this;
118		}
119
120		/**
121		* @param callable(ConfigBuilder):void $callable
122		*/
123	3	public function setConfigFn(callable $callable): self
124		{
125	3	$this->configFn = $callable;
126
127	3	return $this;
128		}
129
130	77	public function buildConfig(ConfigBuilder $builder): ConfigBuilder
131		{
132	77	if ($this->configBuilder) {
133	47	$builder = $this->configBuilder;
134		}
135
136	77	($this->configFn)($builder);
137
138	77	return $builder;
139		}
140
141		/**
142		* @param callable(MappingInterfacesBuilder,array<string,mixed>):void $callable
143		*/
144	3	public function setMappingInterfacesFn(callable $callable): self
145		{
146	3	$this->mappingInterfacesFn = $callable;
147
148	3	return $this;
149		}
150
151		/**
152		* Define the mapping between interfaces and concretions, so Gacela services will auto-resolve them automatically.
153		*
154		* @param array<string,class-string\|object\|callable> $externalServices
		1 ignored issue – show Documentation Bug introduced 2022-05-14 18:03 UTC by Report Bug Copy Issue Report The doc comment `array<string,class-string\|object\|callable>` at position `4` could not be parsed: Unknown type name 'class-string' at position 4 in array<string,class-string\|object\|callable>. Loading history...
155		*/
156	77	public function buildMappingInterfaces(
157		MappingInterfacesBuilder $builder,
158		array $externalServices
159		): MappingInterfacesBuilder {
160	77	if ($this->mappingInterfacesBuilder) {
161	47	$builder = $this->mappingInterfacesBuilder;
162		}
163
164	77	($this->mappingInterfacesFn)(
165		$builder,
166	77	array_merge($this->externalServices, $externalServices)
167		);
168
169	77	return $builder;
170		}
171
172		/**
173		* @param callable(SuffixTypesBuilder):void $callable
174		*/
175	3	public function setSuffixTypesFn(callable $callable): self
176		{
177	3	$this->suffixTypesFn = $callable;
178
179	3	return $this;
180		}
181
182		/**
183		* Allow overriding gacela resolvable types.
184		*/
185	77	public function buildSuffixTypes(SuffixTypesBuilder $builder): SuffixTypesBuilder
186		{
187	77	if ($this->suffixTypesBuilder) {
188	47	$builder = $this->suffixTypesBuilder;
189		}
190
191	77	($this->suffixTypesFn)($builder);
192
193	77	return $builder;
194		}
195
196		/**
197		* @param array<string,class-string\|object\|callable> $array
		1 ignored issue – show Documentation Bug introduced 2022-05-14 18:03 UTC by Report Bug Copy Issue Report The doc comment `array<string,class-string\|object\|callable>` at position `4` could not be parsed: Unknown type name 'class-string' at position 4 in array<string,class-string\|object\|callable>. Loading history...
198		*/
199	50	public function setExternalServices(array $array): self
200		{
201	50	$this->externalServices = $array;
202
203	50	return $this;
204		}
205
206		/**
207		* @return array<string,class-string\|object\|callable>
		1 ignored issue – show Documentation Bug introduced 2022-05-14 18:03 UTC by Report Bug Copy Issue Report The doc comment `array<string,class-string\|object\|callable>` at position `4` could not be parsed: Unknown type name 'class-string' at position 4 in array<string,class-string\|object\|callable>. Loading history...
208		*/
209	16	public function externalServices(): array
210		{
211	16	return $this->externalServices;
212		}
213
214	47	public function setShouldResetInMemoryCache(bool $flag): self
215		{
216	47	$this->shouldResetInMemoryCache = $flag;
217
218	47	return $this;
219		}
220
221	64	public function shouldResetInMemoryCache(): bool
222		{
223	64	return $this->shouldResetInMemoryCache;
224		}
225
226	47	public function setFileCacheEnabled(bool $flag): self
227		{
228	47	$this->fileCacheEnabled = $flag;
229
230	47	return $this;
231		}
232
233	3	public function isFileCacheEnabled(): bool
234		{
235	3	return $this->fileCacheEnabled;
236		}
237
238	14	public function getFileCacheDirectory(): string
239		{
240	14	return $this->fileCacheDirectory;
241		}
242
243	47	public function setFileCacheDirectory(string $dir): self
244		{
245	47	$this->fileCacheDirectory = $dir;
246
247	47	return $this;
248		}
249
250		/**
251		* @param list<string> $list
252		*/
253	47	public function setProjectNamespaces(array $list): self
254		{
255	47	$this->projectNamespaces = $list;
		0 ignored issues – show Documentation Bug introduced 2022-06-30 19:54 UTC by Report Bug Copy Issue Report It seems like `$list` of type `array` is incompatible with the declared type `Gacela\Framework\Bootstrap\list` of property `$projectNamespaces`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
256
257	47	return $this;
258		}
259
260		/**
261		* @return list<string>
262		*/
263	34	public function getProjectNamespaces(): array
264		{
265	34	return $this->projectNamespaces;
266		}
267
268		/**
269		* @return array<string,mixed>
270		*/
271	64	public function getConfigKeyValues(): array
272		{
273	64	return $this->configKeyValues;
274		}
275
276		/**
277		* @param array<string,mixed> $configKeyValues
278		*/
279	47	private function setConfigKeyValues(array $configKeyValues): self
280		{
281	47	$this->configKeyValues = $configKeyValues;
282
283	47	return $this;
284		}
285		}
286

gacela-project / gacela

Pull Request — master (#212)

SetupGacela::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like