RoutesList::setRoute() - Code Metrics - Inspection of "All: Adding missing const types." - valkyrjaio/valkyrja - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — master (e894a3)

by Melech

created 2025-06-15 07:42 UTC

RoutesList::setRoute() B

↳ Parent: Project

Complexity

Conditions	6
Paths	12

Size

Total Lines	34
Code Lines	26

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	6
eloc	26
nc	12
nop	2
dl	0
loc	34
rs	8.8817
c	1
b	0
f	0

<?php

declare(strict_types=1);

/*
 * This file is part of the Valkyrja Framework package.
 *
 * (c) Melech Mizrachi <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Valkyrja\Http\Routing\Command;

use InvalidArgumentException;
use Valkyrja\Console\Commander\Commander;
use Valkyrja\Console\Enum\FormatForeground;
use Valkyrja\Console\Input\Contract\Input as InputContract;
use Valkyrja\Console\Input\Input;
use Valkyrja\Console\Output\Contract\Output as OutputContract;
use Valkyrja\Console\Output\Output;
use Valkyrja\Console\Support\Provides;
use Valkyrja\Http\Routing\Contract\Router;
use Valkyrja\Http\Routing\Model\Contract\Route;

use function implode;
use function max;
use function str_repeat;
use function strlen;
use function usort;

/**
 * Class RoutesList.
 *
 * @author Melech Mizrachi
 */
class RoutesList extends Commander
{
    use Provides;

    /** @var string */
    public const string COMMAND = 'routes:list';

    /** @var string */
    public const string PATH = self::COMMAND;
    /** @var string */
    public const string SHORT_DESCRIPTION = 'List all routes';
    /** @var string */
    public const string DESCRIPTION = '';

    /** @var string */
    protected const string INVERT_FORMAT = "\e[7m";
    /** @var string */
    protected const string END_FORMAT = "\e[0m";

    public function __construct(
        protected Router $router,
        InputContract $input = new Input(),
        OutputContract $output = new Output()
    ) {
        parent::__construct($input, $output);
    }

    /**
     * @inheritDoc
     *
     * @throws InvalidArgumentException
     */
    public function run(): int
    {
        $routerRoutes = $this->router->getRoutes();
        $routes       = [];
        $headerTexts  = [
            'Request Methods',
            'Path',
            'Name',
            'Dispatch',
            'Regex',
        ];
        $lengths      = [
            strlen($headerTexts[0]),
            strlen($headerTexts[1]),
            strlen($headerTexts[2]),
            strlen($headerTexts[3]),
            strlen($headerTexts[4]),
        ];

        // Sort routes by path
        usort($routerRoutes, static fn (Route $a, Route $b) => $a->getPath() <=> $b->getPath());

        foreach ($routerRoutes as $route) {
            $routes[] = $this->setRoute($route, $lengths);
        }

        $sepLine = $this->getSepLine($lengths);
        $odd     = false;

        $this->output->writeMessage($this->oddFormat(true) . $sepLine, true);
        $this->headerMessage($headerTexts, $lengths);
        $this->output->writeMessage($sepLine, true);

        foreach ($routes as $key => $route) {
            $routeMessage = '| '
                . $route[0]
                . str_repeat(' ', $lengths[0] - strlen($route[0]))
                . ' | '
                . $route[1]
                . str_repeat(' ', $lengths[1] - strlen($route[1]))
                . ' | '
                . $route[2]
                . str_repeat(' ', $lengths[2] - strlen($route[2]))
                . ' | '
                . $route[3]
                . str_repeat(' ', $lengths[3] - strlen($route[3]))
                . ' | '
                . $route[4]
                . str_repeat(' ', $lengths[4] - strlen($route[4]))
                . ' |';

            $odd          = $key % 2 > 0;
            $routeMessage = $this->oddFormat($odd) . $routeMessage;

            $this->output->writeMessage($routeMessage . static::END_FORMAT, true);
        }

        $this->output->writeMessage($this->oddFormat(! $odd) . $sepLine . static::END_FORMAT, true);

        return 0;
    }

