fix csv provider - add dependency on splFileObject

Author: Oleg

README.md

@@ -71,7 +71,9 @@ $pipeline = (new PipelineBuilder($emitter))
 use SlayerBirden\DataFlow\Plumber;
 use SlayerBirden\DataFlow\Provider\Csv;
 ...
-(new Plumber(new Csv('users_file', __DIR__ . '/users.csv'), $pipeline, $emitter))->pour();
+$file = new \SplFileObject(__DIR__ . '/users.csv');
+$file->setFlags(\SplFileObject::READ_CSV | \SplFileObject::READ_AHEAD | \SplFileObject::SKIP_EMPTY);
+(new Plumber(new Csv('users_file', $file), $pipeline, $emitter))->pour();
 ```
 5. We want some reporting to know what's going on. Let's implement basic stdOut emitter.
 ```php

examples/example1-import-cli/import.php

@@ -48,4 +48,7 @@ public function __invoke($value, DataBagInterface $dataBag)
     ->addSection($dbWrite)
     ->build();
 
-(new Plumber(new Csv('users_file', __DIR__ . '/users.csv'), $pipeline, $emitter))->pour();
+$file = new \SplFileObject(__DIR__ . '/users.csv');
+$file->setFlags(\SplFileObject::READ_CSV | \SplFileObject::READ_AHEAD | \SplFileObject::SKIP_EMPTY);
+
+(new Plumber(new Csv('users_file', $file), $pipeline, $emitter))->pour();

src/Provider/Csv.php

@@ -33,21 +33,16 @@ class Csv implements ProviderInterface
 
     /**
      * @param string $id
-     * @param string $fileName
+     * @param \SplFileObject $file
      * @param bool $headerRow
      * @param string[]|null $header
      * @throws FileDoesNotExist
      * @throws HeaderMissing
      */
-    public function __construct(string $id, string $fileName, bool $headerRow = true, ?array $header = null)
+    public function __construct(string $id, \SplFileObject $file, bool $headerRow = true, ?array $header = null)
     {
         $this->id = $id;
-        $path = realpath($fileName);
-        if ($path === false) {
-            throw new FileDoesNotExist(sprintf('Could not find file %s.', $fileName));
-        }
-        $this->file = new \SplFileObject($path);
-        $this->file->setFlags(\SplFileObject::READ_CSV | \SplFileObject::READ_AHEAD | \SplFileObject::SKIP_EMPTY);
+        $this->file = $file;
         if (!$headerRow && empty($header)) {
             throw new HeaderMissing(
                 sprintf('You did not provide header for the file %s.', $this->file->getFilename())

tests/unit/Provider/CsvTest.php

@@ -48,25 +48,21 @@ protected function setUp()
         fclose($file);
     }
 
-    /**
-     * @expectedException \SlayerBirden\DataFlow\Provider\Exception\FileDoesNotExist
-     */
-    public function testNonExistingFile()
-    {
-        new Csv('testId', self::$root->url() . '/fictional.file', true);
-    }
-
     /**
      * @expectedException \SlayerBirden\DataFlow\Provider\Exception\HeaderMissing
      */
     public function testNoHeader()
     {
-        new Csv('testId', self::$root->getChild('users.csv')->url(), false);
+        $file = new \SplFileObject(self::$root->getChild('users.csv')->url());
+        $file->setFlags(\SplFileObject::READ_CSV | \SplFileObject::READ_AHEAD | \SplFileObject::SKIP_EMPTY);
+        new Csv('testId', $file, false);
     }
 
     public function testGetCask()
     {
-        $csv = new Csv('testId', self::$root->getChild('users.csv')->url());
+        $file = new \SplFileObject(self::$root->getChild('users.csv')->url());
+        $file->setFlags(\SplFileObject::READ_CSV | \SplFileObject::READ_AHEAD | \SplFileObject::SKIP_EMPTY);
+        $csv = new Csv('testId', $file);
 
         $cask = $csv->getCask();
         $actual = [];
@@ -84,7 +80,9 @@ public function testGetCask()
 
     public function testInvalidHeader()
     {
-        $csv = new Csv('testId', self::$root->getChild('users.csv')->url(), true, [
+        $file = new \SplFileObject(self::$root->getChild('users.csv')->url());
+        $file->setFlags(\SplFileObject::READ_CSV | \SplFileObject::READ_AHEAD | \SplFileObject::SKIP_EMPTY);
+        $csv = new Csv('testId', $file, true, [
             'firstname',
             'lastname',
             'age'
@@ -98,7 +96,9 @@ public function testInvalidHeader()
 
     public function testGetCaskWithOverridenHeader()
     {
-        $csv = new Csv('testId', self::$root->getChild('users.csv')->url(), true, [
+        $file = new \SplFileObject(self::$root->getChild('users.csv')->url());
+        $file->setFlags(\SplFileObject::READ_CSV | \SplFileObject::READ_AHEAD | \SplFileObject::SKIP_EMPTY);
+        $csv = new Csv('testId', $file, true, [
             'first',
             'last',
         ]);
@@ -119,7 +119,9 @@ public function testGetCaskWithOverridenHeader()
 
     public function testGetEstimatedSize()
     {
-        $csv = new Csv('testId', self::$root->getChild('users.csv')->url());
+        $file = new \SplFileObject(self::$root->getChild('users.csv')->url());
+        $file->setFlags(\SplFileObject::READ_CSV | \SplFileObject::READ_AHEAD | \SplFileObject::SKIP_EMPTY);
+        $csv = new Csv('testId', $file);
 
         $this->assertSame(1, $csv->getEstimatedSize());
     }