Scientist\Machine

Complexity

Total Complexity

11

Size/Duplication

Total Lines	151
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	4
Bugs	0	Features	1

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	executeQuietly()	0	8	1
A	executeLoudly()	0	8	1
A	setStartValues()	0	5	1
A	executeCallback()	0	8	2
A	executeMutedCallback()	0	9	2
A	setEndValues()	0	5	1
A	addOutputBufferToResult()	0	5	1
A	execute()	0	7	1

<?php

namespace Scientist;

use Exception;

/**
 * Class Executor
 *
 * @package \Scientist
 */
class Machine
{
    /**
     * The callback to execute.
     *
     * @var callable
     */
    protected $callback;

    /**
     * Parameters to provide to the callback.
     *
     * @var array
     */
    protected $params = [];

    /**
     * Should exceptions be muted.
     *
     * @var boolean
     */
    protected $muted = false;

    /**
     * The result instance.
     *
     * @var \Scientist\Result
     */
    protected $result;

    /**
     * Inject machine dependencies.
     *
     * @param callable $callback
     * @param array    $params
     * @param boolean  $muted
     */
    public function __construct(callable $callback, array $params = [], $muted = false)
    {
        $this->callback = $callback;
        $this->params   = $params;
        $this->muted    = $muted;
        $this->result   = new Result;

    }

    /**
     * Execute the callback and retrieve a result. Any output from
     * echo commands will be intercepted and stored in the result.
     *
     * @return \Scientist\Result
     */
    public function executeQuietly()
    {
        ob_start();
        $this->execute();
        ob_end_clean();

        return $this->result;
    }

    /**
     * Execute the callback and retrieve a result. Any output from
     * echo commands will be output as normal.
     *
     * @return Result
     */
    public function executeLoudly()
    {
        ob_start();
        $this->execute();
        ob_end_flush();

        return $this->result;
    }

    /**
     * Set values before callback is executed.
     *
     * @return void
     */
    protected function setStartValues()
    {
        $this->result->setStartTime(microtime(true));
        $this->result->setStartMemory(memory_get_usage());
    }

    /**
     * Execute the callback with parameters.
     *
     * @return void
     */
    protected function executeCallback()
    {
        if ($this->muted) {
            return $this->executeMutedCallback();
        }

        $this->result->setValue(call_user_func_array($this->callback, $this->params));
    }

    /**
     * Execute the callback, but swallow exceptions.
     *
     * @return void
     */
    protected function executeMutedCallback()
    {
        try {
            $this->result->setValue(call_user_func_array($this->callback, $this->params));
        } catch (Exception $exception) {
            $this->result->setException($exception);
            $this->result->setValue(null);
        }
    }

    /**
     * Set values after the callback has executed.
     *
     * @return void
     */
    protected function setEndValues()
    {
        $this->result->setEndTime(microtime(true));
        $this->result->setEndMemory(memory_get_usage());
    }

    /**
     * Flushes & cleans the buffer and adds this to the result.
     *
     * @return void
     */
    protected function addOutputBufferToResult()
    {
        $echoedOutput = ob_get_contents();
        $this->result->setEchoValue($echoedOutput);
    }

    /**
     * Execute the callback and build the result
     *
     * @return void
     */
    protected function execute()
    {
        $this->setStartValues();
        $this->executeCallback();
        $this->setEndValues();
        $this->addOutputBufferToResult();
    }
}