Rade\AppBuilder

Complexity

Total Complexity

31

Size/Duplication

Total Lines	200
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	4
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	pipe()	0	8	3
A	group()	0	5	1
A	generateUri()	0	3	1
A	options()	0	3	1
A	match()	0	5	1
A	patch()	0	3	1
A	put()	0	3	1
A	delete()	0	3	1
A	post()	0	3	1
A	pipes()	0	3	1
A	compile()	0	10	2
F	build()	0	65	16

<?php

declare(strict_types=1);

/*
 * This file is part of DivineNii opensource projects.
 *
 * PHP version 7.4 and above required
 *
 * @author    Divine Niiquaye Ibok <divineibok@gmail.com>
 * @copyright 2019 DivineNii (https://divinenii.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 Rade;

use Fig\Http\Message\RequestMethodInterface;
use Flight\Routing\Interfaces\RouteMatcherInterface;
use Flight\Routing\Interfaces\UrlGeneratorInterface;
use Flight\Routing\Route;
use Flight\Routing\RouteCollection;
use Flight\Routing\Router;
use Rade\DI\Exceptions\ServiceCreationException;
use Symfony\Component\Config\ConfigCache;

/**
 * Create a cacheable application.
 *
 * @author Divine Niiquaye Ibok <divineibok@gmail.com>
 */
class AppBuilder extends DI\ContainerBuilder implements RouterInterface, KernelInterface
{
    use Traits\HelperTrait;

    public function __construct(bool $debug = true)
    {
        parent::__construct(Application::class);

        $this->parameters['debug'] = $debug;
        $this->set('http.router', new DI\Definition(Router::class))->autowire([Router::class, RouteMatcherInterface::class, UrlGeneratorInterface::class]);
    }

    /**
     * {@inheritdoc}
     *
     * @param DI\Definitions\Reference|DI\Definitions\Statement|DI\Definition ...$middlewares
     */
    public function pipe(object ...$middlewares): void
    {
        foreach ($middlewares as $middleware) {
            if ($middleware instanceof DI\Definitions\Reference) {
                continue;
            }

            $this->set('http.middleware.' . \spl_object_id($middleware), $middleware)->public(false)->tag('router.middleware');
        }
    }

    /**
     * {@inheritdoc}
     *
     * @param DI\Definitions\Reference|DI\Definitions\Statement|DI\Definition ...$middlewares
     */
    public function pipes(string $named, object ...$middlewares): void
    {
        $this->definition('http.router')->bind('pipes', \func_get_args());
    }

    /**
     * {@inheritdoc}
     */
    public function generateUri(string $routeName, array $parameters = []): DI\Definitions\Statement
    {
        return new DI\Definitions\Statement([new DI\Definitions\Reference('http.router'), 'generateUri'], \func_get_args());

The expression return new Rade\DI\Definitions\Statement(array(new Rade\DI\Definitions\Reference('http.router'), 'generateUri'), func_get_args()) returns the type Rade\DI\Definitions\Statement which is incompatible with the return type mandated by Rade\RouterInterface::generateUri() of Rade\GeneratedUri.

    }

    /**
     * {@inheritdoc}
     */
    public function match(string $pattern, array $methods = Route::DEFAULT_METHODS, $to = null)
    {
        $routes = $this->parameters['routes'] ??= new RouteCollection();

        return $routes->add(new Route($pattern, $methods, $to), false)->getRoute();
    }

    /**
     * {@inheritdoc}
     */
    public function post(string $pattern, $to = null)
    {
        return $this->match($pattern, [RequestMethodInterface::METHOD_POST], $to);
    }

    /**
     * {@inheritdoc}
     */
    public function put(string $pattern, $to = null)
    {
        return $this->match($pattern, [RequestMethodInterface::METHOD_PUT], $to);
    }

    /**
     * {@inheritdoc}
     */
    public function delete(string $pattern, $to = null)
    {
        return $this->match($pattern, [RequestMethodInterface::METHOD_DELETE], $to);
    }

    /**
     * {@inheritdoc}
     */
    public function options(string $pattern, $to = null)
    {
        return $this->match($pattern, [RequestMethodInterface::METHOD_OPTIONS], $to);
    }

