code coverage (#50)

test code coverage
Signed-off-by: rahul <[email protected]>

Author: rcsofttech85

src/CsvFileHandler.php

@@ -76,20 +76,20 @@ public function findAndReplaceInCsv(
         string $filename,
         string $keyword,
         string $replace,
-        string|null $column = null
+        string|null $column = null,
+        string|null $dirName = null
     ): bool {
         $headers = $this->extractHeader($filename);
 
         if (!$headers) {
             throw new FileHandlerException('failed to extract header');
         }
 
-        $tempFilePath = $this->tempFileHandler->createTempFileWithHeaders($headers);
+        $tempFilePath = $this->tempFileHandler->createTempFileWithHeaders($headers, $dirName);
         if (!$tempFilePath) {
-            return false;
+            throw new FileHandlerException('could not create temp file');
         }
 
-
         try {
             $count = 0;
             foreach ($this->getRows($filename) as $row) {
@@ -168,11 +168,7 @@ private function isValidCsvFileFormat(array $row): bool
     private function getRows(string $filename, array|false $hideColumns = false, int|false $limit = false): Generator
     {
         $filename = $this->validateFileName($filename);
-        $csvFile = fopen($filename, 'r');
-        if (!$csvFile) {
-            throw new FileHandlerException('file not found');
-        }
-
+        $csvFile = $this->openFileAndReturnResource($filename, 'r');
         $headers = $this->extractHeader($csvFile);
         if (!is_array($headers)) {
             fclose($csvFile);

src/DependencyInjection/ServiceContainer.php

@@ -19,7 +19,10 @@ public function getContainerBuilder(): ContainerBuilder
         $loader = new YamlFileLoader($containerBuilder, new FileLocator(__DIR__ . '/../../src/config'));
         $loader->load('services.yaml');
 
-        $containerBuilder->setParameter('STORED_HASH_FILE', $_ENV['STORED_HASH_FILE']);
+        foreach ($_ENV as $key => $value) {
+            $containerBuilder->setParameter($key, $value);
+        }
+
 
         return $containerBuilder;
     }

src/FileEncryptor.php

@@ -54,10 +54,7 @@ public function encryptFile(): bool
 
         $output = bin2hex($nonce . $ciphertext);
 
-        $file = fopen($this->filename, 'w');
-        if (!$file) {
-            return false;
-        }
+        $file = $this->openFileAndReturnResource($this->filename);
 
         try {
             fwrite($file, $output);
@@ -69,10 +66,10 @@ public function encryptFile(): bool
     }
 
     /**
-     *
+     * @return bool
      * @throws FileEncryptorException
+     * @throws FileHandlerException
      * @throws SodiumException
-     *
      */
     public function decryptFile(): bool
     {
@@ -86,10 +83,8 @@ public function decryptFile(): bool
             throw new FileEncryptorException('file is not encrypted');
         }
 
-        $bytes = hex2bin($encryptedData);
-        if (!$bytes) {
-            return false;
-        }
+        $bytes = $this->convertHexToBin($encryptedData);
+
         $nonce = substr($bytes, 0, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
         $ciphertext = substr($bytes, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
 
@@ -102,10 +97,7 @@ public function decryptFile(): bool
         }
 
 
-        $file = fopen($this->filename, 'w');
-        if (!$file) {
-            return false;
-        }
+        $file = $this->openFileAndReturnResource($this->filename);
 
         try {
             fwrite($file, $plaintext);
@@ -115,4 +107,18 @@ public function decryptFile(): bool
 
         return true;
     }
+
+    /**
+     * @param string $encryptedData
+     * @return string
+     * @throws FileEncryptorException
+     */
+    public function convertHexToBin(string $encryptedData): string
+    {
+        $bytes = hex2bin($encryptedData);
+        if (!$bytes) {
+            throw new FileEncryptorException('could not convert hex to bin');
+        }
+        return $bytes;
+    }
 }

src/FileHandler.php

@@ -63,34 +63,32 @@ public function write(string $data, ?int $length = null): void
     /**
      * @throws FileHandlerException
      */
-    public function compress(string $filename, string $zipFilename): void
+    public function compress(string $filename, string $zipFilename, int $flag = ZipArchive::CREATE): void
     {
         $filename = $this->validateFileName($filename);
 
         $zip = new ZipArchive();
 
-        if (!$zip->open($zipFilename, ZipArchive::CREATE)) {
-            throw new FileHandlerException('Failed to create the ZIP archive.');
-        }
 
-        if (!$zip->addFile($filename)) {
-            throw new FileHandlerException('Failed to add the file to the ZIP archive.');
+        if (true !== $zip->open($zipFilename, $flag)) {
+            throw new FileHandlerException('Failed to create the ZIP archive.');
         }
 
-
+        $zip->addFile($filename);
         $zip->close();
     }
 
     /**
      * @throws FileHandlerException
      */
-    public function getMimeType(string $filename): string
+    public function getMimeType(string $filename): string|false
     {
         $filename = $this->validateFileName($filename);
 
+
         $fileInfo = new finfo(FILEINFO_MIME_TYPE);
         $mimeType = $fileInfo->file($filename);
-        if (!$mimeType) {
+        if ($mimeType === 'application/octet-stream') {
             throw new FileHandlerException('unknown mime type');
         }
 
@@ -100,35 +98,29 @@ public function getMimeType(string $filename): string
     /**
      * @throws FileHandlerException
      */
-    public function decompress(string $zipFilename, string $extractPath = "./"): void
+    public function decompress(string $zipFilename, string $extractPath = "./", int $flag = ZipArchive::CREATE): void
     {
         $zipFilename = $this->validateFileName($zipFilename);
 
         $zip = new ZipArchive();
 
-        if (!$zip->open($zipFilename)) {
-            throw new FileHandlerException('Failed to open the ZIP archive.');
+        if (true !== $zip->open($zipFilename, $flag)) {
+            throw new FileHandlerException('Invalid or uninitialized Zip object');
         }
 
+
         if (!$zip->extractTo($extractPath)) {
             throw new FileHandlerException('Failed to extract the ZIP archive.');
         }
 
         $zip->close();
     }
 
-    /**
-     * @throws FileHandlerException
-     */
+
     public function close(): void
     {
-        if (!$this->files) {
-            throw new FileHandlerException('no files are opened');
-        }
         foreach ($this->files as $file) {
-            if (!fclose($file)) {
-                throw new FileHandlerException('file was not closed');
-            }
+            fclose($file);
         }
         $this->resetFiles();
     }

src/FileHashChecker.php

@@ -66,8 +66,11 @@ public function verifyHash(string $filename, string $algo = self::ALGO_256): boo
      * @throws HashException|FileHandlerException
      */
 
-    public function hashFile(string $filename, string $algo = self::ALGO_256): string
-    {
+    public function hashFile(
+        string $filename,
+        string $algo = self::ALGO_256,
+        string $env = self::STORED_HASH_FILE
+    ): string {
         $this->validateFileName($filename);
         if (!in_array($algo, [self::ALGO_512, self::ALGO_256])) {
             throw new HashException('algorithm not supported');
@@ -77,7 +80,7 @@ public function hashFile(string $filename, string $algo = self::ALGO_256): strin
             throw new HashException('could not hash file');
         }
 
-        $storedHashesFile = $this->getParameter(self::STORED_HASH_FILE);
+        $storedHashesFile = $this->getParameter($env);
 
 
         $file = fopen($storedHashesFile, 'a+');
@@ -111,7 +114,7 @@ public function hashFile(string $filename, string $algo = self::ALGO_256): strin
      * @param mixed $storedHashFile
      * @return void
      */
-    private function checkHeaderExists(mixed $storedHashFile): void
+    public function checkHeaderExists(mixed $storedHashFile): void
     {
         $header = fgetcsv($storedHashFile);
 

src/JsonFileHandler.php

@@ -86,8 +86,7 @@ public function getRows(
         array &$headers,
         array|false $hideColumns = false,
         int|false $limit = false
-    ): Generator
-    {
+    ): Generator {
         $contents = $this->validateFile($filename);
 
         $headers = array_keys($contents[0]);

src/TempFileHandler.php

@@ -3,9 +3,18 @@
 namespace Rcsofttech85\FileHandler;
 
 use Rcsofttech85\FileHandler\Exception\FileHandlerException;
+use Rcsofttech85\FileHandler\Validator\FileValidatorTrait;
 
 class TempFileHandler
 {
+    use FileValidatorTrait;
+
+    /**
+     * @param string $tempFilePath
+     * @param string $filename
+     * @return void
+     * @throws FileHandlerException
+     */
     public function renameTempFile(string $tempFilePath, string $filename): void
     {
         if (!rename($tempFilePath, $filename)) {
@@ -39,6 +48,7 @@ public function writeRowToTempFile(string $tempFilePath, array $row): void
      * @param string|null $dirName
      * @param string|null $prefix
      * @return string|false
+     * @throws FileHandlerException
      */
     public function createTempFileWithHeaders(
         array $headers,
@@ -57,11 +67,10 @@ public function createTempFileWithHeaders(
         if (!$tempFilePath) {
             return false;
         }
-        $tempFileHandle = fopen($tempFilePath, 'w');
-        if ($tempFileHandle) {
-            fputs($tempFileHandle, implode(',', $headers) . PHP_EOL);
-            fclose($tempFileHandle);
-        }
+        $tempFileHandle = $this->openFileAndReturnResource($tempFilePath);
+
+        fputs($tempFileHandle, implode(',', $headers) . PHP_EOL);
+        fclose($tempFileHandle);
 
 
         return $tempFilePath;

src/Validator/FileValidatorTrait.php

@@ -4,6 +4,7 @@
 
 use Rcsofttech85\FileHandler\DependencyInjection\ServiceContainer;
 use Rcsofttech85\FileHandler\Exception\FileHandlerException;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 trait FileValidatorTrait
 {
@@ -30,10 +31,6 @@ public function validateFileName(string $filename, string|null $path = null): st
             $filename = $absolutePath . DIRECTORY_SEPARATOR . $filename;
         }
 
-
-        if (!file_exists($filename)) {
-            throw new FileHandlerException('file not found');
-        }
         return $filename;
     }
 
@@ -51,44 +48,72 @@ public function sanitize(string $filename): string
     }
 
     /**
+     * @param string $filename
+     * @param string $envVariable
+     * @return bool
      * @throws FileHandlerException
      */
     private function isFileSafe(string $filename, string $envVariable): bool
     {
         $safeFile = $this->getParameter($envVariable);
 
+
         if ($safeFile !== $filename) {
             return false;
         }
-        if (!file_exists($safeFile)) {
-            throw new FileHandlerException('env variable does not contain a valid file path');
-        }
-
 
         return true;
     }
 
     /**
-     * @throws FileHandlerException
+     * @param string $filename
+     * @param string $envVariable
+     * @return bool
      */
     public function isFileRestricted(string $filename, string $envVariable): bool
     {
         return $this->isFileSafe($filename, $envVariable);
     }
 
     /**
+     * @param string $param
+     * @return string
      * @throws FileHandlerException
      */
     private function getParameter(string $param): string
     {
         $container = (new ServiceContainer())->getContainerBuilder();
+        return $this->getParam($container, $param);
+    }
 
-        $parameter = $container->getParameter($param);
-
-        if (!is_string($parameter)) {
-            throw new FileHandlerException("{$param} is expected to be string");
+    /**
+     * @param ContainerBuilder $container
+     * @param string $parameter
+     * @return string
+     * @throws FileHandlerException
+     */
+    public function getParam(ContainerBuilder $container, string $parameter): string
+    {
+        $param = $container->getParameter($parameter);
+        if (!is_string($param)) {
+            throw new FileHandlerException("{$parameter} is not string type");
         }
 
-        return $parameter;
+        return $param;
+    }
+
+    /**
+     * @param string $filename
+     * @param string $mode
+     * @return mixed
+     * @throws FileHandlerException
+     */
+    public function openFileAndReturnResource(string $filename, string $mode = 'w'): mixed
+    {
+        $file = fopen($filename, $mode);
+        if (!$file) {
+            throw new FileHandlerException('file is not valid');
+        }
+        return $file;
     }
 }

tests/Integration/StreamHandlerTest.php

@@ -18,7 +18,7 @@ class StreamHandlerTest extends BaseTest
     public static function setUpBeforeClass(): void
     {
         parent::setUpBeforeClass();
-        static::$files = ["output.html", "output1.html", "output2.html"];
+        static::$files = ["output.html", "output1.html", "output2.html", "profile"];
     }
 
     public static function tearDownAfterClass(): void