Merge pull request #753 from hydephp/add-unlinkIfExists-helper

emmadesilva · web-flow · commit 2aaa83656491 · 2022-12-13T20:06:21.000+01:00
Add Filesystem::unlinkIfExists helper
diff --git a/packages/framework/src/Facades/Filesystem.php b/packages/framework/src/Facades/Filesystem.php
@@ -92,6 +92,17 @@ public static function unlink(string|array $path): bool
         return self::kernel()->filesystem()->unlink($path);
     }
 
+    /**
+     * Unlink a file in the project's directory, but only if it exists.
+     *
+     * @param  string  $path
+     * @return bool True if the file was unlinked, false if it did not exist or failed to unlink.
+     */
+    public static function unlinkIfExists(string $path): bool
+    {
+        return self::kernel()->filesystem()->unlinkIfExists($path);
+    }
+
     /**
      * Get the contents of a file.
      *
diff --git a/packages/framework/src/Foundation/Filesystem.php b/packages/framework/src/Foundation/Filesystem.php
@@ -23,7 +23,8 @@
 /**
  * File helper methods, bound to the HydeKernel instance, and is an integral part of the framework.
  *
- * All paths are relative to the root of the application.
+ * All paths arguments are relative to the root of the application,
+ * and will be automatically resolved to absolute paths.
  *
  * @see \Hyde\Framework\Testing\Feature\Foundation\FilesystemTest
  */
@@ -146,6 +147,18 @@ public function unlink(string|array $path): bool
         return true;
     }
 
