Route::hosts() - Code Metrics - Inspection of "Add attributes support & improve `MatchingResult`" - yiisoft/router - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#196)

by Rustam

created 2023-08-19 05:28 UTC

Route::hosts() A

↳ Parent: Route

Complexity

Conditions	4
Paths	3

Size

Total Lines	14
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	4

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Yiisoft\Router;

use Attribute;
use InvalidArgumentException;
use RuntimeException;
use Stringable;
use Yiisoft\Http\Method;

use function in_array;

/**
 * Route defines a mapping from URL to callback / name and vice versa.
 */
#[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
class Route implements Stringable
{
    private bool $actionAdded = false;
    /**
     * @var array[]|callable[]|string[]
     */
    private array $builtMiddlewares = [];
    /**
     * @var array[]|callable[]|string[]
     */
    private array $middlewares = [];
    /**
     * @var string[]
     */
    private array $methods;
    /**
     * @var string[]
     */
    private array $hosts = [];
    /**
     * @var array<string,scalar|Stringable|null>
     */
    private array $defaults = [];

    /**
     * @param array<string,scalar|Stringable|null> $defaults Parameter default values indexed by parameter names.
     * @param bool $override Marks route as override. When added it will replace existing route with the same name.
     * @param array $disabledMiddlewares Excludes middleware from being invoked when action is handled.
     * It is useful to avoid invoking one of the parent group middleware for
     * a certain route.
     */
    public function __construct(
        array $methods,
        private string $pattern,
        private ?string $name = null,
        array|callable|string $action = null,
        array $middlewares = [],
        array $defaults = [],
        array $hosts = [],
        private bool $override = false,
        private array $disabledMiddlewares = [],
    ) {
        $this->assertListOfStrings($methods, 'methods');
        $this->assertMiddlewares($middlewares);
        $this->assertListOfStrings($hosts, 'hosts');
        $this->methods = $methods;
        $this->middlewares = $middlewares;
        $this->hosts = $hosts;
        $this->defaults = array_map('\strval', $defaults);
        if (!empty($action)) {
            $this->middlewares[] = $action;
            $this->actionAdded = true;
        }
    }

    public static function get(string $pattern): self
    {
        return self::methods([Method::GET], $pattern);
    }

    public static function post(string $pattern): self
    {
        return self::methods([Method::POST], $pattern);
    }

    public static function put(string $pattern): self
    {
        return self::methods([Method::PUT], $pattern);
    }

    public static function delete(string $pattern): self
    {
        return self::methods([Method::DELETE], $pattern);
    }

    public static function patch(string $pattern): self
    {
        return self::methods([Method::PATCH], $pattern);
    }

    public static function head(string $pattern): self
    {
        return self::methods([Method::HEAD], $pattern);
    }

    public static function options(string $pattern): self
    {
        return self::methods([Method::OPTIONS], $pattern);
    }

    /**
     * @param string[] $methods
     */
    public static function methods(array $methods, string $pattern): self
    {
        return new self(
            methods: $methods,
            pattern: $pattern
        );
    }

    public function name(string $name): self
    {
        $route = clone $this;
        $route->name = $name;
        return $route;
    }

    public function pattern(string $pattern): self
    {
        $new = clone $this;
        $new->pattern = $pattern;
        return $new;
    }

    public function host(string $host): self
    {
        return $this->hosts($host);
    }

    public function hosts(string ...$hosts): self
    {
        $route = clone $this;
        $route->hosts = [];

        foreach ($hosts as $host) {
            $host = rtrim($host, '/');

            if ($host !== '' && !in_array($host, $route->hosts, true)) {
                $route->hosts[] = $host;
            }
        }

        return $route;
    }

    /**
     * Marks route as override. When added it will replace existing route with the same name.
     */
    public function override(): self
    {
        $route = clone $this;
        $route->override = true;
        return $route;
    }

    /**
     * Parameter default values indexed by parameter names.
     *
     * @psalm-param array<string,null|Stringable|scalar> $defaults
     */
    public function defaults(array $defaults): self
    {
        $route = clone $this;
        $route->defaults = array_map('\strval', $defaults);
        return $route;
    }

