Merge pull request #13 from sebastianfeldmann

Add method to handle command variables

.github/workflows/integration.yml

@@ -41,4 +41,4 @@ jobs:
       run: tools/phpcs --standard=psr12 src tests
 
     - name: Static code analysis
-      run: tools/phpstan analyse
+      run: tools/phpstan analyse -c phpstan-${{ matrix.php-versions }}.neon

phive.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="phpunit" version="^9.0.0" installed="9.5.0" location="./tools/phpunit" copy="true"/>
-  <phar name="phpcs" version="^3.5.2" installed="3.5.8" location="./tools/phpcs" copy="true"/>
-  <phar name="phpstan" version="^0.12.2" installed="0.12.59" location="./tools/phpstan" copy="true"/>
+  <phar name="phpunit" version="^9.0.0" installed="9.5.10" location="./tools/phpunit" copy="true"/>
+  <phar name="phpcs" version="^3.5.2" installed="3.6.1" location="./tools/phpcs" copy="true"/>
+  <phar name="phpstan" version="^0.12.2" installed="0.12.99" location="./tools/phpstan" copy="true"/>
 </phive>

phpstan-7.3.neon

@@ -0,0 +1,4 @@
+parameters:
+  level: 5
+  paths:
+  - %currentWorkingDirectory%/src/

phpstan-7.4.neon

@@ -0,0 +1,4 @@
+parameters:
+  level: 5
+  paths:
+  - %currentWorkingDirectory%/src/

phpstan-8.0.neon

@@ -0,0 +1,6 @@
+parameters:
+  level: 5
+  paths:
+  - %currentWorkingDirectory%/src/
+  ignoreErrors:
+    - '#Left side of && is always true#'

src/Command/Executable.php

@@ -45,6 +45,13 @@ class Executable implements Command
      */
     private $options = [];
 
+    /**
+     * List of variables to define
+     *
+     * @var string[]
+     */
+    private $vars = [];
+
     /**
      * List of acceptable exit codes.
      *
@@ -71,9 +78,9 @@ public function __construct(string $cmd, array $exitCodes = [0])
      */
     public function getCommand(): string
     {
-        $cmd = sprintf('"%s"', $this->cmd)
-            . (count($this->options)   ? ' ' . implode(' ', $this->options)   : '')
-            . ($this->isSilent         ? ' 2> /dev/null'                      : '');
+        $cmd = $this->getVars() . sprintf('"%s"', $this->cmd)
+             . (count($this->options)   ? ' ' . implode(' ', $this->options)   : '')
+             . ($this->isSilent         ? ' 2> /dev/null'                      : '');
 
         return Util::escapeSpacesIfOnWindows($cmd);
     }
@@ -125,6 +132,36 @@ public function addOption(string $option, $value = null, string $glue = '='): Ex
         return $this;
     }
 
+    /**
+     * Add a var definition to a command
+     *
+     * @param  string $name
+     * @param  string $value
+     * @return $this
+     */
+    public function addVar(string $name, string $value): Executable
+    {
+        $this->vars[$name] = $value;
+
+        return $this;
+    }
+
+    /**
+     * Return variable definition string e.g. "MYFOO='sometext' MYBAR='nothing' "
+     *
+     * @return string
+     */
+    protected function getVars(): string
+    {
+        $varStrings = [];
+
+        foreach ($this->vars as $name => $value) {
+            $varStrings[] = $name . '=' . escapeshellarg($value);
+        }
+
+        return count($varStrings) ? implode(' ', $varStrings) . ' ' : '';
+    }
+
     /**
      * Adds an option to a command if it is not empty.
      *

tests/cli/Command/ExecutableTest.php

@@ -107,4 +107,17 @@ public function testAddOptionIfEmptyAsValue()
 
         $this->assertEquals('"foo" -bar=\'fiz\'', (string) $cmd, 'option should be added');
     }
+
+    /**
+     * Tests Executable::addVar
+     */
+    public function testAddVar()
+    {
+        $cmd = new Executable('tool');
+        $cmd->addVar('FOO', 'fiz');
+        $cmd->addVar('BAR', 'baz');
+        $cmd->addOptionIfNotEmpty('--extra', 'bonus');
+
+        $this->assertEquals('FOO=\'fiz\' BAR=\'baz\' "tool" --extra=\'bonus\'', (string) $cmd, 'vars prefix');
+    }
 }