Group::routes() - Code Metrics - Inspection of "Improve Group, add Group::name, Group::host" - yiisoft/router - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#113)

by Rustam

created 2021-07-06 03:52 UTC

Group::routes() B

↳ Parent: Group

Complexity

Conditions	9
Paths	7

Size

Total Lines	32
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	15
CRAP Score	10.8889

Importance

Changes

Metric	Value
cc	9
eloc	21
c	0
b	0
f	0
nc	7
nop	1
dl	0
loc	32
ccs	15
cts	21
cp	0.7143
crap	10.8889
rs	8.0555

<?php

declare(strict_types=1);

namespace Yiisoft\Router;

use InvalidArgumentException;
use RuntimeException;
use Yiisoft\Middleware\Dispatcher\MiddlewareDispatcher;

use function get_class;
use function in_array;
use function is_array;
use function is_callable;
use function is_object;

final class Group implements RouteCollectorInterface
{
    /**
     * @var Group[]|Route[]
     */
    private array $items = [];
    private ?string $prefix;
    private array $middlewareDefinitions = [];
    private ?string $host = null;
    private ?string $name = null;
    private bool $routesAdded = false;
    private bool $middlewareAdded = false;
    private array $disabledMiddlewareDefinitions = [];
    private ?MiddlewareDispatcher $dispatcher;

    private function __construct(?string $prefix = null, MiddlewareDispatcher $dispatcher = null)
    {
        $this->dispatcher = $dispatcher;
        $this->prefix = $prefix;
    }

    /**
     * Create a new group instance.
     *
     * @param string|null $prefix URL prefix to prepend to all routes of the group.
     * @param MiddlewareDispatcher|null $dispatcher Middleware dispatcher to use for the group.
     *
     * @return RouteCollectorInterface
     */
    public static function create(
        ?string $prefix = null,
        MiddlewareDispatcher $dispatcher = null
    ): RouteCollectorInterface {
        return new self($prefix, $dispatcher);
    }

    public function routes(...$routes): RouteCollectorInterface
    {
        if ($this->middlewareAdded) {
            throw new RuntimeException('routes() can not be used after prependMiddleware().');
        }
        if (is_callable($routes)) {
            $callback = $routes;
        } elseif (is_array($routes)) {

            $callback = static function (self $group) use (&$routes) {
                foreach ($routes as $route) {
                    if ($route instanceof Route) {
                        $group->addRoute($route);
                    } elseif ($route instanceof self) {
                        $group->addGroup($route);
                    } else {
                        $type = is_object($route) ? get_class($route) : gettype($route);
                        throw new InvalidArgumentException(
                            sprintf('Route should be either an instance of Route or Group, %s given.', $type)
                        );
                    }
                }
            };
        } else {
            $callback = null;
        }

        if ($callback !== null) {

            $callback($this);
        }
        $this->routesAdded = true;

        return $this;
    }

    public function withDispatcher(MiddlewareDispatcher $dispatcher): RouteCollectorInterface
    {
        $group = clone $this;
        $group->dispatcher = $dispatcher;
        foreach ($group->items as $index => $item) {
            if (!$item->hasDispatcher()) {
                $item = $item->withDispatcher($dispatcher);
                $group->items[$index] = $item;
            }
        }

        return $group;
    }

    public function hasDispatcher(): bool
    {
        return $this->dispatcher !== null;
    }

    public function addRoute(Route $route): RouteCollectorInterface
    {
        if (!$route->hasDispatcher() && $this->hasDispatcher()) {
            $route->injectDispatcher($this->dispatcher);
        }
        $this->items[] = $route;
        return $this;
    }

    public function addGroup(self $group): RouteCollectorInterface
    {
        if (!$group->hasDispatcher() && $this->hasDispatcher()) {
            $group = $group->withDispatcher($this->dispatcher);
        }
        $this->items[] = $group;


        return $this;
    }

    /**
     * Appends a handler middleware definition that should be invoked for a matched route.
     * First added handler will be executed first.
     *
     * @param mixed $middlewareDefinition
     *
     * @return self
     */
    public function middleware($middlewareDefinition): RouteCollectorInterface
    {
        if ($this->routesAdded) {
            throw new RuntimeException('middleware() can not be used after routes().');
        }
        array_unshift($this->middlewareDefinitions, $middlewareDefinition);
        return $this;
    }

