Add CsvOptions

Author: chadicus

src/CsvOptions.php

@@ -0,0 +1,83 @@
+<?php
+
+namespace SubjectivePHP\Csv;
+
+use InvalidArgumentException;
+
+final class CsvOptions
+{
+    /**
+     * @var string
+     */
+    private $delimiter;
+
+    /**
+     * @var string
+     */
+    private $enclosure;
+
+    /**
+     * @var string
+     */
+    private $escapeChar;
+
+    /**
+     * Construct a new CsvOptions instance.
+     *
+     * @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).
+     *
+     * @throws InvalidArgumentException Thrown if $delimiter is not one character.
+     * @throws InvalidArgumentException Thrown if $enclosure is not one character.
+     * @throws InvalidArgumentException Thrown if $escapeChar is not one character.
+     */
+    public function __construct(string $delimiter = ',', string $enclosure = '"', string $escapeChar = '\\')
+    {
+        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->delimiter = $delimiter;
+        $this->enclosure = $enclosure;
+        $this->escapeChar = $escapeChar;
+    }
+
+    /**
+     * Gets the field delimiter (one character only).
+     *
+     * @return string
+     */
+    public function getDelimiter() : string
+    {
+        return $this->delimiter;
+    }
+
+    /**
+     * Gets the field enclosure character (one character only).
+     *
+     * @return string
+     */
+    public function getEnclosure() : string
+    {
+        return $this->enclosure;
+    }
+
+    /**
+     * Gets the escape character (one character only).
+     *
+     * @return string
+     */
+    public function getEscapeChar() : string
+    {
+        return $this->escapeChar;
+    }
+}

tests/CsvOptionsTest.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace SubjectivePHPTest\Csv;
+
+use SubjectivePHP\Csv\CsvOptions;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @coversDefaultClass \SubjectivePHP\Csv\CsvOptions
+ * @covers ::__construct
+ */
+final class CsvOptionsTest extends TestCase
+{
+    /**
+     * @test
+     * @covers ::__construct
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage $delimiter must be a single character string
+     */
+    public function constructWithDelimiterGreaterThanOneCharacter()
+    {
+        new CsvOptions('too long');
+    }
+
+    /**
+     * @test
+     * @covers ::__construct
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage $enclosure must be a single character string
+     */
+    public function constructWithEnclosureGreaterThanOneCharacter()
+    {
+        new CsvOptions(',', '##');
+    }
+
+    /**
+     * @test
+     * @covers ::__construct
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage $escapeChar must be a single character string
+     */
+    public function constructWithEscapeCharGreaterThanOneCharacter()
+    {
+        new CsvOptions(',', '"', '\\\\');
+    }
+
+    /**
+     * @test
+     * @covers ::getDelimiter
+     */
+    public function getDelimiter()
+    {
+        $this->assertSame(',', (new CsvOptions(',', '"', '\\'))->getDelimiter());
+    }
+
+    /**
+     * @test
+     * @covers ::getEnclosure
+     */
+    public function getEnclosure()
+    {
+        $this->assertSame('"', (new CsvOptions(',', '"', '\\'))->getEnclosure());
+    }
+
+    /**
+     * @test
+     * @covers ::getEscapeChar
+     */
+    public function getEscapeChar()
+    {
+        $this->assertSame('\\', (new CsvOptions(',', '"', '\\'))->getEscapeChar());
+    }
+}