zicht / z

src/Zicht/Tool/Application.php

Doc Comments +1 added lines, -1 removed lines

@@ -45,7 +45,7 @@
      * Construct the application with the specified name, version and config loader.
      *
      * @param string $name
-     * @param string $version
+     * @param Version $version
      * @param Configuration\ConfigurationLoader $loader
      */
     public function __construct($name, Version $version, ConfigurationLoader $loader = null)

Unused Use Statements -3 removed lines

@@ -6,16 +6,13 @@
 namespace Zicht\Tool;
 
 use Symfony\Component\Console\Application as BaseApplication;
-use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputDefinition;
 use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\Yaml\Yaml;
 use Zicht\Version\Version;
-
 use Zicht\Tool\Command as Cmd;
 use Zicht\Tool\Configuration\ConfigurationLoader;
 use Zicht\Tool\Container\Container;

Spacing +10 added lines, -10 removed lines

@@ -90,10 +90,10 @@ 
                             '%s%-40s %s',
                             ($depth > 0 ? str_repeat('   ', $depth - 1) . '-> ' : ''),
                             '<fg=red;options=bold>' . $e->getMessage() . '</fg=red;options=bold>',
-                            $depth == count($ancestry) -1 ? str_pad('[' . get_class($e) . ']', $maxLength + 15, ' ') : ''
+                            $depth == count($ancestry) - 1 ? str_pad('[' . get_class($e) . ']', $maxLength + 15, ' ') : ''
                         )
                     );
-                    $depth ++;
+                    $depth++;
                 }
             }
         }
@@ -157,10 +157,10 @@ 
             array(
                 new InputArgument('command', InputArgument::REQUIRED, 'The command to execute'),
 
-                new InputOption('--help',           '-h', InputOption::VALUE_NONE, 'Display this help message.'),
-                new InputOption('--verbose',        '-v|vv|vvv', InputOption::VALUE_NONE, 'Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug'),
-                new InputOption('--no-cache',       '-c', InputOption::VALUE_NONE, 'Force recompilation of container code'),
-                new InputOption('--version',        '-V', InputOption::VALUE_NONE, 'Display this application version.'),
+                new InputOption('--help', '-h', InputOption::VALUE_NONE, 'Display this help message.'),
+                new InputOption('--verbose', '-v|vv|vvv', InputOption::VALUE_NONE, 'Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug'),
+                new InputOption('--no-cache', '-c', InputOption::VALUE_NONE, 'Force recompilation of container code'),
+                new InputOption('--version', '-V', InputOption::VALUE_NONE, 'Display this application version.'),
             )
         );
     }
@@ -196,10 +196,10 @@ 
 
         $container->output = $output;
 
