RouteMatcher::match() - Code Metrics - Inspection of "Fixed coding standard issues" - divineniiquaye/flight-routing - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 08de7a...d45f24 )

by Divine Niiquaye

created 2021-10-08 12:25 UTC

RouteMatcher::match() C

↳ Parent: RouteMatcher

Complexity

Conditions	13
Paths	22

Size

Total Lines	46
Code Lines	24

Duplication

Lines	0
Ratio	0 %

Importance

Changes	9
Bugs	1	Features	0

Metric	Value
cc	13
eloc	24
c	9
b	1
f	0
nc	22
nop	2
dl	0
loc	46
rs	6.6166

How to fix Complexity

<?php

declare(strict_types=1);

/*
 * This file is part of Flight Routing.
 *
 * PHP version 7.4 and above required
 *
 * @author    Divine Niiquaye Ibok <[email protected]>
 * @copyright 2019 Biurad Group (https://biurad.com/)
 * @license   https://opensource.org/licenses/BSD-3-Clause License
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Flight\Routing;

use Flight\Routing\Routes\{FastRoute as Route, Route as BaseRoute};
use Flight\Routing\Exceptions\{UriHandlerException, UrlGenerationException};
use Flight\Routing\Generator\{GeneratedRoute, GeneratedUri};
use Flight\Routing\Interfaces\{RouteCompilerInterface, RouteMatcherInterface};
use Psr\Http\Message\{ServerRequestInterface, UriInterface};

/**
 * The bidirectional route matcher responsible for matching
 * HTTP request and generating url from routes.
 *
 * @author Divine Niiquaye Ibok <[email protected]>
 */
final class RouteMatcher implements RouteMatcherInterface
{
    /** @var Route[] */
    private iterable $routes;

    private RouteCompilerInterface $compiler;

    private ?GeneratedRoute $compiledData = null;

    public function __construct(RouteCollection $collection, RouteCompilerInterface $compiler = null)
    {
        $this->compiler = $compiler ?? new RouteCompiler();
        $this->routes = $collection->getRoutes();

    }

    /**
     * @internal
     */
    public function __serialize(): array
    {
        $routes = $this->getRoutes();

        return [$this->compiler->build($routes), $routes, $this->compiler];
    }

    /**
     * @internal
     *
     * @param array<int,mixed> $data
     */
    public function __unserialize(array $data): void
    {
        [$this->compiledData, $this->routes, $this->compiler] = $data;
    }

    /**
     * {@inheritdoc}
     */
    public function matchRequest(ServerRequestInterface $request): ?Route
    {
        $requestUri = $request->getUri();

        // Resolve request path to match sub-directory or /index.php/path
        if ('' !== ($pathInfo = $request->getServerParams()['PATH_INFO'] ?? '') && $pathInfo !== $requestUri->getPath()) {
            $requestUri = $requestUri->withPath($pathInfo);
        }

        return $this->match($request->getMethod(), $requestUri);
    }

    /**
     * {@inheritdoc}
     */
    public function match(string $method, UriInterface $uri): ?Route
    {
        $requestPath = $uri->getPath();

        if (\array_key_exists($requestPath[-1], BaseRoute::URL_PREFIX_SLASHES)) {
            $requestPath = \substr($requestPath, 0, -1) ?: '/';
        }

        if (null === $nextHandler = $this->compiledData) {
            foreach ($this->routes as $route) {
                [$pathRegex, $hostsRegex, $variables] = $this->compiler->compile($route);

                if (\preg_match('{^' . $pathRegex . '$}u', $requestPath, $matches, \PREG_UNMATCHED_AS_NULL)) {
                    if (empty($variables)) {
                        return $route->match($method, $uri);
                    }

                    return static::doMatch($method, $uri, [$hostsRegex, $variables, $route], $matches);
                }
            }

            goto route_not_found;
        }

        [$staticRoutes, $regexList, $variables] = $nextHandler->getData();

        if (null === $matchedId = $staticRoutes[$requestPath] ?? null) {
            if (null === $regexList || !\preg_match($regexList, $requestPath, $matches, \PREG_UNMATCHED_AS_NULL)) {
                goto route_not_found;
            }

            $matchedId = (int) $matches['MARK'];
        }

        foreach ($variables as $domain => $routeVar) {
            if (\array_key_exists($matchedId, $routeVar)) {
                if (empty($routeVar)) {
                    return $this->routes[$matchedId]->match($method, $uri);
                }

                return static::doMatch($method, $uri, [$domain, $routeVar[$matchedId], $this->routes[$matchedId]], $matches ?? []);
            }
        }

        route_not_found:
        return null;
    }

