Merge pull request #27 from keboola/odin-reader-writer

Refactor - split into Reader and Writer classes

Author: Halama

README.md

@@ -7,26 +7,25 @@
 
 The library provides a simple reader and writer for CSV files according to [RFC4180](https://tools.ietf.org/html/rfc4180). 
 The library is licensed under the [MIT](https://github.com/keboola/php-csv/blob/master/LICENSE) license. The library provides 
-a single `CsvFile` class for both reading and writing CSV files. The class is designed to be **immutable** and minimalistic.
+classes `CsvReader` and `CsvWriter` for reading and writing CSV files. The classes are designed to be **immutable** 
+and minimalistic.
 
 ## Usage
 
 ### Read CSV
 
 ```php
-$csvFile = new Keboola\Csv\CsvFile(__DIR__ . '/_data/test-input.csv');
+$csvFile = new Keboola\Csv\CsvReader(__DIR__ . '/_data/test-input.csv');
 foreach($csvFile as $row) {
 	var_dump($row);
 }
 ```
 
 #### Skip lines
-Skip the first two lines:
+Skip the first line:
 
 ```php
-use Keboola\Csv\CsvFile;
-$filename = __DIR__ . '/_data/test-input.csv';
-$csvFile = new \Keboola\Csv\CsvFile($fileName, CsvFile::DEFAULT_DELIMITER, CsvFile::DEFAULT_ENCLOSURE, CsvFile::DEFAULT_ENCLOSURE, 2)
+$csvFile = new \Keboola\Csv\CsvFile($fileName, CsvFile::DEFAULT_DELIMITER, CsvFile::DEFAULT_ENCLOSURE, CsvFile::DEFAULT_ESCAPED_BY, 1)
 foreach($csvFile as $row) {
 	var_dump($row);
 }
@@ -36,21 +35,42 @@ foreach($csvFile as $row) {
 ### Write CSV
 
 ```php
-$csvFile = new Keboola\Csv\CsvFile(__DIR__ . '/_data/test-output.csv');
-$rows = array(
-	array(
+$csvFile = new Keboola\Csv\CsvWriter(__DIR__ . '/_data/test-output.csv');
+$rows = [
+	[
 		'col1', 'col2',
-	),
-	array(
-		'line without enclosure', 'second column',
-	),
-);
+	],
+	[
+		'first column', 'second column',
+	],
+];
 
 foreach ($rows as $row) {
 	$csvFile->writeRow($row);
 }
 ```
 
+### Append to CSV
+
+```php
+$fileName = __DIR__ . '/_data/test-output.csv';
+$file = fopen($fileName, 'a');
+$csvFile = new Keboola\Csv\CsvWriter($file);
+$rows = [
+	[
+		'col1', 'col2',
+	],
+	[
+		'first column', 'second column',
+	],
+];
+
+foreach ($rows as $row) {
+	$csvFile->writeRow($row);
+}
+fclose($file);
+```
+
 ## Installation
 
 The library is available as [composer package](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx). 
@@ -69,5 +89,4 @@ composer require keboola/csv
 require 'vendor/autoload.php';
 ```
 
-
 Read more in [Composer documentation](http://getcomposer.org/doc/01-basic-usage.md)

src/AbstractCsvFile.php

@@ -0,0 +1,137 @@
+<?php
+
+namespace Keboola\Csv;
+
+abstract class AbstractCsvFile
+{
+    const DEFAULT_DELIMITER = ',';
+    const DEFAULT_ENCLOSURE = '"';
+    /**
+     * @var string
+     */
+    protected $fileName;
+    /**
+     * @var resource
+     */
+    protected $filePointer;
+
+    /**
+     * @var string
+     */
+    private $delimiter;
+
+    /**
+     * @var string
+     */
+    private $enclosure;
+
+    /**
+     * @return string
+     */
+    public function getDelimiter()
+    {
+        return $this->delimiter;
+    }
+
+    /**
+     * @param string $delimiter
+     * @throws InvalidArgumentException
+     */
+    protected function setDelimiter($delimiter)
+    {
+        $this->validateDelimiter($delimiter);
+        $this->delimiter = $delimiter;
+    }
+
+    /**
+     * @param string $delimiter
+     * @throws InvalidArgumentException
+     */
+    protected function validateDelimiter($delimiter)
+    {
+        if (strlen($delimiter) > 1) {
+            throw new InvalidArgumentException(
+                "Delimiter must be a single character. " . json_encode($delimiter) . " received",
+                Exception::INVALID_PARAM
+            );
+        }
+
+        if (strlen($delimiter) == 0) {
+            throw new InvalidArgumentException(
+                "Delimiter cannot be empty.",
+                Exception::INVALID_PARAM
+            );
+        }
+    }
+
+    /**
+     * @return string
+     */
+    public function getEnclosure()
+    {
+        return $this->enclosure;
+    }
+
+    /**
+     * @param string $enclosure
+     * @return $this
+     * @throws InvalidArgumentException
+     */
+    protected function setEnclosure($enclosure)
+    {
+        $this->validateEnclosure($enclosure);
+        $this->enclosure = $enclosure;
+        return $this;
+    }
+
+    /**
+     * @param string $enclosure
+     * @throws InvalidArgumentException
+     */
+    protected function validateEnclosure($enclosure)
+    {
+        if (strlen($enclosure) > 1) {
+            throw new InvalidArgumentException(
+                "Enclosure must be a single character. " . json_encode($enclosure) . " received",
+                Exception::INVALID_PARAM
+            );
+        }
+    }
+
+    public function __destruct()
+    {
+        $this->closeFile();
+    }
+
+    protected function closeFile()
+    {
+        if ($this->fileName && is_resource($this->filePointer)) {
+            fclose($this->filePointer);
+        }
+    }
+
+    /**
+     * @param string|resource $file
+     */
+    protected function setFile($file)
+    {
+        if (is_string($file)) {
+            $this->openCsvFile($file);
+            $this->fileName = $file;
+        } elseif (is_resource($file)) {
+            $this->filePointer = $file;
+        } else {
+            throw new InvalidArgumentException("Invalid file: " . var_export($file, true));
+        }
+    }
+
+    abstract protected function openCsvFile($fileName);
+
+    /**
+     * @return resource
+     */
+    protected function getFilePointer()
+    {
+        return $this->filePointer;
+    }
+}