Merge pull request #50 from adhocore/develop

Develop

Author: adhocore

README.md

@@ -11,6 +11,7 @@ Framework agnostic Command Line Interface utilities and helpers for PHP. Build C
 
 - Command line application made easy
 - Inspired by nodejs [commander](https://github.com/tj/commander.js) (thanks tj)
+- Zero dependency.
 - For PHP7 and for good
 
 [![Screen Preview](https://i.imgur.com/qIYg9Zn.gif "Preview from adhocore/phalcon-ext which uses this cli package")](https://github.com/adhocore/phalcon-ext/tree/master/example/cli)
@@ -499,6 +500,22 @@ $reader->read('abc', 'trim');
 // Read at most first 5 chars
 // (if ENTER is pressed before 5 chars then further read is aborted)
 $reader->read('', 'trim', 5);
+
+// Read but dont echo back the input
+$reader->readHidden($default, $callback);
+
+// Read from piped stream (or STDIN) if available without waiting
+$reader->readPiped();
+
+// Pass in a callback for if STDIN is empty
+// The callback recieves $reader instance and MUST return string
+$reader->readPiped(function ($reader) {
+    // Wait to read a line!
+    return $reader->read();
+
+    // Wait to read multi lines (until Ctrl+D pressed)
+    return $reader->readAll();
+});
 ```
 
 #### Exceptions
@@ -579,3 +596,7 @@ appname subcommand <tab> # autocompletes options for subcommand (phint init <tab
 ## License
 
 > &copy; 2018, [Jitendra Adhikari](https://github.com/adhocore) | [MIT](./LICENSE)
+
+### Credits
+
+This project is release managed by [please](https://github.com/adhocore/please).

composer.json

@@ -29,5 +29,9 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^6.0"
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit",
+        "test:cov": "vendor/bin/phpunit --coverage-text --coverage-clover coverage.xml --coverage-html vendor/cov"
     }
 }

src/Helper/OutputHelper.php

@@ -191,6 +191,40 @@ protected function showHelp(string $for, array $items, string $header = '', stri
         }
     }
 
+    /**
+     * Show usage examples of a Command.
+     *
+     * It replaces $0 with actual command name and properly pads ` ## ` segments.
+     *
+     * @param string|null $usage Usage description.
+     *
+     * @return self
+     */
+    public function showUsage(string $usage = null): self
+    {
+        $usage = \str_replace('$0', $_SERVER['argv'][0] ?? '[cmd]', $usage);
+
+        if (\strpos($usage, ' ## ') === false) {
+            $this->writer->eol()->boldGreen('Usage Examples:', true)->colors($usage)->eol();
+
+            return $this;
+        }
+
+        $lines = \explode("\n", \str_replace(['<eol>', '<eol/>', '</eol>', "\r\n"], "\n", $usage));
+        foreach ($lines as &$pos) {
+            $pos = \strpos(\preg_replace('~<.*?>~', '', $pos), ' ##');
+        }
+
+        $maxlen = \max($lines) + 4;
+        $usage  = \preg_replace_callback('~ ## ~', function () use (&$lines, $maxlen) {
+            return \str_pad('# ', $maxlen - \array_shift($lines), ' ', \STR_PAD_LEFT);
+        }, $usage);
+
+        $this->writer->eol()->boldGreen('Usage Examples:', true)->colors($usage)->eol();
+
+        return $this;
+    }
+
     /**
      * Sort items by name. As a side effect sets max length of all names.
      *

src/Helper/Shell.php

@@ -152,8 +152,11 @@ protected function checkTimeout()
 
             throw new RuntimeException('Timeout occurred, process terminated.');
         }
+        // @codeCoverageIgnoreStart
     }
 
+    // @codeCoverageIgnoreEnd
+
     public function setOptions(string $cwd = null, array $env = null, float $timeout = null, array $otherOptions = []): self
     {
         $this->cwd            = $cwd;

src/Input/Command.php

@@ -343,12 +343,8 @@ public function showHelp()
 
         $helper
             ->showArgumentsHelp($this->allArguments())
-            ->showOptionsHelp($this->allOptions(), '', 'Legend: <required> [optional] variadic...');
-
-        if ($this->_usage) {
-            $io->eol();
-            $io->boldGreen('Usage Examples:', true)->colors($this->_usage)->eol();
-        }
+            ->showOptionsHelp($this->allOptions(), '', 'Legend: <required> [optional] variadic...')
+            ->showUsage($this->_usage);
 
         return $this->emit('_exit', 0);
     }

src/Input/Reader.php

@@ -53,6 +53,51 @@ public function read($default = null, callable $fn = null)
         return $fn ? $fn($in) : $in;
     }
 
+    /**
+     * Same like read but it reads all the lines.
+     *
+     * @codeCoverageIgnore
+     *
+     * @param callable|null $fn The validator/sanitizer callback.
+     *
+     * @return string
+     */
+    public function readAll(callable $fn = null): string
+    {
+        $in = \stream_get_contents($this->stream);
+
+        return $fn ? $fn($in) : $in;
+    }
+
+    /**
+     * Read content piped to the stream without waiting.
+     *
+     * @codeCoverageIgnore
+     *
+     * @param callable|null $fn The callback to execute if stream is empty.
+     *
+     * @return string
+     */
+    public function readPiped(callable $fn = null): string
+    {
+        $stdin = '';
+        $read  = [$this->stream];
+        $write = [];
+        $exept = [];
+
+        if (\stream_select($read, $write, $exept, 0) === 1) {
+            while ($line = \fgets($this->stream)) {
+                $stdin .= $line;
+            }
+        }
+
+        if ('' === $stdin) {
+            return $fn ? $fn($this) : '';
+        }
+
+        return $stdin;
+    }
+
     /**
      * Read a line from configured stream (or terminal) but don't echo it back.
      *
@@ -86,7 +131,7 @@ public function readHidden($default = null, callable $fn = null)
      *
      * @return mixed
      */
-    private function readHiddenWinOS($default = null, callable $fn = null)
+    protected function readHiddenWinOS($default = null, callable $fn = null)
     {
         $cmd = 'powershell -Command ' . \implode('; ', \array_filter([
             '$pword = Read-Host -AsSecureString',

src/Output/Color.php

@@ -23,14 +23,16 @@
  */
 class Color
 {
-    const BLACK  = 30;
-    const RED    = 31;
-    const GREEN  = 32;
-    const YELLOW = 33;
-    const BLUE   = 34;
-    const PURPLE = 35;
-    const CYAN   = 36;
-    const WHITE  = 37;
+    const BLACK    = 30;
+    const RED      = 31;
+    const GREEN    = 32;
+    const YELLOW   = 33;
+    const BLUE     = 34;
+    const PURPLE   = 35;
+    const CYAN     = 36;
+    const WHITE    = 37;
+    const GRAY     = 47;
+    const DARKGRAY = 100;
 
     /** @var string Cli format */
     protected $format = "\033[:bold:;:fg:;:bg:m:text:\033[0m";
@@ -48,7 +50,7 @@ class Color
      */
     public function comment(string $text, array $style = []): string
     {
-        return $this->line($text, ['fg' => static::BLACK, 'bold' => 1] + $style);
+        return $this->line($text, ['fg' => static::DARKGRAY, 'bold' => 0] + $style);
     }
 
     /**

src/Output/Table.php

@@ -0,0 +1,104 @@
+<?php
+
+/*
+ * This file is part of the PHP-CLI package.
+ *
+ * (c) Jitendra Adhikari <[email protected]>
+ *     <https://github.com/adhocore>
+ *
+ * Licensed under MIT license.
+ */
+
+namespace Ahc\Cli\Output;
+
+use Ahc\Cli\Exception\InvalidArgumentException;
+use Ahc\Cli\Helper\InflectsString;
+
+class Table
+{
+    use InflectsString;
+
+    public function render(array $rows, array $styles = []): string
+    {
+        if ([] === $table = $this->normalize($rows)) {
+            return '';
+        }
+
+        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 "$dash$title$dash$body$dash";
+    }
+
+    protected function normalize(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;
+    }
+}