EnumLocator::isTargeted() - Code Metrics - Inspection of "[spiral/tokenizer] Create Enum loader" - spiral/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#947)

unknown

created 2023-06-20 16:43 UTC

EnumLocator::isTargeted() A

↳ Parent: EnumLocator

Complexity

Conditions	4
Paths	4

Size

Total Lines	13
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace Spiral\Tokenizer;

use Spiral\Tokenizer\Exception\LocatorException;

/**
 * Can locate enums in a specified directory.
 */
final class EnumLocator extends AbstractLocator implements EnumsInterface
{
    public const INJECTOR = ClassLocatorInjector::class;

    public function getEnums(object|string|null $target = null): array
    {
        if (! empty($target)) {
            $target = new \ReflectionClass($target);
        }

        $result = [];
        foreach ($this->availableEnums() as $enum) {
            try {
                $reflection = $this->enumReflection($enum);
            } catch (LocatorException $e) {
                if ($this->debug) {
                    throw $e;
                }

                //Ignoring
                continue;
            }

            if (! $this->isTargeted($reflection, $target) || $reflection->isInterface()) {
                continue;
            }

            $result[$reflection->getName()] = $reflection;
        }

        return $result;
    }

    /**
     * Enums available in finder scope.
     *
     * @return class-string[]

     */
    protected function availableEnums(): array
    {
        $enums = [];

        foreach ($this->availableReflections() as $reflection) {
            $enums = \array_merge($enums, $reflection->getEnums());
        }

        return $enums;
    }

    /**
     * Check if given enum targeted by locator.
     *
     * @param \ReflectionClass|null $target
     */
    protected function isTargeted(\ReflectionEnum $enum, \ReflectionClass $target = null): bool
filter:
    dependency_paths: ["lib/*"]
    {
        if (empty($target)) {
            return true;
        }

        if (! $target->isTrait()) {
            //Target is interface or class
            return $enum->isSubclassOf($target) || $enum->getName() === $target->getName();
        }

        // Checking using traits
        return \in_array($target->getName(), $this->fetchTraits($enum->getName()));
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Spiral\Tokenizer;
6
7		use Spiral\Tokenizer\Exception\LocatorException;
8
9		/**
10		* Can locate enums in a specified directory.
11		*/
12		final class EnumLocator extends AbstractLocator implements EnumsInterface
13		{
14		public const INJECTOR = ClassLocatorInjector::class;
15
16	355	public function getEnums(object\|string\|null $target = null): array
17		{
18	355	if (! empty($target)) {
19		$target = new \ReflectionClass($target);
20		}
21
22	355	$result = [];
23	355	foreach ($this->availableEnums() as $enum) {
24		try {
25		$reflection = $this->enumReflection($enum);
26		} catch (LocatorException $e) {
27		if ($this->debug) {
28		throw $e;
29		}
30
31		//Ignoring
32		continue;
33		}
34
35		if (! $this->isTargeted($reflection, $target) \|\| $reflection->isInterface()) {
36		continue;
37		}
38
39		$result[$reflection->getName()] = $reflection;
40		}
41
42	355	return $result;
43		}
44
45		/**
46		* Enums available in finder scope.
47		*
48		* @return class-string[]
		0 ignored issues – show Documentation Bug introduced 2023-06-20 17:03 UTC by Report Bug Copy Issue Report The doc comment `class-string[]` at position `0` could not be parsed: Unknown type name 'class-string' at position 0 in class-string[]. Loading history...
49		*/
50	355	protected function availableEnums(): array
51		{
52	355	$enums = [];
53
54	355	foreach ($this->availableReflections() as $reflection) {
55	355	$enums = \array_merge($enums, $reflection->getEnums());
56		}
57
58	355	return $enums;
59		}
60
61		/**
62		* Check if given enum targeted by locator.
63		*
64		* @param \ReflectionClass\|null $target
65		*/
66		protected function isTargeted(\ReflectionEnum $enum, \ReflectionClass $target = null): bool
		0 ignored issues – show Bug introduced 2023-06-20 17:03 UTC by Report Bug Copy Issue Report The type `ReflectionEnum` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
67		{
68		if (empty($target)) {
69		return true;
70		}
71
72		if (! $target->isTrait()) {
73		//Target is interface or class
74		return $enum->isSubclassOf($target) \|\| $enum->getName() === $target->getName();
75		}
76
77		// Checking using traits
78		return \in_array($target->getName(), $this->fetchTraits($enum->getName()));
79		}
80		}
81

spiral / framework

Pull Request — master (#947)

EnumLocator::isTargeted() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like