    /**
     * Appends a handler middleware definition that should be invoked for a matched route.
     * First added handler will be executed first.
     */
    public function middleware(array|callable|string ...$middlewareDefinition): self
    {
        if ($this->actionAdded) {
            throw new RuntimeException('middleware() can not be used after action().');
        }
        $route = clone $this;
        array_push(
            $route->middlewares,
            ...array_values($middlewareDefinition)
        );
        $route->builtMiddlewares = [];
        return $route;
    }

    /**
     * Prepends a handler middleware definition that should be invoked for a matched route.
     * Last added handler will be executed first.
     */
    public function prependMiddleware(array|callable|string ...$middlewareDefinition): self
    {
        if (!$this->actionAdded) {
            throw new RuntimeException('prependMiddleware() can not be used before action().');
        }
        $route = clone $this;
        array_unshift(
            $route->middlewares,
            ...array_values($middlewareDefinition)
        );
        $route->builtMiddlewares = [];
        return $route;
    }

    /**
     * Appends action handler. It is a primary middleware definition that should be invoked last for a matched route.
     */
    public function action(array|callable|string $middlewareDefinition): self
    {
        $route = clone $this;
        $route->middlewares[] = $middlewareDefinition;
        $route->actionAdded = true;
        $route->builtMiddlewares = [];
        return $route;
    }

    /**
     * Excludes middleware from being invoked when action is handled.
     * It is useful to avoid invoking one of the parent group middleware for
     * a certain route.
     */
    public function disableMiddleware(mixed ...$middlewareDefinition): self
    {
        $route = clone $this;
        array_push(
            $route->disabledMiddlewares,
            ...array_values($middlewareDefinition)
        );
        $route->builtMiddlewares = [];
        return $route;
    }

    /**
     * @psalm-template T as string
     *
     * @psalm-param T $key
     *
     * @psalm-return (
     *   T is ('name'|'pattern') ? string :
     *       (T is 'host' ? string|null :
     *           (T is 'hosts' ? array<array-key, string> :
     *               (T is 'methods' ? array<array-key,string> :
     *                   (T is 'defaults' ? array<string,string> :
     *                       (T is ('override'|'hasMiddlewares') ? bool :
     *                           (T is 'builtMiddlewares' ? array<array-key,array|callable|string> : mixed)
     *                       )
     *                   )
     *               )
     *           )
     *       )
     *    )
     */
    public function getData(string $key): mixed
    {
        return match ($key) {
            'name' => $this->name ??
                (implode(', ', $this->methods) . ' ' . implode('|', $this->hosts) . $this->pattern),
            'pattern' => $this->pattern,
            'host' => $this->hosts[0] ?? null,
            'hosts' => $this->hosts,
            'methods' => $this->methods,
            'defaults' => $this->defaults,
            'override' => $this->override,
            'hasMiddlewares' => !empty($this->middlewares),
            'builtMiddlewares' => $this->getBuiltMiddlewares(),
            default => throw new InvalidArgumentException('Unknown data key: ' . $key),
        };
    }

    public function __toString(): string
    {
        $result = $this->name === null
            ? ''
            : '[' . $this->name . '] ';

        if ($this->methods !== []) {
            $result .= implode(',', $this->methods) . ' ';
        }

        if ($this->hosts) {

            $quoted = array_map(static fn ($host) => preg_quote($host, '/'), $this->hosts);

            if (!preg_match('/' . implode('|', $quoted) . '/', $this->pattern)) {
                $result .= implode('|', $this->hosts);
            }
        }

        $result .= $this->pattern;

        return $result;
    }

    public function __debugInfo()
    {
        return [
            'name' => $this->name,
            'methods' => $this->methods,
            'pattern' => $this->pattern,
            'hosts' => $this->hosts,
            'defaults' => $this->defaults,
            'override' => $this->override,
            'actionAdded' => $this->actionAdded,
            'middlewares' => $this->middlewares,
            'builtMiddlewares' => $this->builtMiddlewares,
            'disabledMiddlewares' => $this->disabledMiddlewares,
        ];
    }

