Merge pull request #1081 from hydephp/update-FileConflictException-class

emmadesilva · web-flow · commit d5bb9f4856f8 · 2023-02-21T10:54:26.000+01:00
Update FileConflictException message to turn absolute paths to relative
diff --git a/packages/framework/src/Framework/Exceptions/FileConflictException.php b/packages/framework/src/Framework/Exceptions/FileConflictException.php
@@ -5,6 +5,7 @@
 namespace Hyde\Framework\Exceptions;
 
 use Exception;
+use Hyde\Hyde;
 
 class FileConflictException extends Exception
 {
@@ -16,7 +17,7 @@ class FileConflictException extends Exception
 
     public function __construct(?string $path = null, ?string $message = null)
     {
-        $this->message = $message ?? ($path ? "File already exists: $path" : $this->message);
+        $this->message = $message ?? ($path ? sprintf('File already exists: %s', Hyde::pathToRelative($path)) : $this->message);
 
         parent::__construct($this->message, $this->code);
     }
diff --git a/packages/framework/tests/Feature/Actions/CreatesNewPageSourceFileTest.php b/packages/framework/tests/Feature/Actions/CreatesNewPageSourceFileTest.php
@@ -39,7 +39,7 @@ public function test_that_an_exception_is_thrown_if_file_already_exists_and_over
         $this->file('_pages/foo.md', 'foo');
 
         $this->expectException(FileConflictException::class);
-        $this->expectExceptionMessage('File already exists: '.Hyde::path('_pages/foo.md'));
+        $this->expectExceptionMessage('File already exists: _pages/foo.md');
         $this->expectExceptionCode(409);
 
         new CreatesNewPageSourceFile('foo');
@@ -61,7 +61,7 @@ public function test_exception_is_thrown_for_conflicting_blade_pages()
         $this->file('_pages/foo.blade.php', 'foo');
 
         $this->expectException(FileConflictException::class);
-        $this->expectExceptionMessage('File already exists: '.Hyde::path('_pages/foo.blade.php'));
+        $this->expectExceptionMessage('File already exists: _pages/foo.blade.php');
         $this->expectExceptionCode(409);
 
         new CreatesNewPageSourceFile('foo', BladePage::class);
@@ -74,7 +74,7 @@ public function test_exception_is_thrown_for_conflicting_documentation_pages()
         $this->file('_docs/foo.md', 'foo');
 
         $this->expectException(FileConflictException::class);
-        $this->expectExceptionMessage('File already exists: '.Hyde::path('_docs/foo.md'));
+        $this->expectExceptionMessage('File already exists: _docs/foo.md');
         $this->expectExceptionCode(409);
 
         new CreatesNewPageSourceFile('foo', DocumentationPage::class);
diff --git a/packages/framework/tests/Feature/Commands/MakePageCommandTest.php b/packages/framework/tests/Feature/Commands/MakePageCommandTest.php
@@ -98,7 +98,7 @@ public function test_command_fails_if_file_already_exists()
         file_put_contents($this->markdownPath, 'This should not be overwritten');
 
         $this->expectException(FileConflictException::class);
-        $this->expectExceptionMessage("File already exists: $this->markdownPath");
+        $this->expectExceptionMessage('File already exists: _pages/foo-test-page.md');
         $this->expectExceptionCode(409);
         $this->artisan('make:page "foo test page"')->assertExitCode(409);
 
diff --git a/packages/framework/tests/Unit/FileConflictExceptionTest.php b/packages/framework/tests/Unit/FileConflictExceptionTest.php
@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Hyde\Framework\Testing\Unit;
+
+use Hyde\Foundation\HydeKernel;
+use Hyde\Framework\Exceptions\FileConflictException;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \Hyde\Framework\Exceptions\FileConflictException
+ */
+class FileConflictExceptionTest extends TestCase
+{
+    public function test_it_can_be_instantiated()
+    {
+        $this->assertInstanceOf(FileConflictException::class, new FileConflictException());
+    }
+
+    public function test_it_can_be_thrown()
+    {
+        $this->expectException(FileConflictException::class);
+
+        throw new FileConflictException();
+    }
+
+    public function test_exception_code()
+    {
+        $this->assertSame(409, (new FileConflictException())->getCode());
+    }
+
+    public function test_exception_message()
+    {
+        $this->assertSame('A file already exists at this path.', (new FileConflictException())->getMessage());
+    }
+
+    public function test_exception_message_with_path()
+    {
+        HydeKernel::setInstance(new HydeKernel('my-base-path'));
+        $this->assertSame('File already exists: path/to/file', (new FileConflictException('path/to/file'))->getMessage());
+    }
+
+    public function test_exception_message_with_absolute_path()
+    {
+        HydeKernel::setInstance(new HydeKernel('my-base-path'));
+        $this->assertSame('File already exists: path/to/file', (new FileConflictException('my-base-path/path/to/file'))->getMessage());
+    }
+
+    public function test_exception_message_with_custom_message()
+    {
+        $this->assertSame('Custom message', (new FileConflictException(null, 'Custom message'))->getMessage());
+    }
+
+    public function test_exception_message_with_custom_message_and_path()
+    {
+        $this->assertSame('Custom message', (new FileConflictException('foo', 'Custom message'))->getMessage());
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`namespace Hyde\Framework\Exceptions;`
`6`	`6`
`7`	`7`	`use Exception;`
	`8`	`+use Hyde\Hyde;`
`8`	`9`
`9`	`10`	`class FileConflictException extends Exception`
`10`	`11`	`{`
`@@ -16,7 +17,7 @@ class FileConflictException extends Exception`
`16`	`17`
`17`	`18`	`public function __construct(?string $path = null, ?string $message = null)`
`18`	`19`	`{`
`19`		`- $this->message = $message ?? ($path ? "File already exists: $path" : $this->message);`
	`20`	`+ $this->message = $message ?? ($path ? sprintf('File already exists: %s', Hyde::pathToRelative($path)) : $this->message);`
`20`	`21`
`21`	`22`	`parent::__construct($this->message, $this->code);`
`22`	`23`	`}`