Merge pull request #25 from keboola/odin-string-obj

feat: support objects convertible to strings

Author: odinuv

src/CsvFile.php

@@ -340,7 +340,14 @@ public function rowToStr(array $row)
     {
         $return = [];
         foreach ($row as $column) {
-            if (!is_scalar($column) && !is_null($column)) {
+            if (!(
+                is_scalar($column)
+                || is_null($column)
+                || (
+                    is_object($column)
+                    && method_exists($column, '__toString')
+                )
+            )) {
                 $type = gettype($column);
                 throw new Exception(
                     "Cannot write {$type} into a column",

tests/CsvFileTest.php

@@ -3,6 +3,7 @@
 namespace Keboola\Csv\Tests;
 
 use Keboola\Csv\CsvFile;
+use Keboola\Csv\Exception;
 use PHPUnit\Framework\TestCase;
 
 class CsvFileTest extends TestCase
@@ -228,6 +229,83 @@ public function testWrite()
         foreach ($rows as $row) {
             $csvFile->writeRow($row);
         }
+        $data = file_get_contents($fileName);
+        self::assertEquals(
+            implode(
+                "\n",
+                [
+                    '"col1","col2"',
+                    '"line without enclosure","second column"',
+                    '"enclosure "" in column","hello \\"',
+                    '"line with enclosure","second column"',
+                    '"column with enclosure "", and comma inside text","second column enclosure in text """',
+                    "\"columns with\nnew line\",\"columns with\ttab\"",
+                    '"column with \\n \\t \\\\","second col"',
+                    '',
+                ]
+            ),
+            $data
+        );
+        @unlink($fileName);
+    }
+
+    public function testWriteInvalidObject()
+    {
+        $fileName = __DIR__ . '/data/_out.csv';
+        if (file_exists($fileName)) {
+            unlink($fileName);
+        }
+
+        $csvFile = new CsvFile($fileName);
+
+        $rows = [
+            [
+                'col1', 'col2',
+            ],
+            [
+                '1', new \stdClass(),
+            ],
+        ];
+
+        $csvFile->writeRow($rows[0]);
+        self::expectException(Exception::class);
+        self::expectExceptionMessage("Cannot write object into a column");
+        $csvFile->writeRow($rows[1]);
+        @unlink($fileName);
+    }
+
+    public function testWriteValidObject()
+    {
+        $fileName = __DIR__ . '/data/_out.csv';
+        if (file_exists($fileName)) {
+            unlink($fileName);
+        }
+
+        $csvFile = new CsvFile($fileName);
+        $rows = [
+            [
+                'col1', 'col2',
+            ],
+            [
+                '1', new StringObject(),
+            ],
+        ];
+
+        $csvFile->writeRow($rows[0]);
+        $csvFile->writeRow($rows[1]);
+        $data = file_get_contents($fileName);
+        self::assertEquals(
+            implode(
+                "\n",
+                [
+                    '"col1","col2"' ,
+                    '"1","me string"',
+                    '',
+                ]
+            ),
+            $data
+        );
+        @unlink($fileName);
     }
 
     public function testIterator()

tests/StringObject.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Keboola\Csv\Tests;
+
+class StringObject
+{
+    public function __toString()
+    {
+        return "me string";
+    }
+}