Merge pull request #13 from Rodenastyle/csvEmptyLinesFix

CSV empty lines detection

composer.json

@@ -14,6 +14,7 @@
 
   "require": {
     "php": "^7.0",
+    "ext-xmlreader": "*",
     "maxakawizard/json-collection-parser": "^1.1",
     "tightenco/collect": "^5.5.33"
   },

src/Parsers/CSVParser.php

@@ -18,18 +18,7 @@ class CSVParser implements StreamParserInterface
 	protected $reader, $source, $headers, $currentLine;
 
 	public static $delimiters = [",", ";"];
-
-	public function __construct()
-	{
-		Collection::macro('recursive', function () {
-			return $this->map(function ($value) {
-				if (is_array($value) || is_object($value)) {
-					return (new Collection($value))->recursive();
-				}
-				return $value;
-			});
-		});
-	}
+	public static $skipsEmptyLines = true;
 
 	public function from(String $source): StreamParserInterface
 	{
@@ -42,7 +31,9 @@ public function each(callable $function)
 	{
 		$this->start();
 		while($this->read()){
-			$function($this->getCurrentLineAsCollection());
+			if($this->currentLineIsValid()){
+				$function($this->getCurrentLineAsCollection());
+			}
 		}
 		$this->close();
 	}
@@ -52,7 +43,7 @@ private function start()
 		$this->reader = fopen($this->source, 'r');
 
 		$this->read();
-		$this->headers = new Collection($this->currentLine);
+		$this->headers = $this->currentLine;
 
 		return $this;
 	}
@@ -64,16 +55,40 @@ private function close(){
 	}
 
 	private function read(): bool{
-		$this->currentLine = (new Collection(fgetcsv($this->reader)))->filter();
-		return $this->currentLine->isNotEmpty();
+		$this->currentLine = new Collection(fgetcsv($this->reader));
+
+		//EOF detection
+		return $this->currentLine->first() !== false;
+	}
+
+	private function currentLineIsValid(): bool{
+		if(static::$skipsEmptyLines){
+			return ! $this->currentLineIsEmpty();
+		}
+
+		return true;
+	}
+
+	private function currentLineIsEmpty(){
+		return $this->currentLine->reject(function($value){
+			return $this->isEmptyValue($value);
+		})->isEmpty();
+	}
+
+	private function isEmptyValue($value){
+		return $value === "" || $value === null;
 	}
 
 	private function getCurrentLineAsCollection()
 	{
 		$headers = $this->headers;
 		$values = $this->formatCurrentLineValues($this->currentLine);
 
-		return $headers->intersectByKeys($this->currentLine)->combine($values->recursive());
+		return $headers->intersectByKeys($this->currentLine)
+			->combine($values->recursive())
+			->reject(function($value){
+				return $this->isEmptyValue($value);
+			});
 	}
 
 	private function formatCurrentLineValues(Collection $collection){
@@ -90,7 +105,7 @@ private function explodeCollectionValues(Collection $collection){
 			});
 			if(is_array($value)){
 				return (new Collection($value))->reject(function($value){
-					return empty($value);
+					return $this->isEmptyValue($value);
 				});
 			} else {
 				return $value;

src/Parsers/JSONParser.php

@@ -17,18 +17,6 @@ class JSONParser implements StreamParserInterface
 {
 	protected $reader, $source;
 
-	public function __construct()
-	{
-		Collection::macro('recursive', function () {
-			return $this->map(function ($value) {
-				if (is_array($value) || is_object($value)) {
-					return (new Collection($value))->recursive();
-				}
-				return $value;
-			});
-		});
-	}
-
 	public function from(String $source): StreamParserInterface
 	{
 		$this->source = $source;

src/StreamParser.php

@@ -12,18 +12,34 @@
 use Rodenastyle\StreamParser\Parsers\CSVParser;
 use Rodenastyle\StreamParser\Parsers\JSONParser;
 use Rodenastyle\StreamParser\Parsers\XMLParser;
+use Rodenastyle\StreamParser\Traits\Facade;
+use Tightenco\Collect\Support\Collection;
 
 class StreamParser
 {
-	public static function xml(String $source){
+	use Facade;
+
+	private function __construct()
+	{
+		Collection::macro('recursive', function () {
+			return $this->map(function ($value) {
+				if (is_array($value) || is_object($value)) {
+					return (new Collection($value))->recursive();
+				}
+				return $value;
+			});
+		});
+	}
+
+	private function xml(String $source){
 		return (new XMLParser())->from($source);
 	}
 
-	public static function json(String $source){
+	private function json(String $source){
 		return (new JSONParser())->from($source);
 	}
 
-	public static function csv(String $source){
+	private function csv(String $source){
 		return (new CSVParser())->from($source);
 	}
 }

src/Traits/Facade.php

@@ -0,0 +1,18 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: sergio.rodenas
+ * Date: 27/6/18
+ * Time: 15:49
+ */
+
+namespace Rodenastyle\StreamParser\Traits;
+
+
+trait Facade
+{
+	public static function __callStatic($name, $arguments)
+	{
+		return (new static())->{$name}(...$arguments);
+	}
+}

tests/Parsers/CSVParserTest.php

@@ -10,6 +10,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Rodenastyle\StreamParser\StreamParser;
+use Rodenastyle\StreamParser\Parsers\CSVParser;
 use Tightenco\Collect\Support\Collection;
 
 class CSVParserTest extends TestCase
@@ -24,7 +25,7 @@ public function test_detects_main_elements_automatically()
 			$count++;
 		});
 
-		$this->assertEquals(5, $count);
+		$this->assertEquals(6, $count);
 	}
 
 	public function test_transforms_elements_to_collections()
@@ -41,11 +42,21 @@ public function test_element_values_are_there_after_transform()
 			"Anthology of World Literature",
 			"Computer Dictionary",
 			"Cooking on a Budget",
-			"Great Works of Art"
+			"Great Works of Art",
+			"0"
 		];
 
-		StreamParser::csv($this->stub)->each(function($book) use ($titles){
+		$prices = [
+			'12.95',
+			'24.95',
+			'24.90',
+			'0',
+			'29.95',
+		];
+
+		StreamParser::csv($this->stub)->each(function($book) use ($titles, $prices){
 			$this->assertContains($book->get('title'), $titles);
+			$this->assertContains($book->get('price'), $prices);
 		});
 	}
 
@@ -57,4 +68,16 @@ public function test_also_transforms_element_childs_to_collections_recursively()
 			}
 		});
 	}
+
+	public function test_allow_empty_string()
+	{
+		CSVParser::$skipsEmptyLines = false;
+
+		$count = 0;
+		StreamParser::csv($this->stub)->each(function() use (&$count){
+			$count++;
+		});
+
+		$this->assertEquals(8, $count);
+	}
 }

tests/Stubs/sample.csv

@@ -1,6 +1,9 @@
 title,price,comments
 The Iliad and The Odyssey,12.95,"Best translation I've read.,I like other versions better."
 Anthology of World Literature,24.95,"Needs more modern literature.,Excellent overview of world literature."
-Computer Dictionary,24.95,"A valuable resource.,"
-Cooking on a Budget,23.95,"Delicious!,"
-Great Works of Art,29.95,
+
+Computer Dictionary,24.90,"A valuable resource.,"
+,,
+0,0,"0,0"
+Cooking on a Budget,0,"Delicious!,"
+Great Works of Art,29.95,