Routes::getAllRoutes() - Code Metrics - Inspection of "Group Configure classes in the same dir" - gacela-project/router - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — main (#32)

by Chema

created 2023-05-06 18:15 UTC

Routes::getAllRoutes() A

↳ Parent: Routes

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Gacela\Router\Configure;

use Gacela\Router\Controllers\RedirectController;
use Gacela\Router\Entities\Request;
use Gacela\Router\Entities\Route;
use Gacela\Router\Exceptions\UnsupportedHttpMethodException;

use function in_array;
use function is_array;

/**
 * @method head(string $path, object|string $controller, string $action = '__invoke')
 * @method connect(string $path, object|string $controller, string $action = '__invoke')
 * @method get(string $path, object|string $controller, string $action = '__invoke')
 * @method post(string $path, object|string $controller, string $action = '__invoke')
 * @method put(string $path, object|string $controller, string $action = '__invoke')
 * @method patch(string $path, object|string $controller, string $action = '__invoke')
 * @method delete(string $path, object|string $controller, string $action = '__invoke')
 * @method options(string $path, object|string $controller, string $action = '__invoke')
 * @method trace(string $path, object|string $controller, string $action = '__invoke')
 * @method any(string $path, object|string $controller, string $action = '__invoke')
 */
final class Routes
{
    /** @var list<Route> */
    private array $routes = [];

    /**
     * @psalm-suppress MixedArgument
     */
    public function __call(string $method, array $arguments): void
    {
        if ($method === 'any') {
            $this->addRoute(Request::ALL_METHODS, ...$arguments);
        } else {
            $this->addRoute($method, ...$arguments);
        }
    }

    /**
     * @psalm-suppress MixedArgument
     *
     * @param string[] $methods
     * @param object|class-string $controller

     */
    public function match(array $methods, string $path, object|string $controller, string $action = '__invoke'): void
    {
        $this->addRoute($methods, $path, $controller, $action);
    }

    public function redirect(
        string $uri,
        string $destination,
        int $status = 302,
        string $method = null,
    ): void {
        if ($method === null) {
            $this->addRoute(Request::ALL_METHODS, $uri, new RedirectController($destination, $status));
        } else {
            $this->addRoute([$method], $uri, new RedirectController($destination, $status));
        }
    }

    /**
     * @return list<Route>
     */
    public function getAllRoutes(): array
    {
        return $this->routes;
    }

    /**
     * @param string[]|string $methods
     * @param object|class-string $controller

     */
    private function addRoute(
        array|string $methods,
        string $path,
        object|string $controller,
        string $action = '__invoke',
    ): void {
        if (!is_array($methods)) {

            $methods = [$methods];
        }

        $methods = array_map(static fn ($method) => strtoupper($method), $methods);

        foreach ($methods as $method) {
            if (!in_array($method, Request::ALL_METHODS, true)) {
                throw UnsupportedHttpMethodException::withName($method);
            }
            $path = ($path === '/') ? '' : $path;

            $this->routes[] = new Route($method, $path, $controller, $action);
        }
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Gacela\Router\Configure;
6
7		use Gacela\Router\Controllers\RedirectController;
8		use Gacela\Router\Entities\Request;
9		use Gacela\Router\Entities\Route;
10		use Gacela\Router\Exceptions\UnsupportedHttpMethodException;
11
12		use function in_array;
13		use function is_array;
14
15		/**
16		* @method head(string $path, object\|string $controller, string $action = '__invoke')
17		* @method connect(string $path, object\|string $controller, string $action = '__invoke')
18		* @method get(string $path, object\|string $controller, string $action = '__invoke')
19		* @method post(string $path, object\|string $controller, string $action = '__invoke')
20		* @method put(string $path, object\|string $controller, string $action = '__invoke')
21		* @method patch(string $path, object\|string $controller, string $action = '__invoke')
22		* @method delete(string $path, object\|string $controller, string $action = '__invoke')
23		* @method options(string $path, object\|string $controller, string $action = '__invoke')
24		* @method trace(string $path, object\|string $controller, string $action = '__invoke')
25		* @method any(string $path, object\|string $controller, string $action = '__invoke')
26		*/
27		final class Routes
28		{
29		/** @var list<Route> */
30		private array $routes = [];
31
32		/**
33		* @psalm-suppress MixedArgument
34		*/
35	71	public function __call(string $method, array $arguments): void
36		{
37	71	if ($method === 'any') {
38	9	$this->addRoute(Request::ALL_METHODS, ...$arguments);
39		} else {
40	62	$this->addRoute($method, ...$arguments);
41		}
42		}
43
44		/**
45		* @psalm-suppress MixedArgument
46		*
47		* @param string[] $methods
48		* @param object\|class-string $controller
		0 ignored issues – show Documentation Bug introduced 2023-04-09 15:08 UTC by Report Bug Copy Issue Report The doc comment `object\|class-string` at position `2` could not be parsed: Unknown type name 'class-string' at position 2 in object\|class-string. Loading history...
49		*/
50	8	public function match(array $methods, string $path, object\|string $controller, string $action = '__invoke'): void
51		{
52	8	$this->addRoute($methods, $path, $controller, $action);
53		}
54
55	15	public function redirect(
56		string $uri,
57		string $destination,
58		int $status = 302,
59		string $method = null,
60		): void {
61	15	if ($method === null) {
62	10	$this->addRoute(Request::ALL_METHODS, $uri, new RedirectController($destination, $status));
63		} else {
64	5	$this->addRoute([$method], $uri, new RedirectController($destination, $status));
65		}
66		}
67
68		/**
69		* @return list<Route>
70		*/
71	95	public function getAllRoutes(): array
72		{
73	95	return $this->routes;
74		}
75
76		/**
77		* @param string[]\|string $methods
78		* @param object\|class-string $controller
		0 ignored issues – show Documentation Bug introduced 2023-04-09 15:08 UTC by Report Bug Copy Issue Report The doc comment `object\|class-string` at position `2` could not be parsed: Unknown type name 'class-string' at position 2 in object\|class-string. Loading history...
79		*/
80	94	private function addRoute(
81		array\|string $methods,
82		string $path,
83		object\|string $controller,
84		string $action = '__invoke',
85		): void {
86	94	if (!is_array($methods)) {
		0 ignored issues – show introduced 2023-04-16 22:12 UTC by Report Bug Copy Issue Report The condition `is_array($methods)` is always `true`. Loading history...
87	62	$methods = [$methods];
88		}
89
90	94	$methods = array_map(static fn ($method) => strtoupper($method), $methods);
91
92	94	foreach ($methods as $method) {
93	94	if (!in_array($method, Request::ALL_METHODS, true)) {
94	1	throw UnsupportedHttpMethodException::withName($method);
95		}
96	93	$path = ($path === '/') ? '' : $path;
97
98	93	$this->routes[] = new Route($method, $path, $controller, $action);
99		}
100		}
101		}
102

gacela-project / router

Pull Request — main (#32)

Routes::getAllRoutes() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like