Merge pull request #121 from box/add_test_for_empty_csv

Fix infinite loop for CSV with all lines empty

src/Spout/Reader/CSV/RowIterator.php

@@ -111,26 +111,28 @@ class RowIterator implements IteratorInterface
      */
     public function next()
     {
-        $lineData = false;
         $this->hasReachedEndOfFile = $this->globalFunctionsHelper->feof($this->filePointer);
 
-        if (!$this->hasReachedEndOfFile) {
-            do {
-                $utf8EncodedLineData = $this->getNextUTF8EncodedLine();
-                if ($utf8EncodedLineData !== false) {
-                    $lineData = $this->globalFunctionsHelper->str_getcsv($utf8EncodedLineData, $this->fieldDelimiter, $this->fieldEnclosure);
-                }
-                $hasNowReachedEndOfFile = $this->globalFunctionsHelper->feof($this->filePointer);
-            } while (($lineData === false && !$hasNowReachedEndOfFile) || $this->isEmptyLine($lineData));
+        if ($this->hasReachedEndOfFile) {
+            return;
+        }
 
-            if ($lineData !== false) {
-                $this->rowDataBuffer = $lineData;
-                $this->numReadRows++;
-            } else {
-                // If we reach this point, it means end of file was reached.
-                // This happens when the last lines are empty lines.
-                $this->hasReachedEndOfFile = $hasNowReachedEndOfFile;
+        do {
+            $lineData = false;
+            $utf8EncodedLineData = $this->getNextUTF8EncodedLine();
+            if ($utf8EncodedLineData !== false) {
+                $lineData = $this->globalFunctionsHelper->str_getcsv($utf8EncodedLineData, $this->fieldDelimiter, $this->fieldEnclosure);
             }
+            $hasNowReachedEndOfFile = $this->globalFunctionsHelper->feof($this->filePointer);
+        } while (($lineData === false && !$hasNowReachedEndOfFile) || $this->isEmptyLine($lineData));
+
+        if ($lineData !== false) {
+            $this->rowDataBuffer = $lineData;
+            $this->numReadRows++;
+        } else {
+            // If we reach this point, it means end of file was reached.
+            // This happens when the last lines are empty lines.
+            $this->hasReachedEndOfFile = $hasNowReachedEndOfFile;
         }
     }
 

tests/Spout/Reader/CSV/ReaderTest.php

@@ -142,6 +142,29 @@ class ReaderTest extends \PHPUnit_Framework_TestCase
         $this->assertEquals($expectedRows, $allRows);
     }
 
+    /**
+     * @return array
+     */
+    public function dataProviderForTestReadShouldReadEmptyFile()
+    {
+        return [
+            ['csv_empty.csv'],
+            ['csv_all_lines_empty.csv'],
+        ];
+    }
+
+    /**
+     * @dataProvider dataProviderForTestReadShouldReadEmptyFile
+     *
+     * @param string $fileName
+     * @return void
+     */
+    public function testReadShouldReadEmptyFile($fileName)
+    {
+        $allRows = $this->getAllRowsForFile($fileName);
+        $this->assertEquals([], $allRows);
+    }
+
     /**
      * @return void
      */

tests/bootstrap.php

@@ -3,3 +3,6 @@ require_once(dirname(__DIR__) . '/vendor/autoload.php');
 
 require_once(dirname(__DIR__) . '/tests/Spout/TestUsingResource.php');
 require_once(dirname(__DIR__) . '/tests/Spout/ReflectionHelper.php');
+
+// Make sure a timezone is set to be able to work with dates
+date_default_timezone_set('UTC');

tests/resources/csv/csv_all_lines_empty.csv

@@ -0,0 +1,2 @@
+
+