Merge pull request #10 from supportpal/windows-whitespace-escape

Fix windows unrecognized command on directory with empty space
sebastianfeldmann · Jun 2, 2021 · 29e8bbd · 29e8bbd
2 parents 490a6ba + 920fc5a
commit 29e8bbd
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 1 deletion.
diff --git a/src/Command/Executable.php b/src/Command/Executable.php
@@ -12,6 +12,7 @@
 namespace SebastianFeldmann\Cli\Command;
 
 use SebastianFeldmann\Cli\Command;
+use SebastianFeldmann\Cli\Util;
 
 /**
  * Class Executable
@@ -59,7 +60,7 @@ class Executable implements Command
      */
     public function __construct(string $cmd, array $exitCodes = [0])
     {
-        $this->cmd                 = $cmd;
+        $this->cmd                 = ! defined('PHP_WINDOWS_VERSION_BUILD') ? $cmd : Util::escapeSpacesOnWindows($cmd);
         $this->acceptableExitCodes = $exitCodes;
     }
 

diff --git a/src/Util.php b/src/Util.php
@@ -312,4 +312,15 @@ public static function removeDir(string $dir)
         }
         rmdir($dir);
     }
+
+    /**
+     * Escapes 'unescaped' space sequences on Windows.
+     * i.e: 'E:/Program Files' escaped to 'E:/Program^ Files'
+     * @param string $cmd
+     * @return string
+     */
+    public static function escapeSpacesOnWindows(string $cmd): string
+    {
+        return preg_replace('/(?<!\^)( )/', '^ ', $cmd);
+    }
 }
diff --git a/tests/cli/UtilTest.php b/tests/cli/UtilTest.php
@@ -278,6 +278,28 @@ public function testRemoveDir()
         $this->assertFileDoesNotExist($dirToDelete);
     }
 
+    /**
+     * Tests Util::escapeSpacesOnWindows
+     * @dataProvider providerWindowsPathsCases
+     */
+    public function testEscapeSpacesOnWindows(string $expected, string $cmd): void
+    {
+        self::assertSame($expected, Util::escapeSpacesOnWindows($cmd));
+    }
+
+    /**
+     * @return string[][]
+     */
+    public function providerWindowsPathsCases(): array
+    {
+        $escapedCommand = 'E:/Program^ Files/';
+        $unEscapedCommand = 'E:/Program Files/';
+        return [
+            'test already escaped sequence' => [$escapedCommand, $escapedCommand],
+            'test unescaped sequence' => [$escapedCommand, $unEscapedCommand],
+        ];
+    }
+
     /**
      * Create some temp command
      *