[ Feat ] Windows Support (#33)

* fix windows path hook

* fix tests

* github actions windows

---------

Co-authored-by: Gerardo Ibarra <gibarra@upgradeit.com.ar>
Co-authored-by: Len Woodward <Len@ProjektGopher.com>

Author: 3 people

.github/workflows/pint.yml

@@ -3,10 +3,17 @@ on:
   workflow_dispatch:
   push:
     branches-ignore:
-      - 'dependabot/npm_and_yarn/*'
+      - "dependabot/npm_and_yarn/*"
 jobs:
   phplint:
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        operating-system:
+          - ubuntu-latest
+        php-version:
+          - "8.2"
+    name: php ${{ matrix.php-version }} on ${{ matrix.operating-system }}
+    runs-on: ${{ matrix.operating-system }}
     steps:
       - name: Checkout
         uses: actions/checkout@v2

.github/workflows/test.yml

@@ -7,6 +7,7 @@ jobs:
       matrix:
         operating-system:
           - ubuntu-latest
+          - windows-latest
         php-version:
           - "8.1"
           - "8.2"

app/Whisky.php

@@ -15,19 +15,19 @@ public function __construct()
     public static function cwd(string $path = ''): string
     {
         if ($path) {
-            return getcwd().DIRECTORY_SEPARATOR.$path;
+            return Whisky::normalizePath(getcwd().'/'.$path);
         }
 
-        return getcwd();
+        return Whisky::normalizePath(getcwd());
     }
 
     public static function bin(): string
     {
-        return match (true) {
+        return Whisky::normalizePath(match (true) {
             self::dogfooding() => self::cwd('whisky'),
             self::isRunningGlobally() => '/usr/local/bin/whisky', // TODO
             default => self::cwd('vendor/bin/whisky'),
-        };
+        });
     }
 
     public static function dogfooding(): bool
@@ -43,9 +43,9 @@ public static function isRunningGlobally(): bool
 
     public static function base_path(string $path = ''): string
     {
-        return Phar::running()
+        return Whisky::normalizePath(Phar::running()
             ? Whisky::cwd("vendor/projektgopher/whisky/{$path}")
-            : base_path($path);
+            : base_path($path));
     }
 
     public static function readConfig(string $key): string|array|null
@@ -56,4 +56,18 @@ public static function readConfig(string $key): string|array|null
 
         return data_get($cfg, $key);
     }
+
+    public static function normalizePath($path): string
+    {
+        if (Whisky::isWindows()) {
+            return str_replace('\\', '/', $path);
+        }
+
+        return $path;
+    }
+
+    public static function isWindows(): bool
+    {
+        return str_starts_with(strtoupper(PHP_OS), 'WIN');
+    }
 }

tests/Feature/InstallTest.php

@@ -11,7 +11,7 @@
 it('fails if git is not initialized', function () {
     File::shouldReceive('exists')
         ->once()
-        ->with(base_path('.git'))
+        ->with(normalizePath(base_path('.git')))
         ->andReturnFalse();
 
     $this->artisan('install')

tests/Feature/RunTest.php

@@ -5,12 +5,12 @@
 it('deletes skip-once file if exists and outputs nothing', function () {
     File::shouldReceive('exists')
         ->once()
-        ->with(base_path('bin/skip-once'))
+        ->with(normalizePath(base_path('bin/skip-once')))
         ->andReturnTrue();
 
     File::shouldReceive('delete')
         ->once()
-        ->with(base_path('bin/skip-once'))
+        ->with(normalizePath(base_path('bin/skip-once')))
         ->andReturnTrue();
 
     $this->artisan('get-run-cmd pre-commit')

tests/Pest.php

@@ -43,3 +43,17 @@ function something(): void
 {
     // ..
 }
+
+function normalizePath($path): string
+{
+    if (isWindows()) {
+        return str_replace('\\', '/', $path);
+    }
+
+    return $path;
+}
+
+function isWindows(): bool
+{
+    return str_starts_with(strtoupper(PHP_OS), 'WIN');
+}