Router::getCachedData() - Code Metrics - Inspection of "Improved benchmarking routes" - divineniiquaye/flight-routing - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 67a6c5...5b4678 )

by Divine Niiquaye
created 2022-05-09 07:41 UTC
Router::getCachedData() A

↳ Parent: Router
Complexity

Conditions	6
Paths	9
Size

Total Lines	21
Code Lines	11
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	11
CRAP Score	6.0208
Importance

Changes	9
Bugs	0	Features	0
Metric	Value
cc	6
eloc	11
nc	9
nop	1
dl	0
loc	21
ccs	11
cts	12
cp	0.9167
crap	6.0208
rs	9.2222
c	9
b	0
f	0
<?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 Fig\Http\Message\RequestMethodInterface;
use Flight\Routing\Exceptions\UrlGenerationException;
use Flight\Routing\Generator\GeneratedUri;
use Flight\Routing\Interfaces\{RouteCompilerInterface, RouteMatcherInterface, UrlGeneratorInterface};
use Laminas\Stratigility\Next;
use Psr\Http\Message\{ResponseInterface, ServerRequestInterface, UriInterface};
use Psr\Http\Server\{MiddlewareInterface, RequestHandlerInterface};
use Symfony\Component\VarExporter\VarExporter;

/**
 * Aggregate routes for matching and Dispatching.
 *
 * @author Divine Niiquaye Ibok <[email protected]>
 */
class Router implements RouteMatcherInterface, RequestMethodInterface, MiddlewareInterface
{
    /**
     * Standard HTTP methods for browser requests.
     */
    public const HTTP_METHODS_STANDARD = [
        self::METHOD_HEAD,
        self::METHOD_GET,
        self::METHOD_POST,
        self::METHOD_PUT,
        self::METHOD_PATCH,
        self::METHOD_DELETE,
        self::METHOD_PURGE,
        self::METHOD_OPTIONS,
        self::METHOD_TRACE,
        self::METHOD_CONNECT,
    ];

    private ?RouteCompilerInterface $compiler;
    private ?RouteMatcherInterface $matcher = null;
    private ?\SplQueue $pipeline = null;
    private string $matcherClass = RouteMatcher::class;
    private ?string $cacheData;

    /** @var array<string,array<int,MiddlewareInterface>> */
    private array $middlewares = [];

    /** @var RouteCollection|(callable(RouteCollection): void)|null */

    private $collection;

    /**
     * @param string|null $cache file path to store compiled routes
     */
    public function __construct(RouteCompilerInterface $compiler = null, string $cache = null)
    {
        $this->compiler = $compiler;
        $this->cacheData = $cache;
    }

    /**
     * Set a route collection instance into Router in order to use addRoute method.
     *
     * @param string|null $cache file path to store compiled routes
     *
     * @return static
     */
    public static function withCollection(RouteCollection $collection = null, RouteCompilerInterface $compiler = null, string $cache = null)
    {
        $new = new static($compiler, $cache);
        $new->collection = $collection ?? new RouteCollection();

        return $new;
    }

