Merge pull request #166 from igormukhingmailcom/consoletablewriter

ConsoleTableWriter

README.md

@@ -40,6 +40,7 @@ Documentation
     - [DoctrineWriter](#doctrinewriter)
     - [PdoWriter](#pdowriter)
     - [ExcelWriter](#excelwriter)
+    - [ConsoleTableWriter](#consoletablewriter)
     - [ConsoleProgressWriter](#consoleprogresswriter)
     - [CallbackWriter](#callbackwriter)
     - [AbstractStreamWriter](#abstractstreamwriter)
@@ -545,6 +546,34 @@ existing sheet:
 
 ```php
 $writer = new ExcelWriter($file, 'Old sheet');
+```
+#### ConsoleTableWriter
+
+This writer displays items as table on console output for debug purposes
+when you start the workflow from the command-line. 
+It requires Symfony’s Console component 2.5 or higher:
+
+```bash
+$ composer require symfony/console ~2.5
+```
+
+```php
+use Ddeboer\DataImport\Reader;
+use Ddeboer\DataImport\Writer\ConsoleTableWriter;
+use Symfony\Component\Console\Output\ConsoleOutput;
+use Symfony\Component\Console\Helper\Table;
+
+$reader = new Reader\...;
+$output = new ConsoleOutput(...);
+
+$table = new Table($output);
+
+// Make some manipulations, e.g. set table style
+$table->setStyle('compact');
+
+$workflow = new Workflow($reader);
+$workflow->addWriter(new ConsoleTableWriter($output, $table));
+
 ```
 
 #### ConsoleProgressWriter

src/Ddeboer/DataImport/Writer/ConsoleTableWriter.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Ddeboer\DataImport\Writer;
+
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Helper\Table;
+
+/**
+ * @author Igor Mukhin <igor.mukhin@gmail.com>
+ */
+class ConsoleTableWriter implements WriterInterface
+{
+    private $output = null;
+    private $table = null;
+    private $firstItem = null;
+
+    /**
+     * @param OutputInterface $output
+     * @param Table $table
+     */
+    public function __construct(OutputInterface $output, Table $table) {
+        $this->output = $output;
+        $this->table = $table;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function prepare() {
+
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function writeItem(array $item) {
+
+        // Save first item to get keys to display at header
+        if (is_null($this->firstItem)) {
+            $this->firstItem = $item;
+        }
+
+        $this->table->addRow($item);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function finish() {
+        $this->table->setHeaders(array_keys($this->firstItem));
+        $this->table->render();
+
+        $this->firstItem = null;
+    }
+
+    /**
+     * You can get Table object to apply extra
+     * 
+     * @return Table
+     */
+    public function getTable()
+    {
+        return $this->table;
+    }
+}

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

@@ -0,0 +1,52 @@
+<?php
+
+namespace Ddeboer\DataImport\Tests\Writer;
+
+use Symfony\Component\Console\Output\BufferedOutput;
+use Symfony\Component\Console\Helper\Table;
+
+use Ddeboer\DataImport\Workflow;
+use Ddeboer\DataImport\Reader\ArrayReader;
+use Ddeboer\DataImport\ItemConverter\MappingItemConverter;
+use Ddeboer\DataImport\Writer\ConsoleTableWriter;
+
+/**
+ *  @author Igor Mukhin <igor.mukhin@gmail.com>
+ */
+class ConsoleTableWriterTest extends \PHPUnit_Framework_TestCase
+{
+    public function testRightColumnsHeadersNamesAfterItemConverter()
+    {
+        $data = array(
+            array(
+                'first'  => 'John',
+                'lastname' => 'Doe'
+            ),
+            array(
+                'first'  => 'Ivan',
+                'lastname' => 'Sidorov'
+            )
+        );
+        $reader = new ArrayReader($data);
+
+        $converter = new MappingItemConverter();
+        $converter
+            ->addMapping('first', 'firstname')
+        ;
+
+        $output = new BufferedOutput();
+        $table = new Table($output);
+        $table
+            ->setStyle('compact')
+        ;
+
+        $workflow = new Workflow($reader);
+        $workflow
+            ->addItemConverter($converter)
+            ->addWriter(new ConsoleTableWriter($output, $table))
+            ->process()
+        ;
+
+        $this->assertRegExp('/\s+lastname\s+firstname\s+Doe\s+John\s+Sidorov\s+Ivan\s+/', $output->fetch());
+    }
+}