consolidation / robo

src/Common/ConfigAwareTrait.php

Spacing +3 added lines, -3 removed lines

@@ -73,9 +73,9 @@
      */
     private static function getClassKey($key)
     {
-        $configPrefix = static::configPrefix();                            // task.
-        $configClass = static::configClassIdentifier(get_called_class());  // PARTIAL_NAMESPACE.CLASSNAME
-        $configPostFix = static::configPostfix();                          // .settings
+        $configPrefix = static::configPrefix(); // task.
+        $configClass = static::configClassIdentifier(get_called_class()); // PARTIAL_NAMESPACE.CLASSNAME
+        $configPostFix = static::configPostfix(); // .settings
 
         return sprintf('%s%s%s.%s', $configPrefix, $configClass, $configPostFix, $key);
     }

tests/unit/ConfigurationInjectionTest.php

Unused Use Statements -1 removed lines

@@ -1,6 +1,5 @@
 <?php
 use Robo\Robo;
-
 use Consolidation\Config\Loader\ConfigProcessor;
 use Consolidation\Config\Loader\YamlConfigLoader;
 

src/GlobalOptionsEventListener.php

Doc Comments +1 added lines, -1 removed lines

@@ -83,7 +83,7 @@
      * the input string contains no '=' character, then the value will be 'true'.
      *
      * @param string $value
-     * @return array
+     * @return boolean[]
      */
     protected function splitConfigKeyValue($value)
     {

src/Common/ProcessUtils.php

Unused Use Statements -2 removed lines

@@ -7,8 +7,6 @@
 
 namespace Robo\Common;
 
-use Symfony\Component\Process\Exception\InvalidArgumentException;
-
 /**
  * ProcessUtils is a bunch of utility methods. We want to allow Robo 1.x
  * to work with Symfony 4.x while remaining backwards compatibility. This

Doc Comments +3 added lines

@@ -72,6 +72,9 @@
         return "'".str_replace("'", "'\\''", $argument)."'";
     }
 
+    /**
+     * @param string $char
+     */
     private static function isSurroundedBy($arg, $char)
     {
         return 2 < strlen($arg) && $char === $arg[0] && $char === $arg[strlen($arg) - 1];

Spacing +4 added lines, -4 removed lines

@@ -34,7 +34,7 @@ 
      */
     public static function escapeArgument($argument)
     {
-        @trigger_error('The '.__METHOD__.'() method is a copy of a method that was deprecated by Symfony 3.3 and removed in Symfony 4; it will be removed in Robo 2.0.', E_USER_DEPRECATED);
+        @trigger_error('The ' . __METHOD__ . '() method is a copy of a method that was deprecated by Symfony 3.3 and removed in Symfony 4; it will be removed in Robo 2.0.', E_USER_DEPRECATED);
 
         //Fix for PHP bug #43784 escapeshellarg removes % from given string
         //Fix for PHP bug #49446 escapeshellarg doesn't work on Windows
@@ -52,7 +52,7 @@ 
                     $escapedArgument .= '\\"';
                 } elseif (self::isSurroundedBy($part, '%')) {
                     // Avoid environment variable expansion
-                    $escapedArgument .= '^%"'.substr($part, 1, -1).'"^%';
+                    $escapedArgument .= '^%"' . substr($part, 1, -1) . '"^%';
                 } else {
                     // escape trailing backslash
                     if ('\\' === substr($part, -1)) {
@@ -63,13 +63,13 @@ 
                 }
             }
             if ($quote) {
-                $escapedArgument = '"'.$escapedArgument.'"';
+                $escapedArgument = '"' . $escapedArgument . '"';
             }
 
             return $escapedArgument;
         }
 
-        return "'".str_replace("'", "'\\''", $argument)."'";
+        return "'" . str_replace("'", "'\\''", $argument) . "'";
     }
 
     private static function isSurroundedBy($arg, $char)

tests/cli/ForEachCest.php

Spacing +7 added lines, -7 removed lines

@@ -41,8 +41,8 @@ 
         $I->wantTo('set iterable in the __constructor');
         $I
             ->taskForEach($example['items'])
