Merge pull request #28 from adhocore/develop

Develop

Author: adhocore

Diff for: readme.md

@@ -345,6 +345,36 @@ $writer->errorBold('This is error');
 
 // Write a normal raw text.
 $writer->raw('Enter name: ');
+
+// Creating tables: just pass array of assoc arrays.
+// The keys of first array will be taken as heading.
+// Heading is auto inflected to human readable capitalized words (ucwords).
+$writer->table([
+    ['a' => 'apple', 'b-c' => 'ball', 'c_d' => 'cat'],
+    ['a' => 'applet', 'b-c' => 'bee', 'c_d' => 'cute'],
+]);
+
+// Gives something like:
+//
+// +--------+------+------+
+// | A      | B C  | C D  |
+// +--------+------+------+
+// | apple  | ball | cat  |
+// | applet | bee  | cute |
+// +--------+------+------+
+
+// Designing table look and feel: just pass 2nd param $styles.
+$writer->table([
+    ['a' => 'apple', 'b-c' => 'ball', 'c_d' => 'cat'],
+    ['a' => 'applet', 'b-c' => 'bee', 'c_d' => 'cute'],
+], [
+    // for => styleName (anything that you would call in $writer instance)
+    'head' => 'boldGreen', // For the table heading
+    'odd'  => 'bold',      // For the odd rows (1st row is odd, then 3, 5 etc)
+    'even' => 'comment',   // For the even rows (2nd row is even, then 4, 6 etc)
+]);
+// 'head', 'odd', 'even' are all the styles for now
+// In future we may support styling a column by its name!
 ```
 
 #### Reader

Diff for: src/Helper/InflectsString.php

@@ -27,4 +27,18 @@ public function toCamelCase(string $string): string
 
         return \lcfirst($words);
     }
+
+    /**
+     * Convert a string to capitalized words.
+     *
+     * @param string $string
+     *
+     * @return string
+     */
+    public function toWords(string $string): string
+    {
+        $words = \trim(\str_replace(['-', '_'], ' ', $string));
+
+        return \ucwords($words);
+    }
 }

Diff for: src/Helper/OutputHelper.php

@@ -21,6 +21,9 @@ class OutputHelper
     /** @var Writer */
     protected $writer;
 
+    /** @var int Max width of command name */
+    protected $maxCmdName;
+
     public function __construct(Writer $writer = null)
     {
         $this->writer = $writer ?? new Writer;
@@ -63,6 +66,10 @@ public function showOptionsHelp(array $options, string $header = '', string $foo
      */
     public function showCommandsHelp(array $commands, string $header = '', string $footer = ''): self
     {
+        $this->maxCmdName = $commands ? \max(\array_map(function (Command $cmd) {
+            return \strlen($cmd->name());
+        }, $commands)) : 0;
+
         $this->showHelp('Commands', $commands, $header, $footer);
 
         return $this;
@@ -114,14 +121,13 @@ protected function showHelp(string $for, array $items, string $header = '', stri
      */
     protected function sortItems(array $items, &$max = 0): array
     {
-        $first = reset($items);
-        $max   = \strlen($first->name());
-
-        \uasort($items, function ($a, $b) use (&$max) {
-            /** @var Parameter $b */
-            /** @var Parameter $a */
-            $max = \max(\strlen($this->getName($a)), \strlen($this->getName($b)), $max);
+        $max = \max(\array_map(function ($item) {
+            return \strlen($this->getName($item));
+        }, $items));
 
+        \uasort($items, function ($a, $b) {
+            /* @var Parameter $b */
+            /* @var Parameter $a */
             return $a->name() <=> $b->name();
         });
 
@@ -140,7 +146,7 @@ protected function getName($item): string
         $name = $item->name();
 
         if ($item instanceof Command) {
-            return \trim($item->alias() . '|' . $name, '|');
+            return \trim(\str_pad($name, $this->maxCmdName) . ' ' . $item->alias());
         }
 
         return $this->label($item);

Diff for: src/IO/Interactor.php

@@ -140,6 +140,7 @@
  * @method Writer redBgPurple($text, $eol = false)
  * @method Writer redBgWhite($text, $eol = false)
  * @method Writer redBgYellow($text, $eol = false)
+ * @method Writer table(array $rows, array $styles = [])
  * @method Writer warn($text, $eol = false)
  * @method Writer white($text, $eol = false)
  * @method Writer yellow($text, $eol = false)
@@ -334,6 +335,8 @@ protected function promptOptions(array $choices, $default): self
             $options .= "/<$style>$choice</end>";
         }
 
+        $options = \ltrim($options, '/');
+
         $this->writer->colors(" ($options): ");
 
         return $this;

Diff for: src/Output/Writer.php

@@ -2,6 +2,9 @@
 
 namespace Ahc\Cli\Output;
 
+use Ahc\Cli\Exception\InvalidArgumentException;
+use Ahc\Cli\Helper\InflectsString;
+
 /**
  * Cli Writer.
  *
@@ -149,6 +152,8 @@
  */
 class Writer
 {
+    use InflectsString;
+
     /** @var resource Output file handle */
     protected $stream;
 
@@ -267,6 +272,98 @@ public function raw($text, bool $error = false): self
         return $this->doWrite((string) $text, $error);
     }
 
+    /**
+     * Generate table for the console. Keys of first row are taken as header.
+     *
+     * @param array[] $rows   Array of assoc arrays.
+     * @param array   $styles Eg: ['head' => 'bold', 'odd' => 'comment', 'even' => 'green']
+     *
+     * @return self
+     */
+    public function table(array $rows, array $styles = []): self
+    {
+        if ([] === $table = $this->normalizeTable($rows)) {
+            return $this;
+        }
+
+        list($head, $rows) = $table;
+
+        $styles = $this->normalizeStyles($styles);
+        $title  = $body = $dash = [];
+
+        list($start, $end) = $styles['head'];
+        foreach ($head as $col => $size) {
+            $dash[]  = \str_repeat('-', $size + 2);
+            $title[] = \str_pad($this->toWords($col), $size, ' ');
+        }
+
+        $title = "|$start " . \implode(" $end|$start ", $title) . " $end|" . \PHP_EOL;
+
+        $odd = true;
+        foreach ($rows as $row) {
+            $parts = [];
+
+            list($start, $end) = $styles[['even', 'odd'][(int) $odd]];
+            foreach ($head as $col => $size) {
+                $parts[] = \str_pad($row[$col] ?? '', $size, ' ');
+            }
+
+            $odd    = !$odd;
+            $body[] = "|$start " . \implode(" $end|$start ", $parts) . " $end|";
+        }
+
+        $dash  = '+' . \implode('+', $dash) . '+' . \PHP_EOL;
+        $body  = \implode(\PHP_EOL, $body) . \PHP_EOL;
+
+        return $this->colors("$dash$title$dash$body$dash");
+    }
+
+    protected function normalizeTable(array $rows): array
+    {
+        $head = \reset($rows);
+        if (empty($head)) {
+            return [];
+        }
+
+        if (!\is_array($head)) {
+            throw new InvalidArgumentException(
+                \sprintf('Rows must be array of assoc arrays, %s given', \gettype($head))
+            );
+        }
+
+        $head = \array_fill_keys(\array_keys($head), null);
+        foreach ($rows as $i => &$row) {
+            $row = \array_merge($head, $row);
+        }
+
+        foreach ($head as $col => &$value) {
+            $cols   = \array_column($rows, $col);
+            $span   = \array_map('strlen', $cols);
+            $span[] = \strlen($col);
+            $value  = \max($span);
+        }
+
+        return [$head, $rows];
+    }
+
+    protected function normalizeStyles(array $styles)
+    {
+        $default = [
+            // styleFor => ['styleStartFn', 'end']
+            'head' => ['', ''],
+            'odd'  => ['', ''],
+            'even' => ['', ''],
+        ];
+
+        foreach ($styles as $for => $style) {
+            if (isset($default[$for])) {
+                $default[$for] = ['<' . \trim($style, '<> ') . '>', '</end>'];
+            }
+        }
+
+        return $default;
+    }
+
     /**
      * Write to stdout or stderr magically.
      *

Diff for: tests/CliTestCase.php

@@ -9,6 +9,8 @@
  */
 class CliTestCase extends TestCase
 {
+    protected static $ou = __DIR__ . '/output';
+
     public static function setUpBeforeClass()
     {
         // Thanks: https://stackoverflow.com/a/39785995
@@ -21,16 +23,27 @@ public function setUp()
     {
         ob_start();
         StreamInterceptor::$buffer = '';
+        file_put_contents(static::$ou, '');
     }
 
     public function tearDown()
     {
         ob_end_clean();
     }
 
+    public static function tearDownAfterClass()
+    {
+        unlink(static::$ou);
+    }
+
     public function buffer()
     {
-        return StreamInterceptor::$buffer;
+        return StreamInterceptor::$buffer ?: file_get_contents(static::$ou);
+    }
+
+    public function assertBufferContains($expect)
+    {
+        $this->assertContains($expect, $this->buffer());
     }
 }
 

Diff for: tests/Helper/InflectsStringTest.php

@@ -15,4 +15,11 @@ public function test_to_camel_case()
         $this->assertSame('theLongName', $this->toCamelCase('--the_long-name'));
         $this->assertSame('aBC', $this->toCamelCase('a_bC'));
     }
+
+    public function test_to_words()
+    {
+        $this->assertSame('A B', $this->toWords('a-b'));
+        $this->assertSame('The Long Name', $this->toWords('--the_long-name'));
+        $this->assertSame('A BC', $this->toWords('a_bC'));
+    }
 }

Diff for: tests/Output/WriterTest.php

@@ -42,7 +42,7 @@ public function test_write_bold_red_bggreen()
 
     public function test_raw()
     {
-        $w = new Writer($ou = __DIR__ . '/output');
+        $w = new Writer(static::$ou);
 
         $w->raw(new class {
             public function __toString()
@@ -51,10 +51,45 @@ public function __toString()
             }
         })->clear();
 
-        $out = file_get_contents($ou);
-        $this->assertSame("__toString\e[2J", $out);
+        $this->assertSame("__toString\e[2J", $this->buffer());
+    }
+
+    public function test_empty_table()
+    {
+        $w = new Writer(static::$ou);
+
+        $w->table([]);
+
+        $this->assertSame('', $this->buffer(), 'empty');
+    }
+
+    public function test_table()
+    {
+        $w = new Writer(static::$ou);
+
+        $w->table([
+            ['a' => 'apple', 'b-c' => 'ball', 'c_d' => 'cat'],
+            ['a' => 'applet', 'b-c' => 'bee', 'c_d' => 'cute'],
+        ], [
+            'head' => 'boldBgGreen',
+            'odd'  => 'purple',
+            'even' => 'cyan',
+        ]);
+
+        $this->assertSame(3, \substr_count($this->buffer(), '+--------+------+------+'), '3 dashes');
+        $this->assertBufferContains("|\33[1;37;42m A      \33[0m|\33[1;37;42m B C  \33[0m|\33[1;37;42m C D  \33[0m|", 'Head');
+        $this->assertBufferContains("|\33[0;35m apple  \33[0m|\33[0;35m ball \33[0m|\33[0;35m cat  \33[0m|", 'Odd');
+        $this->assertBufferContains("|\33[0;36m applet \33[0m|\33[0;36m bee  \33[0m|\33[0;36m cute \33[0m|", 'Even');
+    }
+
+    public function test_table_throws()
+    {
+        $w = new Writer(static::$ou);
+
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('Rows must be array of assoc arrays');
 
-        unlink($ou);
+        $w->table([1, 2]);
     }
 
     public function test_colorizer()