Task::compile() - Code Metrics - zicht/z - Measure and Improve Code Quality continuously with Scrutinizer

Task::compile() B
last analyzed 2017-06-16 11:38 UTC

↳ Parent: Task

Complexity

Conditions	3
Paths	2

Size

Total Lines	31
Code Lines	27

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	31
ccs	0
cts	28
cp	0
rs	8.8571
cc	3
eloc	27
nc	2
nop	1
crap	12

<?php
/**
 * @author Gerard van Helden <[email protected]>
 * @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;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }


    /**
     * 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'])) {

                    $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'])) {

                    $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;
    }
}


1		<?php
2		/**
3		* @author Gerard van Helden <[email protected]>
4		* @copyright Zicht Online <http://zicht.nl>
5		*/
6
7		namespace Zicht\Tool\Container;
8
9		use Zicht\Tool\Script\Buffer;
10		use Zicht\Tool\Util;
11
12		/**
13		* Compilable node that represents an executable task
14		*/
15		class Task extends Declaration
16		{
17		/**
18		* Construct the task with the provided array as task definition
19		*
20		* @param array $path
21		* @param array $node
22		*/
23		public function __construct($path, $node)
24		{
25		parent::__construct($path);
26
27		if (strpos(end($this->path), '.') !== false) {
28		$end = array_pop($this->path);
29		$this->path = array_merge($this->path, explode('.', $end));
30		}
31		$this->taskDef = $node;
		0 ignored issues – show Bug introduced 2017-01-21 13:11 UTC by Report Bug Copy Issue Report The property `taskDef` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
32		}
33
34
35		/**
36		* Returns the task name.
37		*
38		* @return string
39		*/
40		public function getName()
41		{
42		return join('.', array_slice($this->path, 1));
43		}
44
45
46		/**
47		* Returns the task help
48		*
49		* @return mixed
50		*/
51		public function getHelp()
52		{
53		return $this->taskDef['help'];
54		}
55
56
57		/**
58		* Compiles the task initialization code into the buffer.
59		*
60		* @param \Zicht\Tool\Script\Buffer $buffer
61		* @return void
62		*/
63		public function compile(Buffer $buffer)
64		{
65		parent::compile($buffer);
66		if (substr($this->getName(), 0, 1) !== '_') {
67		$buffer
68		->writeln('try {')
69		->indent(1)
70		->writeln('$z->addCommand(')
71		->indent(1)
72		->write('new \Zicht\Tool\Command\TaskCommand(')
73		->asPhp($this->getName())
74		->raw(', ')
75		->asPhp($this->getArguments(true))
76		->raw(', ')
77		->asPhp($this->getOptions())
78		->raw(', ')
79		->asPhp($this->taskDef['flags'])
80		->raw(', ')
81		->asPhp($this->getHelp() ? $this->getHelp() : "(no help available for this task)")
82		->raw(')')->eol()
83		->indent(-1)
84		->writeln(');')
85		->indent(-1)
86		->writeln('} catch (\Exception $e) {')
87		->indent(1)
88		->writeln('throw new \Zicht\Tool\Container\ConfigurationException("Error while initializing task \'' . $this->getName() . '\'", 0, $e);')
89		->indent(-1)
90		->writeln('}')
91		;
92		}
93		}
94
95
96		/**
97		* Compile the node
98		*
99		* @param Buffer $buffer
100		* @return void
101		*/
102		public function compileBody(Buffer $buffer)
103		{
104		$buffer->writeln('$ret = null;');
105
106		foreach ($this->taskDef['flags'] as $flag => $value) {
107		$buffer
108		->write('if (null === $z->resolve(')->asPhp($flag)->raw(', false)) {')->eol()
109		->indent(1)
110		->write('$z->set(')->asPhp($flag)->raw(', ')->asPhp($value)->raw(');')->eol()
111		->indent(-1)
112		->writeln('}')
113		;
114		}
115		foreach ($this->taskDef['args'] as $node) {
116		$node->compile($buffer);
117		}
118		foreach ($this->taskDef['opts'] as $node) {
119		$node->compile($buffer);
120		}
121		foreach ($this->taskDef['set'] as $node) {
122		$node->compile($buffer);
123		}
124		$buffer->writeln('$skip = false;');
125		foreach (array('pre', 'do', 'post') as $scope) {
126		if ($scope === 'do') {
127	View Code Duplication	if (!empty($this->taskDef['unless'])) {
		0 ignored issues – show Duplication introduced 2017-01-21 13:11 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
128		$buffer->write('if (!$z->resolve(\'FORCE\') &&');
129		$this->taskDef['unless']->compile($buffer);
130		$buffer->raw(') {')->eol()->indent(1);
131		$echoStr = sprintf('echo "%s skipped", because \'unless\' evaluated to true.', join('.', $this->path));
132		$buffer->writeln(sprintf('$z->cmd(%s);', Util::toPhp($echoStr)));
133		$buffer->writeln('$skip = true;');
134		$buffer->indent(-1);
135		$buffer->writeln('}');
136		}
137	View Code Duplication	if (!empty($this->taskDef['if'])) {
		0 ignored issues – show Duplication introduced 2017-01-21 13:11 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
138		$buffer->write('if (!$z->resolve(\'FORCE\') && !(');
139		$this->taskDef['if']->compile($buffer);
140		$buffer->raw(') ) {')->eol()->indent(1);
141		$echoStr = sprintf('echo "%s skipped", because \'if\' evaluated to false.', join('.', $this->path));
142		$buffer->writeln(sprintf('$z->cmd(%s);', Util::toPhp($echoStr)));
143		$buffer->writeln('$skip = true;');
144		$buffer->indent(-1);
145		$buffer->writeln('}');
146		}
147
148		if (!empty($this->taskDef['assert'])) {
149		$buffer->write('if (!(');
150		$this->taskDef['assert']->compile($buffer);
151		$buffer->raw(')) {')->eol()->indent(1);
152		$buffer->writeln('throw new \RuntimeException("Assertion failed");');
153		$buffer->indent(-1)->writeln('}');
154		}
155
156		$buffer->writeln('if (!$skip) {');
157		$buffer->indent(1);
158		}
159		foreach ($this->taskDef[$scope] as $i => $cmd) {
160		$buffer->write('Debug::enterScope(')->asPhp($scope . '[' . $i . ']')->raw(');')->eol();
161		if ($cmd) {
162		$cmd->compile($buffer);
163		}
164		$buffer->write('Debug::exitScope(')->asPhp($scope . '[' . $i . ']')->raw(');')->eol();
165		}
166
167		if ($scope === 'post') {
168		$buffer->indent(-1);
169		$buffer->writeln('}');
170		}
171		}
172		if (!empty($this->taskDef['yield'])) {
173		$buffer->writeln('$ret = ');
174		$this->taskDef['yield']->compile($buffer);
175		$buffer->write(';');
176		}
177		$buffer->writeln('return $ret;');
178		}
179
180
181		/**
182		* Returns all variables that can be injected into the task.
183		*
184		* @param bool $onlyPublic
185		* @return array
186		*/
187		public function getArguments($onlyPublic = true)
188		{
189		$ret = array();
190		if (isset($this->taskDef['args'])) {
191		foreach ($this->taskDef['args'] as $name => $expr) {
192		if ($onlyPublic && $name{0} === '_') {
193		// Variables prefixed with an underscore are considered non public
194		continue;
195		}
196		if ($expr->conditional) {
197		// if the part after the question mark is empty, the variable is assumed to be required
198		// for execution of the task
199		$ret[$name] = ($expr->nodes[0] === null);
200		}
201		}
202		}
203		return $ret;
204		}
205
206		/**
207		* Returns all variables that can be injected into the task.
208		*
209		* @return array
210		*/
211		public function getOptions()
212		{
213		$ret = array();
214		if (!empty($this->taskDef['opts'])) {
215		foreach ($this->taskDef['opts'] as $opt) {
216		$ret[] = $opt->name;
217		}
218		}
219		return $ret;
220		}
221		}
222

zicht / z

Task::compile() B last analyzed 2017-06-16 11:38 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Task::compile() B
last analyzed 2017-06-16 11:38 UTC