refactor: creating one exception file per class

rcsofttech85 · rcsofttech85 · commit 8e294e8a80ca · 2023-09-04T09:44:12.000+05:30
Signed-off-by: rahul &lt;rcsofttech85@gmail.com&gt;
diff --git a/src/Exception/CouldNotWriteFileException.php b/src/Exception/CouldNotWriteFileException.php
diff --git a/src/Exception/FileEncryptorException.php b/src/Exception/FileEncryptorException.php
@@ -5,9 +5,9 @@
 use Exception;
 use Throwable;
 
-class FileNotClosedException extends Exception
+class FileEncryptorException extends Exception
 {
-    public function __construct($message = "Failed to close file", $code = 0, Throwable $previous = null)
+    public function __construct($message = "could not encrypt file", $code = 0, Throwable $previous = null)
     {
         parent::__construct($message, $code, $previous);
     }
diff --git a/src/Exception/FileHandlerException.php b/src/Exception/FileHandlerException.php
@@ -5,9 +5,9 @@
 use Exception;
 use Throwable;
 
-class FileNotFoundException extends Exception
+class FileHandlerException extends Exception
 {
-    public function __construct($message = "File not found", $code = 0, Throwable $previous = null)
+    public function __construct($message = "There was an error", $code = 0, Throwable $previous = null)
     {
         parent::__construct($message, $code, $previous);
     }
diff --git a/src/Exception/InvalidFileException.php b/src/Exception/InvalidFileException.php
diff --git a/src/FileEncryptor.php b/src/FileEncryptor.php
@@ -3,31 +3,33 @@
 namespace rcsofttech85\FileHandler;
 
 use Exception;
-use rcsofttech85\FileHandler\Exception\FileNotFoundException;
+use rcsofttech85\FileHandler\Exception\FileEncryptorException;
 use SensitiveParameter;
 use SodiumException;
 
-class FileEncryptor
+readonly class FileEncryptor
 {
     public function __construct(
-        private readonly string $filename,
-        #[SensitiveParameter] private readonly string $secret
+        private string $filename,
+        #[SensitiveParameter] private string $secret
     ) {
     }
 
     /**
-     * @throws SodiumException
+     *
+     * @throws FileEncryptorException
      * @throws Exception
+     *
      */
     public function encryptFile(): bool
     {
         $plainText = file_get_contents($this->filename);
 
         if (!$plainText) {
-            throw new FileNotFoundException('File not found or has no content');
+            throw new FileEncryptorException('File not found or has no content');
         }
         if (ctype_xdigit($plainText)) {
-            throw new SodiumException('file is already encrypted');
+            throw new FileEncryptorException('file is already encrypted');
         }
 
 
@@ -53,18 +55,21 @@ public function encryptFile(): bool
     }
 
     /**
+     *
+     * @throws FileEncryptorException
      * @throws SodiumException
+     *
      */
     public function decryptFile(): bool
     {
         $encryptedData = file_get_contents($this->filename);
 
         if (!$encryptedData) {
-            throw new FileNotFoundException('File not found or has no content');
+            throw new FileEncryptorException('File not found or has no content');
         }
 
         if (!ctype_xdigit($encryptedData)) {
-            throw new SodiumException('file is not encrypted');
+            throw new FileEncryptorException('file is not encrypted');
         }
 
         $bytes = hex2bin($encryptedData);
@@ -76,7 +81,7 @@ public function decryptFile(): bool
         $plaintext = sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
 
         if (!$plaintext) {
-            throw new SodiumException('could not decrypt file');
+            throw new FileEncryptorException('could not decrypt file');
         }
 
 
diff --git a/src/FileHandler.php b/src/FileHandler.php
@@ -3,10 +3,7 @@
 namespace rcsofttech85\FileHandler;
 
 use Generator;
-use rcsofttech85\FileHandler\Exception\CouldNotWriteFileException;
-use rcsofttech85\FileHandler\Exception\FileNotClosedException;
-use rcsofttech85\FileHandler\Exception\FileNotFoundException;
-use rcsofttech85\FileHandler\Exception\InvalidFileException;
+use rcsofttech85\FileHandler\Exception\FileHandlerException;
 
 class FileHandler
 {
@@ -15,7 +12,7 @@ class FileHandler
     private array $files = [];
 
     /**
-     * @throws FileNotFoundException
+     * @throws FileHandlerException
      */
     public function open(
         string $filename,
@@ -26,7 +23,7 @@ public function open(
         $file = fopen($filename, $mode, $include_path, $context);
 
         if (!$file) {
-            throw new FileNotFoundException();
+            throw new FileHandlerException('File not found');
         }
 
         $this->files[] = $file;
@@ -36,7 +33,7 @@ public function open(
 
 
     /**
-     * @throws CouldNotWriteFileException
+     * @throws FileHandlerException
      */
     public function write(string $data, ?int $length = null): void
     {
@@ -46,18 +43,18 @@ public function write(string $data, ?int $length = null): void
                 continue;
             }
 
-            throw new CouldNotWriteFileException();
+            throw new FileHandlerException('Error writing to file');
         }
     }
 
     /**
-     * @throws FileNotClosedException
+     * @throws FileHandlerException
      */
     public function close(): void
     {
         foreach ($this->files as $file) {
             if (!fclose($file)) {
-                throw new FileNotClosedException();
+                throw new FileHandlerException('file was not closed');
             }
         }
     }
@@ -68,7 +65,7 @@ public function searchInCsvFile(string $keyword, string $column, string|null $fo
     }
 
     /**
-     * @throws InvalidFileException
+     * @throws FileHandlerException
      */
     public function toArray(): array
     {
@@ -77,7 +74,7 @@ public function toArray(): array
 
 
     /**
-     * @throws InvalidFileException
+     * @throws FileHandlerException
      */
     public function toJson(): string
     {
@@ -86,13 +83,22 @@ public function toJson(): string
         return json_encode($data);
     }
 
+    public function delete()
+    {
+        foreach ($this->files as $file) {
+            if (!unlink($file)) {
+                throw new FileHandlerException('could not delete file');
+            }
+        }
+    }
+
     /**
-     * @throws InvalidFileException
+     * @throws FileHandlerException
      */
     private function getRows(): Generator
     {
         if (count($this->files) > 1) {
-            throw new InvalidFileException("multiple files not allowed");
+            throw new FileHandlerException("multiple files not allowed");
         }
 
         $file = $this->files[0];
@@ -110,13 +116,13 @@ private function getRows(): Generator
         fclose($file);
 
         if ($isEmptyFile) {
-            throw new InvalidFileException('invalid file format');
+            throw new FileHandlerException('invalid file format');
         }
     }
 
 
     /**
-     * @throws InvalidFileException
+     * @throws FileHandlerException
      */
     private function search(string $keyword, string $column, string|null $format): bool|array
     {
@@ -129,12 +135,12 @@ private function search(string $keyword, string $column, string|null $format): b
     }
 
     /**
-     * @throws InvalidFileException
+     * @throws FileHandlerException
      */
     private function isValidCsvFileFormat(array|false $row): void
     {
         if (!$row || count($row) <= 1) {
-            throw new InvalidFileException('invalid file format');
+            throw new FileHandlerException('invalid file format');
         }
     }
 }
diff --git a/tests/unit/FileEncryptorTest.php b/tests/unit/FileEncryptorTest.php
@@ -4,8 +4,8 @@
 
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\TestCase;
+use rcsofttech85\FileHandler\Exception\FileEncryptorException;
 use rcsofttech85\FileHandler\FileEncryptor;
-use SodiumException;
 use Symfony\Component\Dotenv\Dotenv;
 
 class FileEncryptorTest extends TestCase
@@ -38,7 +38,7 @@ public static function tearDownAfterClass(): void
     #[Test]
     public function throwExceptionOnDecryptingNonEncryptedFile()
     {
-        $this->expectException(SodiumException::class);
+        $this->expectException(FileEncryptorException::class);
         $this->expectExceptionMessage('file is not encrypted');
         $this->fileEncryptor->decryptFile();
     }
@@ -54,7 +54,7 @@ public function canEncryptFile()
     #[Test]
     public function throwExceptionIfAlreadyEncrypted()
     {
-        $this->expectException(SodiumException::class);
+        $this->expectException(FileEncryptorException::class);
         $this->expectExceptionMessage('file is already encrypted');
         $this->fileEncryptor->encryptFile();
     }
@@ -63,7 +63,7 @@ public function throwExceptionIfAlreadyEncrypted()
     public function throwExceptionIfDecryptionFails()
     {
         $this->fileEncryptor = new FileEncryptor("movie.csv", 'wrongSecret');
-        $this->expectException(SodiumException::class);
+        $this->expectException(FileEncryptorException::class);
         $this->expectExceptionMessage('could not decrypt file');
         $this->fileEncryptor->decryptFile();
     }
diff --git a/tests/unit/FileHandlerTest.php b/tests/unit/FileHandlerTest.php
@@ -6,9 +6,7 @@
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\Attributes\TestDox;
 use PHPUnit\Framework\TestCase;
-use rcsofttech85\FileHandler\Exception\CouldNotWriteFileException;
-use rcsofttech85\FileHandler\Exception\FileNotFoundException;
-use rcsofttech85\FileHandler\Exception\InvalidFileException;
+use rcsofttech85\FileHandler\Exception\FileHandlerException;
 use rcsofttech85\FileHandler\FileHandler;
 use TypeError;
 
@@ -54,7 +52,7 @@ public function fileSuccessfullyWritten()
     #[Test]
     public function shouldThrowExceptionIfFileIsNotFound()
     {
-        $this->expectException(FileNotFoundException::class);
+        $this->expectException(FileHandlerException::class);
         $this->expectExceptionMessage('File not found');
         $this->fileHandler->open(filename: 'unknown');
     }
@@ -64,7 +62,7 @@ public function shouldThrowExceptionIfFileIsNotWritable()
     {
         $this->fileHandler->open(filename: 'file', mode: 'r');
 
-        $this->expectException(CouldNotWriteFileException::class);
+        $this->expectException(FileHandlerException::class);
         $this->expectExceptionMessage('Error writing to file');
         $this->fileHandler->write(data: "hello world");
     }
@@ -180,7 +178,7 @@ public function searchByKeywordAndReturnArray()
     #[DataProvider('fileProvider')]
     public function throwErrorIfFileFormatIsInvalid(string $file)
     {
-        $this->expectException(InvalidFileException::class);
+        $this->expectException(FileHandlerException::class);
         $this->expectExceptionMessage('invalid file format');
 
         try {

Original file line number	Diff line number	Diff line change
`@@ -5,9 +5,9 @@`
`5`	`5`	`use Exception;`
`6`	`6`	`use Throwable;`
`7`	`7`
`8`		`-class FileNotClosedException extends Exception`
	`8`	`+class FileEncryptorException extends Exception`
`9`	`9`	`{`
`10`		`- public function __construct($message = "Failed to close file", $code = 0, Throwable $previous = null)`
	`10`	`+ public function __construct($message = "could not encrypt file", $code = 0, Throwable $previous = null)`
`11`	`11`	`{`
`12`	`12`	`parent::__construct($message, $code, $previous);`
`13`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,10 +3,7 @@`
`3`	`3`	`namespace rcsofttech85\FileHandler;`
`4`	`4`
`5`	`5`	`use Generator;`
`6`		`-use rcsofttech85\FileHandler\Exception\CouldNotWriteFileException;`
`7`		`-use rcsofttech85\FileHandler\Exception\FileNotClosedException;`
`8`		`-use rcsofttech85\FileHandler\Exception\FileNotFoundException;`
`9`		`-use rcsofttech85\FileHandler\Exception\InvalidFileException;`
	`6`	`+use rcsofttech85\FileHandler\Exception\FileHandlerException;`
`10`	`7`
`11`	`8`	`class FileHandler`
`12`	`9`	`{`
`@@ -15,7 +12,7 @@ class FileHandler`
`15`	`12`	`private array $files = [];`
`16`	`13`
`17`	`14`	`/**`
`18`		`- * @throws FileNotFoundException`
	`15`	`+ * @throws FileHandlerException`
`19`	`16`	`*/`
`20`	`17`	`public function open(`
`21`	`18`	`string $filename,`
`@@ -26,7 +23,7 @@ public function open(`
`26`	`23`	`$file = fopen($filename, $mode, $include_path, $context);`
`27`	`24`
`28`	`25`	`if (!$file) {`
`29`		`- throw new FileNotFoundException();`
	`26`	`+ throw new FileHandlerException('File not found');`
`30`	`27`	`}`
`31`	`28`
`32`	`29`	`$this->files[] = $file;`
`@@ -36,7 +33,7 @@ public function open(`
`36`	`33`
`37`	`34`
`38`	`35`	`/**`
`39`		`- * @throws CouldNotWriteFileException`
	`36`	`+ * @throws FileHandlerException`
`40`	`37`	`*/`
`41`	`38`	`public function write(string $data, ?int $length = null): void`
`42`	`39`	`{`
`@@ -46,18 +43,18 @@ public function write(string $data, ?int $length = null): void`
`46`	`43`	`continue;`
`47`	`44`	`}`
`48`	`45`
`49`		`- throw new CouldNotWriteFileException();`
	`46`	`+ throw new FileHandlerException('Error writing to file');`
`50`	`47`	`}`
`51`	`48`	`}`
`52`	`49`
`53`	`50`	`/**`
`54`		`- * @throws FileNotClosedException`
	`51`	`+ * @throws FileHandlerException`
`55`	`52`	`*/`
`56`	`53`	`public function close(): void`
`57`	`54`	`{`
`58`	`55`	`foreach ($this->files as $file) {`
`59`	`56`	`if (!fclose($file)) {`
`60`		`- throw new FileNotClosedException();`
	`57`	`+ throw new FileHandlerException('file was not closed');`
`61`	`58`	`}`
`62`	`59`	`}`
`63`	`60`	`}`
`@@ -68,7 +65,7 @@ public function searchInCsvFile(string $keyword, string $column, string\|null $fo`
`68`	`65`	`}`
`69`	`66`
`70`	`67`	`/**`
`71`		`- * @throws InvalidFileException`
	`68`	`+ * @throws FileHandlerException`
`72`	`69`	`*/`
`73`	`70`	`public function toArray(): array`
`74`	`71`	`{`
`@@ -77,7 +74,7 @@ public function toArray(): array`
`77`	`74`
`78`	`75`
`79`	`76`	`/**`
`80`		`- * @throws InvalidFileException`
	`77`	`+ * @throws FileHandlerException`
`81`	`78`	`*/`
`82`	`79`	`public function toJson(): string`
`83`	`80`	`{`
`@@ -86,13 +83,22 @@ public function toJson(): string`
`86`	`83`	`return json_encode($data);`
`87`	`84`	`}`
`88`	`85`
	`86`	`+ public function delete()`
	`87`	`+ {`
	`88`	`+ foreach ($this->files as $file) {`
	`89`	`+ if (!unlink($file)) {`
	`90`	`+ throw new FileHandlerException('could not delete file');`
	`91`	`+ }`
	`92`	`+ }`
	`93`	`+ }`
	`94`	`+`
`89`	`95`	`/**`
`90`		`- * @throws InvalidFileException`
	`96`	`+ * @throws FileHandlerException`
`91`	`97`	`*/`
`92`	`98`	`private function getRows(): Generator`
`93`	`99`	`{`
`94`	`100`	`if (count($this->files) > 1) {`
`95`		`- throw new InvalidFileException("multiple files not allowed");`
	`101`	`+ throw new FileHandlerException("multiple files not allowed");`
`96`	`102`	`}`
`97`	`103`
`98`	`104`	`$file = $this->files[0];`
`@@ -110,13 +116,13 @@ private function getRows(): Generator`
`110`	`116`	`fclose($file);`
`111`	`117`
`112`	`118`	`if ($isEmptyFile) {`
`113`		`- throw new InvalidFileException('invalid file format');`
	`119`	`+ throw new FileHandlerException('invalid file format');`
`114`	`120`	`}`
`115`	`121`	`}`
`116`	`122`
`117`	`123`
`118`	`124`	`/**`
`119`		`- * @throws InvalidFileException`
	`125`	`+ * @throws FileHandlerException`
`120`	`126`	`*/`
`121`	`127`	`private function search(string $keyword, string $column, string\|null $format): bool\|array`
`122`	`128`	`{`
`@@ -129,12 +135,12 @@ private function search(string $keyword, string $column, string\|null $format): b`
`129`	`135`	`}`
`130`	`136`
`131`	`137`	`/**`
`132`		`- * @throws InvalidFileException`
	`138`	`+ * @throws FileHandlerException`
`133`	`139`	`*/`
`134`	`140`	`private function isValidCsvFileFormat(array\|false $row): void`
`135`	`141`	`{`
`136`	`142`	`if (!$row \|\| count($row) <= 1) {`
`137`		`- throw new InvalidFileException('invalid file format');`
	`143`	`+ throw new FileHandlerException('invalid file format');`
`138`	`144`	`}`
`139`	`145`	`}`
`140`	`146`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,8 @@`
`4`	`4`
`5`	`5`	`use PHPUnit\Framework\Attributes\Test;`
`6`	`6`	`use PHPUnit\Framework\TestCase;`
	`7`	`+use rcsofttech85\FileHandler\Exception\FileEncryptorException;`
`7`	`8`	`use rcsofttech85\FileHandler\FileEncryptor;`
`8`		`-use SodiumException;`
`9`	`9`	`use Symfony\Component\Dotenv\Dotenv;`
`10`	`10`
`11`	`11`	`class FileEncryptorTest extends TestCase`
`@@ -38,7 +38,7 @@ public static function tearDownAfterClass(): void`
`38`	`38`	`#[Test]`
`39`	`39`	`public function throwExceptionOnDecryptingNonEncryptedFile()`
`40`	`40`	`{`
`41`		`- $this->expectException(SodiumException::class);`
	`41`	`+ $this->expectException(FileEncryptorException::class);`
`42`	`42`	`$this->expectExceptionMessage('file is not encrypted');`
`43`	`43`	`$this->fileEncryptor->decryptFile();`
`44`	`44`	`}`
`@@ -54,7 +54,7 @@ public function canEncryptFile()`
`54`	`54`	`#[Test]`
`55`	`55`	`public function throwExceptionIfAlreadyEncrypted()`
`56`	`56`	`{`
`57`		`- $this->expectException(SodiumException::class);`
	`57`	`+ $this->expectException(FileEncryptorException::class);`
`58`	`58`	`$this->expectExceptionMessage('file is already encrypted');`
`59`	`59`	`$this->fileEncryptor->encryptFile();`
`60`	`60`	`}`
`@@ -63,7 +63,7 @@ public function throwExceptionIfAlreadyEncrypted()`
`63`	`63`	`public function throwExceptionIfDecryptionFails()`
`64`	`64`	`{`
`65`	`65`	`$this->fileEncryptor = new FileEncryptor("movie.csv", 'wrongSecret');`
`66`		`- $this->expectException(SodiumException::class);`
	`66`	`+ $this->expectException(FileEncryptorException::class);`
`67`	`67`	`$this->expectExceptionMessage('could not decrypt file');`
`68`	`68`	`$this->fileEncryptor->decryptFile();`
`69`	`69`	`}`