-        $container->set('VERBOSE',  $input->hasParameterOption(array('--verbose', '-v')));
-        $container->set('FORCE',    $input->hasParameterOption(array('--force', '-f')));
-        $container->set('EXPLAIN',  $input->hasParameterOption(array('--explain')));
-        $container->set('DEBUG',    $input->hasParameterOption(array('--debug')));
+        $container->set('VERBOSE', $input->hasParameterOption(array('--verbose', '-v')));
+        $container->set('FORCE', $input->hasParameterOption(array('--force', '-f')));
+        $container->set('EXPLAIN', $input->hasParameterOption(array('--explain')));
+        $container->set('DEBUG', $input->hasParameterOption(array('--debug')));
 
         foreach ($container->getCommands() as $task) {
             $this->add($task);

src/Zicht/Tool/Command/Descriptor/TextDescriptor.php

Doc Comments +1 added lines, -1 removed lines

@@ -70,7 +70,7 @@
      * the former representing the options that are hidden.
      *
      * @param \Symfony\Component\Console\Input\InputDefinition $definition
-     * @return array
+     * @return InputDefinition[]
      */
     public function splitDefinition(InputDefinition $definition)
     {

Unused Use Statements -1 removed lines

@@ -3,7 +3,6 @@
 
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputDefinition;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Descriptor\TextDescriptor as BaseDescriptor;

Spacing +5 added lines, -5 removed lines

@@ -37,12 +37,12 @@ 
 
         $this->writeText('<comment>Usage:</comment>', $options);
         $this->writeText("\n");
-        $this->writeText(' '.$synopsis->getSynopsis(), $options);
+        $this->writeText(' ' . $synopsis->getSynopsis(), $options);
         $this->writeText("\n");
 
         if (count($command->getAliases()) > 0) {
             $this->writeText("\n");
-            $this->writeText('<comment>Aliases:</comment> <info>'.implode(', ', $command->getAliases()).'</info>', $options);
+            $this->writeText('<comment>Aliases:</comment> <info>' . implode(', ', $command->getAliases()) . '</info>', $options);
         }
 
         $this->writeText("\n");
@@ -50,7 +50,7 @@ 
         if (count($internal->getOptions())) {
             $this->writeText("\n\n" . '<comment>Global options:</comment>' . "\n");
             $this->writeText(' Following global options are available for all task commands:');
-            $this->writeText(' ' . join(', ', array_map(function($o) { return $o->getName(); }, $internal->getOptions())));
+            $this->writeText(' ' . join(', ', array_map(function ($o) { return $o->getName(); }, $internal->getOptions())));
             $this->writeText(' Read the application help for more info' . "\n");
         }
         $this->writeText("\n");
@@ -58,7 +58,7 @@ 
         if ($help = $command->getProcessedHelp()) {
             $this->writeText('<comment>Help:</comment>', $options);
             $this->writeText("\n");
-            $this->writeText(' '.str_replace("\n", "\n ", $help), $options);
+            $this->writeText(' ' . str_replace("\n", "\n ", $help), $options);
             $this->writeText("\n");
         }
 
@@ -115,7 +115,7 @@ 
         foreach ($description->getNamespaces() as $namespace) {
             if (!$describedNamespace && ApplicationDescription::GLOBAL_NAMESPACE !== $namespace['id']) {
                 $this->writeText("\n");
-                $this->writeText('<comment>'.$namespace['id'].'</comment>', $options);
+                $this->writeText('<comment>' . $namespace['id'] . '</comment>', $options);
             }
 
             foreach ($namespace['commands'] as $name) {

src/Zicht/Tool/Command/TaskCommand.php

Doc Comments +9 added lines

@@ -69,6 +69,10 @@ 
         }
     }
 
+    /**
+     * @param string $shortcut
+     * @param string $help
+     */
     public function addOption($name, $shortcut = null, $mode = null, $help = null, $default = null)
     {
         $helpTag = ($mode === InputOption::VALUE_NONE) ? "--$name" : "--$name=" . strtoupper($name);
@@ -104,6 +108,11 @@ 
     }
 
 
+    /**
+     * @param string $name
+     *
+     * @return string
+     */
     protected function nameToVar($name)
     {
         return str_replace('-', '_', $name);

Spacing +9 added lines, -9 removed lines

@@ -46,11 +46,11 @@ 
         $this->setHelp(trim($help));
 
         foreach ($arguments as $name => $required) {
-            $mode  = $required ? InputArgument::REQUIRED : InputArgument::OPTIONAL;
+            $mode = $required ? InputArgument::REQUIRED : InputArgument::OPTIONAL;
 
             if ($multiple = ('[]' === substr($name, -2))) {
                 $name = substr($name, 0, -2);
-                $mode |=  InputArgument::IS_ARRAY;
+                $mode |= InputArgument::IS_ARRAY;
             }
 
             $this->addArgument($name, $mode);
@@ -121,9 +121,9 @@ 
             $i = 0;
             $ret = preg_replace_callback(
                 '/\[--(no-)?' . $name . '\]/',
-                function() use(&$i, $name) {
-                    if ($i ++ == 0) {
-                        return '[--[no|]-' . $name .']';
+                function () use(&$i, $name) {
+                    if ($i++ == 0) {
+                        return '[--[no|]-' . $name . ']';
                     }
                     return '';
                 },
@@ -143,10 +143,10 @@ 
     protected function configure()
     {
         $this
-            ->addOption('explain',  '',     InputOption::VALUE_NONE,        'Explains the commands that would be executed.')
-            ->addOption('force',    'f',    InputOption::VALUE_NONE,        'Force execution of otherwise skipped tasks.')
-            ->addOption('plugin',   '',     InputOption::VALUE_REQUIRED,    'Load additional plugins on-the-fly')
-            ->addOption('debug',    '',     InputOption::VALUE_NONE,        "Set the debug flag")
+            ->addOption('explain', '', InputOption::VALUE_NONE, 'Explains the commands that would be executed.')
+            ->addOption('force', 'f', InputOption::VALUE_NONE, 'Force execution of otherwise skipped tasks.')
+            ->addOption('plugin', '', InputOption::VALUE_REQUIRED, 'Load additional plugins on-the-fly')
+            ->addOption('debug', '', InputOption::VALUE_NONE, "Set the debug flag")
         ;
     }
 

src/Zicht/Tool/Configuration/PathDefaultFileLocator.php

Doc Comments +1 added lines, -1 removed lines

@@ -30,7 +30,7 @@
     /**
      * Construct the locator based on the passed environment variable.
      *
-     * @param array|string $envName
+     * @param string $envName
      * @param array $defaultPaths
      */
     public function __construct($envName, $defaultPaths = array())

src/Zicht/Tool/Container/Container.php

Doc Comments +4 added lines, -4 removed lines

@@ -200,7 +200,7 @@ 
      * @param array $context
      * @param array $path
      * @param bool $require
-     * @return mixed
+     * @return string
      *
      * @throws \RuntimeException
      * @throws \InvalidArgumentException
@@ -222,7 +222,7 @@ 
      *
      * @param array $id
      * @param bool $required
-     * @return mixed
+     * @return string
      *
      * @throws \RuntimeException
      * @throws CircularReferenceException
@@ -389,7 +389,7 @@ 
      * @param string $expression
      * @param string &$code
      *
-     * @return mixed
+     * @return string
      */
     public function evaluate($expression, &$code = null)
     {
@@ -496,7 +496,7 @@ 
      * Execute a command. This is a wrapper for 'exec', so that a task prefixed with '@' can be passed as well.
      *
      * @param string $cmd
-     * @return int
+     * @return string|null
      */
     public function cmd($cmd)
     {

Unused Use Statements -3 removed lines

@@ -9,16 +9,13 @@
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Output\NullOutput;
 use Symfony\Component\Console\Output\OutputInterface;
-
 use Zicht\Tool\Debug;
 use Zicht\Tool\PropertyPath\PropertyAccessor;
 use Zicht\Tool\PluginInterface;
 use Zicht\Tool\Script\Compiler as ScriptCompiler;
-use Zicht\Tool\Script;
 use Zicht\Tool\Util;
 use Zicht\Tool\Script\Parser\Expression as ExpressionParser;
 use Zicht\Tool\Script\Tokenizer\Expression as ExpressionTokenizer;
-
 use UnexpectedValueException;
 
 /**

Spacing +20 added lines, -20 removed lines

@@ -54,7 +54,7 @@ 
         $this->output = $output ?: new NullOutput();
 
         $this->values = array(
-            'SHELL'         => function($z) {
+            'SHELL'         => function ($z) {
                 return '/bin/bash -e' . ($z->has('DEBUG') && $z->get('DEBUG') ? 'x' : '');
             },
             'TIMEOUT'       => null,
@@ -63,11 +63,11 @@ 
         // gather the options for nested z calls.
         $this->set(
             array('z', 'opts'),
-            function($z) {
+            function ($z) {
                 $opts = array();
                 foreach (array('FORCE', 'VERBOSE', 'EXPLAIN', 'DEBUG') as $opt) {
                     if ($z->has($opt) && $z->get($opt)) {
-                        $opts[]= '--' . strtolower($opt);
+                        $opts[] = '--' . strtolower($opt);
                     }
                 }
                 return join(' ', $opts);
@@ -80,10 +80,10 @@ 
                 return stream_get_contents(STDIN);
             }
         );
-        $this->fn('confirm', function() {
+        $this->fn('confirm', function () {
             return false;
         });
-        $this->set('cwd',  getcwd());
+        $this->set('cwd', getcwd());
         $this->set('user', getenv('USER'));
 
 
@@ -91,7 +91,7 @@ 
         // string functions
         $this->fn(
             'cat',
-            function() {
+            function () {
                 return join('', func_get_args());
             }
         );
@@ -106,7 +106,7 @@ 
         $this->fn('ltrim');
         $this->fn('rtrim');
         $this->fn('sprintf');
-        $this->fn(array('safename'), function($fn) {
+        $this->fn(array('safename'), function ($fn) {
             return preg_replace('/[^a-z0-9]+/', '-', $fn);
         });
         
@@ -119,7 +119,7 @@ 
         $this->fn('mtime', 'filemtime');
         $this->fn('atime', 'fileatime');
         $this->fn('ctime', 'filectime');
-        $this->fn('escape', function($value) {
+        $this->fn('escape', function ($value) {
             if (is_array($value)) {
                 return array_map('escapeshellarg', $value);
             }
@@ -127,11 +127,11 @@ 
         });
         $this->fn(
             'path',
-            function() {
+            function () {
                 return join(
                     "/",
                     array_map(
-                        function($el) {
+                        function ($el) {
                             return rtrim($el, "/");
                         },
                         array_filter(func_get_args())
@@ -145,7 +145,7 @@ 
         $this->fn('join', 'implode');
         $this->fn('keys', 'array_keys');
         $this->fn('values', 'array_values');
-        $this->fn('range', function() {
+        $this->fn('range', function () {
             if (func_num_args() > 1) {
                 return range(func_get_arg(1), func_get_arg(0));
             }
@@ -167,16 +167,16 @@ 
         $this->fn('str', array($this, 'str'));
         $this->fn(
             array('url', 'host'),
-            function($url) {
+            function ($url) {
                 return parse_url($url, PHP_URL_HOST);
             }
         );
-        $this->decl(array('now'), function() {
+        $this->decl(array('now'), function () {
             return date('YmdHis');
         });
 
         $exitCode = self::ABORT_EXIT_CODE;
-        $this->decl(array('abort'), function() use($exitCode) {
+        $this->decl(array('abort'), function () use($exitCode) {
             return 'exit ' . $exitCode;
         });
     }
@@ -234,7 +234,7 @@ 
         try {
             if (in_array($id, $this->resolutionStack)) {
                 $path = array_map(
-                    function($a) {
+                    function ($a) {
                         return join('.', $a);
                     },
                     $this->resolutionStack
@@ -360,7 +360,7 @@ 
         if (!is_callable($callable)) {
             throw new \InvalidArgumentException("Passed declaration is not callable");
         }
-        $this->set($id, function(Container $c) use($callable, $id) {
+        $this->set($id, function (Container $c) use($callable, $id) {
             Debug::enterScope(join('.', (array)$id));
             if (null !== ($value = call_user_func($callable, $c))) {
                 $c->set($id, $value);
@@ -393,7 +393,7 @@ 
      */
     public function evaluate($expression, &$code = null)
     {
-        $exprcompiler  = new ScriptCompiler(new ExpressionParser(), new ExpressionTokenizer());
+        $exprcompiler = new ScriptCompiler(new ExpressionParser(), new ExpressionTokenizer());
 
         $z = $this;
         $_value = null;
@@ -540,7 +540,7 @@ 
             $allScalar = function ($a, $b) {
                 return $a && is_scalar($b);
             };
-            if (! array_reduce($value, $allScalar, true)) {
+            if (!array_reduce($value, $allScalar, true)) {
                 throw new UnexpectedValueException("Unexpected complex type " . Util::toPhp($value));
             }
             return join(' ', $value);
@@ -557,7 +557,7 @@ 
      */
     public function addPlugin(PluginInterface $plugin)
     {
-        $this->plugins[]= $plugin;
+        $this->plugins[] = $plugin;
         $plugin->setContainer($this);
     }
 
@@ -570,7 +570,7 @@ 
      */
     public function addCommand(Command $command)
     {
-        $this->commands[]= $command;
+        $this->commands[] = $command;
     }
 
 

src/Zicht/Tool/Container/ContainerBuilder.php

Doc Comments +1 added lines, -1 removed lines

@@ -188,7 +188,7 @@
      *
      * @param array $path
      * @param string $node
-     * @return \Zicht\Tool\Script\Node\Task\OptNode
+     * @return SetNode
      */
     public function createSetNode($path, $node)
     {

Unused Use Statements -1 removed lines

@@ -11,7 +11,6 @@
 use Zicht\Tool\Script\Node\Task\OptNode;
 use Zicht\Tool\Script\Compiler;
 use Zicht\Tool\Script\Node\Task\SetNode;
-use Zicht\Tool\Script\Parser;
 use Zicht\Tool\Debug;
 use Zicht\Tool\Script\Parser\Expression as ExpressionParser;
 use Zicht\Tool\Script\Tokenizer\Expression as ExpressionTokenizer;

Spacing +11 added lines, -11 removed lines

@@ -32,7 +32,7 @@ 
     {
         $this->config = $config;
 
-        $this->exprcompiler  = new Compiler(new ExpressionParser(), new ExpressionTokenizer());
+        $this->exprcompiler = new Compiler(new ExpressionParser(), new ExpressionTokenizer());
         $this->scriptcompiler = new Compiler();
     }
 
@@ -45,7 +45,7 @@ 
      */
     public function addExpressionPath($callable)
     {
-        $this->expressionPaths[]= $callable;
+        $this->expressionPaths[] = $callable;
     }
 
 
@@ -100,7 +100,7 @@ 
     {
         $gatherer = new Traverser($result);
         $gatherer->addVisitor(
-            function($path, $node) use($containerNode) {
+            function ($path, $node) use($containerNode) {
                 $containerNode->append($node);
             },
             function ($path, $node) {
@@ -234,21 +234,21 @@ 
 
         $traverser->addVisitor(
             array($this, 'createArgNode'),
-            function($path) {
+            function ($path) {
                 return (count($path) == 4 && $path[0] == 'tasks' && $path[2] == 'args');
             },
             Traverser::BEFORE
         );
         $traverser->addVisitor(
             array($this, 'createOptNode'),
-            function($path) {
+            function ($path) {
                 return (count($path) == 4 && $path[0] == 'tasks' && $path[2] == 'opts');
             },
             Traverser::BEFORE
         );
         $traverser->addVisitor(
             array($this, 'createSetNode'),
-            function($path) {
+            function ($path) {
                 return (count($path) == 4 && $path[0] == 'tasks' && $path[2] == 'set');
             },
             Traverser::BEFORE
@@ -256,7 +256,7 @@ 
 
         $traverser->addVisitor(
             array($this, 'createExpressionNode'),
-            function($path) {
+            function ($path) {
                 return
                     count($path) === 3
                     && $path[0] == 'tasks'
@@ -267,18 +267,18 @@ 
         );
         $traverser->addVisitor(
             array($this, 'createScriptNode'),
-            function($path) {
+            function ($path) {
                 return
                     count($path) == 4
                     && $path[0] == 'tasks'
-                    && in_array($path[2], array('do', 'pre' ,'post'))
+                    && in_array($path[2], array('do', 'pre', 'post'))
                 ;
             },
             Traverser::BEFORE
         );
         $traverser->addVisitor(
             array($this, 'createTaskNode'),
-            function($path) {
+            function ($path) {
                 return count($path) == 2 && $path[0] == 'tasks';
             },
             Traverser::AFTER
@@ -290,7 +290,7 @@ 
         );
         $traverser->addVisitor(
             array($this, 'createDefinitionNode'),
-            function($path, $node) {
+            function ($path, $node) {
                 return $path[0] !== 'tasks' && (is_scalar($node) || (is_array($node) && count($node) === 0));
             },
             Traverser::AFTER

src/Zicht/Tool/Container/Declaration.php

Doc Comments +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
      * Constructor.
      *
      * @param array $path
-     * @param mixed $value
+     * @param null|Node $value
      */
     public function __construct(array $path, Node $value = null)
     {

src/Zicht/Tool/Container/Executor.php

Doc Comments +1 added lines

@@ -30,6 +30,7 @@
      *
      * @param string $cmd
      * @param null &$captureOutput
+     * @param string $captureOutput
      * @return int
      *
      * @throws ExecutionAbortedException

Unused Use Statements -1 removed lines

@@ -7,7 +7,6 @@
 namespace Zicht\Tool\Container;
 
 use Symfony\Component\Process\Process;
-use Symfony\Component\Process\ProcessBuilder;
 
 /**
  * Runs the commands in the shell.

Spacing +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
         }
 
         if (null !== $captureOutput && false === $isInteractive) {
-            $process->run(function($type, $data) use(&$captureOutput) {
+            $process->run(function ($type, $data) use(&$captureOutput) {
                 $captureOutput .= $data;
             });
         } else {

src/Zicht/Tool/Container/Task.php

Unused Use Statements -1 removed lines

@@ -7,7 +7,6 @@
 namespace Zicht\Tool\Container;
 
 use Zicht\Tool\Script\Buffer;
-use Zicht\Tool\Script\Node\Node;
 use Zicht\Tool\Util;
 
 /**

Spacing +1 added lines, -1 removed lines

@@ -214,7 +214,7 @@
         $ret = array();
         if (!empty($this->taskDef['opts'])) {
             foreach ($this->taskDef['opts'] as $opt) {
-                $ret[]= $opt->name;
+                $ret[] = $opt->name;
             }
         }
         return $ret;