    /**
     * Set a route as an array from a route object.
     *
     * @param Route           $route   The route object
     * @param array<int, int> $lengths The longest string lengths
     *
     * @throws InvalidArgumentException
     *
     * @return array{0: string, 1: string, 2: string, 3: string, 4: string}
     */
    protected function setRoute(Route $route, array &$lengths): array
    {
        $requestMethod = implode(' | ', array_column($route->getMethods(), 'value'));
        $dispatch      = 'Closure';
        $regex         = $route->getRegex() ?? '';
        $path          = $route->getPath();
        $name          = $route->getName() ?? '';

        if ($requestMethod === 'GET | HEAD | POST | PUT | PATCH | CONNECT | OPTIONS | TRACE | DELETE') {
            $requestMethod = 'ANY';
        }

        if (($function = $route->getFunction()) !== null) {
            $dispatch = $function;
        } elseif (null !== $class = $route->getClass()) {
            $dispatch = $class
                . ($route->isStatic() ? '::' : '->')
                . ((($method = $route->getMethod()) !== null)
                    ? $method . '()'
                    : $route->getProperty() ?? '');
        }

        $lengths[0] = max($lengths[0], strlen($requestMethod));
        $lengths[1] = max($lengths[1], strlen($path));
        $lengths[2] = max($lengths[2], strlen($name));
        $lengths[3] = max($lengths[3], strlen($dispatch));
        $lengths[4] = max($lengths[4], strlen($regex));

        return [
            $requestMethod,
            $path,
            $name,
            $dispatch,
            $regex,
        ];
    }

    /**
     * Get the separation line.
     *
     * @param array<int, int> $lengths The longest lengths
     *
     * @return string
     */
    protected function getSepLine(array $lengths): string
    {
        return '+-' . str_repeat('-', $lengths[0])
            . '-+-' . str_repeat('-', $lengths[1])
            . '-+-' . str_repeat('-', $lengths[2])
            . '-+-' . str_repeat('-', $lengths[3])
            . '-+-' . str_repeat('-', $lengths[4])
            . '-+';
    }

    /**
     * Format odd rows.
     *
     * @param bool $odd
     *
     * @return string
     */
    protected function oddFormat(bool $odd): string
    {
        return $odd
            ? static::INVERT_FORMAT . "\e[" . ((string) FormatForeground::CYAN->value) . 'm'
            : static::INVERT_FORMAT . "\e[" . ((string) FormatForeground::LIGHT_CYAN->value) . 'm';
    }