    /**
     * {@inheritdoc}
     */
    public function generateUri(string $routeName, array $parameters = []): GeneratedUri
    {
        foreach ($this->routes as $route) {
            if ($routeName === $route->getName()) {
                return $this->compiler->generateUri($route, $parameters);
            }
        }

        throw new UrlGenerationException(\sprintf('Unable to generate a URL for the named route "%s" as such route does not exist.', $routeName), 404);
    }

    /**
     * Get the compiler associated with this class.
     */
    public function getCompiler(): RouteCompilerInterface
    {
        return $this->compiler;
    }

    /**
     * Get the routes associated with this class.
     *
     * @return iterable<int,Route>
     */
    public function getRoutes(): iterable
    {
        return $this->routes;
    }

    /**
     * @param array<int,mixed> $routeData
     * @param array<int|string,mixed> $matches
     */
    private static function doMatch(string $method, UriInterface $uri, array $routeData, array $matches): Route
    {
        /** @var Route $matchedRoute */
        [$hostsRegex, $variables, $matchedRoute] = $routeData;
        $matchVar = 0;
        $hostsVar = [];

        if (!empty($hostsRegex)) {
            $hostAndPost = $uri->getHost() . (null !== $uri->getPort() ? ':' . $uri->getPort() : '');

            if (!\preg_match('{^' . $hostsRegex . '$}i', $hostAndPost, $hostsVar, \PREG_UNMATCHED_AS_NULL)) {
                throw new UriHandlerException(\sprintf('Unfortunately current host "%s" is not allowed on requested path [%s].', $hostAndPost, $uri->getPath()), 400);
            }
        }

        foreach ($variables as $key => $value) {
            $matchedRoute->argument($key, $matches[++$matchVar] ?? $matches[$key] ?? $hostsVar[$key] ?? $value);
        }

        return $matchedRoute->match($method, $uri);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of Flight Routing.
7			*
8			* PHP version 7.4 and above required
9			*
10			* @author Divine Niiquaye Ibok <[email protected]>
11			* @copyright 2019 Biurad Group (https://biurad.com/)
12			* @license https://opensource.org/licenses/BSD-3-Clause License
13			*
14			* For the full copyright and license information, please view the LICENSE
15			* file that was distributed with this source code.
16			*/
17
18			namespace Flight\Routing;
19
20			use Flight\Routing\Routes\{FastRoute as Route, Route as BaseRoute};
21			use Flight\Routing\Exceptions\{UriHandlerException, UrlGenerationException};
22			use Flight\Routing\Generator\{GeneratedRoute, GeneratedUri};
23			use Flight\Routing\Interfaces\{RouteCompilerInterface, RouteMatcherInterface};
24			use Psr\Http\Message\{ServerRequestInterface, UriInterface};
25
26			/**
27			* The bidirectional route matcher responsible for matching
28			* HTTP request and generating url from routes.
29			*
30			* @author Divine Niiquaye Ibok <[email protected]>
31			*/
32			final class RouteMatcher implements RouteMatcherInterface
33			{
34			/** @var Route[] */
35			private iterable $routes;
36
37			private RouteCompilerInterface $compiler;
38
39			private ?GeneratedRoute $compiledData = null;
40
41			public function __construct(RouteCollection $collection, RouteCompilerInterface $compiler = null)
42			{
43			$this->compiler = $compiler ?? new RouteCompiler();
44			$this->routes = $collection->getRoutes();
			0 ignored issues – show Documentation Bug introduced 2021-10-08 12:37 UTC by Report Bug Copy Issue Report It seems like `$collection->getRoutes()` of type `iterable` is incompatible with the declared type `Flight\Routing\Routes\FastRoute[]` of property `$routes`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
45			}
46
47			/**
48			* @internal
49			*/
50			public function __serialize(): array
51			{
52			$routes = $this->getRoutes();
53
54			return [$this->compiler->build($routes), $routes, $this->compiler];
55			}
56
57			/**
58			* @internal
59			*
60			* @param array<int,mixed> $data
61			*/
62			public function __unserialize(array $data): void
63			{
64			[$this->compiledData, $this->routes, $this->compiler] = $data;
65			}
66
67			/**
68			* {@inheritdoc}
69			*/
70			public function matchRequest(ServerRequestInterface $request): ?Route
71			{
72			$requestUri = $request->getUri();
73
74			// Resolve request path to match sub-directory or /index.php/path
75			if ('' !== ($pathInfo = $request->getServerParams()['PATH_INFO'] ?? '') && $pathInfo !== $requestUri->getPath()) {
76			$requestUri = $requestUri->withPath($pathInfo);
77			}
78
79			return $this->match($request->getMethod(), $requestUri);
80			}
81
82			/**
83			* {@inheritdoc}
84			*/
85			public function match(string $method, UriInterface $uri): ?Route
86			{
87			$requestPath = $uri->getPath();
88
89			if (\array_key_exists($requestPath[-1], BaseRoute::URL_PREFIX_SLASHES)) {
90			$requestPath = \substr($requestPath, 0, -1) ?: '/';
91			}
92
93			if (null === $nextHandler = $this->compiledData) {
94			foreach ($this->routes as $route) {
95			[$pathRegex, $hostsRegex, $variables] = $this->compiler->compile($route);
96
97			if (\preg_match('{^' . $pathRegex . '$}u', $requestPath, $matches, \PREG_UNMATCHED_AS_NULL)) {
98			if (empty($variables)) {
99			return $route->match($method, $uri);
100			}
101
102			return static::doMatch($method, $uri, [$hostsRegex, $variables, $route], $matches);
103			}
104			}
105
106			goto route_not_found;
107			}
108
109			[$staticRoutes, $regexList, $variables] = $nextHandler->getData();
110
111			if (null === $matchedId = $staticRoutes[$requestPath] ?? null) {
112			if (null === $regexList \|\| !\preg_match($regexList, $requestPath, $matches, \PREG_UNMATCHED_AS_NULL)) {
113			goto route_not_found;
114			}
115
116			$matchedId = (int) $matches['MARK'];
117			}
118
119			foreach ($variables as $domain => $routeVar) {
120			if (\array_key_exists($matchedId, $routeVar)) {
121			if (empty($routeVar)) {
122			return $this->routes[$matchedId]->match($method, $uri);
123			}
124
125			return static::doMatch($method, $uri, [$domain, $routeVar[$matchedId], $this->routes[$matchedId]], $matches ?? []);
126			}
127			}
128
129			route_not_found:
130			return null;
131			}
132
133			/**
134			* {@inheritdoc}
135			*/
136			public function generateUri(string $routeName, array $parameters = []): GeneratedUri
137			{
138			foreach ($this->routes as $route) {
139			if ($routeName === $route->getName()) {
140			return $this->compiler->generateUri($route, $parameters);
141			}
142			}
143
144			throw new UrlGenerationException(\sprintf('Unable to generate a URL for the named route "%s" as such route does not exist.', $routeName), 404);
145			}
146
147			/**
148			* Get the compiler associated with this class.
149			*/
150			public function getCompiler(): RouteCompilerInterface
151			{
152			return $this->compiler;
153			}
154
155			/**
156			* Get the routes associated with this class.
157			*
158			* @return iterable<int,Route>
159			*/
160			public function getRoutes(): iterable
161			{
162			return $this->routes;
163			}
164
165			/**
166			* @param array<int,mixed> $routeData
167			* @param array<int\|string,mixed> $matches
168			*/
169			private static function doMatch(string $method, UriInterface $uri, array $routeData, array $matches): Route
170			{
171			/** @var Route $matchedRoute */
172			[$hostsRegex, $variables, $matchedRoute] = $routeData;
173			$matchVar = 0;
174			$hostsVar = [];
175
176			if (!empty($hostsRegex)) {
177			$hostAndPost = $uri->getHost() . (null !== $uri->getPort() ? ':' . $uri->getPort() : '');
178
179			if (!\preg_match('{^' . $hostsRegex . '$}i', $hostAndPost, $hostsVar, \PREG_UNMATCHED_AS_NULL)) {
180			throw new UriHandlerException(\sprintf('Unfortunately current host "%s" is not allowed on requested path [%s].', $hostAndPost, $uri->getPath()), 400);
181			}
182			}
183
184			foreach ($variables as $key => $value) {
185			$matchedRoute->argument($key, $matches[++$matchVar] ?? $matches[$key] ?? $hostsVar[$key] ?? $value);
186			}
187
188			return $matchedRoute->match($method, $uri);
189			}
190			}
191

divineniiquaye / flight-routing

Push — master ( 08de7a...d45f24 )

RouteMatcher::match() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like