NamedParamMetas::getNames() - Code Metrics - Inspection of "Fix parameter order" - bearsunday/BEAR.Resource - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 1.x (#273)

by Akihito

created 2022-11-20 00:54 UTC

NamedParamMetas::getNames() A

↳ Parent: NamedParamMetas::convertParam()

Complexity

Conditions	3
Paths	2

Size

Total Lines	10
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace BEAR\Resource;

use BEAR\Resource\Annotation\RequestParamInterface;
use BEAR\Resource\Annotation\ResourceParam;
use Doctrine\Common\Annotations\Reader;
use Ray\Di\Di\Assisted;
use Ray\WebContextParam\Annotation\AbstractWebContextParam;
use ReflectionAttribute;
use ReflectionMethod;
use ReflectionNamedType;
use ReflectionParameter;

use const PHP_VERSION_ID;

final class NamedParamMetas implements NamedParamMetasInterface
{
    private Reader $reader;

    public function __construct(Reader $reader)
    {
        $this->reader = $reader;
    }

    /**
     * {@inheritdoc}
     */
    public function __invoke(callable $callable): array
    {
        /** @var array{0:object, 1:string} $callable */
        $method = new ReflectionMethod($callable[0], $callable[1]);
        $paramMetas = false;
        if (PHP_VERSION_ID >= 80000) {
            $paramMetas = $this->getAttributeParamMetas($method);
        }

        if (! $paramMetas) {
            $paramMetas = $this->getAnnotationParamMetas($method);
        }

        return $paramMetas;

    }

    /**
     * @return array<string, AssistedWebContextParam|ParamInterface>
     */
    private function getAnnotationParamMetas(ReflectionMethod $method)
    {
        $parameters = $method->getParameters();
        $annotations = $this->reader->getMethodAnnotations($method);
        $assistedNames = $this->getAssistedNames($annotations);
        $webContext = $this->getWebContext($annotations);

        return $this->addNamedParams($parameters, $assistedNames, $webContext);
    }

    /**
     * @return array<string, ParamInterface>
     *
     * @psalm-suppress TooManyTemplateParams $refAttribute
     */
    private function getAttributeParamMetas(ReflectionMethod $method): array
    {
        $parameters = $method->getParameters();
        $names = $valueParams = [];

        foreach ($parameters as $parameter) {
            /** @var array<ReflectionAttribute<RequestParamInterface>> $refAttribute */
            $refAttribute = $parameter->getAttributes(RequestParamInterface::class, ReflectionAttribute::IS_INSTANCEOF);
            if ($refAttribute) {

                /** @var ?ResourceParam $resourceParam */
                $resourceParam = $refAttribute[0]->newInstance();
                if ($resourceParam instanceof ResourceParam) {
                    $names[$parameter->name] = new AssistedResourceParam($resourceParam);
                    continue;
                }
            }

            /** @var array<ReflectionAttribute<AbstractWebContextParam>> $refWebContext */
            $refWebContext = $parameter->getAttributes(AbstractWebContextParam::class, ReflectionAttribute::IS_INSTANCEOF);
            if ($refWebContext) {

                /** @var AbstractWebContextParam $webParam */
                $webParam = $refWebContext[0]->newInstance();
                /** @psalm-var scalar $defaultValue */
                $defaultValue = $parameter->isDefaultValueAvailable() ? $parameter->getDefaultValue() : null;
                $param = new AssistedWebContextParam($webParam, new DefaultParam($defaultValue));
                $names[$parameter->name] = $param;
                continue;
            }

            $names[$parameter->name] = $parameter;
        }

        $names = $this->convertParam($names);

        return $names;
    }

    /**
     * @param array<Assisted|object|ResourceParam> $annotations
     *
     * @return array<string, ParamInterface>
     */
    private function getAssistedNames(array $annotations): array
    {
        $names = [];
        foreach ($annotations as $annotation) {
            if ($annotation instanceof ResourceParam) {
                $names[$annotation->param] = new AssistedResourceParam($annotation);
            }

            if (! ($annotation instanceof Assisted)) {
                continue;
            }

            $names = $this->setAssistedAnnotation($names, $annotation);
        }

        return $names;
    }

    /**
     * @param array<object> $annotations
     *
     * @return array<string, AbstractWebContextParam>
     */
    private function getWebContext(array $annotations): array
    {
        $webcontext = [];
        foreach ($annotations as $annotation) {
            if (! ($annotation instanceof AbstractWebContextParam)) {
                continue;
            }

            $webcontext[$annotation->param] = $annotation;
        }

        return $webcontext;
    }

    /**
     * @param array<string, ParamInterface> $names
     *
     * @return array<string, ParamInterface>
     */
    private function setAssistedAnnotation(array $names, Assisted $assisted): array
    {
        foreach ($assisted->values as $assistedParam) {
            $names[$assistedParam] = new AssistedParam();
        }

        return $names;
    }

    /**
     * @param ReflectionParameter[]                  $parameters
     * @param array<string, ParamInterface>          $assistedNames
     * @param array<string, AbstractWebContextParam> $webcontext
     *
     * @return (AssistedWebContextParam|ParamInterface)[]
     * @psalm-return array<string, AssistedWebContextParam|ParamInterface>
     */
    private function addNamedParams(array $parameters, array $assistedNames, array $webcontext): array
    {
        $names = [];
        foreach ($parameters as $parameter) {
            $name = $parameter->name;
            if (isset($assistedNames[$name])) {
                $names[$name] = $assistedNames[$parameter->name];

                continue;
            }

            if (isset($webcontext[$name])) {
                $default = $this->getDefault($parameter);
                $names[$name] = new AssistedWebContextParam($webcontext[$name], $default);

                continue;
            }

            $names[$name] = $this->getParam($parameter);
        }

        return $names;
    }

    /**
     * @return DefaultParam|NoDefaultParam
     * @psalm-return DefaultParam<mixed>|NoDefaultParam
     */
    private function getDefault(ReflectionParameter $parameter)
    {
        return $parameter->isDefaultValueAvailable() === true ? new DefaultParam($parameter->getDefaultValue()) : new NoDefaultParam();
    }

    /**
     * @param array<string, AssistedResourceParam|AssistedWebContextParam> $names
     * @param array<string, ReflectionParameter>                           $valueParams
     *
     * @return array<string, ParamInterface>
     */
    private function convertParam(array $names): array
    {
        // if there is more than single attributes
        if ($names) {

            foreach ($names as $paramName => $maybeParam) {
                if (! ($maybeParam instanceof ReflectionParameter)) {
                    continue;
                }

                $names[$paramName] = $this->getParam($maybeParam);
            }
        }

        return $names;
    }

    /**
     * @return ClassParam|OptionalParam|RequiredParam
     * @psalm-return ClassParam|OptionalParam<mixed>|RequiredParam
     */
    private function getParam(ReflectionParameter $parameter): ParamInterface
    {
        $type = $parameter->getType();
        if ($type instanceof ReflectionNamedType && ! $type->isBuiltin()) {
            return new ClassParam($type, $parameter);
        }

        return $parameter->isDefaultValueAvailable() === true ? new OptionalParam($parameter->getDefaultValue()) : new RequiredParam();
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace BEAR\Resource;
6
7		use BEAR\Resource\Annotation\RequestParamInterface;
8		use BEAR\Resource\Annotation\ResourceParam;
9		use Doctrine\Common\Annotations\Reader;
10		use Ray\Di\Di\Assisted;
11		use Ray\WebContextParam\Annotation\AbstractWebContextParam;
12		use ReflectionAttribute;
13		use ReflectionMethod;
14		use ReflectionNamedType;
15		use ReflectionParameter;
16
17		use const PHP_VERSION_ID;
18
19		final class NamedParamMetas implements NamedParamMetasInterface
20		{
21		private Reader $reader;
22
23		public function __construct(Reader $reader)
24		{
25	107	$this->reader = $reader;
26		}
27	107
28	107	/**
29	107	* {@inheritdoc}
30		*/
31	75	public function __invoke(callable $callable): array
32		{
33	75	/** @var array{0:object, 1:string} $callable */
34		$method = new ReflectionMethod($callable[0], $callable[1]);
35		$paramMetas = false;
36	75	if (PHP_VERSION_ID >= 80000) {
37	75	$paramMetas = $this->getAttributeParamMetas($method);
38	75	}
39	8
40		if (! $paramMetas) {
41	72	$paramMetas = $this->getAnnotationParamMetas($method);
42	72	}
43	72
44	72	return $paramMetas;
		0 ignored issues – show Bug Best Practice introduced 2021-10-31 16:26 UTC by Report Bug Copy Issue Report The expression `return $paramMetas` could return the type `false` which is incompatible with the type-hinted return `array`. Consider adding an additional type-check to rule them out. Loading history...
45	72	}
46	72
47	72	/**
48		* @return array<string, AssistedWebContextParam\|ParamInterface>
49	72	*/
50		private function getAnnotationParamMetas(ReflectionMethod $method)
51		{
52	72	$parameters = $method->getParameters();
53		$annotations = $this->reader->getMethodAnnotations($method);
54	72	$assistedNames = $this->getAssistedNames($annotations);
55	72	$webContext = $this->getWebContext($annotations);
56	35
57	3	return $this->addNamedParams($parameters, $assistedNames, $webContext);
58		}
59	35
60	35	/**
61		* @return array<string, ParamInterface>
62		*
63		* @psalm-suppress TooManyTemplateParams $refAttribute
64	72	*/
65		private function getAttributeParamMetas(ReflectionMethod $method): array
66		{
67	72	$parameters = $method->getParameters();
68		$names = $valueParams = [];
		0 ignored issues – show Unused Code introduced 2022-11-20 00:58 UTC by Report Bug Copy Issue Report The assignment to `$valueParams` is dead and can be removed. Loading history...
69	72	foreach ($parameters as $parameter) {
70	72	/** @var array<ReflectionAttribute<RequestParamInterface>> $refAttribute */
71	35	$refAttribute = $parameter->getAttributes(RequestParamInterface::class, ReflectionAttribute::IS_INSTANCEOF);
72	35	if ($refAttribute) {
		0 ignored issues – show Bug Best Practice introduced 2021-10-31 14:08 UTC by Report Bug Copy Issue Report The expression `$refAttribute` of type `ReflectionAttribute[]` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
73		/** @var ?ResourceParam $resourceParam */
74		$resourceParam = $refAttribute[0]->newInstance();
75		if ($resourceParam instanceof ResourceParam) {
76	72	$names[$parameter->name] = new AssistedResourceParam($resourceParam);
77		continue;
78		}
79	1	}
80
81		/** @var array<ReflectionAttribute<AbstractWebContextParam>> $refWebContext */
82	1	$refWebContext = $parameter->getAttributes(AbstractWebContextParam::class, ReflectionAttribute::IS_INSTANCEOF);
83	1	if ($refWebContext) {
		0 ignored issues – show Bug Best Practice introduced 2021-10-31 14:08 UTC by Report Bug Copy Issue Report The expression `$refWebContext` of type `ReflectionAttribute[]` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
84		/** @var AbstractWebContextParam $webParam */
85		$webParam = $refWebContext[0]->newInstance();
86	1	/** @psalm-var scalar $defaultValue */
87		$defaultValue = $parameter->isDefaultValueAvailable() ? $parameter->getDefaultValue() : null;
88		$param = new AssistedWebContextParam($webParam, new DefaultParam($defaultValue));
89		$names[$parameter->name] = $param;
90		continue;
91		}
92
93		$names[$parameter->name] = $parameter;
94	72	}
95
96	72	$names = $this->convertParam($names);
97	72
98	65	return $names;
99	4	}
100
101	4	/**
102		* @param array<Assisted\|object\|ResourceParam> $annotations
103	64	*
104	4	* @return array<string, ParamInterface>
105	4	*/
106		private function getAssistedNames(array $annotations): array
107	4	{
108		$names = [];
109	62	foreach ($annotations as $annotation) {
110		if ($annotation instanceof ResourceParam) {
111		$names[$annotation->param] = new AssistedResourceParam($annotation);
112	72	}
113
114		if (! ($annotation instanceof Assisted)) {
115	4	continue;
116		}
117	4
118		$names = $this->setAssistedAnnotation($names, $annotation);
119		}
120	62
121		return $names;
122	62	}
123
124		/**
125		* @param array<object> $annotations
126		*
127		* @return array<string, AbstractWebContextParam>
128		*/
129		private function getWebContext(array $annotations): array
130		{
131		$webcontext = [];
132		foreach ($annotations as $annotation) {
133		if (! ($annotation instanceof AbstractWebContextParam)) {
134		continue;
135		}
136
137		$webcontext[$annotation->param] = $annotation;
138		}
139
140		return $webcontext;
141		}
142
143		/**
144		* @param array<string, ParamInterface> $names
145		*
146		* @return array<string, ParamInterface>
147		*/
148		private function setAssistedAnnotation(array $names, Assisted $assisted): array
149		{
150		foreach ($assisted->values as $assistedParam) {
151		$names[$assistedParam] = new AssistedParam();
152		}
153
154		return $names;
155		}
156
157		/**
158		* @param ReflectionParameter[] $parameters
159		* @param array<string, ParamInterface> $assistedNames
160		* @param array<string, AbstractWebContextParam> $webcontext
161		*
162		* @return (AssistedWebContextParam\|ParamInterface)[]
163		* @psalm-return array<string, AssistedWebContextParam\|ParamInterface>
164		*/
165		private function addNamedParams(array $parameters, array $assistedNames, array $webcontext): array
166		{
167		$names = [];
168		foreach ($parameters as $parameter) {
169		$name = $parameter->name;
170		if (isset($assistedNames[$name])) {
171		$names[$name] = $assistedNames[$parameter->name];
172
173		continue;
174		}
175
176		if (isset($webcontext[$name])) {
177		$default = $this->getDefault($parameter);
178		$names[$name] = new AssistedWebContextParam($webcontext[$name], $default);
179
180		continue;
181		}
182
183		$names[$name] = $this->getParam($parameter);
184		}
185
186		return $names;
187		}
188
189		/**
190		* @return DefaultParam\|NoDefaultParam
191		* @psalm-return DefaultParam<mixed>\|NoDefaultParam
192		*/
193		private function getDefault(ReflectionParameter $parameter)
194		{
195		return $parameter->isDefaultValueAvailable() === true ? new DefaultParam($parameter->getDefaultValue()) : new NoDefaultParam();
196		}
197
198		/**
199		* @param array<string, AssistedResourceParam\|AssistedWebContextParam> $names
200		* @param array<string, ReflectionParameter> $valueParams
201		*
202		* @return array<string, ParamInterface>
203		*/
204		private function convertParam(array $names): array
205		{
206		// if there is more than single attributes
207		if ($names) {
		0 ignored issues – show Bug Best Practice introduced 2021-10-31 16:26 UTC by Report Bug Copy Issue Report The expression `$names` of type `array<string,BEAR\Resour...ssistedWebContextParam>` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
208		foreach ($names as $paramName => $maybeParam) {
209		if (! ($maybeParam instanceof ReflectionParameter)) {
210		continue;
211		}
212
213		$names[$paramName] = $this->getParam($maybeParam);
214		}
215		}
216
217		return $names;
218		}
219
220		/**
221		* @return ClassParam\|OptionalParam\|RequiredParam
222		* @psalm-return ClassParam\|OptionalParam<mixed>\|RequiredParam
223		*/
224		private function getParam(ReflectionParameter $parameter): ParamInterface
225		{
226		$type = $parameter->getType();
227		if ($type instanceof ReflectionNamedType && ! $type->isBuiltin()) {
228		return new ClassParam($type, $parameter);
229		}
230
231		return $parameter->isDefaultValueAvailable() === true ? new OptionalParam($parameter->getDefaultValue()) : new RequiredParam();
232		}
233		}
234

bearsunday / BEAR.Resource

Pull Request — 1.x (#273)

NamedParamMetas::getNames() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like