Merge pull request #88 from bburnichon/ticket_87_writer_fluent_interface

Add proper writer fluent interface tests

src/Ddeboer/DataImport/Writer/AbstractWriter.php

@@ -15,17 +15,23 @@ abstract class AbstractWriter implements WriterInterface
      * This template method can be overridden in concrete writer
      * implementations.
      *
-     * @return WriterInterface
+     * @return $this
      */
-    public function prepare() {}
+    public function prepare()
+    {
+        return $this;
+    }
 
     /**
      * Wrap up the writer after all items have been written
      *
      * This template method can be overridden in concrete writer
      * implementations.
      *
-     * @return WriterInterface
+     * @return $this
      */
-    public function finish() {}
+    public function finish()
+    {
+        return $this;
+    }
 }

src/Ddeboer/DataImport/Writer/ConsoleProgressWriter.php

@@ -28,16 +28,22 @@ public function prepare()
         $this->progress = new ProgressBar($this->output, $this->reader->count());
         $this->progress->setFormat($this->verbosity);
         $this->progress->start();
+
+        return $this;
     }
 
     public function writeItem(array $item)
     {
         $this->progress->advance();
+
+        return $this;
     }
 
     public function finish()
     {
         $this->progress->finish();
+
+        return $this;
     }
 
     public function getVerbosity()

src/Ddeboer/DataImport/Writer/CsvWriter.php

@@ -42,5 +42,7 @@ public function writeItem(array $item)
     public function finish()
     {
         fclose($this->fp);
+
+        return $this;
     }
 }

src/Ddeboer/DataImport/Writer/ExcelWriter.php

@@ -97,5 +97,7 @@ public function finish()
     {
         $writer = \PHPExcel_IOFactory::createWriter($this->excel, $this->type);
         $writer->save($this->filename);
+
+        return $this;
     }
 }

src/Ddeboer/DataImport/Writer/PdoWriter.php

@@ -50,6 +50,7 @@ public function __construct(\PDO $pdo, $tableName)
      */
     public function prepare()
     {
+        return $this;
     }
 
     /**
@@ -80,12 +81,15 @@ public function writeItem(array $item)
             //convert exception so the abstracton doesn't leak
             throw new WriterException('Write failed ('.$e->getMessage().').', null, $e);
         }
+
+        return $this;
     }
 
     /**
      * {@inheritDoc}
      */
     public function finish()
     {
+        return $this;
     }
 }

src/Ddeboer/DataImport/Writer/WriterInterface.php

@@ -12,7 +12,7 @@ interface WriterInterface
     /**
      * Prepare the writer before writing the items
      *
-     * @return WriterInterface
+     * @return $this
      */
     public function prepare();
 
@@ -21,14 +21,14 @@ public function prepare();
      *
      * @param array $item The data item with converted values
      *
-     * @return WriterInterface
+     * @return $this
      */
     public function writeItem(array $item);
 
     /**
      * Wrap up the writer after all items have been written
      *
-     * @return WriterInterface
+     * @return $this
      */
     public function finish();
 }

tests/Ddeboer/DataImport/Tests/Writer/CallbackWriterTest.php

@@ -40,4 +40,17 @@ public function testFinish()
         $writer = new CallbackWriter($callable);
         $this->assertEquals($writer, $writer->finish());
     }
+
+    public function testFluentInterface()
+    {
+        $callable = function(array $item) {
+            return '';
+        };
+
+        $writer = new CallbackWriter($callable);
+
+        $this->assertSame($writer, $writer->prepare());
+        $this->assertSame($writer, $writer->writeItem(array('foo' => 'bar', 'bar' => 'foo')));
+        $this->assertSame($writer, $writer->finish());
+    }
 }

tests/Ddeboer/DataImport/Tests/Writer/ConsoleProgressWriterTest.php

@@ -5,6 +5,7 @@
 use Ddeboer\DataImport\Writer\ConsoleProgressWriter;
 use Ddeboer\DataImport\Workflow;
 use Ddeboer\DataImport\Reader\ArrayReader;
+use Symfony\Component\Console\Output\NullOutput;
 
 class ConsoleProgressWriterTest extends \PHPUnit_Framework_TestCase
 {
@@ -43,4 +44,25 @@ public function testWrite()
 
         $this->assertEquals('debug', $writer->getVerbosity());
     }
+
+    public function testFluentInterface()
+    {
+        $data = array(
+            array(
+                'first'  => 'The first',
+                'second' => 'Second property'
+            ), array(
+                'first'  => 'Another first',
+                'second' => 'Last second'
+            )
+        );
+        $reader = new ArrayReader($data);
+        $output = new NullOutput();
+
+        $writer = new ConsoleProgressWriter($output, $reader);
+
+        $this->assertSame($writer, $writer->prepare());
+        $this->assertSame($writer, $writer->writeItem(array('foo' => 'bar', 'bar' => 'foo')));
+        $this->assertSame($writer, $writer->finish());
+    }
 }

tests/Ddeboer/DataImport/Tests/Writer/CsvWriterTest.php

@@ -33,4 +33,14 @@ public function testWriteItem()
 
         $writer->finish();
     }
+
+    public function testFluentInterface()
+    {
+        $outputFile = new \SplFileObject(tempnam('/tmp', null));
+        $writer = new CsvWriter($outputFile);
+
+        $this->assertSame($writer, $writer->prepare());
+        $this->assertSame($writer, $writer->writeItem(array('foo' => 'bar', 'bar' => 'foo')));
+        $this->assertSame($writer, $writer->finish());
+    }
 }

tests/Ddeboer/DataImport/Tests/Writer/DoctrineWriterTest.php

@@ -130,4 +130,20 @@ protected function getEntityManager()
 
         return $em;
     }
+
+    public function testFluentInterface()
+    {
+        $writer = new DoctrineWriter($this->getEntityManager(), 'DdeboerDataImport:TestEntity');
+
+        $association = new TestEntity();
+        $item = array(
+            'firstProperty'   => 'some value',
+            'secondProperty'  => 'some other value',
+            'firstAssociation'=> $association
+        );
+
+        $this->assertSame($writer, $writer->prepare());
+        $this->assertSame($writer, $writer->writeItem($item));
+        $this->assertSame($writer, $writer->finish());
+    }
 }

tests/Ddeboer/DataImport/Tests/Writer/ExcelWriterTest.php

@@ -60,4 +60,14 @@ public function testWriteItemWithoutSheetTitle()
             ->writeItem(array('first', 'last'))
             ->finish();
     }
-}
+
+    public function testFluentInterface()
+    {
+        $outputFile = new \SplFileObject(tempnam(sys_get_temp_dir(), null));
+        $writer = new ExcelWriter($outputFile);
+
+        $this->assertSame($writer, $writer->prepare());
+        $this->assertSame($writer, $writer->writeItem(array('first', 'last')));
+        $this->assertSame($writer, $writer->finish());
+    }
+}

tests/Ddeboer/DataImport/Tests/Writer/PdoWriterTest.php

@@ -103,4 +103,14 @@ public function testWriteFailureWithNoException()
         $writer->writeItem(array('foo', 'bar', 'baz'));
         $writer->finish();
     }
+
+    public function testFluentInterface()
+    {
+        $this->pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_SILENT);
+        $writer = new PdoWriter($this->pdo, 'example');
+
+        $this->assertSame($writer, $writer->prepare());
+        $this->assertSame($writer, $writer->writeItem(array('foo', 'bar')));
+        $this->assertSame($writer, $writer->finish());
+    }
 }