RouteCollection::getRouteTree() - Code Metrics - Inspection of "Fix auto response options" - yiisoft/router - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#134)

by Alexander

created 2021-12-16 19:07 UTC

RouteCollection::getRouteTree() A

↳ Parent: RouteCollection

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace Yiisoft\Router;

use InvalidArgumentException;
use Psr\Http\Message\ResponseFactoryInterface;
use Yiisoft\Http\Method;

final class RouteCollection implements RouteCollectionInterface
{
    private RouteCollectorInterface $collector;

    private array $items = [];

    /**
     * All attached routes as Route instances
     *
     * @var Route[]
     */
    private array $routes = [];

    public function __construct(RouteCollectorInterface $collector)
    {
        $this->collector = $collector;
    }

    public function getRoutes(): array
    {
        $this->ensureItemsInjected();
        return $this->routes;
    }

    public function getRoute(string $name): Route
    {
        $this->ensureItemsInjected();
        if (!array_key_exists($name, $this->routes)) {
            throw new RouteNotFoundException($name);
        }

        return $this->routes[$name];
    }

    public function getRouteTree(bool $routeAsString = true): array
    {
        $this->ensureItemsInjected();
        return $this->buildTree($this->items, $routeAsString);
    }

    private function ensureItemsInjected(): void
    {
        if ($this->items === []) {
            $this->injectItems($this->collector->getItems());
        }
    }

    /**
     * Build routes array
     *
     * @param Group[]|Route[] $items
     */
    private function injectItems(array $items): void
    {
        foreach ($items as $index => $item) {
            foreach ($this->collector->getMiddlewareDefinitions() as $middlewareDefinition) {
                $item = $item->prependMiddleware($middlewareDefinition);
            }
            $this->injectItem($item);
        }
    }

    /**
     * Add an item into routes array
     *
     * @param Group|Route $route
     */
    private function injectItem($route): void
    {
        if ($route instanceof Group) {
            $this->injectGroup($route, $this->items);
            return;
        }

        $this->items[] = $route->getName();
        $routeName = $route->getName();
        if (isset($this->routes[$routeName]) && !$route->isOverride()) {
            throw new InvalidArgumentException("A route with name '$routeName' already exists.");
        }
        $this->routes[$routeName] = $route;
    }

    /**
     * Inject a Group instance into route and item arrays.
     */
    private function injectGroup(Group $group, array &$tree, string $prefix = '', string $namePrefix = ''): void
    {
        $prefix .= $group->getPrefix();
        $namePrefix .= $group->getNamePrefix();
        $items = $group->getItems();
        $pattern = null;
        $host = null;
        foreach ($items as $item) {
            if ($item instanceof Group || $item->hasMiddlewares()) {
                foreach ($group->getMiddlewareDefinitions() as $middleware) {
                    $item = $item->prependMiddleware($middleware);
                }
            }

            if ($group->getHost() !== null && $item->getHost() === null) {
                $item = $item->host($group->getHost());
            }

            if ($item instanceof Group) {
                if ($group->hasCorsMiddleware()) {
                    $item = $item->withCors($group->getCorsMiddleware());
                }
                /** @var Group $item */
                if (empty($item->getPrefix())) {
                    $this->injectGroup($item, $tree, $prefix, $namePrefix);
                    continue;
                }
                $tree[$item->getPrefix()] = [];
                $this->injectGroup($item, $tree[$item->getPrefix()], $prefix, $namePrefix);
                continue;
            }

            /** @var Route $modifiedItem */
            $modifiedItem = $item->pattern($prefix . $item->getPattern());

            if (strpos($modifiedItem->getName(), implode(', ', $modifiedItem->getMethods())) === false) {
                $modifiedItem = $modifiedItem->name($namePrefix . $modifiedItem->getName());
            }

            if ($group->hasCorsMiddleware()) {
                $this->processCors($group, $host, $pattern, $modifiedItem, $tree);
            }

            if (empty($tree[$group->getPrefix()])) {
                $tree[] = $modifiedItem->getName();
            } else {
                $tree[$group->getPrefix()][] = $modifiedItem->getName();
            }

            $routeName = $modifiedItem->getName();
            if (isset($this->routes[$routeName]) && !$modifiedItem->isOverride()) {
                throw new InvalidArgumentException("A route with name '$routeName' already exists.");
            }
            $this->routes[$routeName] = $modifiedItem;
        }
    }

