check if the file is a valid csv

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

Author: rcsofttech85

src/FileHandler.php

@@ -14,6 +14,9 @@ class FileHandler
 
     private array $files = [];
 
+    /**
+     * @throws FileNotFoundException
+     */
     public function open(
         string $filename,
         string $mode = "r+",
@@ -32,6 +35,9 @@ public function open(
     }
 
 
+    /**
+     * @throws CouldNotWriteFileException
+     */
     public function write(string $data, ?int $length = null): void
     {
         foreach ($this->files as $file) {
@@ -44,6 +50,9 @@ public function write(string $data, ?int $length = null): void
         }
     }
 
+    /**
+     * @throws FileNotClosedException
+     */
     public function close(): void
     {
         foreach ($this->files as $file) {
@@ -63,6 +72,9 @@ public function toArray(): array
         return iterator_to_array($this->getRows());
     }
 
+    /**
+     * @throws InvalidFileException
+     */
     private function getRows(): Generator
     {
         if (count($this->files) > 1) {
@@ -71,14 +83,27 @@ private function getRows(): Generator
 
         $file = $this->files[0];
         $headers = fgetcsv($file);
+
+        $this->isValidCsvFileFormat($headers);
+
+        $isEmptyFile = true;
         while (($row = fgetcsv($file)) !== false) {
+            $isEmptyFile = false;
+            $this->isValidCsvFileFormat($row);
             $item = array_combine($headers, $row);
             yield $item;
         }
         fclose($file);
+
+        if ($isEmptyFile) {
+            throw new InvalidFileException('invalid file format');
+        }
     }
 
 
+    /**
+     * @throws InvalidFileException
+     */
     private function search(string $keyword, string $column, string|null $format): bool|array
     {
         foreach ($this->getRows() as $row) {
@@ -88,4 +113,14 @@ private function search(string $keyword, string $column, string|null $format): b
         }
         return false;
     }
+
+    /**
+     * @throws InvalidFileException
+     */
+    private function isValidCsvFileFormat(array|false $row): void
+    {
+        if (!$row || count($row) <= 1) {
+            throw new InvalidFileException('invalid file format');
+        }
+    }
 }

tests/unit/FileHandlerTest.php

@@ -8,6 +8,7 @@
 use PHPUnit\Framework\TestCase;
 use rcsofttech85\FileHandler\Exception\CouldNotWriteFileException;
 use rcsofttech85\FileHandler\Exception\FileNotFoundException;
+use rcsofttech85\FileHandler\Exception\InvalidFileException;
 use rcsofttech85\FileHandler\FileHandler;
 use TypeError;
 
@@ -131,6 +132,23 @@ public function toArrayMethodReturnsValidArray()
         $this->assertEquals($expected, $data[0]);
     }
 
+    #[Test]
+    #[DataProvider('fileProvider')]
+    public function throwErrorIfFileFormatIsInvalid(string $file)
+    {
+        $this->expectException(InvalidFileException::class);
+        $this->expectExceptionMessage('invalid file format');
+
+        try {
+            $this->fileHandler->open($file)->searchInCsvFile(
+                keyword: 'Twilight',
+                column: 'Summit'
+            );
+        } finally {
+            unlink($file);
+        }
+    }
+
     #[Test]
     public function searchByKeywordAndReturnArray()
     {
@@ -169,4 +187,20 @@ public static function provideMovieNames(): iterable
         yield ["Leap Year"];
         yield ["Twilight"];
     }
+
+    public static function fileProvider(): iterable
+    {
+        $file1 = 'file1.txt';
+        $file2 = 'file2.txt';
+        $file3 = 'file3.txt';
+
+        file_put_contents($file1, "film,year");
+        file_put_contents($file2, "film\nyear");
+        file_put_contents($file3, "Film");
+
+
+        yield [$file1];
+        yield [$file2];
+        yield [$file3];
+    }
 }