RouteCollection::head() - Code Metrics - Inspection of "Fixed annotations loading from routes" - divineniiquaye/flight-routing - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#14)

by Divine Niiquaye
created 2021-05-20 19:43 UTC
RouteCollection::head() A

↳ Parent: RouteCollection
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
c	0
b	0
f	0
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
cc	1
nc	1
nop	2
crap	1
<?php

declare(strict_types=1);

/*
 * This file is part of Flight Routing.
 *
 * PHP version 7.1 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;

/**
 * A RouteCollection represents a set of Route instances.
 *
 * This class provides all(*) methods for creating path+HTTP method-based routes and
 * injecting them into the router:
 *
 * - head
 * - get
 * - post
 * - put
 * - patch
 * - delete
 * - options
 * - any
 * - resource
 *
 * A general `addRoute()` method allows specifying multiple request methods and/or
 * arbitrary request methods when creating a path-based route.
 *
 * __call() forwards method-calls to Route, but returns instance of RouteCollection
 * listing Route's methods below, so that IDEs know they are valid
 *
 * @method RouteCollection withAssert(string $variable, string|string[] $regexp)
 * @method RouteCollection withDefault(string $variable, mixed $default)
 * @method RouteCollection withArgument($variable, mixed $value)
 * @method RouteCollection withMethod(string ...$methods)
 * @method RouteCollection withScheme(string ...$schemes)
 * @method RouteCollection withMiddleware(mixed ...$middlewares)
 * @method RouteCollection withDomain(string ...$hosts)
 * @method RouteCollection withPrefix(string $path)
 * @method RouteCollection withDefaults(array $values)
 * @method RouteCollection withAsserts(array $patterns)
 * @method RouteCollection withArguments(array $patterns)
 *
 * @author Divine Niiquaye Ibok <[email protected]>
 */
final class RouteCollection implements \IteratorAggregate, \Countable
{
    /** @var string|null */
    private $namePrefix;

    /** @var Route[] */
    private $routes = [];

    /** @var self|null */
    private $parent = null;

    /** @var array<string,mixed[]>|null */
    private $stack = null;

    /** @var \ArrayIterator|null */
    private $iterable = null;

    /**
     * @param string   $method
     * @param string[] $arguments
     *
     * @return mixed
     */
    public function __call($method, $arguments)
    {
        $routeMethod = (string) \preg_replace('/^with([A-Z]{1}[a-z]+)$/', '\1', $method, 1);
        $routeMethod = \strtolower($routeMethod);

        if (null !== $this->stack) {
            if ([] !== $stack = $this->stack[$routeMethod] ?? []) {
                $arguments = \array_merge(\end($stack), $arguments);
            }

            $this->stack[$routeMethod][] = $arguments;
        } else {
            foreach ($this->routes as $route) {
                \call_user_func_array([$route, $routeMethod], $arguments);
            }
        }

        return $this;
    }

    /**
     * Gets the number of Routes in this collection.
     *
     * @return int The number of routes
     */
    public function count(): int
    {
        return $this->getIterator()->count();
    }

    /**
     * Gets the filtered RouteCollection as an ArrayIterator that includes all routes.
     *
     * @see doMerge() method
     *
     * @return \ArrayIterator<int,Route> The filtered routes
     */
    public function getIterator(): \ArrayIterator
    {
        return $this->iterable ?? $this->iterable = new \ArrayIterator($this->doMerge('', new static()));
    }

    /**
     * Add route(s) to the collection.
     *
     * This method unset all setting from default route and use new settings
     * from new the route(s). If you want the default settings to be merged
     * into routes, use `addRoute` method instead.
     *
     * @param Route ...$routes
     */
    public function add(Route ...$routes): self
    {
        foreach ($routes as $route) {
            $this->routes[] = $route;

            $this->resolveWith($route);
        }

        return $this;
    }

    /**
     * Maps a pattern to a handler.
     *
     * You can must specify HTTP methods that should be matched.
     *
     * @param string   $pattern Matched route pattern
     * @param string[] $methods Matched HTTP methods
     * @param mixed    $handler Handler that returns the response when matched
     */
    public function addRoute(string $pattern, array $methods, $handler = null): Route
    {
        $this->routes[] = $route = new Route($pattern, $methods, $handler);

        $this->resolveWith($route);

        return $route;
    }

    /**
     * Mounts controllers under the given route prefix.
     *
     * @param string                   $name        The route group prefixed name
     * @param callable|RouteCollection $controllers A RouteCollection instance or a callable for defining routes
     *
     * @throws \LogicException
     */
    public function group(string $name, $controllers = null): self
    {
        if (null === $controllers) {
            $controllers = new static();
            $controllers->stack = $this->stack ?? [];
        }

        if (\is_callable($controllers)) {
            $deprecated = 'Since %s v1.1, usage of %s() method\'s second parameter for callable is deprecated. Will be dropped in v2.0';
            @\trigger_error(\sprintf($deprecated, 'divineniiquaye/flight-routing', __METHOD__), \E_USER_DEPRECATED);

            $controllers($collection = new static());
            $controllers = clone $collection;
        } elseif (!$controllers instanceof self) {
            throw new \LogicException('The "group" method takes either a "RouteCollection" instance or callable.');
        }

        $this->routes[] = $controllers;

        $controllers->namePrefix = $name;
        $controllers->parent = $this;

        return $controllers;
    }