    /**
     * This method works only if withCollection method is used.
     */
    public function addRoute(Route ...$routes): void
    {
        if ($this->collection instanceof RouteCollection) {
            $this->collection->routes($routes);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function match(string $method, UriInterface $uri): ?Route
    {
        return $this->getMatcher()->match($method, $uri);
    }

    /**
     * {@inheritdoc}
     */
    public function matchRequest(ServerRequestInterface $request): ?Route
    {
        return $this->getMatcher()->matchRequest($request);
    }

    /**
     * {@inheritdoc}
     */
    public function generateUri(string $routeName, array $parameters = [], int $referenceType = GeneratedUri::ABSOLUTE_PATH): GeneratedUri
    {
        $matcher = $this->getMatcher();

        //@codeCoverageIgnoreStart
        if (!$matcher instanceof UrlGeneratorInterface) {
            throw new UrlGenerationException(\sprintf('The route matcher does not support using the %s implementation', UrlGeneratorInterface::class));
        }
        //@codeCoverageIgnoreEnd

        return $matcher->generateUri($routeName, $parameters, $referenceType);
    }

    /**
     * Attach middleware to the pipeline.
     */
    public function pipe(MiddlewareInterface ...$middlewares): void
    {
        if (null === $this->pipeline) {
            $this->pipeline = new \SplQueue();
        }

        foreach ($middlewares as $middleware) {
            $this->pipeline->enqueue($middleware);
        }
    }

    /**
     * Attach a name to a group of middlewares.
     */
    public function pipes(string $name, MiddlewareInterface ...$middlewares): void
    {
        $this->middlewares[$name] = $middlewares;
    }

    /**
     * Sets the RouteCollection instance associated with this Router.
     *
     * @param (callable(RouteCollection): void) $routeDefinitionCallback takes only one parameter of route collection

     */
    public function setCollection(callable $routeDefinitionCallback): void
    {
        $this->collection = $routeDefinitionCallback;
    }

    /**
     *  Get the RouteCollection instance associated with this Router.
     */
    public function getCollection(): RouteCollection
    {
        if (\is_callable($collection = $this->collection)) {
            $collection($collection = new RouteCollection());
        } elseif (null === $collection) {
            throw new \RuntimeException(\sprintf('Did you forget to set add the route collection with the "%s".', __CLASS__ . '::setCollection'));
        }

        return $this->collection = $collection;
    }

    /**
     * Set where cached data will be stored.
     *
     * @param string $cache file path to store compiled routes
     */
    public function setCache(string $cache): void
    {
        $this->cacheData = $cache;
    }

    /**
     * If RouteCollection's data has been cached.
     */
    public function isCached(): bool
    {
        return ($cache = $this->cacheData) && \file_exists($cache);
    }

    /**
     * Set a matcher class associated with this Router.
     */
    public function setMatcher(string $matcherClass): void
    {
        if (!\is_subclass_of($matcherClass, RouteMatcherInterface::class)) {
            throw new \InvalidArgumentException(\sprintf('"%s" must be a subclass of "%s".', $matcherClass, RouteMatcherInterface::class));
        }
        $this->matcherClass = $matcherClass;
    }

    /**
     * Gets the Route matcher instance associated with this Router.
     */
    public function getMatcher(): RouteMatcherInterface
    {
        return $this->matcher ??= $this->cacheData ? $this->getCachedData($this->cacheData) : new $this->matcherClass($this->getCollection(), $this->compiler);
    }

    /**
     * {@inheritdoc}
     */
    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
    {
        $route = $this->getMatcher()->matchRequest($request);

        if (null !== $route) {
            foreach ($route->getPiped() as $middleware) {
                if (isset($this->middlewares[$middleware])) {
                    $this->pipe(...$this->middlewares[$middleware]);
                }
            }
        }

        if (null !== $this->pipeline) {
            $handler = new Next($this->pipeline, $handler);
        }

        return $handler->handle($request->withAttribute(Route::class, $route));
    }

    protected function getCachedData(string $cache): RouteMatcherInterface
    {
        $cachedData = @include $cache;

        if (!$cachedData instanceof RouteMatcherInterface) {
            $cachedData = new $this->matcherClass($this->getCollection(), $this->compiler);
            $dumpData = \class_exists(VarExporter::class) ? VarExporter::export($cachedData) : "\unserialize(<<<'SERIALIZED'\n" . \serialize($cachedData) . "\nSERIALIZED)";

            if (!\is_dir($directory = \dirname($cache))) {
                @\mkdir($directory, 0775, true);
                /** @scrutinizer ignore-unhandled */ @\mkdir($directory, 0775, true);
            }

            \file_put_contents($cache, "<?php // auto generated: AVOID MODIFYING\n\nreturn " . $dumpData . ";\n");

            if (\function_exists('opcache_invalidate') && \filter_var(\ini_get('opcache.enable'), \FILTER_VALIDATE_BOOLEAN)) {
                @\opcache_invalidate($cache, true);
                /** @scrutinizer ignore-unhandled */ @\opcache_invalidate($cache, true);
            }
            $cachedData = require $cache;
        }

        return $cachedData;
    }
}

divineniiquaye / flight-routing

Push — master ( 67a6c5...5b4678 )

Router::getCachedData() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
