ClassResolverFactory::createClassNameFinder() - Code Metrics - Inspection of "Revisit again file cache system on class resolver" - gacela-project/gacela - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#208)

by Jesús

created 2022-10-16 17:11 UTC

ClassResolverFactory::createClassNameFinder() A

↳ Parent: ClassResolverFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes	2
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace Gacela\Framework\ClassResolver;

use Gacela\Framework\Bootstrap\SetupGacelaInterface;
use Gacela\Framework\ClassResolver\Cache\CacheInterface;
use Gacela\Framework\ClassResolver\Cache\ClassNamePhpCache;
use Gacela\Framework\ClassResolver\Cache\GacelaFileCache;
use Gacela\Framework\ClassResolver\Cache\InMemoryCache;
use Gacela\Framework\ClassResolver\Cache\ProfiledCache;
use Gacela\Framework\ClassResolver\ClassNameFinder\ClassNameFinder;
use Gacela\Framework\ClassResolver\ClassNameFinder\ClassNameFinderInterface;
use Gacela\Framework\ClassResolver\ClassNameFinder\ClassValidator;
use Gacela\Framework\ClassResolver\ClassNameFinder\ClassValidatorInterface;
use Gacela\Framework\ClassResolver\ClassNameFinder\Rule\FinderRuleInterface;
use Gacela\Framework\ClassResolver\ClassNameFinder\Rule\FinderRuleWithModulePrefix;
use Gacela\Framework\ClassResolver\ClassNameFinder\Rule\FinderRuleWithoutModulePrefix;
use Gacela\Framework\ClassResolver\Profiler\ClassNameJsonProfiler;
use Gacela\Framework\ClassResolver\Profiler\FileProfilerInterface;
use Gacela\Framework\ClassResolver\Profiler\GacelaProfiler;
use Gacela\Framework\Config\Config;

final class ClassResolverFactory
{
    private GacelaFileCache $gacelaCache;
    private GacelaProfiler $gacelaProfiler;
    private SetupGacelaInterface $setupGacela;

    public function __construct(
        GacelaFileCache $gacelaCache,
        GacelaProfiler $gacelaProfiler,
        SetupGacelaInterface $setupGacela
    ) {
        $this->gacelaCache = $gacelaCache;
        $this->gacelaProfiler = $gacelaProfiler;
        $this->setupGacela = $setupGacela;
    }

    public function createClassNameFinder(): ClassNameFinderInterface
    {
        return new ClassNameFinder(
            $this->createClassValidator(),
            $this->createFinderRules(),
            $this->createClassNameCache(),
            $this->getProjectNamespaces()
        );
    }

    private function createClassValidator(): ClassValidatorInterface
    {
        return new ClassValidator();
    }

    /**
     * @return list<FinderRuleInterface>
     */
    private function createFinderRules(): array
    {
        return [

            new FinderRuleWithModulePrefix(),
            new FinderRuleWithoutModulePrefix(),
        ];
    }

    private function createClassNameCache(): CacheInterface
    {
        $cache = $this->createCache();

        if ($this->gacelaProfiler->isEnabled()) {
            return new ProfiledCache(
                $cache,
                $this->createProfiler()
            );
        }

        return $cache;
    }

    private function createCache(): CacheInterface
    {
        if ($this->gacelaCache->isEnabled()) {
            return new ClassNamePhpCache(
                Config::getInstance()->getCacheDir(),
            );
        }

        return new InMemoryCache(ClassNamePhpCache::class);
    }