    /**
     * Unmounts a group collection to continue routes stalk.
     */
    public function end(): self
    {
        // Remove last element from stack.
        foreach ($this->stack as $stack) {
            \array_pop($stack);
        }

        return $this->parent ?? $this;
    }

    /**
     * Maps a HEAD request to a handler.
     *
     * @param string $pattern Matched route pattern
     * @param mixed  $handler Handler that returns the response when matched
     */
    public function head(string $pattern, $handler = null): Route
    {
        return $this->addRoute($pattern, [Router::METHOD_HEAD], $handler);
    }

    /**
     * Maps a GET and HEAD request to a handler.
     *
     * @param string $pattern Matched route pattern
     * @param mixed  $handler Handler that returns the response when matched
     */
    public function get(string $pattern, $handler = null): Route
    {
        return $this->addRoute($pattern, [Router::METHOD_GET, Router::METHOD_HEAD], $handler);
    }

    /**
     * Maps a POST request to a handler.
     *
     * @param string $pattern Matched route pattern
     * @param mixed  $handler Handler that returns the response when matched
     */
    public function post(string $pattern, $handler = null): Route
    {
        return $this->addRoute($pattern, [Router::METHOD_POST], $handler);
    }

    /**
     * Maps a PUT request to a handler.
     *
     * @param string $pattern Matched route pattern
     * @param mixed  $handler Handler that returns the response when matched
     */
    public function put(string $pattern, $handler = null): Route
    {
        return $this->addRoute($pattern, [Router::METHOD_PUT], $handler);
    }

    /**
     * Maps a PATCH request to a handler.
     *
     * @param string $pattern Matched route pattern
     * @param mixed  $handler Handler that returns the response when matched
     */
    public function patch(string $pattern, $handler = null): Route
    {
        return $this->addRoute($pattern, [Router::METHOD_PATCH], $handler);
    }

    /**
     * Maps a DELETE request to a handler.
     *
     * @param string $pattern Matched route pattern
     * @param mixed  $handler Handler that returns the response when matched
     */
    public function delete(string $pattern, $handler = null): Route
    {
        return $this->addRoute($pattern, [Router::METHOD_DELETE], $handler);
    }

    /**
     * Maps a OPTIONS request to a handler.
     *
     * @param string $pattern Matched route pattern
     * @param mixed  $handler Handler that returns the response when matched
     */
    public function options(string $pattern, $handler = null): Route
    {
        return $this->addRoute($pattern, [Router::METHOD_OPTIONS], $handler);
    }

    /**
     * Maps any request to a handler.
     *
     * @param string $pattern Matched route pattern
     * @param mixed  $handler Handler that returns the response when matched
     */
    public function any(string $pattern, $handler = null): Route
    {
        return $this->addRoute($pattern, Router::HTTP_METHODS_STANDARD, $handler);
    }

    /**
     * Maps any request to a resource handler and prefix class method by request method.
     * If you request on "/account" path with a GET method, prefixed by the name
     * parameter eg: 'user', class method will match `getUser`.
     *
     * @param string              $name     The prefixed name attached to request method
     * @param string              $pattern  matched path where request should be sent to
     * @param class-string|object $resource Handler that returns the response

     */
    public function resource(string $name, string $pattern, $resource): Route
    {
        return $this->any(\sprintf('api://%s/%s', $name, $pattern), $resource);
    }

    /**
     * Find a route by name.
     *
     * @param string $name The route name
     *
     * @return Route|null A Route instance or null when not found
     */
    public function find(string $name): ?Route
    {
        /** @var Route|RouteCollection $route */
        foreach ($this->iterable ?? $this->routes as $route) {
            if ($route instanceof Route && $name === $route->get('name')) {
                return $route;
            }
        }

        return null;
    }

    /**
     * Bind route with collection.
     */
    private function resolveWith(Route $route): void
    {
        foreach ($this->stack ?? [] as $routeMethod => $arguments) {
            $stack = \end($arguments);

            if (false !== $stack) {
                \call_user_func_array([$route, $routeMethod], 'prefix' === $routeMethod ? [\implode('', $stack)] : $stack);
            }
        }

        if (null !== $this->parent) {
            $route->end($this);
        }
    }

    /**
     * @return Route[]
     */
    private function doMerge(string $prefix, self $routes): array
    {
        $defaultUnnamedIndex = 0;

        /** @var Route|RouteCollection $route */
        foreach ($this->routes as $route) {
            if ($route instanceof self) {
                $route->doMerge($prefix . $route->namePrefix, $routes);
                        doMerge($prefix . $route->namePrefix, $routes);

                continue;
            }

            if (null === $name = $route->get('name')) {
                $name = $base = $route->generateRouteName('');

                while ($routes->find($name)) {
                    $name = $base . '_' . ++$defaultUnnamedIndex;
                }
            }

            $routes->routes[] = $route->bind($prefix . $name);
        }
        $this->routes = [];

        return $routes->routes;
    }
}

divineniiquaye / flight-routing

Pull Request — master (#14)

RouteCollection::head() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
