Use CsvOptions in Reader

Author: chadicus

src/Reader.php

@@ -14,27 +14,6 @@ class Reader implements \Iterator
      */
     private $headers;
 
-    /**
-     * The field delimiter (one character only).
-     *
-     * @var string
-     */
-    private $delimiter;
-
-    /**
-     *  The field enclosure character (one character only).
-     *
-     * @var string
-     */
-    private $enclosure;
-
-    /**
-     * The escape character (one character only).
-     *
-     * @var string
-     */
-    private $escapeChar;
-
     /**
      * File pointer to the csv file.
      *
@@ -56,45 +35,32 @@ class Reader implements \Iterator
      */
     private $current = null;
 
+    /**
+     * @var CsvOptions
+     */
+    private $csvOptions;
+
     /**
      * Create a new Reader instance.
      *
-     * @param string $file       The full path to the csv file.
-     * @param array  $headers    The column headers. If null, the headers will be derived from the first line in the
-     *                           file.
-     * @param string $delimiter  The field delimiter (one character only).
-     * @param string $enclosure  The field enclosure character (one character only).
-     * @param string $escapeChar The escape character (one character only).
+     * @param string $file           The full path to the csv file.
+     * @param array  $headers        The column headers. If null, the headers will be derived from the first line in
+     *                               the file.
+     * @param CsvOptions $csvOptions Options for the csv file.
      *
      * @throws \InvalidArgumentException Thrown if $file is not readable.
-     * @throws \InvalidArgumentException Thrown if $delimiter is a single character string.
-     * @throws \InvalidArgumentException Thrown if $enclosure is a single character string.
-     * @throws \InvalidArgumentException Thrown if $escapeChar is a single character string.
      */
-    public function __construct($file, array $headers = null, $delimiter = ',', $enclosure = '"', $escapeChar = '\\')
+    public function __construct($file, array $headers = null, CsvOptions $csvOptions = null)
     {
         if (!is_readable((string)$file)) {
             throw new \InvalidArgumentException(
                 '$file must be a string containing a full path to a readable delimited file'
             );
         }
 
-        if (strlen($delimiter) !== 1) {
-            throw new \InvalidArgumentException('$delimiter must be a single character string');
-        }
-
-        if (strlen($enclosure) !== 1) {
-            throw new \InvalidArgumentException('$enclosure must be a single character string');
-        }
-
-        if (strlen($escapeChar) !== 1) {
-            throw new \InvalidArgumentException('$escapeChar must be a single character string');
-        }
+        $this->csvOptions = $csvOptions ?? new CsvOptions();
 
         $this->headers = $headers;
-        $this->delimiter = $delimiter;
-        $this->enclosure = $enclosure;
-        $this->escapeChar = $escapeChar;
         $this->handle = fopen((string)$file, 'r');
     }
 
@@ -140,7 +106,13 @@ public function next()
      */
     private function readLine()
     {
-        $raw = fgetcsv($this->handle, 0, $this->delimiter, $this->enclosure, $this->escapeChar);
+        $raw = fgetcsv(
+            $this->handle,
+            0,
+            $this->csvOptions->getDelimiter(),
+            $this->csvOptions->getEnclosure(),
+            $this->csvOptions->getEscapeChar()
+        );
         if (empty($raw)) {
             throw new \Exception('Empty line read');
         }

tests/ReaderTest.php

@@ -1,6 +1,7 @@
 <?php
 namespace SubjectivePHPTest\Csv;
 
+use SubjectivePHP\Csv\CsvOptions;
 use SubjectivePHP\Csv\Reader;
 use PHPUnit\Framework\TestCase;
 
@@ -92,8 +93,8 @@ public function getReaders()
             [new Reader(__DIR__ . '/_files/basic.csv')],
             [new Reader(__DIR__ . '/_files/basic.csv', $headers)],
             [new Reader(__DIR__ . '/_files/no_headers.csv', $headers)],
-            [new Reader(__DIR__ . '/_files/pipe_delimited.txt', $headers, '|')],
-            [new Reader(__DIR__ . '/_files/tab_delimited.txt', $headers, "\t")],
+            [new Reader(__DIR__ . '/_files/pipe_delimited.txt', $headers, new CsvOptions('|'))],
+            [new Reader(__DIR__ . '/_files/tab_delimited.txt', $headers, new CsvOptions("\t"))],
         ];
     }
 
@@ -130,51 +131,6 @@ public function getFiles()
         ];
     }
 
-    /**
-     * Verify behavior of __construct with an invalid delimiter.
-     *
-     * @test
-     * @covers ::__construct
-     * @expectedException \InvalidArgumentException
-     * @expectedExceptionMessage $delimiter must be a single character string
-     *
-     * @return void
-     */
-    public function constructInvalidDelimiter()
-    {
-        new Reader(__DIR__ . '/_files/basic.csv', null, 'too long');
-    }
-
-    /**
-     * Verify behavior of __construct with an invalid enclosure.
-     *
-     * @test
-     * @covers ::__construct
-     * @expectedException \InvalidArgumentException
-     * @expectedExceptionMessage $enclosure must be a single character string
-     *
-     * @return void
-     */
-    public function constructInvalidEnclosure()
-    {
-        new Reader(__DIR__ . '/_files/basic.csv', null, ',', 123);
-    }
-
-    /**
-     * Verify behavior of __construct with an invalid escapeChar.
-     *
-     * @test
-     * @covers ::__construct
-     * @expectedException \InvalidArgumentException
-     * @expectedExceptionMessage $escapeChar must be a single character string
-     *
-     * @return void
-     */
-    public function constructInvalidEscapeChar()
-    {
-        new Reader(__DIR__ . '/_files/basic.csv', null, ',', '"', null);
-    }
-
     /**
      * Verify behaviour of consecutive rewind().
      *