Limoncello\Testing\ApplicationWrapperTrait

Complexity

Total Complexity

11

Size/Duplication

Total Lines	153
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	addOnHandleRequest()	0	4	1
A	addOnHandleResponse()	0	4	1
A	addOnContainerCreated()	0	4	1
A	addOnContainerLastConfigurator()	0	4	1
A	addEventHandler()	0	11	1
A	dispatchEvent()	0	7	2
A	createContainerInstance()	0	9	1
A	configureContainer()	0	10	1
A	handleRequest()	0	11	1
A	getContainer()	0	4	1

<?php namespace Limoncello\Testing;

/**
 * Copyright 2015-2017 info@neomerx.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use Closure;
use Limoncello\Contracts\Container\ContainerInterface as LimoncelloContainerInterface;
use Psr\Container\ContainerInterface as PsrContainerInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;

/**
 * @package Limoncello\Testing
 */
trait ApplicationWrapperTrait
{
    /** Called right before request will be passed through all middleware, controller and back */
    protected static $EVENT_ON_HANDLE_REQUEST = 0;

    /** Called when response has passed back all middleware right before sending to client */
    protected static $EVENT_ON_HANDLE_RESPONSE = 1;

    /** Called on empty container created (before it's set up) */
    protected static $EVENT_ON_CONTAINER_CREATED = 2;

    /** Called right before controller is called */
    protected static $EVENT_ON_CONTAINER_LAST_CONFIGURATOR = 3;

    /**
     * @var array
     */
    private $events = [];

    /**
     * @var PsrContainerInterface
     */
    private $container;

    /**
     * @param Closure $handler
     *
     * @return void
     */
    public function addOnHandleRequest(Closure $handler)
    {
        $this->addEventHandler(static::$EVENT_ON_HANDLE_REQUEST, $handler);
    }

    /**
     * @param Closure $handler
     *
     * @return void
     */
    public function addOnHandleResponse(Closure $handler)
    {
        $this->addEventHandler(static::$EVENT_ON_HANDLE_RESPONSE, $handler);
    }

    /**
     * @param Closure $handler
     *
     * @return void
     */
    public function addOnContainerCreated(Closure $handler)
    {
        $this->addEventHandler(static::$EVENT_ON_CONTAINER_CREATED, $handler);
    }

    /**
     * @param Closure $handler
     *
     * @return void
     */
    public function addOnContainerLastConfigurator(Closure $handler)
    {
        $this->addEventHandler(static::$EVENT_ON_CONTAINER_LAST_CONFIGURATOR, $handler);
    }

    /**
     * @param int     $eventId
     * @param Closure $handler
     *
     * @return void
     */
    protected function addEventHandler(int $eventId, Closure $handler)
    {
        assert(in_array($eventId, [
                static::$EVENT_ON_HANDLE_REQUEST,
                static::$EVENT_ON_HANDLE_RESPONSE,
                static::$EVENT_ON_CONTAINER_CREATED,
                static::$EVENT_ON_CONTAINER_LAST_CONFIGURATOR,
            ]) === true);

        $this->events[$eventId][] = $handler;
    }

    /**
     * @param int   $eventId
     * @param array $arguments
     *
     * @return void
     */
    protected function dispatchEvent($eventId, array $arguments)
    {
        $appAndArgs = array_merge([$this], $arguments);
        foreach ($this->events[$eventId] ?? [] as $handler) {
            call_user_func_array($handler, $appAndArgs);
        }
    }

    /**
     * @return LimoncelloContainerInterface
     */
    protected function createContainerInstance(): LimoncelloContainerInterface
    {
        /** @noinspection PhpUndefinedMethodInspection */
        $this->container = parent::createContainerInstance();

        $this->dispatchEvent(static::$EVENT_ON_CONTAINER_CREATED, [$this->container]);

        return $this->container;
    }

    /**
     * @param LimoncelloContainerInterface $container
     * @param array|null                   $globalConfigurators
     * @param array|null                   $routeConfigurators
     *
     * @return void
     */
    protected function configureContainer(
        LimoncelloContainerInterface $container,
        array $globalConfigurators = null,
        array $routeConfigurators = null
    ) {
        /** @noinspection PhpUndefinedMethodInspection */
        parent::configureContainer($container, $globalConfigurators, $routeConfigurators);

        $this->dispatchEvent(static::$EVENT_ON_CONTAINER_LAST_CONFIGURATOR, [$container]);
    }

    /**
     * @param Closure               $handler
     * @param RequestInterface|null $request
     *
     * @return ResponseInterface
     */
    protected function handleRequest(Closure $handler, RequestInterface $request = null): ResponseInterface
    {
        $this->dispatchEvent(static::$EVENT_ON_HANDLE_REQUEST, [$request]);

        /** @noinspection PhpUndefinedMethodInspection */
        $response = parent::handleRequest($handler, $request);

        $this->dispatchEvent(static::$EVENT_ON_HANDLE_RESPONSE, [$response]);

        return $response;
    }

    /**
     * @return PsrContainerInterface
     */
    protected function getContainer(): PsrContainerInterface
    {
        return $this->container;
    }
}