RouteBuilder::addMethod() - Code Metrics - Inspection of "Fix: more precise tests" - Micro-PHP/plugin-http-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#10)

by Oleksii

created 2023-08-05 07:54 UTC

RouteBuilder::addMethod() A

↳ Parent: RouteBuilder

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes

Metric	Value
eloc	3
dl	0
loc	7
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	1
crap	2

<?php

declare(strict_types=1);

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

namespace Micro\Plugin\Http\Business\Route;

use Micro\Plugin\Http\Exception\RouteInvalidConfigurationException;
use Symfony\Component\HttpFoundation\Request;

/**
 * @author Stanislau Komar <[email protected]>
 */
class RouteBuilder implements RouteBuilderInterface
{
    private string|null $name;

    /**
     * @var array<class-string, string|null>|class-string|\Closure|null

     */
    private mixed $action;

    private string|null $uri;

    /**
     * @var array|string[]
     */
    private array $methods;

    /**
     * @param string[] $methodsByDefault
     */
    public function __construct(
        private readonly array $methodsByDefault = [
            Request::METHOD_GET,
            Request::METHOD_POST,
            Request::METHOD_PUT,
            Request::METHOD_PATCH,
            Request::METHOD_DELETE,
        ],
    ) {
        $this->name = null;
        $this->action = null;
        $this->uri = null;
        $this->methods = $this->methodsByDefault;
    }

    /**
     * {@inheritDoc}
     */
    public function setName(string $name): self
    {
        $this->name = $name;

        return $this;
    }

    /**
     * {@inheritDoc}
     */
    public function addMethod(string $method): self
    {
        if (!\in_array($method, $this->methods)) {
            $this->methods[] = mb_strtoupper($method);
        }

        return $this;
    }

    /**
     * {@inheritDoc}
     */
    public function setMethods(array $methods): self
    {
        $this->methods = [];

        foreach ($methods as $method) {
            $this->addMethod($method);
        }

        return $this;
    }

    /**
     * {@inheritDoc}
     */
    public function setController(string|array|\Closure $action): self
    {
        $this->action = $action;

        return $this;
    }

    /**
     * {@inheritDoc}
     */
    public function setUri(string $uri): self
    {
        $this->uri = $uri;

        return $this;
    }

    /**
     * TODO: Move pattern builder to separate class.
     *
     * {@inheritDoc}
     */
    public function build(): RouteInterface
    {
        $exceptions = [];

        if (!$this->uri) {
            $exceptions[] = 'Uri can not be empty.';
        }

        if ($this->name && !preg_match('/^([a-zA-Z_][a-zA-Z0-9_]*)$/', $this->name)) {
            $exceptions[] = 'The route name must match "[a-zA-Z][a-zA-Z0-9_]*".';
        }

        if (!$this->action) {
            $exceptions[] = 'The route action can not be empty.';
        }

        if (
            $this->action &&
            (
                !\is_callable($this->action) &&
                (\is_string($this->action) && (class_exists($this->action) && !$this->name))
            )
        ) {
            $exceptions[] = 'The route action should be callable. Examples: `[object, "method|<route_name>"], [Classname, "metnod|<routeName>"], Classname::method, Classname, function() {}` Current value: '.$this->action;
        }

        if (!\count($this->methods)) {
            $exceptions[] = 'The route should support at least one HTTP method.';
        }

        if (\count($exceptions)) {
            $exception = new RouteInvalidConfigurationException($this->name ?: $this->uri ?: 'Undefined', $exceptions);

            $this->clear();

            throw $exception;
        }

        $pattern = null;
        $parameters = null;
        /** @psalm-suppress PossiblyNullArgument */
        $isDynamic = preg_match_all('/\{\s*([^}\s]*)\s*}/', $this->uri, $matches);
        if ($isDynamic) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $parameters = $matches[1];
            /** @psalm-suppress PossiblyNullArgument */
            $pattern = '/'.addcslashes($this->uri, '/.').'$/';
            $pattern = '/'.addcslashes(/** @scrutinizer ignore-type */ $this->uri, '/.').'$/';

            foreach ($matches[0] as $replaced) {
                $pattern = str_replace($replaced, '([a-zA-Z_][a-zA-Z0-9_]*)', $pattern);
            }
        }
        /**
         * @psalm-suppress PossiblyNullArgument
         * @psalm-suppress MixedArgumentTypeCoercion
         */
        $route = new Route(
            $this->uri,
            $this->action,
            $this->methods,
            $this->name,
            $pattern,
            $parameters
        );

        $this->clear();

        return $route;
    }

    protected function clear(): void
    {
        $this->uri = null;
        $this->action = null;
        $this->methods = $this->methodsByDefault;
        $this->name = null;
    }
}


Micro-PHP / plugin-http-core

Pull Request — master (#10)

RouteBuilder::addMethod() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like