Argument::supports() - Code Metrics - Inspection of "Resolve improvements" - zenstruck/callback - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 1.x (#3)

by Kevin

created 2021-07-19 22:51 UTC

Argument::supports() C

↳ Parent: Argument

Complexity

Conditions	16
Paths	12

Size

Total Lines	49
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	16
eloc	23
c	1
b	0
f	0
nc	12
nop	2
dl	0
loc	49
rs	5.5666

How to fix Complexity

<?php

namespace Zenstruck\Callback;

/**
 * @author Kevin Bond <[email protected]>
 */
final class Argument
{
    /**
     * If type is class, parent classes are supported.
     */
    public const COVARIANCE = 2;

    /**
     * If type is class, child classes are supported.
     */
    public const CONTRAVARIANCE = 4;

    /**
     * If type is string, do not support other scalar types. Follows
     * same logic as "declare(strict_types=1)".
     */
    public const STRICT = 8;

    /**
     * If type is float, do not support int (implies {@see STRICT).
     */
    public const VERY_STRICT = 16;

    private const TYPE_NORMALIZE_MAP = [
        'boolean' => 'bool',
        'integer' => 'int',
        'double' => 'float',
        'resource (closed)' => 'resource',
    ];

    private const ALLOWED_TYPE_MAP = [
        'string' => ['bool', 'int', 'float'],
        'bool' => ['string', 'int', 'float'],
        'float' => ['string', 'int', 'bool'],
        'int' => ['string', 'float', 'bool'],
    ];

    /** @var \ReflectionParameter */
    private $parameter;

    public function __construct(\ReflectionParameter $parameter)
    {
        $this->parameter = $parameter;
    }

    public function type(): ?string
    {
        return $this->hasType() ? \implode('|', $this->types()) : null;
    }

    /**
     * @return string[]
     */
    public function types(): array
    {
        return \array_map(static function(\ReflectionNamedType $type) { return $type->getName(); }, $this->reflectionTypes());
    }

    public function hasType(): bool
    {
        return !empty($this->types());
    }

    public function isUnionType(): bool
    {
        return \count($this->types()) > 1;
    }

    /**
     * @param string $type    The type to check if this argument supports
     * @param int    $options {@see COVARIANCE}, {@see CONTRAVARIANCE}
     *                        Bitwise disjunction of above is allowed
     */
    public function supports(string $type, int $options = self::COVARIANCE): bool
    {
        if (!$this->hasType()) {
            // no type-hint so any type is supported
            return true;
        }

        if ('null' === \mb_strtolower($type) && $this->parameter->allowsNull()) {
            return true;
        }

        $type = self::TYPE_NORMALIZE_MAP[$type] ?? $type;

        foreach ($this->types() as $supportedType) {
            if ($supportedType === $type) {
                return true;
            }

            if ($options & self::COVARIANCE && \is_a($type, $supportedType, true)) {
                return true;
            }

            if ($options & self::CONTRAVARIANCE && \is_a($supportedType, $type, true)) {
                return true;
            }

            if ($options & self::VERY_STRICT) {
                continue;
            }

            if ('float' === $supportedType && 'int' === $type) {
                // strict typing allows int to pass a float validation
                return true;
            }

            if ($options & self::STRICT) {
                continue;
            }

            if (\in_array($type, self::ALLOWED_TYPE_MAP[$supportedType] ?? [], true)) {
                return true;
            }

            if (\method_exists($type, '__toString')) {
                return true;
            }
        }

        return false;
    }

    /**
     * @param mixed $value
     * @param bool  $strict {@see STRICT}
     */
    public function allows($value, bool $strict = false): bool
    {
        if (!$this->hasType()) {
            // no type-hint so any type is supported
            return true;
        }

        $type = \is_object($value) ? \get_class($value) : \gettype($value);
        $type = self::TYPE_NORMALIZE_MAP[$type] ?? $type;
        $supports = $this->supports($type, $strict ? self::COVARIANCE|self::STRICT : self::COVARIANCE);

        if (!$supports) {
            return false;
        }

        if ('string' === $type && !\is_numeric($value) && !\in_array('string', $this->types(), true)) {
            // non-numeric strings cannot be used for float/int
            return false;
        }

        return true;
    }

    /**
     * @return \ReflectionNamedType[]
     */
    private function reflectionTypes(): array
    {
        if (!$type = $this->parameter->getType()) {
            return [];
        }

        if ($type instanceof \ReflectionNamedType) {
            return [$type];
        }

        /** @var \ReflectionUnionType $type */
        return $type->getTypes();
    }
}


1			<?php
2
3			namespace Zenstruck\Callback;
4
5			/**
6			* @author Kevin Bond <[email protected]>
7			*/
8			final class Argument
9			{
10			/**
11			* If type is class, parent classes are supported.
12			*/
13			public const COVARIANCE = 2;
14
15			/**
16			* If type is class, child classes are supported.
17			*/
18			public const CONTRAVARIANCE = 4;
19
20			/**
21			* If type is string, do not support other scalar types. Follows
22			* same logic as "declare(strict_types=1)".
23			*/
24			public const STRICT = 8;
25
26			/**
27			* If type is float, do not support int (implies {@see STRICT).
28			*/
29			public const VERY_STRICT = 16;
30
31			private const TYPE_NORMALIZE_MAP = [
32			'boolean' => 'bool',
33			'integer' => 'int',
34			'double' => 'float',
35			'resource (closed)' => 'resource',
36			];
37
38			private const ALLOWED_TYPE_MAP = [
39			'string' => ['bool', 'int', 'float'],
40			'bool' => ['string', 'int', 'float'],
41			'float' => ['string', 'int', 'bool'],
42			'int' => ['string', 'float', 'bool'],
43			];
44
45			/** @var \ReflectionParameter */
46			private $parameter;
47
48			public function __construct(\ReflectionParameter $parameter)
49			{
50			$this->parameter = $parameter;
51			}
52
53			public function type(): ?string
54			{
55			return $this->hasType() ? \implode('\|', $this->types()) : null;
56			}
57
58			/**
59			* @return string[]
60			*/
61			public function types(): array
62			{
63			return \array_map(static function(\ReflectionNamedType $type) { return $type->getName(); }, $this->reflectionTypes());
64			}
65
66			public function hasType(): bool
67			{
68			return !empty($this->types());
69			}
70
71			public function isUnionType(): bool
72			{
73			return \count($this->types()) > 1;
74			}
75
76			/**
77			* @param string $type The type to check if this argument supports
78			* @param int $options {@see COVARIANCE}, {@see CONTRAVARIANCE}
79			* Bitwise disjunction of above is allowed
80			*/
81			public function supports(string $type, int $options = self::COVARIANCE): bool
82			{
83			if (!$this->hasType()) {
84			// no type-hint so any type is supported
85			return true;
86			}
87
88			if ('null' === \mb_strtolower($type) && $this->parameter->allowsNull()) {
89			return true;
90			}
91
92			$type = self::TYPE_NORMALIZE_MAP[$type] ?? $type;
93
94			foreach ($this->types() as $supportedType) {
95			if ($supportedType === $type) {
96			return true;
97			}
98
99			if ($options & self::COVARIANCE && \is_a($type, $supportedType, true)) {
100			return true;
101			}
102
103			if ($options & self::CONTRAVARIANCE && \is_a($supportedType, $type, true)) {
104			return true;
105			}
106
107			if ($options & self::VERY_STRICT) {
108			continue;
109			}
110
111			if ('float' === $supportedType && 'int' === $type) {
112			// strict typing allows int to pass a float validation
113			return true;
114			}
115
116			if ($options & self::STRICT) {
117			continue;
118			}
119
120			if (\in_array($type, self::ALLOWED_TYPE_MAP[$supportedType] ?? [], true)) {
121			return true;
122			}
123
124			if (\method_exists($type, '__toString')) {
125			return true;
126			}
127			}
128
129			return false;
130			}
131
132			/**
133			* @param mixed $value
134			* @param bool $strict {@see STRICT}
135			*/
136			public function allows($value, bool $strict = false): bool
137			{
138			if (!$this->hasType()) {
139			// no type-hint so any type is supported
140			return true;
141			}
142
143			$type = \is_object($value) ? \get_class($value) : \gettype($value);
144			$type = self::TYPE_NORMALIZE_MAP[$type] ?? $type;
145			$supports = $this->supports($type, $strict ? self::COVARIANCE\|self::STRICT : self::COVARIANCE);
146
147			if (!$supports) {
148			return false;
149			}
150
151			if ('string' === $type && !\is_numeric($value) && !\in_array('string', $this->types(), true)) {
152			// non-numeric strings cannot be used for float/int
153			return false;
154			}
155
156			return true;
157			}
158
159			/**
160			* @return \ReflectionNamedType[]
161			*/
162			private function reflectionTypes(): array
163			{
164			if (!$type = $this->parameter->getType()) {
165			return [];
166			}
167
168			if ($type instanceof \ReflectionNamedType) {
169			return [$type];
170			}
171
172			/** @var \ReflectionUnionType $type */
173			return $type->getTypes();
174			}
175			}
176

zenstruck / callback

Pull Request — 1.x (#3)

Argument::supports() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like