Added console extension

Author: dantleech

lib/Core/PipelineBuilder.php

@@ -2,8 +2,9 @@
 
 namespace PhpBench\Pipeline\Core;
 
-use PhpBench\Pipeline\Extension\Core\CoreExtension;
+use PhpBench\Pipeline\Extension\Console\ConsoleExtension;
 use Generator;
+use PhpBench\Pipeline\Extension\Core\CoreExtension;
 
 final class PipelineBuilder
 {
@@ -31,6 +32,7 @@ public static function createWithDefaults(): self
     {
         $builder = self::create();
         $builder->addExtension(new CoreExtension());
+        $builder->addExtension(new ConsoleExtension());
 
         return $builder;
     }

lib/Extension/Console/ConsoleExtension.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace PhpBench\Pipeline\Extension\Console;
+
+use PhpBench\Pipeline\Core\PipelineExtension;
+use PhpBench\Pipeline\Core\Stage;
+use PhpBench\Pipeline\Extension\Core\Stage\Encoder\JsonEncoder;
+use PhpBench\Pipeline\Extension\Core\Stage\Sampler\CallableSampler;
+use PhpBench\Pipeline\Extension\Core\Stage\Output\StreamOutput;
+use PhpBench\Pipeline\Extension\Core\Stage\Parameter\SerialParameter;
+use PhpBench\Pipeline\Extension\Core\Stage\Valve\TakeValve;
+use PhpBench\Pipeline\Extension\Core\Stage\Sampler\CurlSampler;
+use PhpBench\Pipeline\Extension\Core\Stage\Filter\KeysFilter;
+use PhpBench\Pipeline\Extension\Core\Stage\Aggregator\DescribeAggregator;
+use PhpBench\Pipeline\Extension\Core\Stage\Parameter\CounterParameter;
+use PhpBench\Pipeline\Extension\Core\Stage\Valve\DelayValve;
+use PhpBench\Pipeline\Extension\Console\Stage\Redraw;
+
+class ConsoleExtension implements PipelineExtension
+{
+    /**
+     * @var array
+     */
+    private $stages;
+
+    public function __construct()
+    {
+        $this->stages = [
+            'console/redraw' => new Redraw(),
+        ];
+    }
+
+    public function stageAliases(): array
+    {
+        return array_keys($this->stages);
+    }
+
+    public function stage(string $alias): Stage
+    {
+        return $this->stages[$alias];
+    }
+}

lib/Extension/Console/Stage/Redraw.php

@@ -0,0 +1,67 @@
+<?php
+
+namespace PhpBench\Pipeline\Extension\Console\Stage;
+
+use PhpBench\Pipeline\Core\Stage;
+use PhpBench\Pipeline\Extension\Console\Util\ConsoleUtil;
+use Generator;
+use PhpBench\Pipeline\Core\Schema;
+
+class Redraw implements Stage
+{
+    const ANSI_SAVE_CURSOR_POS = "\033[s";
+    const ANSI_RESTORE_CURSOR_POS = "\033[u";
+
+    public function __invoke(): Generator
+    {
+        list($config, $data) = yield;
+
+        $lastData = null;
+        $lineLength = 0;
+
+        while (true) {
+            foreach ($data as &$line) {
+                if (null === $lastData) {
+                    $line = self::ANSI_SAVE_CURSOR_POS . $line;
+                }
+
+                if ($lastData) {
+                    $line = self::ANSI_RESTORE_CURSOR_POS . $line;
+                    $lineLength = $this->maxLineLength($line, $lineLength);
+                    $line = $this->maximizeLines($line, $lineLength);
+                }
+            }
+
+            list($config, $data) = yield $data;
+            $lastData = $data;
+        }
+    }
+
+    private function maxLineLength(string $result, int $maxLineLength)
+    {
+        foreach (explode(PHP_EOL, $result) as $line) {
+            $length = mb_strlen($line);
+            if ($length > $maxLineLength) {
+                $maxLineLength = $length;
+            }
+        }
+
+        return $maxLineLength;
+    }
+
+    private function maximizeLines(string $result, int $maxLineLength)
+    {
+        $result = trim($result, PHP_EOL);
+        $lines = explode(PHP_EOL, $result);
+
+        foreach ($lines as &$line) {
+            $line = ConsoleUtil::pad($line, $maxLineLength);
+        }
+
+        return implode(PHP_EOL, $lines);
+    }
+
+    public function configure(Schema $schema)
+    {
+    }
+}

lib/Extension/Console/Util/ConsoleUtil.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace PhpBench\Pipeline\Extension\Console\Util;
+
+class ConsoleUtil
+{
+    public static function pad(string $string, int $length)
+    {
+        $width = $length - mb_strlen($string);
+        return $string . str_repeat(' ', $width);
+    }
+}

tests/Unit/Extension/Console/ConsoleTestCase.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace PhpBench\Pipeline\Tests\Unit\Extension\Console;
+
+use PHPUnit\Framework\TestCase;
+use PhpBench\Pipeline\Core\PipelineBuilder;
+use PhpBench\Pipeline\Extension\Core\CoreExtension;
+use PhpBench\Pipeline\Extension\Console\ConsoleExtension;
+
+class ConsoleTestCase extends TestCase
+{
+    protected function pipeline(): PipelineBuilder
+    {
+        return PipelineBuilder::create()
+            ->addExtension(new ConsoleExtension());
+    }
+}

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

@@ -0,0 +1,26 @@
+<?php
+
+namespace PhpBench\Pipeline\Tests\Unit\Extension\Console\Stage;
+
+use PHPUnit\Framework\TestCase;
+use PhpBench\Pipeline\Tests\Unit\Extension\Console\ConsoleTestCase;
+
+class RedrawTest extends ConsoleTestCase
+{
+    public function testAnsiControlCharsToOverwritePreviousOutput()
+    {
+        $generator = $this->pipeline()
+            ->stage(function () {
+                yield;
+                yield ['hello'];
+                yield ['goodbye'];
+                yield ['ciao'];
+            })
+            ->stage('console/redraw')
+            ->generator();
+        $generator->next();
+        $generator->next();
+        $result = $generator->current();
+        $this->assertContains('ciao', $result[0]);
+    }
+}

tests/Unit/Extension/Core/CoreTestCase.php

@@ -5,6 +5,7 @@
 use PHPUnit\Framework\TestCase;
 use PhpBench\Pipeline\Core\PipelineBuilder;
 use PhpBench\Pipeline\Extension\Core\CoreExtension;
+use PhpBench\Pipeline\Extension\Console\ConsoleExtension;
 
 class CoreTestCase extends TestCase
 {

tests/Unit/Extension/Core/Stage/Sampler/CurlSamplerTest.php

@@ -94,8 +94,6 @@ public function testConcurrentRequests()
             ->run();
 
         $requests = $this->requests();
-
-        // although we specified a concurrency of 4, 6 requests were made?
         $this->assertCount(4, $requests);
     }