    /**
     * Output the header message.
     *
     * @param array<int, string> $headerTexts The header texts
     * @param array<int, int>    $lengths     The longest lengths
     *
     * @return void
     */
    protected function headerMessage(array $headerTexts, array $lengths): void
    {
        $headerMessage = '| ' . $headerTexts[0]
            . str_repeat(' ', $lengths[0] - strlen($headerTexts[0]))
            . ' | ' . $headerTexts[1]
            . str_repeat(' ', $lengths[1] - strlen($headerTexts[1]))
            . ' | ' . $headerTexts[2]
            . str_repeat(' ', $lengths[2] - strlen($headerTexts[2]))
            . ' | ' . $headerTexts[3]
            . str_repeat(' ', $lengths[3] - strlen($headerTexts[3]))
            . ' | ' . $headerTexts[4]
            . str_repeat(' ', $lengths[4] - strlen($headerTexts[4]))
            . ' |';

        $this->output->writeMessage($headerMessage, true);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Valkyrja Framework package.
7			*
8			* (c) Melech Mizrachi <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Valkyrja\Http\Routing\Command;
15
16			use InvalidArgumentException;
17			use Valkyrja\Console\Commander\Commander;
18			use Valkyrja\Console\Enum\FormatForeground;
19			use Valkyrja\Console\Input\Contract\Input as InputContract;
20			use Valkyrja\Console\Input\Input;
21			use Valkyrja\Console\Output\Contract\Output as OutputContract;
22			use Valkyrja\Console\Output\Output;
23			use Valkyrja\Console\Support\Provides;
24			use Valkyrja\Http\Routing\Contract\Router;
25			use Valkyrja\Http\Routing\Model\Contract\Route;
26
27			use function implode;
28			use function max;
29			use function str_repeat;
30			use function strlen;
31			use function usort;
32
33			/**
34			* Class RoutesList.
35			*
36			* @author Melech Mizrachi
37			*/
38			class RoutesList extends Commander
39			{
40			use Provides;
41
42			/** @var string */
43			public const string COMMAND = 'routes:list';
			0 ignored issues – show Bug introduced 2025-06-15 07:58 UTC by Report Bug Copy Issue Report A parse error occurred: Syntax error, unexpected T_STRING, expecting '=' on line 43 at column 24 Loading history...
44			/** @var string */
45			public const string PATH = self::COMMAND;
46			/** @var string */
47			public const string SHORT_DESCRIPTION = 'List all routes';
48			/** @var string */
49			public const string DESCRIPTION = '';
50
51			/** @var string */
52			protected const string INVERT_FORMAT = "\e[7m";
53			/** @var string */
54			protected const string END_FORMAT = "\e[0m";
55
56			public function __construct(
57			protected Router $router,
58			InputContract $input = new Input(),
59			OutputContract $output = new Output()
60			) {
61			parent::__construct($input, $output);
62			}
63
64			/**
65			* @inheritDoc
66			*
67			* @throws InvalidArgumentException
68			*/
69			public function run(): int
70			{
71			$routerRoutes = $this->router->getRoutes();
72			$routes = [];
73			$headerTexts = [
74			'Request Methods',
75			'Path',
76			'Name',
77			'Dispatch',
78			'Regex',
79			];
80			$lengths = [
81			strlen($headerTexts[0]),
82			strlen($headerTexts[1]),
83			strlen($headerTexts[2]),
84			strlen($headerTexts[3]),
85			strlen($headerTexts[4]),
86			];
87
88			// Sort routes by path
89			usort($routerRoutes, static fn (Route $a, Route $b) => $a->getPath() <=> $b->getPath());
90
91			foreach ($routerRoutes as $route) {
92			$routes[] = $this->setRoute($route, $lengths);
93			}
94
95			$sepLine = $this->getSepLine($lengths);
96			$odd = false;
97
98			$this->output->writeMessage($this->oddFormat(true) . $sepLine, true);
99			$this->headerMessage($headerTexts, $lengths);
100			$this->output->writeMessage($sepLine, true);
101
102			foreach ($routes as $key => $route) {
103			$routeMessage = '\| '
104			. $route[0]
105			. str_repeat(' ', $lengths[0] - strlen($route[0]))
106			. ' \| '
107			. $route[1]
108			. str_repeat(' ', $lengths[1] - strlen($route[1]))
109			. ' \| '
110			. $route[2]
111			. str_repeat(' ', $lengths[2] - strlen($route[2]))
112			. ' \| '
113			. $route[3]
114			. str_repeat(' ', $lengths[3] - strlen($route[3]))
115			. ' \| '
116			. $route[4]
117			. str_repeat(' ', $lengths[4] - strlen($route[4]))
118			. ' \|';
119
120			$odd = $key % 2 > 0;
121			$routeMessage = $this->oddFormat($odd) . $routeMessage;
122
123			$this->output->writeMessage($routeMessage . static::END_FORMAT, true);
124			}
125
126			$this->output->writeMessage($this->oddFormat(! $odd) . $sepLine . static::END_FORMAT, true);
127
128			return 0;
129			}
130
131			/**
132			* Set a route as an array from a route object.
133			*
134			* @param Route $route The route object
135			* @param array<int, int> $lengths The longest string lengths
136			*
137			* @throws InvalidArgumentException
138			*
139			* @return array{0: string, 1: string, 2: string, 3: string, 4: string}
140			*/
141			protected function setRoute(Route $route, array &$lengths): array
142			{
143			$requestMethod = implode(' \| ', array_column($route->getMethods(), 'value'));
144			$dispatch = 'Closure';
145			$regex = $route->getRegex() ?? '';
146			$path = $route->getPath();
147			$name = $route->getName() ?? '';
148
149			if ($requestMethod === 'GET \| HEAD \| POST \| PUT \| PATCH \| CONNECT \| OPTIONS \| TRACE \| DELETE') {
150			$requestMethod = 'ANY';
151			}
152
153			if (($function = $route->getFunction()) !== null) {
154			$dispatch = $function;
155			} elseif (null !== $class = $route->getClass()) {
156			$dispatch = $class
157			. ($route->isStatic() ? '::' : '->')
158			. ((($method = $route->getMethod()) !== null)
159			? $method . '()'
160			: $route->getProperty() ?? '');
161			}
162
163			$lengths[0] = max($lengths[0], strlen($requestMethod));
164			$lengths[1] = max($lengths[1], strlen($path));
165			$lengths[2] = max($lengths[2], strlen($name));
166			$lengths[3] = max($lengths[3], strlen($dispatch));
167			$lengths[4] = max($lengths[4], strlen($regex));
168
169			return [
170			$requestMethod,
171			$path,
172			$name,
173			$dispatch,
174			$regex,
175			];
176			}
177
178			/**
179			* Get the separation line.
180			*
181			* @param array<int, int> $lengths The longest lengths
182			*
183			* @return string
184			*/
185			protected function getSepLine(array $lengths): string
186			{
187			return '+-' . str_repeat('-', $lengths[0])
188			. '-+-' . str_repeat('-', $lengths[1])
189			. '-+-' . str_repeat('-', $lengths[2])
190			. '-+-' . str_repeat('-', $lengths[3])
191			. '-+-' . str_repeat('-', $lengths[4])
192			. '-+';
193			}
194
195			/**
196			* Format odd rows.
197			*
198			* @param bool $odd
199			*
200			* @return string
201			*/
202			protected function oddFormat(bool $odd): string
203			{
204			return $odd
205			? static::INVERT_FORMAT . "\e[" . ((string) FormatForeground::CYAN->value) . 'm'
206			: static::INVERT_FORMAT . "\e[" . ((string) FormatForeground::LIGHT_CYAN->value) . 'm';
207			}
208
209			/**
210			* Output the header message.
211			*
212			* @param array<int, string> $headerTexts The header texts
213			* @param array<int, int> $lengths The longest lengths
214			*
215			* @return void
216			*/
217			protected function headerMessage(array $headerTexts, array $lengths): void
218			{
219			$headerMessage = '\| ' . $headerTexts[0]
220			. str_repeat(' ', $lengths[0] - strlen($headerTexts[0]))
221			. ' \| ' . $headerTexts[1]
222			. str_repeat(' ', $lengths[1] - strlen($headerTexts[1]))
223			. ' \| ' . $headerTexts[2]
224			. str_repeat(' ', $lengths[2] - strlen($headerTexts[2]))
225			. ' \| ' . $headerTexts[3]
226			. str_repeat(' ', $lengths[3] - strlen($headerTexts[3]))
227			. ' \| ' . $headerTexts[4]
228			. str_repeat(' ', $lengths[4] - strlen($headerTexts[4]))
229			. ' \|';
230
231			$this->output->writeMessage($headerMessage, true);
232			}
233			}
234

valkyrjaio / valkyrja

Branch — master (e894a3)

RoutesList::setRoute() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like