Merge pull request #15 from SoapBox/M-CommaSupportCSV

Fix CSV export

Author: Jaspaul

src/SoapBox/Formatter/Parsers/Parser.php

@@ -121,35 +121,45 @@ private function csvify($data) {
 	}
 
 	/**
+	 * Ported from laravel-formatter
+	 * https://github.com/SoapBox/laravel-formatter
+	 *
+	 * @author  Daniel Berry <daniel@danielberry.me>
+	 * @license MIT License (see LICENSE.readme included in the bundle)
+	 *
 	 * Return a csv representation of the data stored in the parser
 	 *
 	 * @return string An csv string representing the encapsulated data
 	 */
-	public function toCsv() {
+	public function toCsv($newline = "\n", $delimiter = ",", $enclosure = '"', $escape = "\\") {
 		$data = $this->toArray();
 
 		if (ArrayHelpers::isAssociative($data) || !is_array($data[0])) {
 			$data = [$data];
 		}
 
-		$result = [];
+		$escaper = function($items) use($enclosure, $escape) {
+			return array_map(function($item) use($enclosure, $escape) {
+				return str_replace($enclosure, $escape.$enclosure, $item);
+			}, $items);
+		};
 
-		$result[] = ArrayHelpers::dotKeys($data[0]);
+		$headings = ArrayHelpers::dotKeys($data[0]);
+		$result = [];
 
 		foreach ($data as $row) {
 			$result[] = array_values(ArrayHelpers::dot($row));
 		}
 
-		$output = '';
-		$count = 0;
-		foreach ($result as $row) {
-			if ($count != 0) {
-				$output .=  "\r\n";
-			}
-			$count++;
-			$output .= implode(',', $row);
+		$data = $result;
+
+		$output = $enclosure.implode($enclosure.$delimiter.$enclosure, $escaper($headings)).$enclosure.$newline;
+
+		foreach ($data as $row)
+		{
+			$output .= $enclosure.implode($enclosure.$delimiter.$enclosure, $escaper((array) $row)).$enclosure.$newline;
 		}
 
-		return $output;
+		return rtrim($output, $newline);
 	}
 }

tests/unit/ParserTest.php

@@ -65,7 +65,7 @@ public function testJSONToXMLToArrayToJsonToArray() {
 	}
 
 	public function testMultiDimensionalArrayFromJsonToCsv() {
-		$expected = "simple,date,time,duration_onset,devicename,calc_data.0.0,calc_data.0.1,calc_data.0.2,calc_data.0.3,calc_data.0.4,calc_data.0.5,calc_data.1.0,calc_data.1.1,calc_data.1.2,calc_data.1.3,calc_data.1.4,calc_data.1.5\r\n118,2014-05-20 21:03:59.333,4067,,My Device,1400609039,0,37,0,0,1,1400609039,0,37,0,0,1";
+		$expected = "\"simple\",\"date\",\"time\",\"duration_onset\",\"devicename\",\"calc_data.0.0\",\"calc_data.0.1\",\"calc_data.0.2\",\"calc_data.0.3\",\"calc_data.0.4\",\"calc_data.0.5\",\"calc_data.1.0\",\"calc_data.1.1\",\"calc_data.1.2\",\"calc_data.1.3\",\"calc_data.1.4\",\"calc_data.1.5\"\n\"118\",\"2014-05-20 21:03:59.333\",\"4067\",\"\",\"My Device\",\"1400609039\",\"0\",\"37\",\"0\",\"0\",\"1\",\"1400609039\",\"0\",\"37\",\"0\",\"0\",\"1\"";
 
 		$json =
 '{

tests/unit/Parsers/ArrayParserTest.php

@@ -50,4 +50,9 @@ public function testtoJsonReturnsJsonRepresentationOfNamedArray() {
 		$this->assertEquals($expected, $parser->toJson());
 	}
 
+	public function testtoCSVFromArrayContainingContentWithCommasWorks() {
+		$expected = "\"0\",\"1\",\"2\",\"3\"\n\"a\",\"b\",\"c,e\",\"d\"";
+		$parser = new ArrayParser(['a','b','c,e','d']);
+		$this->assertEquals($expected, $parser->toCsv());
+	}
 }