-            ->withBuilder(function (CollectionBuilder $builder, $key, $value) use (&$actual) {
-                $builder->addCode(function () use ($key, $value, &$actual) {
+            ->withBuilder(function(CollectionBuilder $builder, $key, $value) use (&$actual) {
+                $builder->addCode(function() use ($key, $value, &$actual) {
                     $actual[] = "$key = $value";
 
                     return 0;
@@ -63,7 +63,7 @@ 
         $I->wantTo('set iterable with deferTaskConfiguration()');
         $I
             ->collectionBuilder()
-            ->addCode(function (Data $data) use ($example) {
+            ->addCode(function(Data $data) use ($example) {
                 $data['items'] = $example['items'];
 
                 return 0;
@@ -72,8 +72,8 @@ 
                 $I
                     ->taskForEach()
                     ->deferTaskConfiguration('setIterable', 'items')
-                    ->withBuilder(function (CollectionBuilder $builder, $key, $value) use (&$actual) {
-                        $builder->addCode(function () use ($key, $value, &$actual) {
+                    ->withBuilder(function(CollectionBuilder $builder, $key, $value) use (&$actual) {
+                        $builder->addCode(function() use ($key, $value, &$actual) {
                             $actual[] = "$key = $value";
 
                             return 0;
@@ -91,8 +91,8 @@ 
         $I->wantTo('call the __constructor() without argument');
         $I
             ->taskForEach()
-            ->withBuilder(function (CollectionBuilder $builder, $key, $value) use (&$actual) {
-                $builder->addCode(function () use ($key, $value, &$actual) {
+            ->withBuilder(function(CollectionBuilder $builder, $key, $value) use (&$actual) {
+                $builder->addCode(function() use ($key, $value, &$actual) {
                     $actual++;
 
                     return 0;

src/ClassDiscovery/RelativeNamespaceDiscovery.php

Indentation +2 added lines, -2 removed lines

@@ -91,8 +91,8 @@
     {
         $finder = new Finder();
         $finder->files()
-          ->name($pattern)
-          ->in($directories);
+            ->name($pattern)
+            ->in($directories);
 
         return $finder;
     }

Doc Comments +5 added lines, -3 removed lines

@@ -62,6 +62,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param string $class
      */
     public function getFile($class)
     {
@@ -70,7 +71,7 @@ 
 
     /**
      * @param $directories
-     * @param $pattern
+     * @param string $pattern
      *
      * @return \Symfony\Component\Finder\Finder
      */
@@ -85,9 +86,9 @@ 
     }
 
     /**
-     * @param $path
+     * @param string $path
      *
-     * @return mixed
+     * @return string
      */
     protected function convertPathToNamespace($path)
     {
@@ -95,6 +96,7 @@ 
     }
 
     /**
+     * @param string $namespace
      * @return string
      */
     public function convertNamespaceToPath($namespace)

Spacing +4 added lines, -4 removed lines

@@ -53,14 +53,14 @@ 
         $relativePath = $this->convertNamespaceToPath($this->relativeNamespace);
 
         foreach ($this->classLoader->getPrefixesPsr4() as $baseNamespace => $directories) {
-            $directories = array_filter(array_map(function ($directory) use ($relativePath) {
-                return $directory.$relativePath;
+            $directories = array_filter(array_map(function($directory) use ($relativePath) {
+                return $directory . $relativePath;
             }, $directories), 'is_dir');
 
             if ($directories) {
                 foreach ($this->search($directories, $this->searchPattern) as $file) {
                     $relativePathName = $file->getRelativePathname();
-                    $classes[] = $baseNamespace.$this->convertPathToNamespace($relativePath.'/'.$relativePathName);
+                    $classes[] = $baseNamespace . $this->convertPathToNamespace($relativePath . '/' . $relativePathName);
                 }
             }
         }
@@ -107,6 +107,6 @@ 
      */
     public function convertNamespaceToPath($namespace)
     {
-        return '/'.str_replace("\\", '/', trim($namespace, '\\'));
+        return '/' . str_replace("\\", '/', trim($namespace, '\\'));
     }
 }

tests/unit/ClassDiscovery/RelativeNamespaceDiscoveryTest.php

Indentation +7 added lines, -7 removed lines

@@ -38,10 +38,10 @@ 
     public function testConvertPathToNamespaceData()
     {
         return [
-          ['/A/B/C', 'A\B\C'],
-          ['A/B/C', 'A\B\C'],
-          ['A/B/C', 'A\B\C'],
-          ['A/B/C.php', 'A\B\C'],
+            ['/A/B/C', 'A\B\C'],
+            ['A/B/C', 'A\B\C'],
+            ['A/B/C', 'A\B\C'],
+            ['A/B/C.php', 'A\B\C'],
         ];
     }
 
@@ -61,9 +61,9 @@ 
     public function testConvertNamespaceToPathData()
     {
         return [
-          ['A\B\C', '/A/B/C'],
-          ['\A\B\C\\', '/A/B/C'],
-          ['A\B\C\\', '/A/B/C'],
+            ['A\B\C', '/A/B/C'],
+            ['\A\B\C\\', '/A/B/C'],
+            ['A\B\C\\', '/A/B/C'],
         ];
     }
 

Spacing +2 added lines, -2 removed lines

@@ -11,7 +11,7 @@ 
     public function testGetClasses()
     {
         $classLoader = new ClassLoader();
-        $classLoader->addPsr4('\\Robo\\PluginTest\\', [realpath(__DIR__.'/../../plugins')]);
+        $classLoader->addPsr4('\\Robo\\PluginTest\\', [realpath(__DIR__ . '/../../plugins')]);
         $service = new RelativeNamespaceDiscovery($classLoader);
         $service->setRelativeNamespace('Robo\Plugin');
         $service->setSearchPattern('*Commands.php');
@@ -25,7 +25,7 @@ 
     public function testGetFile()
     {
         $classLoader = new ClassLoader();
-        $classLoader->addPsr4('\\Robo\\PluginTest\\', [realpath(__DIR__.'/../../plugins')]);
+        $classLoader->addPsr4('\\Robo\\PluginTest\\', [realpath(__DIR__ . '/../../plugins')]);
         $service = new RelativeNamespaceDiscovery($classLoader);
         $service->setRelativeNamespace('Robo\Plugin');
 

src/Runner.php

Spacing +5 added lines, -5 removed lines

@@ -63,7 +63,7 @@ 
     public function __construct($roboClass = null, $roboFile = null)
     {
         // set the const as class properties to allow overwriting in child classes
-        $this->roboClass = $roboClass ? $roboClass : self::ROBOCLASS ;
+        $this->roboClass = $roboClass ? $roboClass : self::ROBOCLASS;
         $this->roboFile  = $roboFile ? $roboFile : self::ROBOFILE;
         $this->dir = getcwd();
     }
@@ -239,7 +239,7 @@ 
     {
         /** @var \Robo\ClassDiscovery\RelativeNamespaceDiscovery $discovery */
         $discovery = Robo::service('relativeNamespaceDiscovery');
-        $discovery->setRelativeNamespace($relativeNamespace.'\Commands')
+        $discovery->setRelativeNamespace($relativeNamespace . '\Commands')
             ->setSearchPattern('*Commands.php');
         return $discovery->getClasses();
     }
@@ -413,9 +413,9 @@ 
 
         if (substr($argv[$pos], 0, 12) == '--load-from=') {
             $this->dir = substr($argv[$pos], 12);
-        } elseif (isset($argv[$pos +1])) {
-            $this->dir = $argv[$pos +1];
-            unset($argv[$pos +1]);
+        } elseif (isset($argv[$pos + 1])) {
+            $this->dir = $argv[$pos + 1];
+            unset($argv[$pos + 1]);
         }
         unset($argv[$pos]);
         // Make adjustments if '--load-from' points at a file.

Doc Comments +8 added lines, -4 removed lines

@@ -79,6 +79,9 @@ 
         $this->dir = getcwd();
     }
 
+    /**
+     * @param string $errorType
+     */
     protected function errorCondition($msg, $errorType)
     {
         $this->errorConditions[$msg] = $errorType;
@@ -126,7 +129,7 @@ 
     }
 
     /**
-     * @param array $argv
+     * @param string[] $argv
      * @param null|string $appName
      * @param null|string $appVersion
      * @param null|\Symfony\Component\Console\Output\OutputInterface $output
@@ -147,6 +150,7 @@ 
 
     /**
      * Get a list of locations where config files may be loaded
+     * @param string $userConfig
      * @return string[]
      */
     protected function getConfigFilePaths($userConfig)
@@ -162,7 +166,7 @@ 
      * @param null|\Symfony\Component\Console\Input\InputInterface $input
      * @param null|\Symfony\Component\Console\Output\OutputInterface $output
      * @param null|\Robo\Application $app
-     * @param array[] $commandFiles
+     * @param null|string $commandFiles
      * @param null|ClassLoader $classLoader
      *
      * @return int
@@ -258,9 +262,9 @@ 
     }
 
     /**
-     * @param $relativeNamespace
+     * @param string $relativeNamespace
      *
-     * @return array|string[]
+     * @return string[]
      */
     protected function discoverCommandClasses($relativeNamespace)
     {

examples/src/Robo/Plugin/Commands/ExampleCommands.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 -1 removed lines

@@ -2,7 +2,6 @@
 namespace RoboExample\Robo\Plugin\Commands;
 
 use Robo\Result;
-
 use Consolidation\AnnotatedCommand\CommandData;
 use Consolidation\OutputFormatters\Options\FormatterOptions;
 use Consolidation\OutputFormatters\StructuredData\RowsOfFields;

Spacing +11 added lines, -11 removed lines

@@ -29,7 +29,7 @@ 
      */
     public function tryWatch()
     {
-        $this->taskWatch()->monitor(['composer.json', 'composer.lock'], function () {
+        $this->taskWatch()->monitor(['composer.json', 'composer.lock'], function() {
             $this->taskComposerUpdate()->run();
         })->run();
     }
@@ -41,7 +41,7 @@ 
     {
         $this->say('The <b>expression</b> <bogus>is</bogus> <info>a < b</> it even works');
         $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();
@@ -49,7 +49,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!');
     }
 
@@ -173,7 +173,7 @@ 
         // using yaml or json output formats.
         $data->addRendererFunction(
             // n.b. There is a fourth parameter $rowData that may be added here.
-            function ($key, $cellData, FormatterOptions $options) {
+            function($key, $cellData, FormatterOptions $options) {
                 if ($key == 'name') {
                     return "<info>$cellData</>";
                 }
@@ -203,10 +203,10 @@ 
     public function tryFormatters($somthing = 'default', $options = ['format' => 'table', 'fields' => ''])
     {
         $outputData = [
-            'en' => [ 'first' => 'One',  'second' => 'Two',  'third' => 'Three' ],
-            'de' => [ 'first' => 'Eins', 'second' => 'Zwei', 'third' => 'Drei'  ],
-            'jp' => [ 'first' => 'Ichi', 'second' => 'Ni',   'third' => 'San'   ],
-            'es' => [ 'first' => 'Uno',  'second' => 'Dos',  'third' => 'Tres'  ],
+            'en' => ['first' => 'One', 'second' => 'Two', 'third' => 'Three'],
+            'de' => ['first' => 'Eins', 'second' => 'Zwei', 'third' => 'Drei'],
+            'jp' => ['first' => 'Ichi', 'second' => 'Ni', 'third' => 'San'],
+            'es' => ['first' => 'Uno', 'second' => 'Dos', 'third' => 'Tres'],
         ];
         return new RowsOfFields($outputData);
     }
@@ -241,7 +241,7 @@ 
     public function alterFormatters($result, CommandData $commandData)
     {
         if ($commandData->input()->getOption('french')) {
-            $result['fr'] = [ 'first' => 'Un',  'second' => 'Deux',  'third' => 'Trois'  ];
+            $result['fr'] = ['first' => 'Un', 'second' => 'Deux', 'third' => 'Trois'];
         }
 
         return $result;
@@ -396,7 +396,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.
@@ -418,7 +418,7 @@ 
             ->taskCleanDir($workdir)
             ->taskForEach($processList)
                 ->withBuilder(
-                    function ($builder, $key, $value) use ($workdir) {
+                    function($builder, $key, $value) use ($workdir) {
                         return $builder
                             ->taskFilesystemStack()
                                 ->mkdir("$workdir/$value");