NamedParamMetas::getAnnotationParamMetas() - Code Metrics - Inspection of "Remove doctrine/annotation" - bearsunday/BEAR.Resource - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 1.x (#286)

by Akihito

created 2023-09-12 01:28 UTC

NamedParamMetas::getAnnotationParamMetas() A

↳ Parent: NamedParamMetas

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes

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

<?php

declare(strict_types=1);

namespace BEAR\Resource;

use BEAR\Resource\Annotation\RequestParamInterface;
use BEAR\Resource\Annotation\ResourceParam;
use Ray\Aop\ReflectionMethod;
use Ray\Di\Di\Assisted;
use Ray\WebContextParam\Annotation\AbstractWebContextParam;
use ReflectionAttribute;
use ReflectionNamedType;
use ReflectionParameter;

final class NamedParamMetas implements NamedParamMetasInterface
{
    /**
     * {@inheritDoc}
     */
    public function __invoke(callable $callable): array
    {
        /** @var array{0:object, 1:string} $callable */
        $method = new ReflectionMethod($callable[0], $callable[1]);
        $paramMetas = $this->getAttributeParamMetas($method);

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

        return $paramMetas;
    }

    /** @return array<string, AssistedWebContextParam|ParamInterface> */
    private function getAnnotationParamMetas(ReflectionMethod $method): array
    {
        $parameters = $method->getParameters();
        $annotations = $method->getAnnotations();
        $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) {
            $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;
                }
            }

            $refWebContext = $parameter->getAttributes(AbstractWebContextParam::class, ReflectionAttribute::IS_INSTANCEOF);
            if ($refWebContext) {

                $webParam = $refWebContext[0]->newInstance();
                $default = $this->getDefault($parameter);
                $param = new AssistedWebContextParam($webParam, $default);
                $names[$parameter->name] = $param;
                continue;
            }

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

        $names = $this->getNames($names, $valueParams);

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

    /** @psalm-return DefaultParam<mixed>|NoDefaultParam */
    private function getDefault(ReflectionParameter $parameter): DefaultParam|NoDefaultParam
    {
        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 getNames(array $names, array $valueParams): array
    {
        // if there is more than single attributes
        if ($names) {

            foreach ($valueParams as $paramName => $valueParam) {
                $names[$paramName] = $this->getParam($valueParam);
            }
        }

        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 Ray\Aop\ReflectionMethod;
10		use Ray\Di\Di\Assisted;
11		use Ray\WebContextParam\Annotation\AbstractWebContextParam;
12		use ReflectionAttribute;
13		use ReflectionNamedType;
14		use ReflectionParameter;
15
16		final class NamedParamMetas implements NamedParamMetasInterface
17		{
18		/**
19		* {@inheritDoc}
20		*/
21		public function __invoke(callable $callable): array
22		{
23		/** @var array{0:object, 1:string} $callable */
24		$method = new ReflectionMethod($callable[0], $callable[1]);
25	107	$paramMetas = $this->getAttributeParamMetas($method);
26
27	107	if (! $paramMetas) {
28	107	$paramMetas = $this->getAnnotationParamMetas($method);
29	107	}
30
31	75	return $paramMetas;
32		}
33	75
34		/** @return array<string, AssistedWebContextParam\|ParamInterface> */
35		private function getAnnotationParamMetas(ReflectionMethod $method): array
36	75	{
37	75	$parameters = $method->getParameters();
38	75	$annotations = $method->getAnnotations();
39	8	$assistedNames = $this->getAssistedNames($annotations);
40		$webContext = $this->getWebContext($annotations);
41	72
42	72	return $this->addNamedParams($parameters, $assistedNames, $webContext);
43	72	}
44	72
45	72	/**
46	72	* @return array<string, ParamInterface>
47	72	*
48		* @psalm-suppress TooManyTemplateParams $refAttribute
49	72	*/
50		private function getAttributeParamMetas(ReflectionMethod $method): array
51		{
52	72	$parameters = $method->getParameters();
53		$names = $valueParams = [];
54	72	foreach ($parameters as $parameter) {
55	72	$refAttribute = $parameter->getAttributes(RequestParamInterface::class, ReflectionAttribute::IS_INSTANCEOF);
56	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...
57	3	/** @var ?ResourceParam $resourceParam */
58		$resourceParam = $refAttribute[0]->newInstance();
59	35	if ($resourceParam instanceof ResourceParam) {
60	35	$names[$parameter->name] = new AssistedResourceParam($resourceParam);
61		continue;
62		}
63		}
64	72
65		$refWebContext = $parameter->getAttributes(AbstractWebContextParam::class, ReflectionAttribute::IS_INSTANCEOF);
66		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...
67	72	$webParam = $refWebContext[0]->newInstance();
68		$default = $this->getDefault($parameter);
69	72	$param = new AssistedWebContextParam($webParam, $default);
70	72	$names[$parameter->name] = $param;
71	35	continue;
72	35	}
73
74		$valueParams[$parameter->name] = $parameter;
75		}
76	72
77		$names = $this->getNames($names, $valueParams);
78
79	1	return $names;
80		}
81
82	1	/**
83	1	* @param array<Assisted\|object\|ResourceParam> $annotations
84		*
85		* @return array<string, ParamInterface>
86	1	*/
87		private function getAssistedNames(array $annotations): array
88		{
89		$names = [];
90		foreach ($annotations as $annotation) {
91		if ($annotation instanceof ResourceParam) {
92		$names[$annotation->param] = new AssistedResourceParam($annotation);
93		}
94	72
95		if (! ($annotation instanceof Assisted)) {
96	72	continue;
97	72	}
98	65
99	4	$names = $this->setAssistedAnnotation($names, $annotation);
100		}
101	4
102		return $names;
103	64	}
104	4
105	4	/**
106		* @param array<object> $annotations
107	4	*
108		* @return array<string, AbstractWebContextParam>
109	62	*/
110		private function getWebContext(array $annotations): array
111		{
112	72	$webcontext = [];
113		foreach ($annotations as $annotation) {
114		if (! ($annotation instanceof AbstractWebContextParam)) {
115	4	continue;
116		}
117	4
118		$webcontext[$annotation->param] = $annotation;
119		}
120	62
121		return $webcontext;
122	62	}
123
124		/**
125		* @param array<string, ParamInterface> $names
126		*
127		* @return array<string, ParamInterface>
128		*/
129		private function setAssistedAnnotation(array $names, Assisted $assisted): array
130		{
131		foreach ($assisted->values as $assistedParam) {
132		$names[$assistedParam] = new AssistedParam();
133		}
134
135		return $names;
136		}
137
138		/**
139		* @param ReflectionParameter[] $parameters
140		* @param array<string, ParamInterface> $assistedNames
141		* @param array<string, AbstractWebContextParam> $webcontext
142		*
143		* @return (AssistedWebContextParam\|ParamInterface)[]
144		* @psalm-return array<string, AssistedWebContextParam\|ParamInterface>
145		*/
146		private function addNamedParams(array $parameters, array $assistedNames, array $webcontext): array
147		{
148		$names = [];
149		foreach ($parameters as $parameter) {
150		$name = $parameter->name;
151		if (isset($assistedNames[$name])) {
152		$names[$name] = $assistedNames[$parameter->name];
153
154		continue;
155		}
156
157		if (isset($webcontext[$name])) {
158		$default = $this->getDefault($parameter);
159		$names[$name] = new AssistedWebContextParam($webcontext[$name], $default);
160
161		continue;
162		}
163
164		$names[$name] = $this->getParam($parameter);
165		}
166
167		return $names;
168		}
169
170		/** @psalm-return DefaultParam<mixed>\|NoDefaultParam */
171		private function getDefault(ReflectionParameter $parameter): DefaultParam\|NoDefaultParam
172		{
173		return $parameter->isDefaultValueAvailable() === true ? new DefaultParam($parameter->getDefaultValue()) : new NoDefaultParam();
174		}
175
176		/**
177		* @param array<string, AssistedResourceParam\|AssistedWebContextParam> $names
178		* @param array<string, ReflectionParameter> $valueParams
179		*
180		* @return array<string, ParamInterface>
181		*/
182		private function getNames(array $names, array $valueParams): array
183		{
184		// if there is more than single attributes
185		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...
186		foreach ($valueParams as $paramName => $valueParam) {
187		$names[$paramName] = $this->getParam($valueParam);
188		}
189		}
190
191		return $names;
192		}
193
194		/**
195		* @return ClassParam\|OptionalParam\|RequiredParam
196		* @psalm-return ClassParam\|OptionalParam<mixed>\|RequiredParam
197		*/
198		private function getParam(ReflectionParameter $parameter): ParamInterface
199		{
200		$type = $parameter->getType();
201		if ($type instanceof ReflectionNamedType && ! $type->isBuiltin()) {
202		return new ClassParam($type, $parameter);
203		}
204
205		return $parameter->isDefaultValueAvailable() === true ? new OptionalParam($parameter->getDefaultValue()) : new RequiredParam();
206		}
207		}
208

bearsunday / BEAR.Resource

Pull Request — 1.x (#286)

NamedParamMetas::getAnnotationParamMetas() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like