Table console output

Author: dantleech

lib/Core/Pipeline.php

@@ -36,7 +36,7 @@ public function __invoke(): Generator
                 if (false === $response instanceof Signal && false === is_array($response)) {
                     throw new InvalidYieldedValue(sprintf(
                         'All yielded values must be arrays or Signals, got "%s"',
-                        gettype($data)
+                        gettype($response)
                     ));
                 }
 

lib/Extension/Console/ConsoleExtension.php

@@ -5,6 +5,7 @@
 use PhpBench\Pipeline\Core\PipelineExtension;
 use PhpBench\Pipeline\Core\Stage;
 use PhpBench\Pipeline\Extension\Console\Stage\Redraw;
+use PhpBench\Pipeline\Extension\Console\Stage\Table;
 
 class ConsoleExtension implements PipelineExtension
 {
@@ -17,6 +18,7 @@ public function __construct()
     {
         $this->stages = [
             'console/redraw' => new Redraw(),
+            'console/table' => new Table(),
         ];
     }
 

lib/Extension/Console/Stage/Table.php

@@ -0,0 +1,98 @@
+<?php
+
+namespace PhpBench\Pipeline\Extension\Console\Stage;
+
+use PhpBench\Pipeline\Core\Stage;
+use Generator;
+use PhpBench\Pipeline\Core\Schema;
+use PhpBench\Pipeline\Extension\Console\Util\ConsoleUtil;
+
+class Table implements Stage
+{
+    private const PADDING = 1;
+
+    public function __invoke(): Generator
+    {
+        list($config, $data) = yield;
+
+        while (true) {
+            $table = (array) $data;
+
+            foreach ($table as &$row) {
+                $row = (array) $row;
+
+                foreach ($row as &$value) {
+                    if (is_scalar($value)) {
+                        continue;
+                    }
+
+                    $value = json_encode($value);
+                }
+            }
+
+            $headers = $this->headers($table);
+            $separator = $this->separatorRow($headers);
+            array_unshift($table, $separator);
+            array_unshift($table, $headers);
+
+            $widths = $this->widths($table);
+            $table = $this->table($table, $widths);
+            
+
+            list($config, $data) = yield [ implode(PHP_EOL, $table) ];
+        }
+    }
+
+    private function headers(array $table): array
+    {
+        foreach ($table as $row) {
+            return array_keys($row);
+        }
+
+        return [];
+    }
+
+    private function widths(array $table): array
+    {
+        $widths = [];
+
+        foreach ($table as $row) {
+            foreach (array_values($row) as $colNumber => $value) {
+                $width = mb_strlen($value) + self::PADDING;
+                if (false === isset($widths[$colNumber]) || $widths[$colNumber] < $width) {
+                    $widths[$colNumber] = $width;
+                }
+            }
+        }
+
+        return $widths;
+    }
+
+    private function separatorRow(array $headers): array
+    {
+        return array_map(function ($header) {
+            return str_repeat('-', iconv_strlen($header));
+        }, $headers);
+    }
+
+    private function table(array $data, array $widths): array
+    {
+        $table = [];
+        foreach ($data as $row) {
+            $tableRow = [];
+
+            foreach (array_values($row) as $colNumber => $value) {
+                $width = $widths[$colNumber];
+                $tableRow[] = ConsoleUtil::pad($value, $width);
+            }
+
+            $table[] = implode('', $tableRow);
+        }
+
+        return $table;
+    }
+
+    public function configure(Schema $schema)
+    {
+    }
+}

tests/Unit/Extension/Console/Stage/TableTest.php

@@ -14,19 +14,85 @@ public function testTransformsInputIntoATable(array $input, string $expected)
         $pipeline = $this->pipeline()
             ->stage('console/table');
 
-        $output = $pipeline->run($input);
+        $output = $pipeline->build()->generator($input)->current();
 
-        $this->assertEquals($expected, $output);
+        $this->assertEquals([ $expected ], $output);
     }
 
     public function provideTransformsInputIntoATable()
     {
-        yield 'single array element' => [
+        yield 'from single array element' => [
             [ 'hallo' ],
             <<<EOT
-0
------
-hallo
+0     
+-     
+hallo 
+EOT
+        ];
+
+        yield 'from single array element with key' => [
+            [ 'tchuss' => 'hallo' ],
+            <<<EOT
+0     
+-     
+hallo 
+EOT
+        ];
+
+        yield 'from single row, single column' => [
+            [ 
+                [ 'tchuss' => 'hallo' ],
+            ],
+            <<<EOT
+tchuss 
+------ 
+hallo  
+EOT
+        ];
+
+        yield 'from single row, multiple columns' => [
+            [ 
+                [ 'tchuss' => 'hallo', 'ciao' => 'goodbye' ],
+            ],
+            <<<EOT
+tchuss ciao    
+------ ----    
+hallo  goodbye 
+EOT
+        ];
+
+        yield 'from multiple rows, multiple columns' => [
+            [ 
+                [ 'tchuss' => 'hallo', 'ciao' => 'goodbye' ],
+                [ 'tchuss' => 'bienvenu', 'ciao' => 'aurevoir' ],
+            ],
+            <<<EOT
+tchuss   ciao     
+------   ----     
+hallo    goodbye  
+bienvenu aurevoir 
+EOT
+        ];
+
+        yield 'where header longer than value' => [
+            [ 
+                [ 'this is a header' => 'value' ],
+            ],
+            <<<EOT
+this is a header 
+---------------- 
+value            
+EOT
+        ];
+
+        yield 'non-scalar value' => [
+            [
+                [ 'blah' => ['value'] ],
+            ],
+            <<<EOT
+blah      
+----      
+["value"] 
 EOT
         ];
     }