    private function createProfiler(): FileProfilerInterface
    {
        return new ClassNameJsonProfiler(
            Config::getInstance()->getProfilerDir(),
        );
    }

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


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Gacela\Framework\ClassResolver;
6
7		use Gacela\Framework\Bootstrap\SetupGacelaInterface;
8		use Gacela\Framework\ClassResolver\Cache\CacheInterface;
9		use Gacela\Framework\ClassResolver\Cache\ClassNamePhpCache;
10		use Gacela\Framework\ClassResolver\Cache\GacelaFileCache;
11		use Gacela\Framework\ClassResolver\Cache\InMemoryCache;
12		use Gacela\Framework\ClassResolver\Cache\ProfiledCache;
13		use Gacela\Framework\ClassResolver\ClassNameFinder\ClassNameFinder;
14		use Gacela\Framework\ClassResolver\ClassNameFinder\ClassNameFinderInterface;
15		use Gacela\Framework\ClassResolver\ClassNameFinder\ClassValidator;
16		use Gacela\Framework\ClassResolver\ClassNameFinder\ClassValidatorInterface;
17		use Gacela\Framework\ClassResolver\ClassNameFinder\Rule\FinderRuleInterface;
18		use Gacela\Framework\ClassResolver\ClassNameFinder\Rule\FinderRuleWithModulePrefix;
19		use Gacela\Framework\ClassResolver\ClassNameFinder\Rule\FinderRuleWithoutModulePrefix;
20		use Gacela\Framework\ClassResolver\Profiler\ClassNameJsonProfiler;
21		use Gacela\Framework\ClassResolver\Profiler\FileProfilerInterface;
22		use Gacela\Framework\ClassResolver\Profiler\GacelaProfiler;
23		use Gacela\Framework\Config\Config;
24
25		final class ClassResolverFactory
26		{
27		private GacelaFileCache $gacelaCache;
28		private GacelaProfiler $gacelaProfiler;
29		private SetupGacelaInterface $setupGacela;
30
31	36	public function __construct(
32		GacelaFileCache $gacelaCache,
33		GacelaProfiler $gacelaProfiler,
34		SetupGacelaInterface $setupGacela
35		) {
36	36	$this->gacelaCache = $gacelaCache;
37	36	$this->gacelaProfiler = $gacelaProfiler;
38	36	$this->setupGacela = $setupGacela;
39		}
40
41	36	public function createClassNameFinder(): ClassNameFinderInterface
42		{
43	36	return new ClassNameFinder(
44	36	$this->createClassValidator(),
45	36	$this->createFinderRules(),
46	36	$this->createClassNameCache(),
47	36	$this->getProjectNamespaces()
48		);
49		}
50
51	36	private function createClassValidator(): ClassValidatorInterface
52		{
53	36	return new ClassValidator();
54		}
55
56		/**
57		* @return list<FinderRuleInterface>
58		*/
59	36	private function createFinderRules(): array
60		{
61		return [
		0 ignored issues – show Bug Best Practice introduced 2022-02-12 21:12 UTC by Report Bug Copy Issue Report The expression `return array(new Gacela\...eWithoutModulePrefix())` returns the type `array<integer,Gacela\Fra...uleWithoutModulePrefix>` which is incompatible with the documented return type `Gacela\Framework\ClassResolver\list`. Loading history...
62	36	new FinderRuleWithModulePrefix(),
63	36	new FinderRuleWithoutModulePrefix(),
64		];
65		}
66
67	36	private function createClassNameCache(): CacheInterface
68		{
69	36	$cache = $this->createCache();
70
71	36	if ($this->gacelaProfiler->isEnabled()) {
72	1	return new ProfiledCache(
73		$cache,
74	1	$this->createProfiler()
75		);
76		}
77
78	35	return $cache;
79		}
80
81	36	private function createCache(): CacheInterface
82		{
83	36	if ($this->gacelaCache->isEnabled()) {
84	11	return new ClassNamePhpCache(
85	11	Config::getInstance()->getCacheDir(),
86		);
87		}
88
89	25	return new InMemoryCache(ClassNamePhpCache::class);
90		}
91
92	1	private function createProfiler(): FileProfilerInterface
93		{
94	1	return new ClassNameJsonProfiler(
95	1	Config::getInstance()->getProfilerDir(),
96		);
97		}
98
99		/**
100		* @return list<string>
101		*/
102	36	private function getProjectNamespaces(): array
103		{
104	36	return $this->setupGacela->getProjectNamespaces();
105		}
106		}
107

gacela-project / gacela

Pull Request — master (#208)

ClassResolverFactory::createClassNameFinder() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like