convert a file to an array

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

Author: rcsofttech85

README.md

@@ -37,3 +37,25 @@ fileHandler->write(data: "hello world");
 $fileHandler->close();
 
 ```
+
+**converting file to an array**
+
+```
+$fileHandler = new FileHandler();
+
+$data = $fileHandler->open(filename: 'movie.csv',mode:'r')->toArray();
+
+// output
+$data[0] = [
+            'Film' => 'Zack and Miri Make a Porno',
+            'Genre' => 'Romance',
+            'Lead Studio' => 'The Weinstein Company',
+            'Audience score %' => '70',
+            'Profitability' => '1.747541667',
+            'Rotten Tomatoes %' => '64',
+            'Worldwide Gross' => '$41.94 ',
+            'Year' => '2008'
+
+        ];
+
+```

invalid.csv

@@ -1,2 +1 @@
-rahul,chavan
-hello
+rahul

src/FileHandler.php

@@ -57,19 +57,40 @@ public function searchInCsvFile(string $keyword, int $offset = 0): bool
         return $this->search($keyword, $offset);
     }
 
+    public function toArray(): array
+    {
+        if (count($this->files) > 2) {
+            throw new InvalidFileException("multiple files not allowed");
+        }
+
+        $headers = fgetcsv($this->files[0]);
+
+        $data = [];
+        while (($row = fgetcsv($this->files[0])) !== false) {
+            if (count($row) < 2 || !is_array($row)) {
+                throw new InvalidFileException('not a valid csv file');
+            }
+            $item = array_combine($headers, $row);
+            $data[] = $item;
+        }
+
+        return $data;
+    }
+
     private function getRows(): Generator
     {
         foreach ($this->files as $file) {
             while (($row = fgetcsv($file)) !== false) {
                 if (count($row) < 2 || !is_array($row)) {
-                    throw new InvalidFileException();
+                    throw new InvalidFileException('not a valid csv file');
                 }
                 yield $row;
             }
             fclose($file);
         }
     }
 
+
     private function search(string $keyword, int $offset): bool
     {
         foreach ($this->getRows() as $row) {

tests/FileHandlerTest.php

@@ -32,7 +32,6 @@ protected function tearDown(): void
 
 
     #[Test]
-    #[TestDox("file was written successfully!")]
     public function file_successfully_written()
     {
         $this->fileHandler->open(filename: 'file');
@@ -43,7 +42,6 @@ public function file_successfully_written()
     }
 
     #[Test]
-    #[TestDox("should throw an exception if file is not found")]
     public function should_throw_exception_if_file_is_not_Found()
     {
         $this->expectException(FileNotFoundException::class);
@@ -52,7 +50,6 @@ public function should_throw_exception_if_file_is_not_Found()
     }
 
     #[Test]
-    #[TestDox("should throw an exception if file is not writable")]
     public function should_throw_exception_if_file_is_not_writable()
     {
         $this->fileHandler->open(filename: 'file', mode: 'r');
@@ -63,7 +60,6 @@ public function should_throw_exception_if_file_is_not_writable()
     }
 
     #[Test]
-    #[TestDox("multiple files can be written simultaneously")]
     public function multiple_file_can_be_written_simultaneously()
     {
         $this->fileHandler->open(filename: 'file');
@@ -81,7 +77,6 @@ public function multiple_file_can_be_written_simultaneously()
 
 
     #[Test]
-    #[TestDox("checks if a movie exists in a collection by a name")]
     public function file_is_closed_properly()
     {
         $this->fileHandler->open(filename: 'file');
@@ -114,10 +109,30 @@ public function studio_is_found_for_exact_name_match(string $keyword)
     public function should_throw_exception_if_not_valid_csv()
     {
         $this->expectException(InvalidFileException::class);
-        $this->expectExceptionMessage("invalid file format");
+        $this->expectExceptionMessage("not a valid csv file");
         $this->fileHandler->open(filename: 'invalid.csv')->searchInCsvFile(keyword: 'hello');
     }
 
+    #[Test]
+    public function to_array_method_returns_valid_array()
+    {
+        $data = $this->fileHandler->open(filename: 'movie.csv')->toArray();
+
+        $expected = [
+            'Film' => 'Zack and Miri Make a Porno',
+            'Genre' => 'Romance',
+            'Lead Studio' => 'The Weinstein Company',
+            'Audience score %' => '70',
+            'Profitability' => '1.747541667',
+            'Rotten Tomatoes %' => '64',
+            'Worldwide Gross' => '$41.94 ',
+            'Year' => '2008'
+
+        ];
+
+        $this->assertEquals($expected, $data[0]);
+    }
+
     public static function provide_studio_names(): iterable
     {
         yield ["Fox"];