consolidation / robo

examples/RoboFile.php

Doc Comments +3 added lines

@@ -348,6 +348,9 @@
 {
     protected $message;
 
+    /**
+     * @param string $message
+     */
     public function __construct($message)
     {
         $this->message = $message;

Unused Use Statements -2 removed lines

@@ -1,8 +1,6 @@
 <?php
 use Robo\Result;
 use Robo\ResultData;
-use Robo\Collection\CollectionBuilder;
-
 use Consolidation\OutputFormatters\StructuredData\RowsOfFields;
 
 /**

Indentation +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
  */
 class RoboFile extends \Robo\Tasks
 {
-   /**
+    /**
      * Watch a file.
      *
      * Demonstrates the 'watch' command. Runs 'composer update' any time

Spacing +9 added lines, -9 removed lines

@@ -23,7 +23,7 @@ 
      */
     public function tryWatch()
     {
-        $this->taskWatch()->monitor(['composer.json', 'composer.lock'], function () {
+        $this->taskWatch()->monitor(['composer.json', 'composer.lock'], function() {
             $this->taskComposerUpdate()->run();
         })->run();
     }
@@ -34,7 +34,7 @@ 
     public function tryInput()
     {
         $answer = $this->ask('how are you?');
-        $this->say('You are '.$answer);
+        $this->say('You are ' . $answer);
         $yes = $this->confirm('Do you want one more question?');
         if (!$yes) {
             return Result::cancelled();
@@ -42,7 +42,7 @@ 
         $lang = $this->askDefault('what is your favorite scripting language?', 'PHP');
         $this->say($lang);
         $pin = $this->askHidden('Ok, now tell your PIN code (it is hidden)');
-        $this->yell('Ha-ha, your pin code is: '.$pin);
+        $this->yell('Ha-ha, your pin code is: ' . $pin);
         $this->say('Bye!');
     }
 
@@ -154,10 +154,10 @@ 
     public function tryFormatters($options = ['format' => 'table', 'fields' => ''])
     {
         $outputData = [
-            [ 'first' => 'One',  'second' => 'Two',  'third' => 'Three' ],
-            [ 'first' => 'Eins', 'second' => 'Zwei', 'third' => 'Drei'  ],
-            [ 'first' => 'Ichi', 'second' => 'Ni',   'third' => 'San'   ],
-            [ 'first' => 'Uno',  'second' => 'Dos',  'third' => 'Tres'  ],
+            ['first' => 'One', 'second' => 'Two', 'third' => 'Three'],
+            ['first' => 'Eins', 'second' => 'Zwei', 'third' => 'Drei'],
+            ['first' => 'Ichi', 'second' => 'Ni', 'third' => 'San'],
+            ['first' => 'Uno', 'second' => 'Dos', 'third' => 'Tres'],
         ];
         // Note that we can also simply return the output data array here.
         return ResultData::message(new RowsOfFields($outputData));
@@ -312,7 +312,7 @@ 
             ->taskForEach($processList)
                 ->iterationMessage('Processing {value}')
                 ->call(
-                    function ($value) use($delay) {
+                    function($value) use($delay) {
                         // TaskForEach::call should only be used to do
                         // non-Robo operations. To use Robo tasks in an
                         // iterator, @see TaskForEach::withBuilder.
@@ -334,7 +334,7 @@ 
             ->taskCleanDir($workdir)
             ->taskForEach($processList)
                 ->withBuilder(
-                    function ($builder, $key, $value) use ($workdir) {
+                    function($builder, $key, $value) use ($workdir) {
                         return $builder
                             ->taskFilesystemStack()
                                 ->mkdir("$workdir/$value");

RoboFile.php

Unused Use Statements -2 removed lines

@@ -1,7 +1,5 @@
 <?php
 use Symfony\Component\Finder\Finder;
-use Robo\Result;
-use Robo\Collection\CollectionBuilder;
 
 class RoboFile extends \Robo\Tasks
 {

Indentation +1 added lines, -1 removed lines

@@ -25,7 +25,7 @@
         }
 
         return $taskCodecept->run();
-     }
+        }
 
     /**
      * Code sniffer.

Spacing +12 added lines, -12 removed lines

@@ -128,12 +128,12 @@ 
     {
         if (empty($version)) {
             $versionParts = explode('.', \Robo\Robo::VERSION);
-            $versionParts[count($versionParts)-1]++;
+            $versionParts[count($versionParts) - 1]++;
             $version = implode('.', $versionParts);
         }
-        return $this->taskReplaceInFile(__DIR__.'/src/Robo.php')
-            ->from("VERSION = '".\Robo\Robo::VERSION."'")
-            ->to("VERSION = '".$version."'")
+        return $this->taskReplaceInFile(__DIR__ . '/src/Robo.php')
+            ->from("VERSION = '" . \Robo\Robo::VERSION . "'")
+            ->to("VERSION = '" . $version . "'")
             ->run();
     }
 
@@ -165,7 +165,7 @@ 
 
         foreach ($docs as $ns => $tasks) {
             $taskGenerator = $collection->taskGenDoc("docs/tasks/$ns.md");
-            $taskGenerator->filterClasses(function (\ReflectionClass $r) {
+            $taskGenerator->filterClasses(function(\ReflectionClass $r) {
                 return !($r->isAbstract() || $r->isTrait()) && $r->implementsInterface('Robo\Contract\TaskInterface');
             })->prepend("# $ns Tasks");
             sort($tasks);
@@ -174,7 +174,7 @@ 
             }
 
             $taskGenerator->filterMethods(
-                function (\ReflectionMethod $m) {
+                function(\ReflectionMethod $m) {
                     if ($m->isConstructor() || $m->isDestructor() || $m->isStatic()) {
                         return false;
                     }
@@ -200,21 +200,21 @@ 
                     return !in_array($m->name, $undocumentedMethods) && $m->isPublic(); // methods are not documented
                 }
             )->processClassSignature(
-                function ($c) {
+                function($c) {
                     return "## " . preg_replace('~Task$~', '', $c->getShortName()) . "\n";
                 }
             )->processClassDocBlock(
-                function (\ReflectionClass $c, $doc) {
+                function(\ReflectionClass $c, $doc) {
                     $doc = preg_replace('~@method .*?(.*?)\)~', '* `$1)` ', $doc);
-                    $doc = str_replace('\\'.$c->name, '', $doc);
+                    $doc = str_replace('\\' . $c->name, '', $doc);
                     return $doc;
                 }
             )->processMethodSignature(
-                function (\ReflectionMethod $m, $text) {
+                function(\ReflectionMethod $m, $text) {
                     return str_replace('#### *public* ', '* `', $text) . '`';
                 }
             )->processMethodDocBlock(
-                function (\ReflectionMethod $m, $text) {
+                function(\ReflectionMethod $m, $text) {
 
                     return $text ? ' ' . trim(strtok($text, "\n"), "\n") : '';
                 }
@@ -323,7 +323,7 @@ 
      */
     protected function devDependenciesToRemoveFromPhar()
     {
-        $composerInfo = (array) json_decode(file_get_contents(__DIR__ . '/composer.json'));
+        $composerInfo = (array)json_decode(file_get_contents(__DIR__ . '/composer.json'));
 
         $devDependencies = array_keys((array)$composerInfo['require-dev']);
         $suggestedProjects = array_keys((array)$composerInfo['suggest']);

Braces +6 added lines, -2 removed lines

@@ -92,7 +92,9 @@ 
             ->push()
             ->run();
 
-        if ($stable) $this->pharPublish();
+        if ($stable) {
+            $this->pharPublish();
+        }
         $this->publish();
 
         $this->taskGitStack()
@@ -100,7 +102,9 @@ 
             ->push('origin master --tags')
             ->run();
 
-        if ($stable) $this->versionBump();
+        if ($stable) {
+            $this->versionBump();
+        }
     }
 
     /**

src/Collection/Collection.php

Doc Comments +6 added lines

@@ -171,6 +171,8 @@ 
 
     /**
      * Add either a 'before' or 'after' function or task.
+     * @param string $method
+     * @param integer $nameOfTaskToAdd
      */
     protected function addBeforeOrAfter($method, $name, $task, $nameOfTaskToAdd)
     {
@@ -276,6 +278,7 @@ 
 
     /**
      * Add the provided task to our task list.
+     * @param integer $name
      */
     protected function addToTaskList($name, TaskInterface $task)
     {
@@ -548,6 +551,9 @@ 
         return $taskResult;
     }
 
+    /**
+     * @param CollectionInterface $parentCollection
+     */
     protected function setParentCollectionForTask($task, $parentCollection)
     {
         if ($task instanceof NestedCollectionInterface) {

Unused Use Statements -3 removed lines

@@ -11,9 +11,6 @@
 use Robo\Exception\TaskException;
 use Robo\Exception\TaskExitException;
 use Robo\Contract\CommandInterface;
-
-
-use Robo\Common\ProgressIndicatorAwareTrait;
 use Robo\Contract\InflectionInterface;
 
 /**

Spacing +4 added lines, -4 removed lines

@@ -107,7 +107,7 @@ 
     {
         $collection = $this;
         $completionRegistrationTask = new CallableTask(
-            function () use ($collection, $completionTask) {
+            function() use ($collection, $completionTask) {
 
                 $collection->registerCompletion($completionTask);
             },
@@ -150,7 +150,7 @@ 
         $context += ['name' => 'Progress'];
         $context += TaskInfo::getTaskContext($this);
         return $this->addCode(
-            function () use ($level, $text, $context) {
+            function() use ($level, $text, $context) {
                 $this->printTaskOutput($level, $text, $context);
             }
         );
@@ -160,7 +160,7 @@ 
     {
         $collection = $this;
         $rollbackRegistrationTask = new CallableTask(
-            function () use ($collection, $rollbackTask) {
+            function() use ($collection, $rollbackTask) {
                 $collection->registerRollback($rollbackTask);
             },
             $this
@@ -202,7 +202,7 @@ 
         if ($task instanceof StackBasedTask) {
             $task->stopOnFail(false);
         }
-        $ignoreErrorsInTask = function () use ($task) {
+        $ignoreErrorsInTask = function() use ($task) {
             $data = [];
             try {
                 $result = $this->runSubtask($task);

src/Collection/CollectionBuilder.php

Doc Comments +1 added lines, -1 removed lines

@@ -205,7 +205,7 @@
 
     /**
      * Create a new builder with its own task collection
-     * @return type
+     * @return CollectionBuilder
      */
     public function newBuilder()
     {

Unused Use Statements -4 removed lines

@@ -2,7 +2,6 @@ 
 namespace Robo\Collection;
 
 use Robo\Config;
-use Robo\Common\Timer;
 use Psr\Log\LogLevel;
 use Robo\Contract\TaskInterface;
 use Robo\Contract\CompletionInterface;
@@ -12,13 +11,10 @@ 
 use Robo\Task\Simulator;
 use Robo\Collection\CompletionWrapper;
 use Robo\Collection\Temporary;
-use Robo\Contract\ConfigAwareInterface;
-use Robo\Common\ConfigAwareTrait;
 use ReflectionClass;
 use Robo\Task\BaseTask;
 use Robo\Contract\BuilderAwareInterface;
 use Robo\Contract\CommandInterface;
-use Robo\Exception\TaskException;
 
 /**
  * Creates a collection, and adds tasks to it.  The collection builder

src/Collection/Temporary.php

Unused Use Statements -2 removed lines

@@ -2,8 +2,6 @@
 
 namespace Robo\Collection;
 
-use Robo\Contract\TaskInterface;
-
 /**
  * The temporary collection keeps track of the global collection of
  * temporary cleanup tasks in instances where temporary-generating

Spacing +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
     {
         if (!static::$collection) {
             static::$collection = \Robo\Robo::getContainer()->get('collection');
-            register_shutdown_function(function () {
+            register_shutdown_function(function() {
                 static::complete();
             });
         }

src/Common/CommandArguments.php

Doc Comments +2 added lines, -2 removed lines

@@ -13,7 +13,7 @@ 
     /**
      * Pass argument to executable. Its value will be automatically escaped.
      *
-     * @param $arg
+     * @param string $arg
      * @return $this
      */
     public function arg($arg)
@@ -86,7 +86,7 @@ 
      * Pass multiple options to executable. Value can be a string or array.
      * Option values are automatically escaped.
      *
-     * @param $option
+     * @param string $option
      * @param string|array $value
      * @return $this
      */

Spacing +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
             $args = func_get_args();
         }
         array_map('static::escape', $args);
-        $this->arguments .= " ".implode(' ', $args);
+        $this->arguments .= " " . implode(' ', $args);
         return $this;
     }
 

src/Common/ResourceExistenceChecker.php

Doc Comments +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
      *
      * @param string $resource File or folder.
      * @param string $type "file", "dir", "fileAndDir"
-     * @return boolean
+     * @return boolean|null
      */
     protected function checkResource($resource, $type)
     {

Indentation +12 added lines, -12 removed lines

@@ -89,23 +89,23 @@
         $this->checkResources($targets);
     }
 
-   /**
-    * Wrapper method around phps is_dir()
-    *
-    * @param string $directory
-    * @return boolean
-    */
+    /**
+     * Wrapper method around phps is_dir()
+     *
+     * @param string $directory
+     * @return boolean
+     */
     protected function isDir($directory)
     {
         return is_dir($directory);
     }
 
-   /**
-    * Wrapper method around phps file_exists()
-    *
-    * @param string $file
-    * @return boolean
-    */
+    /**
+     * Wrapper method around phps file_exists()
+     *
+     * @param string $file
+     * @return boolean
+     */
     protected function isFile($file)
     {
         return file_exists($file);

src/Common/TaskIO.php

Doc Comments +3 added lines

@@ -85,6 +85,7 @@ 
      * execution can continue.
      *
      * Warning messages are displayed at VERBOSITY_NORMAL.
+     * @param string $text
      */
     protected function printTaskWarning($text, $context = null)
     {
@@ -96,6 +97,7 @@ 
      * and the task cannot continue.
      *
      * Error messages are displayed at VERBOSITY_NORMAL.
+     * @param string $text
      */
     protected function printTaskError($text, $context = null)
     {
@@ -148,6 +150,7 @@ 
 
     /**
      * Format a quantity of bytes.
+     * @param integer $size
      */
     protected function formatBytes($size, $precision = 2)
     {

Unused Use Statements -1 removed lines

@@ -6,7 +6,6 @@
 use Consolidation\Log\ConsoleLogLevel;
 use Robo\Common\ConfigAwareTrait;
 use Psr\Log\LoggerAwareTrait;
-use Psr\Log\LoggerInterface;
 use Psr\Log\LogLevel;
 use Robo\Contract\ProgressIndicatorAwareInterface;
 

src/Log/ResultPrinter.php

Doc Comments +3 added lines

@@ -81,6 +81,9 @@
         return false;
     }
 
+    /**
+     * @param string $message
+     */
     protected function printMessage($level, $message, $context = [])
     {
         $inProgress = $this->hideProgressIndicator();

Unused Use Statements -3 removed lines

@@ -2,13 +2,10 @@
 namespace Robo\Log;
 
 use Robo\Result;
-use Robo\TaskInfo;
 use Robo\Contract\PrintedInterface;
 use Robo\Contract\ProgressIndicatorAwareInterface;
 use Robo\Common\ProgressIndicatorAwareTrait;
-
 use Psr\Log\LogLevel;
-use Psr\Log\LoggerInterface;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerAwareTrait;
 use Consolidation\Log\ConsoleLogLevel;