Conveyor\SocketHandlers\Traits\HasPipeline

Complexity

Total Complexity

12

Size/Duplication

Total Lines	126
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	middleware()	0	7	2
A	add()	0	6	1
A	getAction()	0	3	1
A	getPipeline()	0	13	3
A	validateData()	0	8	3
A	__invoke()	0	15	1
A	getParsedData()	0	3	1

<?php

namespace Conveyor\SocketHandlers\Traits;

use Exception;
use InvalidArgumentException;
use League\Pipeline\Pipeline;
use League\Pipeline\PipelineBuilder;
use Conveyor\Exceptions\InvalidActionException;
use Conveyor\Actions\Interfaces\ActionInterface;
use Conveyor\SocketHandlers\Abstractions\SocketHandler;

trait HasPipeline
{
    /** @var array */
    protected $pipelineMap = [];

    /** @var array */
    protected $handlerMap = [];

    /** @var array */
    protected $parsedData;

    /**
     * @param string   $data   Data to be processed.
     * @param int|null $fd     File descriptor (connection).
     * @param mixed    $server Server object, e.g. Swoole\WebSocket\Frame.
     *
     * @throws Exception
     */
    public function __invoke(string $data, $fd = null, $server = null)
    {
        /** @var ActionInterface */
        $action = $this->parseData($data);

It seems like parseData() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        /** @var Pipeline */
        $pipeline = $this->getPipeline($action->getName());

        /** @throws Exception */
        $pipeline->process($this);

        $this->maybeSetFd($fd);

It seems like maybeSetFd() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->maybeSetServer($server);

It seems like maybeSetServer() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $action->execute($this->parsedData);
    }

    /**
     * @return array
     */
    public function getParsedData() : array
    {
        return $this->parsedData;
    }

    /**
     * Prepare pipeline based on the current prepared handlers.
     *
     * @param string $action
     *
     * @return Pipeline
     */
    public function getPipeline(string $action) : Pipeline
    {
        $pipelineBuilder = new PipelineBuilder;

        if (!isset($this->pipelineMap[$action])) {
            return $pipelineBuilder->build();
        }

        foreach ($this->pipelineMap[$action] as $actionName => $middleware) {
            $pipelineBuilder->add($middleware);
        }

        return $pipelineBuilder->build();
    }

    /**
     * Add an action to be handled. It returns a pipeline for
     * eventual middlewares to be added for each.
     *
     * @param ActionInterface $actionHandler
     *
     * @return SocketHandler
     */
    public function add(ActionInterface $actionHandler) : SocketHandler
    {
        $actionName = $actionHandler->getName();
        $this->handlerMap[$actionName] = $actionHandler;
        
        return $this;

The expression return $this returns the type Conveyor\SocketHandlers\Traits\HasPipeline which is incompatible with the type-hinted return Conveyor\SocketHandlers\Abstractions\SocketHandler.

    }

    /**
     * Add a step for the current's action middleware.
     *
     * @param string $action
     * @param Callable $middleware
     *
     * @return void
     */
    public function middleware(string $action, callable $middleware) : void
    {
        if (!isset($this->pipelineMap[$action])) {
            $this->pipelineMap[$action] = [];
        }

        $this->pipelineMap[$action][] = $middleware;
    }

    /**
     * @param array $data
     *
     * @return void
     *
     * @throws InvalidArgumentException|InvalidActionException
     */
    final public function validateData(array $data) : void
    {
        if (!isset($data['action'])) {
            throw new InvalidArgumentException('Missing action key in data!');
        }

        if (!isset($this->handlerMap[$data['action']])) {
            throw new InvalidActionException('Invalid Action! This action (' . $data['action'] . ') is not set.');
        }
    }

    /**
     * Get an Action by name
     *
     * @param string $name
     *
     * @return ActionInterface|null
     */
    public function getAction(string $name)
    {
        return $this->handlerMap[$name];
    }
}