    /**
     * {@inheritdoc}
     */
    public function patch(string $pattern, $to = null)
    {
        return $this->match($pattern, [RequestMethodInterface::METHOD_PATCH], $to);
    }

    /**
     * {@inheritdoc}
     */
    public function group(string $prefix)
    {
        $routes = $this->parameters['routes'] ??= new RouteCollection();

        return $routes->group($prefix);
    }

    /**
     * Compiled container and build the application.
     *
     * supported $options config (defaults):
     * - cacheDir => composer's vendor dir, The directory where compiled application class will live in.
     * - shortArraySyntax => true, Controls whether [] or array() syntax should be used for an array.
     * - maxLineLength => 200, Max line of generated code in compiled container class.
     * - maxDefinitions => 500, Max definitions reach before splitting into traits.
     *
     * @param callable            $application write services in here
     * @param array<string,mixed> $options
     *
     * @throws \ReflectionException
     */
    public static function build(callable $application, array $options = []): Application
    {
        $defFile = 'load_' . ($containerClass = 'App_' . (($debug = $options['debug'] ?? false) ? 'Debug' : '') . 'Container') . '.php';
        $cacheDir = $options['cacheDir'] ?? \dirname((new \ReflectionClass(\Composer\Autoload\ClassLoader::class))->getFileName(), 2);
        $cachePath = $cacheDir . '/' . $containerClass . '_' . \PHP_SAPI . \PHP_OS . \PHP_VERSION_ID . '.php';

        // Silence E_WARNING to ignore "include" failures - don't use "@" to prevent silencing fatal errors
        $errorLevel = \error_reporting(\E_ALL ^ \E_WARNING);

        try {
            if (\is_file($cachePath)) {
                include $cacheDir . '/' . $defFile;
                include $cachePath;
                $container = new $containerClass();

                if (!$debug || ($cache = new ConfigCache($cachePath, $debug))->isFresh()) {
                    \error_reporting($errorLevel);

                    return $container;
                }
            } else {
                \is_dir($cacheDir) ?: \mkdir($cacheDir, 0777, true);
            }
        } catch (\Throwable $e) {

Consider adding a comment why this CATCH block is empty.

        }

        if ($debug && \interface_exists(\Tracy\IBarPanel::class)) {
            Debug\Tracy\ContainerPanel::$compilationTime = \microtime(true);
        }

        try {
            if ($lock = \fopen($cachePath . '.lock', 'w')) {
                \flock($lock, \LOCK_EX | \LOCK_NB, $wouldBlock);

                if (!\flock($lock, $wouldBlock ? \LOCK_SH : \LOCK_EX)) {
                    \fclose($lock);
                    $lock = null;
                } elseif (isset($container) && \is_file($cachePath)) {
                    \flock($lock, \LOCK_UN);
                    \fclose($lock);

                    return new $containerClass();
                }
            }
        } catch (\Throwable $e) {

Consider adding a comment why this CATCH block is empty.

        } finally {
            \error_reporting($errorLevel);
        }

        $application($container = new static($debug));
        $requiredPaths = $container->parameters['project.require_paths'] ?? []; // Autoload require hot paths ...

        $container->addNodeVisitor(new DI\NodeVisitor\MethodsResolver());
        $container->addNodeVisitor(new DI\NodeVisitor\AutowiringResolver());
        $container->addNodeVisitor($splitter = new DI\NodeVisitor\DefinitionsSplitter($options['maxDefinitions'] ?? 500, $defFile));

        if (!isset($cache)) {
            $cache = new ConfigCache($cachePath, $debug); // ... or create a new cache
        }

        $cache->write($container->compile($options + \compact('containerClass')), $container->getResources()); // Generate container class
        require $splitter->buildTraits($cacheDir, $debug, $requiredPaths);
        require $cachePath;

        return new $containerClass();
    }

    /**
     * {@inheritdoc}
     */
    public function compile(array $options = [])
    {
        $this->parameters['project.compiled_container_class'] = $options['containerClass'];
        unset($this->definitions['config.builder.loader_resolver'], $this->parameters['project.require_paths']);

        if (isset($this->parameters['routes'])) {
            throw new ServiceCreationException(\sprintf('The %s extension needs to be registered before adding routes.', DI\Extensions\RoutingExtension::class));
        }

        return parent::compile($options);
    }
}