Router::getCachedData() - Code Metrics - Inspection of "Improved the route collection class (#26)" - divineniiquaye/flight-routing - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 8d099e...79397a )

by Divine Niiquaye
created 2022-03-12 09:59 UTC
Router::getCachedData() B

↳ Parent: Router
Complexity

Conditions	7
Paths	7
Size

Total Lines	30
Code Lines	15
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	10
CRAP Score	9.5839
Importance

Changes	6
Bugs	0	Features	0
Metric	Value
cc	7
eloc	15
c	6
b	0
f	0
nc	7
nop	1
dl	0
loc	30
ccs	10
cts	16
cp	0.625
crap	9.5839
rs	8.8333
<?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\Generator\GeneratedUri;
use Flight\Routing\Interfaces\{RouteCompilerInterface, RouteMatcherInterface};
use Laminas\Stratigility\Next;
use Psr\Cache\CacheItemPoolInterface;
use Psr\Http\Message\{ResponseInterface, ServerRequestInterface, UriInterface};
use Psr\Http\Server\{MiddlewareInterface, RequestHandlerInterface};

/**
 * 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,
    ];

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

    /** @var array<string,Route|null> Match once, use later */
    private array $optimized = [];

    private \SplQueue $pipeline;

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

    private $collection;

    private ?RouteCompilerInterface $compiler;

    private ?RouteMatcherInterface $matcher = null;

    /** @var CacheItemPoolInterface|string|null */
    private $cacheData;

    /**
     * @param CacheItemPoolInterface|string|null $cache use file path or PSR-6 cache
     */
    public function __construct(RouteCompilerInterface $compiler = null, $cache = null)
    {
        $this->compiler = $compiler;
        $this->pipeline = new \SplQueue();
        $this->cacheData = $cache;
    }

    /**
     * Set a route collection instance into Router in order to use addRoute method.
     *
     * @param CacheItemPoolInterface|string|null $cache use file path or PSR-6 cache
     *
     * @return static
     */
    public static function withCollection(RouteCollection $collection = null, RouteCompilerInterface $compiler = null, $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->optimized[$method . (string) $uri] ??= $this->getMatcher()->match($method, $uri);
    }

    /**
     * {@inheritdoc}
     */
    public function matchRequest(ServerRequestInterface $request): ?Route
    {
        return $this->optimized[$request->getMethod() . (string) $request->getUri()] ??= $this->getMatcher()->matchRequest($request);
    }

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

    /**
     * Attach middleware to the pipeline.
     */
    public function pipe(MiddlewareInterface ...$middlewares): void
    {
        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 CacheItemPoolInterface|string $cache use file path or PSR-6 cache
     *
     * @return void
     */
    public function setCache($cache): void
    {
        $this->cacheData = $cache;
    }

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

        return ($cache instanceof CacheItemPoolInterface && $cache->hasItem(__FILE__)) || \file_exists($cache);
        return ($cache instanceof CacheItemPoolInterface && $cache->hasItem(__FILE__)) || \file_exists(/** @scrutinizer ignore-type */ $cache);
    }

    /**
     * Gets the Route matcher instance associated with this Router.
     */
    public function getMatcher(): RouteMatcherInterface
    {
        return $this->matcher
            ?? $this->matcher = (
                $this->cacheData
                    ? $this->getCachedData($this->cacheData)
                    : new RouteMatcher($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) {
                foreach ($this->middlewares[$middleware] ?? [] as $pipedMiddleware) {
                    $this->pipeline->enqueue($pipedMiddleware);
                }
            }
        }

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

    /**
     * @param CacheItemPoolInterface|string $cache
     */
    protected function getCachedData($cache): RouteMatcherInterface
    {
        if ($cache instanceof CacheItemPoolInterface) {
            $cachedData = $cache->getItem(__FILE__)->get();

            if (!$cachedData instanceof RouteMatcherInterface) {
                $cache->deleteItem(__FILE__);
                $cache->save($cache->getItem(__FILE__)->set($cachedData = new RouteMatcher($this->getCollection(), $this->compiler)));
            }

            return $cachedData;
        }

        $cachedData = @include $cache;

        if (!$cachedData instanceof RouteMatcherInterface) {
            $dumpData = "<<<'SERIALIZED'\n" . \serialize($cachedData = new RouteMatcher($this->getCollection(), $this->compiler)) . "\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 \unserialize(" . $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);
            }
        }

        return $cachedData;
    }
}

divineniiquaye / flight-routing

Push — master ( 8d099e...79397a )

Router::getCachedData() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
