Merge pull request #929 from hydephp/refactor-path-assembly

emmadesilva · web-flow · commit ecb50cd298fd · 2023-02-08T12:09:07.000+01:00
Refactor Filesystem path assembly helpers
diff --git a/packages/framework/src/Foundation/Filesystem.php b/packages/framework/src/Foundation/Filesystem.php
@@ -15,6 +15,7 @@
 use Hyde\Pages\MarkdownPage;
 use Hyde\Pages\MarkdownPost;
 use Illuminate\Support\Collection;
+use function Hyde\system_path_join;
 use function is_array;
 use function is_string;
 use function str_replace;
@@ -60,7 +61,7 @@ public function path(string $path = ''): string
 
         $path = unslash($path);
 
-        return $this->implode($this->getBasePath(), $path);
+        return system_path_join($this->getBasePath(), $path);
     }
 
     /**
@@ -208,7 +209,7 @@ public function getModelSourcePath(string $model, string $path = ''): string
 
         $path = unslash($path);
 
-        return $this->path($this->implode(DiscoveryService::getModelSourceDirectory($model), $path));
+        return $this->path(system_path_join(DiscoveryService::getModelSourceDirectory($model), $path));
     }
 
     public function getBladePagePath(string $path = ''): string
@@ -236,12 +237,4 @@ public function smartGlob(string $pattern, int $flags = 0): Collection
         return collect(\Hyde\Facades\Filesystem::glob($pattern, $flags))
             ->map(fn (string $path): string => $this->pathToRelative($path));
     }
-
-    /**
-     * Implode path components into a string with directory separators.
-     */
-    public static function implode(string $base, string ...$paths): string
-    {
-        return implode(DIRECTORY_SEPARATOR, array_merge([$base], $paths));
-    }
 }
diff --git a/packages/framework/src/helpers.php b/packages/framework/src/helpers.php
@@ -99,4 +99,25 @@ function yaml_decode(string $input, int $flags = 0): mixed
             return Yaml::parse($input, $flags);
         }
     }
+
+    if (! function_exists('\Hyde\path_join')) {
+        function path_join(string $directory, string ...$paths): string
+        {
+            return implode('/', array_merge([$directory], $paths));
+        }
+    }
+
+    if (! function_exists('\Hyde\system_path_join')) {
+        function system_path_join(string $directory, string ...$paths): string
+        {
+            return implode(DIRECTORY_SEPARATOR, array_merge([$directory], $paths));
+        }
+    }
+
+    if (! function_exists('\Hyde\normalize_slashes')) {
+        function normalize_slashes(string $string): string
+        {
+            return str_replace('\\', '/', $string);
+        }
+    }
 }
diff --git a/packages/framework/tests/Feature/Foundation/FilesystemTest.php b/packages/framework/tests/Feature/Foundation/FilesystemTest.php
@@ -390,13 +390,6 @@ public function test_path_to_relative_helper_does_not_modify_non_project_paths()
         }
     }
 
-    public function test_implode_helper_merges_path_components_into_a_string_with_directory_separators()
-    {
-        $this->assertSame($this->systemPath('foo'), Filesystem::implode('foo'));
-        $this->assertSame($this->systemPath('foo/bar'), Filesystem::implode('foo', 'bar'));
-        $this->assertSame($this->systemPath('foo/bar/baz'), Filesystem::implode('foo', 'bar', 'baz'));
-    }
-
     protected function systemPath(string $path): string
     {
         return str_replace('/', DIRECTORY_SEPARATOR, $path);
diff --git a/packages/framework/tests/Feature/HelpersTest.php b/packages/framework/tests/Feature/HelpersTest.php
@@ -149,4 +149,36 @@ public function test_hyde_yaml_decode_function_accepts_parameters()
             \Hyde\yaml_decode('foo: bar', 128)
         );
     }
+
+    /** @covers ::\Hyde\path_join */
+    public function test_hyde_path_join_function()
+    {
+        $this->assertSame('foo/bar', \Hyde\path_join('foo', 'bar'));
+    }
+
+    /** @covers ::\Hyde\path_join */
+    public function test_hyde_path_join_function_with_multiple_paths()
+    {
+        $this->assertSame('foo/bar/baz', \Hyde\path_join('foo', 'bar', 'baz'));
+    }
+
+    /** @covers ::\Hyde\system_path_join */
+    public function test_hyde_system_path_join_function()
+    {
+        $this->assertSame('foo'.DIRECTORY_SEPARATOR.'bar', \Hyde\system_path_join('foo', 'bar'));
+    }
+
+    /** @covers ::\Hyde\system_path_join */
+    public function test_hyde_system_path_join_function_with_multiple_paths()
+    {
+        $this->assertSame('foo'.DIRECTORY_SEPARATOR.'bar'.DIRECTORY_SEPARATOR.'baz', \Hyde\system_path_join('foo', 'bar', 'baz'));
+    }
+
+    /** @covers ::\Hyde\normalize_slashes */
+    public function test_hyde_normalize_slashes_function()
+    {
+        $this->assertSame('foo/bar', \Hyde\normalize_slashes('foo'.DIRECTORY_SEPARATOR.'bar'));
+        $this->assertSame('foo/bar', \Hyde\normalize_slashes('foo\\bar'));
+        $this->assertSame('foo/bar', \Hyde\normalize_slashes('foo/bar'));
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -390,13 +390,6 @@ public function test_path_to_relative_helper_does_not_modify_non_project_paths()`
`390`	`390`	`}`
`391`	`391`	`}`
`392`	`392`
`393`		`- public function test_implode_helper_merges_path_components_into_a_string_with_directory_separators()`
`394`		`- {`
`395`		`- $this->assertSame($this->systemPath('foo'), Filesystem::implode('foo'));`
`396`		`- $this->assertSame($this->systemPath('foo/bar'), Filesystem::implode('foo', 'bar'));`
`397`		`- $this->assertSame($this->systemPath('foo/bar/baz'), Filesystem::implode('foo', 'bar', 'baz'));`
`398`		`- }`
`399`		`-`
`400`	`393`	`protected function systemPath(string $path): string`
`401`	`394`	`{`
`402`	`395`	`return str_replace('/', DIRECTORY_SEPARATOR, $path);`