+    /**
+     * Unlink a file in the project's directory, but only if it exists.
+     */
+    public function unlinkIfExists(string $path): bool
+    {
+        if (file_exists($this->path($path))) {
+            return unlink($this->path($path));
+        }
+
+        return false;
+    }
+
     /**
      * Fluent file helper methods.
      *
diff --git a/packages/framework/tests/Feature/FilesystemFacadeTest.php b/packages/framework/tests/Feature/FilesystemFacadeTest.php
@@ -66,6 +66,14 @@ public function testUnlink()
         $this->assertFileDoesNotExist(Hyde::path('foo'));
     }
 
+    public function testUnlinkIfExists()
+    {
+        touch(Hyde::path('foo'));
+        Filesystem::unlinkIfExists('foo');
+
+        $this->assertFileDoesNotExist(Hyde::path('foo'));
+    }
+
     public function testGetContents()
     {
         $this->createExpectation('get', 'string', Hyde::path('path'), false);
diff --git a/packages/framework/tests/Feature/Foundation/FilesystemTest.php b/packages/framework/tests/Feature/Foundation/FilesystemTest.php
@@ -152,6 +152,18 @@ public function test_unlink_helper_deletes_multiple_files_at_given_paths()
         $this->assertFileDoesNotExist(Hyde::path('bar'));
     }
 
+    public function test_unlinkIfExists_helper_deletes_file_at_given_path()
+    {
+        touch(Hyde::path('foo'));
+        $this->assertTrue($this->filesystem->unlinkIfExists('foo'));
+        $this->assertFileDoesNotExist(Hyde::path('foo'));
+    }
+
+    public function test_unlinkIfExists_handles_non_existent_files_gracefully()
+    {
+        $this->assertFalse($this->filesystem->unlinkIfExists('foo'));
+    }
+
     public function test_get_model_source_path_method_returns_path_for_model_classes()
     {
         $this->assertEquals(
diff --git a/packages/testing/src/TestCase.php b/packages/testing/src/TestCase.php
@@ -5,7 +5,6 @@
 use Hyde\Facades\Features;
 use Hyde\Facades\Filesystem;
 use Hyde\Framework\Actions\ConvertsArrayToFrontMatter;
-use Hyde\Hyde;
 use Hyde\Pages\Concerns\HydePage;
 use Hyde\Pages\MarkdownPage;
 use Hyde\Support\Facades\Render;
@@ -96,9 +95,9 @@ protected function mockCurrentPage(string $currentPage)
     protected function file(string $path, ?string $contents = null): void
     {
         if ($contents) {
-            file_put_contents(Hyde::path($path), $contents);
+            Filesystem::put($path, $contents);
         } else {
-            Hyde::touch($path);
+            Filesystem::touch($path);
         }
 
         $this->cleanUpWhenDone($path);
@@ -128,15 +127,16 @@ protected function cleanUpFilesystem(): void
         if (sizeof($this->fileMemory) > 0) {
             foreach ($this->fileMemory as $file) {
                 if (Filesystem::isDirectory($file)) {
-                    $dontDelete = ['_site', '_media', '_pages', '_posts', '_docs', 'app', 'config', 'storage', 'vendor', 'node_modules'];
+                    $keep = ['_site', '_media', '_pages', '_posts', '_docs', 'app', 'config', 'storage', 'vendor', 'node_modules'];
 
-                    if (! in_array($file, $dontDelete)) {
+                    if (! in_array($file, $keep)) {
                         Filesystem::deleteDirectory($file);
                     }
                 } else {
-                    Filesystem::unlink($file);
+                    Filesystem::unlinkIfExists($file);
                 }
             }
+
             $this->fileMemory = [];
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -66,6 +66,14 @@ public function testUnlink()`
`66`	`66`	`$this->assertFileDoesNotExist(Hyde::path('foo'));`
`67`	`67`	`}`
`68`	`68`
	`69`	`+ public function testUnlinkIfExists()`
	`70`	`+ {`
	`71`	`+ touch(Hyde::path('foo'));`
	`72`	`+ Filesystem::unlinkIfExists('foo');`
	`73`	`+`
	`74`	`+ $this->assertFileDoesNotExist(Hyde::path('foo'));`
	`75`	`+ }`
	`76`	`+`
`69`	`77`	`public function testGetContents()`
`70`	`78`	`{`
`71`	`79`	`$this->createExpectation('get', 'string', Hyde::path('path'), false);`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,6 @@`
`5`	`5`	`use Hyde\Facades\Features;`
`6`	`6`	`use Hyde\Facades\Filesystem;`
`7`	`7`	`use Hyde\Framework\Actions\ConvertsArrayToFrontMatter;`
`8`		`-use Hyde\Hyde;`
`9`	`8`	`use Hyde\Pages\Concerns\HydePage;`
`10`	`9`	`use Hyde\Pages\MarkdownPage;`
`11`	`10`	`use Hyde\Support\Facades\Render;`
`@@ -96,9 +95,9 @@ protected function mockCurrentPage(string $currentPage)`
`96`	`95`	`protected function file(string $path, ?string $contents = null): void`
`97`	`96`	`{`
`98`	`97`	`if ($contents) {`
`99`		`- file_put_contents(Hyde::path($path), $contents);`
	`98`	`+ Filesystem::put($path, $contents);`
`100`	`99`	`} else {`
`101`		`- Hyde::touch($path);`
	`100`	`+ Filesystem::touch($path);`
`102`	`101`	`}`
`103`	`102`
`104`	`103`	`$this->cleanUpWhenDone($path);`
`@@ -128,15 +127,16 @@ protected function cleanUpFilesystem(): void`
`128`	`127`	`if (sizeof($this->fileMemory) > 0) {`
`129`	`128`	`foreach ($this->fileMemory as $file) {`
`130`	`129`	`if (Filesystem::isDirectory($file)) {`
`131`		`- $dontDelete = ['_site', '_media', '_pages', '_posts', '_docs', 'app', 'config', 'storage', 'vendor', 'node_modules'];`
	`130`	`+ $keep = ['_site', '_media', '_pages', '_posts', '_docs', 'app', 'config', 'storage', 'vendor', 'node_modules'];`
`132`	`131`
`133`		`- if (! in_array($file, $dontDelete)) {`
	`132`	`+ if (! in_array($file, $keep)) {`
`134`	`133`	`Filesystem::deleteDirectory($file);`
`135`	`134`	`}`
`136`	`135`	`} else {`
`137`		`- Filesystem::unlink($file);`
	`136`	`+ Filesystem::unlinkIfExists($file);`
`138`	`137`	`}`
`139`	`138`	`}`
	`139`	`+`
`140`	`140`	`$this->fileMemory = [];`
`141`	`141`	`}`
`142`	`142`	`}`