    /**
     * Prepends a handler middleware definition that should be invoked for a matched route.
     * First added handler will be executed last.
     *
     * @param mixed $middlewareDefinition
     *
     * @return self
     */
    public function prependMiddleware($middlewareDefinition): RouteCollectorInterface
    {
        $this->middlewareDefinitions[] = $middlewareDefinition;
        $this->middlewareAdded = true;
        return $this;
    }

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

    public function host(string $host): RouteCollectorInterface
    {
        $new = clone $this;
        $new->host = rtrim($host, '/');
        return $new;
    }

    /**
     * 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.
     *
     * @param mixed $middlewareDefinition
     *
     * @return self
     */
    public function disableMiddleware($middlewareDefinition): RouteCollectorInterface
    {
        $new = clone $this;
        $new->disabledMiddlewareDefinitions[] = $middlewareDefinition;
        return $new;
    }

    /**
     * @return Group[]|Route[]
     */
    public function getItems(): array
    {
        return $this->items;
    }

    public function getPrefix(): ?string
    {
        return $this->prefix;
    }

    public function getName(): ?string
    {
        return $this->name;
    }

    public function getHost(): ?string
    {
        return $this->host;
    }

    public function getMiddlewareDefinitions(): array
    {
        foreach ($this->middlewareDefinitions as $index => $definition) {
            if (in_array($definition, $this->disabledMiddlewareDefinitions, true)) {
                unset($this->middlewareDefinitions[$index]);
            }
        }

        return $this->middlewareDefinitions;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Router;
6
7		use InvalidArgumentException;
8		use RuntimeException;
9		use Yiisoft\Middleware\Dispatcher\MiddlewareDispatcher;
10
11		use function get_class;
12		use function in_array;
13		use function is_array;
14		use function is_callable;
15		use function is_object;
16
17		final class Group implements RouteCollectorInterface
18		{
19		/**
20		* @var Group[]\|Route[]
21		*/
22		private array $items = [];
23		private ?string $prefix;
24		private array $middlewareDefinitions = [];
25		private ?string $host = null;
26		private ?string $name = null;
27		private bool $routesAdded = false;
28		private bool $middlewareAdded = false;
29		private array $disabledMiddlewareDefinitions = [];
30		private ?MiddlewareDispatcher $dispatcher;
31
32	14	private function __construct(?string $prefix = null, MiddlewareDispatcher $dispatcher = null)
33		{
34	14	$this->dispatcher = $dispatcher;
35	14	$this->prefix = $prefix;
36	14	}
37
38		/**
39		* Create a new group instance.
40		*
41		* @param string\|null $prefix URL prefix to prepend to all routes of the group.
42		* @param MiddlewareDispatcher\|null $dispatcher Middleware dispatcher to use for the group.
43		*
44		* @return RouteCollectorInterface
45		*/
46	14	public static function create(
47		?string $prefix = null,
48		MiddlewareDispatcher $dispatcher = null
49		): RouteCollectorInterface {
50	14	return new self($prefix, $dispatcher);
51		}
52
53	8	public function routes(...$routes): RouteCollectorInterface
54		{
55	8	if ($this->middlewareAdded) {
56		throw new RuntimeException('routes() can not be used after prependMiddleware().');
57		}
58	8	if (is_callable($routes)) {
59		$callback = $routes;
60	8	} elseif (is_array($routes)) {
		0 ignored issues – show introduced 2021-05-12 05:35 UTC by Report Bug Copy Issue Report The condition `is_array($routes)` is always `true`. Loading history...
61	8	$callback = static function (self $group) use (&$routes) {
62	8	foreach ($routes as $route) {
63	8	if ($route instanceof Route) {
64	8	$group->addRoute($route);
65	5	} elseif ($route instanceof self) {
66	5	$group->addGroup($route);
67		} else {
68		$type = is_object($route) ? get_class($route) : gettype($route);
69		throw new InvalidArgumentException(
70		sprintf('Route should be either an instance of Route or Group, %s given.', $type)
71		);
72		}
73		}
74	8	};
75		} else {
76		$callback = null;
77		}
78
79	8	if ($callback !== null) {
		0 ignored issues – show introduced 2021-05-12 05:35 UTC by Report Bug Copy Issue Report The condition `$callback !== null` is always `true`. Loading history...
80	8	$callback($this);
81		}
82	8	$this->routesAdded = true;
83
84	8	return $this;
85		}
86
87	2	public function withDispatcher(MiddlewareDispatcher $dispatcher): RouteCollectorInterface
88		{
89	2	$group = clone $this;
90	2	$group->dispatcher = $dispatcher;
91	2	foreach ($group->items as $index => $item) {
92	2	if (!$item->hasDispatcher()) {
93	2	$item = $item->withDispatcher($dispatcher);
94	2	$group->items[$index] = $item;
95		}
96		}
97
98	2	return $group;
99		}
100
101	11	public function hasDispatcher(): bool
102		{
103	11	return $this->dispatcher !== null;
104		}
105
106	11	public function addRoute(Route $route): RouteCollectorInterface
107		{
108	11	if (!$route->hasDispatcher() && $this->hasDispatcher()) {
109	3	$route->injectDispatcher($this->dispatcher);
110		}
111	11	$this->items[] = $route;
112	11	return $this;
113		}
114
115	7	public function addGroup(self $group): RouteCollectorInterface
116		{
117	7	if (!$group->hasDispatcher() && $this->hasDispatcher()) {
118	2	$group = $group->withDispatcher($this->dispatcher);
119		}
120	7	$this->items[] = $group;
121
122
123	7	return $this;
124		}
125
126		/**
127		* Appends a handler middleware definition that should be invoked for a matched route.
128		* First added handler will be executed first.
129		*
130		* @param mixed $middlewareDefinition
131		*
132		* @return self
133		*/
134	6	public function middleware($middlewareDefinition): RouteCollectorInterface
135		{
136	6	if ($this->routesAdded) {
137		throw new RuntimeException('middleware() can not be used after routes().');
138		}
139	6	array_unshift($this->middlewareDefinitions, $middlewareDefinition);
140	6	return $this;
141		}
142
143		/**
144		* Prepends a handler middleware definition that should be invoked for a matched route.
145		* First added handler will be executed last.
146		*
147		* @param mixed $middlewareDefinition
148		*
149		* @return self
150		*/
151	1	public function prependMiddleware($middlewareDefinition): RouteCollectorInterface
152		{
153	1	$this->middlewareDefinitions[] = $middlewareDefinition;
154	1	$this->middlewareAdded = true;
155	1	return $this;
156		}
157
158	2	public function name(string $name): RouteCollectorInterface
159		{
160	2	$new = clone $this;
161	2	$new->name = $name;
162	2	return $new;
163		}
164
165	2	public function host(string $host): RouteCollectorInterface
166		{
167	2	$new = clone $this;
168	2	$new->host = rtrim($host, '/');
169	2	return $new;
170		}
171
172		/**
173		* Excludes middleware from being invoked when action is handled.
174		* It is useful to avoid invoking one of the parent group middleware for
175		* a certain route.
176		*
177		* @param mixed $middlewareDefinition
178		*
179		* @return self
180		*/
181		public function disableMiddleware($middlewareDefinition): RouteCollectorInterface
182		{
183		$new = clone $this;
184		$new->disabledMiddlewareDefinitions[] = $middlewareDefinition;
185		return $new;
186		}
187
188		/**
189		* @return Group[]\|Route[]
190		*/
191	11	public function getItems(): array
192		{
193	11	return $this->items;
194		}
195
196	9	public function getPrefix(): ?string
197		{
198	9	return $this->prefix;
199		}
200
201	9	public function getName(): ?string
202		{
203	9	return $this->name;
204		}
205
206	9	public function getHost(): ?string
207		{
208	9	return $this->host;
209		}
210
211	8	public function getMiddlewareDefinitions(): array
212		{
213	8	foreach ($this->middlewareDefinitions as $index => $definition) {
214	6	if (in_array($definition, $this->disabledMiddlewareDefinitions, true)) {
215		unset($this->middlewareDefinitions[$index]);
216		}
217		}
218
219	8	return $this->middlewareDefinitions;
220		}
221		}
222

yiisoft / router

Pull Request — master (#113)

Group::routes() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like