Zicht\Tool\Container\Task

Complexity

Total Complexity

30

Size/Duplication

Total Lines	207
Duplicated Lines	9.66 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes	5
Bugs	0	Features	2

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	2
A	getName()	0	4	1
A	getHelp()	0	4	1
B	compile()	0	31	3
F	compileBody()	20	77	14
B	getArguments()	0	18	6
A	getOptions()	0	10	3

<?php
/**
 * @author Gerard van Helden <gerard@zicht.nl>
 * @copyright Zicht Online <http://zicht.nl>
 */

namespace Zicht\Tool\Container;

use Zicht\Tool\Script\Buffer;
use Zicht\Tool\Util;

/**
 * Compilable node that represents an executable task
 */
class Task extends Declaration
{
    /**
     * Construct the task with the provided array as task definition
     *
     * @param array $path
     * @param array $node
     */
    public function __construct($path, $node)
    {
        parent::__construct($path);

        if (strpos(end($this->path), '.') !== false) {
            $end = array_pop($this->path);
            $this->path = array_merge($this->path, explode('.', $end));
        }
        $this->taskDef = $node;

The property taskDef does not exist. Did you maybe forget to declare it?

    }


    /**
     * Returns the task name.
     *
     * @return string
     */
    public function getName()
    {
        return join('.', array_slice($this->path, 1));
    }


    /**
     * Returns the task help
     *
     * @return mixed
     */
    public function getHelp()
    {
        return $this->taskDef['help'];
    }


    /**
     * Compiles the task initialization code into the buffer.
     *
     * @param \Zicht\Tool\Script\Buffer $buffer
     * @return void
     */
    public function compile(Buffer $buffer)
    {
        parent::compile($buffer);
        if (substr($this->getName(), 0, 1) !== '_') {
            $buffer
                ->writeln('try {')
                ->indent(1)
                    ->writeln('$z->addCommand(')
                    ->indent(1)
                        ->write('new \Zicht\Tool\Command\TaskCommand(')
                        ->asPhp($this->getName())
                        ->raw(', ')
                        ->asPhp($this->getArguments(true))
                        ->raw(', ')
                        ->asPhp($this->getOptions())
                        ->raw(', ')
                        ->asPhp($this->taskDef['flags'])
                        ->raw(', ')
                        ->asPhp($this->getHelp() ? $this->getHelp() : "(no help available for this task)")
                        ->raw(')')->eol()
                        ->indent(-1)
                    ->writeln(');')
                    ->indent(-1)
                ->writeln('} catch (\Exception $e) {')
                    ->indent(1)
                    ->writeln('throw new \Zicht\Tool\Container\ConfigurationException("Error while initializing task \'' . $this->getName() . '\'", 0, $e);')
                    ->indent(-1)
                ->writeln('}')
            ;
        }
    }


    /**
     * Compile the node
     *
     * @param Buffer $buffer
     * @return void
     */
    public function compileBody(Buffer $buffer)
    {
        $buffer->writeln('$ret = null;');

        foreach ($this->taskDef['flags'] as $flag => $value) {
            $buffer
                ->write('if (null === $z->resolve(')->asPhp($flag)->raw(', false)) {')->eol()
                ->indent(1)
                ->write('$z->set(')->asPhp($flag)->raw(', ')->asPhp($value)->raw(');')->eol()
                ->indent(-1)
                ->writeln('}')
            ;
        }
        foreach ($this->taskDef['args'] as $node) {
            $node->compile($buffer);
        }
        foreach ($this->taskDef['opts'] as $node) {
            $node->compile($buffer);
        }
        foreach ($this->taskDef['set'] as $node) {
            $node->compile($buffer);
        }
        $buffer->writeln('$skip = false;');
        foreach (array('pre', 'do', 'post') as $scope) {
            if ($scope === 'do') {
                if (!empty($this->taskDef['unless'])) {

This code seems to be duplicated across your project.

                    $buffer->write('if (!$z->resolve(\'FORCE\') &&');
                    $this->taskDef['unless']->compile($buffer);
                    $buffer->raw(') {')->eol()->indent(1);
                    $echoStr = sprintf('echo "%s skipped", because \'unless\' evaluated to true.', join('.', $this->path));
                    $buffer->writeln(sprintf('$z->cmd(%s);', Util::toPhp($echoStr)));
                    $buffer->writeln('$skip = true;');
                    $buffer->indent(-1);
                    $buffer->writeln('}');
                }
                if (!empty($this->taskDef['if'])) {

This code seems to be duplicated across your project.

                    $buffer->write('if (!$z->resolve(\'FORCE\') && !(');
                    $this->taskDef['if']->compile($buffer);
                    $buffer->raw(') ) {')->eol()->indent(1);
                    $echoStr = sprintf('echo "%s skipped", because \'if\' evaluated to false.', join('.', $this->path));
                    $buffer->writeln(sprintf('$z->cmd(%s);', Util::toPhp($echoStr)));
                    $buffer->writeln('$skip = true;');
                    $buffer->indent(-1);
                    $buffer->writeln('}');
                }

                if (!empty($this->taskDef['assert'])) {
                    $buffer->write('if (!(');
                    $this->taskDef['assert']->compile($buffer);
                    $buffer->raw(')) {')->eol()->indent(1);
                    $buffer->writeln('throw new \RuntimeException("Assertion failed");');
                    $buffer->indent(-1)->writeln('}');
                }

                $buffer->writeln('if (!$skip) {');
                $buffer->indent(1);
            }
            foreach ($this->taskDef[$scope] as $i => $cmd) {
                $buffer->write('Debug::enterScope(')->asPhp($scope . '[' . $i . ']')->raw(');')->eol();
                if ($cmd) {
                    $cmd->compile($buffer);
                }
                $buffer->write('Debug::exitScope(')->asPhp($scope . '[' . $i . ']')->raw(');')->eol();
            }

            if ($scope === 'post') {
                $buffer->indent(-1);
                $buffer->writeln('}');
            }
        }
        if (!empty($this->taskDef['yield'])) {
            $buffer->writeln('$ret = ');
            $this->taskDef['yield']->compile($buffer);
            $buffer->write(';');
        }
        $buffer->writeln('return $ret;');
    }


    /**
     * Returns all variables that can be injected into the task.
     *
     * @param bool $onlyPublic
     * @return array
     */
    public function getArguments($onlyPublic = true)
    {
        $ret = array();
        if (isset($this->taskDef['args'])) {
            foreach ($this->taskDef['args'] as $name => $expr) {
                if ($onlyPublic && $name{0} === '_') {
                    // Variables prefixed with an underscore are considered non public
                    continue;
                }
                if ($expr->conditional) {
                    // if the part after the question mark is empty, the variable is assumed to be required
                    // for execution of the task
                    $ret[$name] = ($expr->nodes[0] === null);
                }
            }
        }
        return $ret;
    }

    /**
     * Returns all variables that can be injected into the task.
     *
     * @return array
     */
    public function getOptions()
    {
        $ret = array();
        if (!empty($this->taskDef['opts'])) {
            foreach ($this->taskDef['opts'] as $opt) {
                $ret[] = $opt->name;
            }
        }
        return $ret;
    }
}