Epfremme\ProcessQueue\Process\ProcessQueue

Complexity

Total Complexity

17

Size/Duplication

Total Lines	146
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	1

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	15	4
A	add()	0	6	1
A	getPending()	0	6	1
A	getRunning()	0	6	1
A	getCompleted()	0	6	1
A	clearCompleted()	0	6	1
A	resolve()	0	11	3
A	__invoke()	0	16	4
A	count()	0	4	1

<?php
/**
 * File ProcessQueue.php
 *
 * @author Edward Pfremmer <epfremme@nerdery.com>
 */
namespace Epfremme\ProcessQueue\Process;

use Epfremme\Collection\Collection;
use Epfremme\ProcessQueue\System\ProcessorCounter;
use GuzzleHttp\Promise\PromiseInterface;
use Symfony\Component\Process\Process;

/**
 * Class ProcessQueue
 *
 * @package Epfremme\ProcessQueue\Process
 */
class ProcessQueue implements \Countable
{
    const SLEEP_MICRO_SECONDS = 1000;
    const PROMISE_KEY = 'promise';

    /**
     * @var int
     */
    private $limit;

    /**
     * @var Collection
     */
    private $queue;

    /**
     * ProcessQueue constructor
     *
     * @param int $limit
     */
    public function __construct($limit = null)
    {
        $limit = !is_null($limit) ? $limit : (new ProcessorCounter())->getCpuCount();

        if (!is_numeric($limit)) {
            throw new \InvalidArgumentException(sprintf('Limit must be numeric, type "%s" given', gettype($limit)));
        }

        if ($limit < 1) {
            throw new \InvalidArgumentException('Process limit must be greater than 0');
        }

        $this->limit = (int) $limit;
        $this->queue = new Collection();
    }

    /**
     * Add new process to the queue
     *
     * @param Process $process
     * @return $this
     */
    public function add(Process $process)
    {
        $this->queue->add($process);

        return $this;
    }

    /**
     * Return pending processes
     *
     * @return Collection
     */
    public function getPending()
    {
        return $this->queue->filter(function(Process $process) {
            return !$process->isStarted();
        });
    }

    /**
     * Return running processes
     *
     * @return Collection
     */
    public function getRunning()
    {
        return $this->queue->filter(function(Process $process) {
            return $process->isRunning();
        });
    }

    /**
     * Return completed processes
     *
     * @return Collection
     */
    public function getCompleted()
    {
        return $this->queue->filter(function(Process $process) {
            return $process->isTerminated();
        });
    }

    /**
     * Clear and resolve completed processes from the queue
     *
     * @return void
     */
    private function clearCompleted()
    {
        $this->getCompleted()->each(function(Process $process) {
            $this->resolve($process);
        });
    }

    /**
     * Halt execution and wait for target process to finish
     *
     * @param Process $process
     */
    public function resolve(Process $process)
    {
        $options = $process->getOptions();
        $promise = array_key_exists(self::PROMISE_KEY, $options) ? $options[self::PROMISE_KEY] : null;

        if ($promise instanceof PromiseInterface) {
            $promise->wait(false);
        }

        $this->queue->remove($process);
    }

    /**
     * Run the queue
     *
     * @return \Generator
     */
    public function __invoke()
    {
        while (!$this->queue->isEmpty()) {
            usleep(self::SLEEP_MICRO_SECONDS);

            $pending = $this->getPending();

            if ($pending->count() && $this->getRunning()->count() < $this->limit) {
                yield $pending->shift();
            } else {
                yield new NullProcess();
            }

            $this->clearCompleted();
        }
    }

    /**
     * Return queue count
     *
     * @return int
     */
    public function count()
    {
        return $this->queue->count();
    }
}