Title

Author: dantleech

lib/Extension/Console/ConsoleExtension.php

@@ -7,6 +7,7 @@
 use PhpBench\Pipeline\Extension\Console\Stage\Redraw;
 use PhpBench\Pipeline\Extension\Console\Stage\Table;
 use PhpBench\Pipeline\Extension\Console\Stage\BarChart;
+use PhpBench\Pipeline\Extension\Console\Stage\Title;
 
 class ConsoleExtension implements PipelineExtension
 {
@@ -20,6 +21,7 @@ public function __construct()
         $this->stages = [
             'console/redraw' => new Redraw(),
             'console/table' => new Table(),
+            'console/title' => new Title(),
             'console/bar-chart' => new BarChart(),
         ];
     }

lib/Extension/Console/Stage/Redraw.php

@@ -32,10 +32,13 @@ public function __invoke(): Generator
                     break;
                 }
 
-                $text = self::ANSI_RESTORE_CURSOR_POS.$text;
+                if ($firstLine) {
+                    $text = self::ANSI_RESTORE_CURSOR_POS.$text;
+                    $firstLine = false;
+                }
+
                 $lineLength = $this->maxLineLength($text, $lineLength);
                 $text = $this->maximizeLines($text, $lineLength);
-                break;
             }
 
             list($config, $data) = yield $data;

lib/Extension/Console/Stage/Title.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace PhpBench\Pipeline\Extension\Console\Stage;
+
+use PhpBench\Pipeline\Core\Stage;
+use Generator;
+use PhpBench\Pipeline\Core\Schema;
+
+class Title implements Stage
+{
+    public function __invoke(): Generator
+    {
+        list($config, $data) = yield;
+        while (true) {
+            list($config, $data) = yield [
+                $this->title($config['text']),
+            ];
+        }
+    }
+
+    public function configure(Schema $schema)
+    {
+        $schema->setRequired([
+            'text'
+        ]);
+        $schema->setTypes([
+            'text' => 'string'
+        ]);
+    }
+
+    private function title(string $text): string
+    {
+        return implode(PHP_EOL, [
+            $text,
+            str_repeat('=', mb_strlen($text))
+        ]);
+    }
+}

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

@@ -0,0 +1,24 @@
+<?php
+
+namespace PhpBench\Pipeline\Tests\Unit\Extension\Console\Stage;
+
+use PhpBench\Pipeline\Tests\Unit\Extension\Console\ConsoleTestCase;
+
+class TitleTest extends ConsoleTestCase
+{
+    public function testUnderlinedTitleText()
+    {
+        $pipeline = $this->pipeline()
+            ->stage('console/title', [
+                'text' => 'Hello World',
+            ]);
+
+        $output = $pipeline->build()->generator([])->current();
+
+        $this->assertEquals([ <<<EOT
+Hello World
+===========
+EOT
+], $output);
+    }
+}