    /**
     * @return array[]|callable[]|string[]
     */
    public function getBuiltMiddlewares(): array
    {
        // Don't build middlewares if we did it earlier.
        // This improves performance in event-loop applications.
        if (!empty($this->builtMiddlewares)) {
            return $this->builtMiddlewares;
        }

        $builtMiddlewares = $this->middlewares;

        foreach ($builtMiddlewares as $index => $definition) {
            if (in_array($definition, $this->disabledMiddlewares, true)) {
                unset($builtMiddlewares[$index]);
            }
        }

        return $this->builtMiddlewares = $builtMiddlewares;
    }

    /**
     * @psalm-assert array<string> $items
     */
    private function assertListOfStrings(array $items, string $argument): void
    {
        foreach ($items as $item) {
            if (!is_string($item)) {
                throw new \InvalidArgumentException('Invalid $' . $argument . ' provided, list of string expected.');
            }
        }
    }

    /**
     * @psalm-assert array<array|callable|string> $middlewares
     */
    private function assertMiddlewares(array $middlewares): void
    {
        /** @var mixed $middleware */
        foreach ($middlewares as $middleware) {
            if (is_string($middleware)) {
                continue;
            }

            if (is_callable($middleware) || is_array($middleware)) {
                continue;
            }

            throw new \InvalidArgumentException(
                'Invalid $middlewares provided, list of string or array or callable expected.'
            );
        }
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Router;
6
7		use Attribute;
8		use InvalidArgumentException;
9		use RuntimeException;
10		use Stringable;
11		use Yiisoft\Http\Method;
12
13		use function in_array;
14
15		/**
16		* Route defines a mapping from URL to callback / name and vice versa.
17		*/
18		#[Attribute(Attribute::TARGET_METHOD \| Attribute::IS_REPEATABLE)]
19		class Route implements Stringable
20		{
21		private bool $actionAdded = false;
22		/**
23		* @var array[]\|callable[]\|string[]
24		*/
25		private array $builtMiddlewares = [];
26		/**
27		* @var array[]\|callable[]\|string[]
28		*/
29		private array $middlewares = [];
30		/**
31		* @var string[]
32		*/
33		private array $methods;
34		/**
35		* @var string[]
36		*/
37		private array $hosts = [];
38		/**
39		* @var array<string,scalar\|Stringable\|null>
40		*/
41		private array $defaults = [];
42
43		/**
44		* @param array<string,scalar\|Stringable\|null> $defaults Parameter default values indexed by parameter names.
45		* @param bool $override Marks route as override. When added it will replace existing route with the same name.
46		* @param array $disabledMiddlewares Excludes middleware from being invoked when action is handled.
47		* It is useful to avoid invoking one of the parent group middleware for
48		* a certain route.
49		*/
50	89	public function __construct(
51		array $methods,
52		private string $pattern,
53		private ?string $name = null,
54		array\|callable\|string $action = null,
55		array $middlewares = [],
56		array $defaults = [],
57		array $hosts = [],
58		private bool $override = false,
59		private array $disabledMiddlewares = [],
60		) {
61	89	$this->assertListOfStrings($methods, 'methods');
62	89	$this->assertMiddlewares($middlewares);
63	88	$this->assertListOfStrings($hosts, 'hosts');
64	87	$this->methods = $methods;
65	87	$this->middlewares = $middlewares;
66	87	$this->hosts = $hosts;
67	87	$this->defaults = array_map('\strval', $defaults);
68	87	if (!empty($action)) {
69		$this->middlewares[] = $action;
70		$this->actionAdded = true;
71		}
72		}
73
74	67	public static function get(string $pattern): self
75		{
76	67	return self::methods([Method::GET], $pattern);
77		}
78
79	9	public static function post(string $pattern): self
80		{
81	9	return self::methods([Method::POST], $pattern);
82		}
83
84	4	public static function put(string $pattern): self
85		{
86	4	return self::methods([Method::PUT], $pattern);
87		}
88
89	1	public static function delete(string $pattern): self
90		{
91	1	return self::methods([Method::DELETE], $pattern);
92		}
93
94	1	public static function patch(string $pattern): self
95		{
96	1	return self::methods([Method::PATCH], $pattern);
97		}
98
99	1	public static function head(string $pattern): self
100		{
101	1	return self::methods([Method::HEAD], $pattern);
102		}
103
104	9	public static function options(string $pattern): self
105		{
106	9	return self::methods([Method::OPTIONS], $pattern);
107		}
108
109		/**
110		* @param string[] $methods
111		*/
112	79	public static function methods(array $methods, string $pattern): self
113		{
114	79	return new self(
115	79	methods: $methods,
116	79	pattern: $pattern
117	79	);
118		}
119
120	23	public function name(string $name): self
121		{
122	23	$route = clone $this;
123	23	$route->name = $name;
124	23	return $route;
125		}
126
127	24	public function pattern(string $pattern): self
128		{
129	24	$new = clone $this;
130	24	$new->pattern = $pattern;
131	24	return $new;
132		}
133
134	9	public function host(string $host): self
135		{
136	9	return $this->hosts($host);
137		}
138
139	13	public function hosts(string ...$hosts): self
140		{
141	13	$route = clone $this;
142	13	$route->hosts = [];
143
144	13	foreach ($hosts as $host) {
145	13	$host = rtrim($host, '/');
146
147	13	if ($host !== '' && !in_array($host, $route->hosts, true)) {
148	12	$route->hosts[] = $host;
149		}
150		}
151
152	13	return $route;
153		}
154
155		/**
156		* Marks route as override. When added it will replace existing route with the same name.
157		*/
158	4	public function override(): self
159		{
160	4	$route = clone $this;
161	4	$route->override = true;
162	4	return $route;
163		}
164
165		/**
166		* Parameter default values indexed by parameter names.
167		*
168		* @psalm-param array<string,null\|Stringable\|scalar> $defaults
169		*/
170	3	public function defaults(array $defaults): self
171		{
172	3	$route = clone $this;
173	3	$route->defaults = array_map('\strval', $defaults);
174	3	return $route;
175		}
176
177		/**
178		* Appends a handler middleware definition that should be invoked for a matched route.
179		* First added handler will be executed first.
180		*/
181	23	public function middleware(array\|callable\|string ...$middlewareDefinition): self
182		{
183	23	if ($this->actionAdded) {
184	1	throw new RuntimeException('middleware() can not be used after action().');
185		}
186	22	$route = clone $this;
187	22	array_push(
188	22	$route->middlewares,
189	22	...array_values($middlewareDefinition)
190	22	);
191	22	$route->builtMiddlewares = [];
192	22	return $route;
193		}
194
195		/**
196		* Prepends a handler middleware definition that should be invoked for a matched route.
197		* Last added handler will be executed first.
198		*/
199	23	public function prependMiddleware(array\|callable\|string ...$middlewareDefinition): self
200		{
201	23	if (!$this->actionAdded) {
202	1	throw new RuntimeException('prependMiddleware() can not be used before action().');
203		}
204	22	$route = clone $this;
205	22	array_unshift(
206	22	$route->middlewares,
207	22	...array_values($middlewareDefinition)
208	22	);
209	22	$route->builtMiddlewares = [];
210	22	return $route;
211		}
212
213		/**
214		* Appends action handler. It is a primary middleware definition that should be invoked last for a matched route.
215		*/
216	27	public function action(array\|callable\|string $middlewareDefinition): self
217		{
218	27	$route = clone $this;
219	27	$route->middlewares[] = $middlewareDefinition;
220	27	$route->actionAdded = true;
221	27	$route->builtMiddlewares = [];
222	27	return $route;
223		}
224
225		/**
226		* Excludes middleware from being invoked when action is handled.
227		* It is useful to avoid invoking one of the parent group middleware for
228		* a certain route.
229		*/
230	3	public function disableMiddleware(mixed ...$middlewareDefinition): self
231		{
232	3	$route = clone $this;
233	3	array_push(
234	3	$route->disabledMiddlewares,
235	3	...array_values($middlewareDefinition)
236	3	);
237	3	$route->builtMiddlewares = [];
238	3	return $route;
239		}
240
241		/**
242		* @psalm-template T as string
243		*
244		* @psalm-param T $key
245		*
246		* @psalm-return (
247		* T is ('name'\|'pattern') ? string :
248		* (T is 'host' ? string\|null :
249		* (T is 'hosts' ? array<array-key, string> :
250		* (T is 'methods' ? array<array-key,string> :
251		* (T is 'defaults' ? array<string,string> :
252		* (T is ('override'\|'hasMiddlewares') ? bool :
253		* (T is 'builtMiddlewares' ? array<array-key,array\|callable\|string> : mixed)
254		* )
255		* )
256		* )
257		* )
258		* )
259		* )
260		*/
261	66	public function getData(string $key): mixed
262		{
263	66	return match ($key) {
264	66	'name' => $this->name ??
265	32	(implode(', ', $this->methods) . ' ' . implode('\|', $this->hosts) . $this->pattern),
266	66	'pattern' => $this->pattern,
267	66	'host' => $this->hosts[0] ?? null,
268	66	'hosts' => $this->hosts,
269	66	'methods' => $this->methods,
270	66	'defaults' => $this->defaults,
271	66	'override' => $this->override,
272	66	'hasMiddlewares' => !empty($this->middlewares),
273	66	'builtMiddlewares' => $this->getBuiltMiddlewares(),
274	66	default => throw new InvalidArgumentException('Unknown data key: ' . $key),
275	66	};
276		}
277
278	5	public function __toString(): string
279		{
280	5	$result = $this->name === null
281	2	? ''
282	3	: '[' . $this->name . '] ';
283
284	5	if ($this->methods !== []) {
285	5	$result .= implode(',', $this->methods) . ' ';
286		}
287
288	5	if ($this->hosts) {
		0 ignored issues – show Bug Best Practice introduced 2022-06-20 19:01 UTC by Report Bug Copy Issue Report The expression `$this->hosts` of type `array` 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...
289	2	$quoted = array_map(static fn ($host) => preg_quote($host, '/'), $this->hosts);
290
291	2	if (!preg_match('/' . implode('\|', $quoted) . '/', $this->pattern)) {
292	2	$result .= implode('\|', $this->hosts);
293		}
294		}
295
296	5	$result .= $this->pattern;
297
298	5	return $result;
299		}
300
301	1	public function __debugInfo()
302		{
303	1	return [
304	1	'name' => $this->name,
305	1	'methods' => $this->methods,
306	1	'pattern' => $this->pattern,
307	1	'hosts' => $this->hosts,
308	1	'defaults' => $this->defaults,
309	1	'override' => $this->override,
310	1	'actionAdded' => $this->actionAdded,
311	1	'middlewares' => $this->middlewares,
312	1	'builtMiddlewares' => $this->builtMiddlewares,
313	1	'disabledMiddlewares' => $this->disabledMiddlewares,
314	1	];
315		}
316
317		/**
318		* @return array[]\|callable[]\|string[]
319		*/
320	21	public function getBuiltMiddlewares(): array
321		{
322		// Don't build middlewares if we did it earlier.
323		// This improves performance in event-loop applications.
324	21	if (!empty($this->builtMiddlewares)) {
325	2	return $this->builtMiddlewares;
326		}
327
328	21	$builtMiddlewares = $this->middlewares;
329
330	21	foreach ($builtMiddlewares as $index => $definition) {
331	20	if (in_array($definition, $this->disabledMiddlewares, true)) {
332	1	unset($builtMiddlewares[$index]);
333		}
334		}
335
336	21	return $this->builtMiddlewares = $builtMiddlewares;
337		}
338
339		/**
340		* @psalm-assert array<string> $items
341		*/
342	89	private function assertListOfStrings(array $items, string $argument): void
343		{
344	89	foreach ($items as $item) {
345	89	if (!is_string($item)) {
346	1	throw new \InvalidArgumentException('Invalid $' . $argument . ' provided, list of string expected.');
347		}
348		}
349		}
350
351		/**
352		* @psalm-assert array<array\|callable\|string> $middlewares
353		*/
354	89	private function assertMiddlewares(array $middlewares): void
355		{
356		/** @var mixed $middleware */
357	89	foreach ($middlewares as $middleware) {
358	1	if (is_string($middleware)) {
359		continue;
360		}
361
362	1	if (is_callable($middleware) \|\| is_array($middleware)) {
363	1	continue;
364		}
365
366	1	throw new \InvalidArgumentException(
367	1	'Invalid $middlewares provided, list of string or array or callable expected.'
368	1	);
369		}
370		}
371		}
372

yiisoft / router

Pull Request — master (#196)

Route::hosts() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like