Merge pull request #2293 from hydephp/feat/ensure-parent-directory-exists-method

Add a `Filesystem::ensureParentDirectoryExists` method

Author: emmadesilva

RELEASE_NOTES.md

@@ -66,6 +66,7 @@ This serves two purposes:
 - You can now add custom posts to the blog post feed component when including it directly in [#1893](https://github.com/hydephp/develop/pull/1893)
 - You can now specify sidebar item priorities by adding a numeric prefix to documentation page source file names in [#1709](https://github.com/hydephp/develop/pull/1709)
 - You can now forward method calls to the underlying `DateTime` instance in `DateString` instances in [#2235](https://github.com/hydephp/develop/pull/2235)
+- Added `Filesystem::ensureParentDirectoryExists()` method to reduce repetitive code when ensuring parent directories exist in [#2293](https://github.com/hydephp/develop/pull/2293)
 
 ### Changed
 

packages/framework/src/Console/Helpers/InteractivePublishCommandHelper.php

@@ -60,7 +60,7 @@ public function getBaseDirectory(): string
     public function publishFiles(): void
     {
         foreach ($this->publishableFilesMap as $source => $target) {
-            Filesystem::ensureDirectoryExists(dirname($target));
+            Filesystem::ensureParentDirectoryExists($target);
             Filesystem::copy($source, $target);
         }
     }

packages/framework/src/Facades/Filesystem.php

@@ -117,6 +117,19 @@ public static function unlinkIfExists(string $path): bool
         return self::kernel()->filesystem()->unlinkIfExists($path);
     }
 
+    /**
+     * Ensure that the parent directory of the given file path exists.
+     *
+     * @param  string  $path
+     * @param  int  $mode
+     * @param  bool  $recursive
+     * @return void
+     */
+    public static function ensureParentDirectoryExists(string $path, int $mode = 0755, bool $recursive = true): void
+    {
+        self::ensureDirectoryExists(self::dirname($path), $mode, $recursive);
+    }
+
     /**
      * Get the contents of a file.
      *

packages/framework/src/Pages/Concerns/BaseMarkdownPage.php

@@ -10,7 +10,6 @@
 use Hyde\Markdown\Models\Markdown;
 use Illuminate\Support\Facades\View;
 
-use function dirname;
 use function ltrim;
 use function trim;
 
@@ -65,7 +64,7 @@ public function compile(): string
      */
     public function save(): static
     {
-        Filesystem::ensureDirectoryExists(dirname($this->getSourcePath()));
+        Filesystem::ensureParentDirectoryExists($this->getSourcePath());
 
         Filesystem::putContents($this->getSourcePath(), ltrim(trim("$this->matter\n$this->markdown")."\n"));
 

packages/framework/tests/Unit/FilesystemFacadeUnitTest.php

@@ -333,6 +333,23 @@ public function testEnsureDirectoryExists()
         Filesystem::ensureDirectoryExists('path');
     }
 
+    public function testEnsureParentDirectoryExists()
+    {
+        $mock = $this->mockFilesystem();
+
+        $mock->shouldReceive('dirname')
+            ->with(Hyde::path('file.txt'))
+            ->once()
+            ->andReturn(Hyde::path('parent'));
+
+        $mock->shouldReceive('ensureDirectoryExists')
+            ->with(Hyde::path('parent'), 0755, true)
+            ->once()
+            ->andReturnNull();
+
+        Filesystem::ensureParentDirectoryExists('file.txt');
+    }
+
     public function testMakeDirectory()
     {
         $this->createExpectation('makeDirectory', true, Hyde::path('path'));

packages/framework/tests/Unit/InteractivePublishCommandHelperTest.php

@@ -67,6 +67,7 @@ public function testOnlyFiltersPublishableFiles(): void
 
     public function testPublishFiles(): void
     {
+        $this->filesystem->shouldReceive('dirname')->times(3)->andReturn(Hyde::path('resources/views/vendor/hyde/layouts'));
         $this->filesystem->shouldReceive('ensureDirectoryExists')->times(3);
         $this->filesystem->shouldReceive('copy')->times(3);
 
@@ -78,7 +79,8 @@ public function testPublishFiles(): void
 
         $helper->publishFiles();
 
-        $this->filesystem->shouldHaveReceived('ensureDirectoryExists')->with(Hyde::path('resources/views/vendor/hyde/layouts'))->times(3);
+        $this->filesystem->shouldHaveReceived('dirname')->times(3);
+        $this->filesystem->shouldHaveReceived('ensureDirectoryExists')->with(Hyde::path('resources/views/vendor/hyde/layouts'), 0755, true)->times(3);
 
         $this->filesystem->shouldHaveReceived('copy')->with(
             Hyde::path('packages/framework/resources/views/layouts/app.blade.php'),