    private function processCors(Group $group, ?string &$host, ?string &$pattern, Route &$modifiedItem, array &$tree): void
    {
        $middleware = $group->getCorsMiddleware();
        $isNotDuplicate = !in_array(Method::OPTIONS, $modifiedItem->getMethods(), true)
            && ($pattern !== $modifiedItem->getPattern() || $host !== $modifiedItem->getHost());

        $pattern = $modifiedItem->getPattern();
        $host = $modifiedItem->getHost();
        /** @var Route $optionsRoute */
        $optionsRoute = Route::options($pattern);
        if ($host !== null) {
            $optionsRoute = $optionsRoute->host($host);
        }
        if ($isNotDuplicate) {
            $optionsRoute = $optionsRoute->middleware($middleware);
            if (empty($tree[$group->getPrefix()])) {
                $tree[] = $optionsRoute->getName();
            } else {
                $tree[$group->getPrefix()][] = $optionsRoute->getName();
            }
            $this->routes[$optionsRoute->getName()] = $optionsRoute->action(
                static fn (ResponseFactoryInterface $responseFactory) => $responseFactory->createResponse(204)
            );
        }
        $modifiedItem = $modifiedItem->prependMiddleware($middleware);
    }

    /**
     * Builds route tree from items
     *
     * @param array $items
     * @param bool $routeAsString
     *
     * @return array
     */
    private function buildTree(array $items, bool $routeAsString): array
    {
        $tree = [];
        foreach ($items as $key => $item) {
            if (is_array($item)) {
                $tree[$key] = $this->buildTree($items[$key], $routeAsString);
            } else {
                $tree[] = $routeAsString ? (string)$this->getRoute($item) : $this->getRoute($item);
            }
        }
        return $tree;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Router;
6
7		use InvalidArgumentException;
8		use Psr\Http\Message\ResponseFactoryInterface;
9		use Yiisoft\Http\Method;
10
11		final class RouteCollection implements RouteCollectionInterface
12		{
13		private RouteCollectorInterface $collector;
14
15		private array $items = [];
16
17		/**
18		* All attached routes as Route instances
19		*
20		* @var Route[]
21		*/
22		private array $routes = [];
23
24	18	public function __construct(RouteCollectorInterface $collector)
25		{
26	18	$this->collector = $collector;
27	18	}
28
29	7	public function getRoutes(): array
30		{
31	7	$this->ensureItemsInjected();
32	5	return $this->routes;
33		}
34
35	13	public function getRoute(string $name): Route
36		{
37	13	$this->ensureItemsInjected();
38	13	if (!array_key_exists($name, $this->routes)) {
39	1	throw new RouteNotFoundException($name);
40		}
41
42	12	return $this->routes[$name];
43		}
44
45	1	public function getRouteTree(bool $routeAsString = true): array
46		{
47	1	$this->ensureItemsInjected();
48	1	return $this->buildTree($this->items, $routeAsString);
49		}
50
51	18	private function ensureItemsInjected(): void
52		{
53	18	if ($this->items === []) {
54	18	$this->injectItems($this->collector->getItems());
55		}
56	16	}
57
58		/**
59		* Build routes array
60		*
61		* @param Group[]\|Route[] $items
62		*/
63	18	private function injectItems(array $items): void
64		{
65	18	foreach ($items as $index => $item) {
66	18	foreach ($this->collector->getMiddlewareDefinitions() as $middlewareDefinition) {
67	1	$item = $item->prependMiddleware($middlewareDefinition);
68		}
69	18	$this->injectItem($item);
70		}
71	16	}
72
73		/**
74		* Add an item into routes array
75		*
76		* @param Group\|Route $route
77		*/
78	18	private function injectItem($route): void
79		{
80	18	if ($route instanceof Group) {
81	18	$this->injectGroup($route, $this->items);
82	17	return;
83		}
84
85	2	$this->items[] = $route->getName();
86	2	$routeName = $route->getName();
87	2	if (isset($this->routes[$routeName]) && !$route->isOverride()) {
88	1	throw new InvalidArgumentException("A route with name '$routeName' already exists.");
89		}
90	1	$this->routes[$routeName] = $route;
91	1	}
92
93		/**
94		* Inject a Group instance into route and item arrays.
95		*/
96	18	private function injectGroup(Group $group, array &$tree, string $prefix = '', string $namePrefix = ''): void
97		{
98	18	$prefix .= $group->getPrefix();
99	18	$namePrefix .= $group->getNamePrefix();
100	18	$items = $group->getItems();
101	18	$pattern = null;
102	18	$host = null;
103	18	foreach ($items as $item) {
104	18	if ($item instanceof Group \|\| $item->hasMiddlewares()) {
105	14	foreach ($group->getMiddlewareDefinitions() as $middleware) {
106	6	$item = $item->prependMiddleware($middleware);
107		}
108		}
109
110	18	if ($group->getHost() !== null && $item->getHost() === null) {
111	1	$item = $item->host($group->getHost());
112		}
113
114	18	if ($item instanceof Group) {
115	6	if ($group->hasCorsMiddleware()) {
116	2	$item = $item->withCors($group->getCorsMiddleware());
117		}
118		/** @var Group $item */
119	6	if (empty($item->getPrefix())) {
120	2	$this->injectGroup($item, $tree, $prefix, $namePrefix);
121	2	continue;
122		}
123	5	$tree[$item->getPrefix()] = [];
124	5	$this->injectGroup($item, $tree[$item->getPrefix()], $prefix, $namePrefix);
125	5	continue;
126		}
127
128		/** @var Route $modifiedItem */
129	18	$modifiedItem = $item->pattern($prefix . $item->getPattern());
130
131	18	if (strpos($modifiedItem->getName(), implode(', ', $modifiedItem->getMethods())) === false) {
132	13	$modifiedItem = $modifiedItem->name($namePrefix . $modifiedItem->getName());
133		}
134
135	18	if ($group->hasCorsMiddleware()) {
136	5	$this->processCors($group, $host, $pattern, $modifiedItem, $tree);
137		}
138
139	18	if (empty($tree[$group->getPrefix()])) {
140	18	$tree[] = $modifiedItem->getName();
141		} else {
142		$tree[$group->getPrefix()][] = $modifiedItem->getName();
143		}
144
145	18	$routeName = $modifiedItem->getName();
146	18	if (isset($this->routes[$routeName]) && !$modifiedItem->isOverride()) {
147	1	throw new InvalidArgumentException("A route with name '$routeName' already exists.");
148		}
149	18	$this->routes[$routeName] = $modifiedItem;
150		}
151	17	}
152
153	5	private function processCors(Group $group, ?string &$host, ?string &$pattern, Route &$modifiedItem, array &$tree): void
154		{
155	5	$middleware = $group->getCorsMiddleware();
156	5	$isNotDuplicate = !in_array(Method::OPTIONS, $modifiedItem->getMethods(), true)
157	5	&& ($pattern !== $modifiedItem->getPattern() \|\| $host !== $modifiedItem->getHost());
158
159	5	$pattern = $modifiedItem->getPattern();
160	5	$host = $modifiedItem->getHost();
161		/** @var Route $optionsRoute */
162	5	$optionsRoute = Route::options($pattern);
163	5	if ($host !== null) {
164	1	$optionsRoute = $optionsRoute->host($host);
165		}
166	5	if ($isNotDuplicate) {
167	5	$optionsRoute = $optionsRoute->middleware($middleware);
168	5	if (empty($tree[$group->getPrefix()])) {
169	5	$tree[] = $optionsRoute->getName();
170		} else {
171		$tree[$group->getPrefix()][] = $optionsRoute->getName();
172		}
173	5	$this->routes[$optionsRoute->getName()] = $optionsRoute->action(
174	5	static fn (ResponseFactoryInterface $responseFactory) => $responseFactory->createResponse(204)
175	5	);
176		}
177	5	$modifiedItem = $modifiedItem->prependMiddleware($middleware);
178	5	}
179
180		/**
181		* Builds route tree from items
182		*
183		* @param array $items
184		* @param bool $routeAsString
185		*
186		* @return array
187		*/
188	1	private function buildTree(array $items, bool $routeAsString): array
189		{
190	1	$tree = [];
191	1	foreach ($items as $key => $item) {
192	1	if (is_array($item)) {
193	1	$tree[$key] = $this->buildTree($items[$key], $routeAsString);
194		} else {
195	1	$tree[] = $routeAsString ? (string)$this->getRoute($item) : $this->getRoute($item);
196		}
197		}
198	1	return $tree;
199		}
200		}
201

yiisoft / router

Pull Request — master (#134)

RouteCollection::getRouteTree() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like