Add file compression feature

- Implement file compression functionality
- Use php-zip for compression
- Add tests for compression

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

Author: rcsofttech85

composer.json

@@ -1,28 +1,30 @@
 {
-    "name": "rcsofttech85/file-handler",
-    "description": "A simple library for abstracting various file operations and providing additional helper functions for file manipulation",
-    "type": "library",
-    "license": "MIT",
-    "autoload": {
-        "psr-4": {
-            "rcsofttech85\\FileHandler\\": "src/"
-        }
-    },
-    "authors": [
-        {
-            "name": "rahul",
-            "email": "[email protected]"
-        }
-    ],
-    "minimum-stability": "stable",
-    "require": {
-        "php": ">8.2",
-        "ext-sodium": "*",
-        "ext-ctype": "*"
-    },
-    "require-dev": {
-        "phpunit/phpunit": "^10",
-        "squizlabs/php_codesniffer": "^3.7",
-        "symfony/dotenv": "^6.3"
+  "name": "rcsofttech85/file-handler",
+  "description": "A simple library for abstracting various file operations and providing additional helper functions for file manipulation",
+  "type": "library",
+  "license": "MIT",
+  "autoload": {
+    "psr-4": {
+      "rcsofttech85\\FileHandler\\": "src/"
     }
+  },
+  "authors": [
+    {
+      "name": "rahul",
+      "email": "[email protected]"
+    }
+  ],
+  "minimum-stability": "stable",
+  "require": {
+    "php": ">8.2",
+    "ext-sodium": "*",
+    "ext-ctype": "*",
+    "ext-zip": "*"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^10",
+    "squizlabs/php_codesniffer": "^3.7",
+    "symfony/dotenv": "^6.3",
+    "ext-fileinfo": "*"
+  }
 }

src/FileHandler.php

@@ -4,6 +4,7 @@
 
 use Generator;
 use rcsofttech85\FileHandler\Exception\FileHandlerException;
+use ZipArchive;
 
 class FileHandler
 {
@@ -45,6 +46,29 @@ public function write(string $data, ?int $length = null): void
         }
     }
 
+    /**
+     * @throws FileHandlerException
+     */
+    public function compress(string $filename, string $zipFilename): void
+    {
+        if (!file_exists($filename)) {
+            throw new FileHandlerException('File to compress does not exist.');
+        }
+
+        $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.');
+        }
+
+
+        $zip->close();
+    }
+
     /**
      * @throws FileHandlerException
      */

tests/unit/FileHandlerTest.php

@@ -2,6 +2,7 @@
 
 namespace unit;
 
+use finfo;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\Attributes\TestDox;
@@ -134,6 +135,23 @@ public function studioIsFoundForExactNameMatch(string $keyword)
         $this->assertTrue($isStudioFound);
     }
 
+    #[Test]
+    public function successfulCompression()
+    {
+        $testFile = 'movie.csv';
+        $compressedZipFilename = 'compressed.zip';
+
+        $this->fileHandler->compress($testFile, $compressedZipFilename);
+
+        $fileInfo = new finfo(FILEINFO_MIME_TYPE);
+        $mimeType = $fileInfo->file($compressedZipFilename);
+
+        $this->assertFileExists($compressedZipFilename);
+        $this->assertEquals('application/zip', $mimeType);
+
+        unlink($compressedZipFilename);
+    }
+
     #[Test]
     public function toArrayMethodReturnsValidArray()
     {