update some logic. rename some classes

Author: inhere

.gitignore

@@ -8,3 +8,4 @@ composer.lock
 *.pid
 *.patch
 .DS_Store
+*.bz2

README.md

@@ -1,21 +1,78 @@
 # cli-utils
 
-some utils for the CLI
+Some useful utils for the php CLI env.
 
 ## Install
 
 ```bash
 composer require toolkit/cli-utils
 ```
 
-## cli color
+## Parse cli arguments and options
 
-![colors](./example/all-color-style.jpg)
+```php
+use Toolkit\Cli\Flags;
+
+$argv = $_SERVER['argv'];
+// notice: must shift first element.
+$script = \array_shift($argv);
+// do parse
+list($args, $shortOpts, $longOpts) = Flags::parseArgv($argv);
+```
 
-## php file highlight
+## PHP file highlight
+
+```php
+use Toolkit\Cli\Highlighter;
+
+// this is an comment
+$rendered = Highlighter::create()->highlight(file_get_contents(__FILE__));
+
+\Toolkit\Cli\Cli::write($rendered);
+```
 
 ![colors](./example/cli-php-file-highlight.jpg)
 
-## license
+## Console color
+
+![colors](./example/all-color-style.jpg)
+
+## Cli downloader
+
+```php
+use Toolkit\Cli\Download;
+
+$url  = 'http://no2.php.net/distributions/php-7.2.5.tar.bz2';
+$down = Download::file($url, '');
+
+// $down->setShowType('bar');
+$down->start();
+```
+
+### progress bar output:
+
+```text
+Connected...
+Mime-type: text/html; charset=utf-8
+Being redirected to: http://no2.php.net/distributions/php-7.2.5.tar.bz2
+Connected...
+FileSize: 14280 kb
+Mime-type: application/octet-stream
+[========================================>                                                           ] 40% (3076/7590 kb)
+```
+
+### progress text output:
+
+```text
+Download: http://no2.php.net/distributions/php-7.2.5.tar.bz2
+Save As: /path/to/php-7.2.5.tar.bz2
+
+Connected ...
+Got the file size: 14280 kb
+Found the mime-type: application/octet-stream
+Made some progress, downloaded 641 kb so far
+```
+
+## License
 
 MIT

composer.json

@@ -24,6 +24,11 @@
       "Toolkit\\Cli\\": "src/"
     }
   },
+  "autoload-dev": {
+    "psr-4": {
+      "Toolkit\\CliTest\\": "src/"
+    }
+  },
   "suggest": {
     "inhere/simple-print-tool": "Very lightweight data printing tools",
     "inhere/php-validate": "Very lightweight data validate tool",

example/down.php

@@ -0,0 +1,19 @@
+<?php
+/**
+ * demo for cli download file.
+ */
+
+use Toolkit\Cli\Download;
+
+require dirname(__DIR__) . '/test/boot.php';
+
+$url  = 'http://no2.php.net/distributions/php-7.2.5.tar.bz2';
+$app  = new \Toolkit\Cli\App();
+$down = Download::file($url, '');
+
+$type = $app->getArg(0, 'text');
+if ($type === 'bar') {
+    $down->setShowType($type);
+}
+
+$down->start();

example/liteApp

@@ -6,7 +6,7 @@ define('BASE_PATH', dirname(__DIR__));
 require dirname(__DIR__) . '/test/boot.php';
 
 // create app instance
-$app = new Toolkit\Cli\LiteApp;
+$app = new Toolkit\Cli\App;
 
 // register commands
 $app->addCommand('test', function () {

src/LiteApp.php renamed to src/App.php

@@ -9,24 +9,21 @@
 namespace Toolkit\Cli;
 
 /**
- * Class LiteApp - A lite CLI Application
+ * Class App - A lite CLI Application
  * @package Inhere\Console
  */
-class LiteApp
+class App
 {
-    /****************************************************************************
-     * simple cli support
-     ****************************************************************************/
+    /** @var string Current dir */
+    private $pwd;
 
     /**
-     * parse from `name=val var2=val2`
-     * @var array
+     * @var array Parsed from `arg0 name=val var2=val2`
      */
     private $args = [];
 
     /**
-     * parse from `--name=val --var2=val2 -d`
-     * @var array
+     * @var array Parsed from `--name=val --var2=val2 -d`
      */
     private $opts = [];
 
@@ -37,25 +34,42 @@ class LiteApp
     private $command = '';
 
     /**
-     * user add commands
-     * @var array
+     * @var array User add commands
      */
     private $commands = [];
 
     /**
-     * description message for the command
-     * @var array
+     * @var array Description message for the commands
      */
     private $messages = [];
 
+    /** @var int */
+    private $keyWidth = 12;
+
+    /**
+     * Class constructor.
+     * @param array|null $argv
+     */
+    public function __construct(array $argv = null)
+    {
+        // get current dir
+        $this->pwd = \getcwd();
+
+        // parse cli argv
+        $argv = $argv ?? (array)$_SERVER['argv'];
+        // get script file
+        $this->script = \array_shift($argv);
+        // parse flags
+        [$this->args, $this->opts] = Flags::simpleParseArgv($argv);
+
+    }
+
     /**
      * @param bool $exit
      * @throws \InvalidArgumentException
      */
     public function run(bool $exit = true)
     {
-        $this->parseCliArgv();
-
         if (isset($this->args[0])) {
             $this->command = $this->args[0];
             unset($this->args[0]);
@@ -71,7 +85,8 @@ public function run(bool $exit = true)
     public function dispatch(bool $exit = true)
     {
         if (!$command = $this->command) {
-            $this->showCommands();
+            $this->displayHelp();
+            return;
         }
 
         $status = 0;
@@ -80,7 +95,7 @@ public function dispatch(bool $exit = true)
             if (isset($this->commands[$command])) {
                 $status = $this->runHandler($command, $this->commands[$command]);
             } else {
-                $this->showCommands("The command {$command} not exists!");
+                $this->displayHelp("The command {$command} not exists!");
             }
         } catch (\Throwable $e) {
             $status = $this->handleException($e);
@@ -152,52 +167,19 @@ protected function handleException(\Throwable $e): int
     }
 
     /**
-     * parseCliArgv
-     */
-    public function parseCliArgv()
-    {
-        /** @var array $argv */
-        $argv = $_SERVER['argv'];
-        $this->script = array_shift($argv);
-
-        foreach ($argv as $key => $value) {
-            // opts
-            if (strpos($value, '-') === 0) {
-                $value = trim($value, '-');
-
-                if (!$value) {
-                    continue;
-                }
-
-                if (strpos($value, '=')) {
-                    list($n, $v) = explode('=', $value);
-                    $this->opts[$n] = $v;
-                } else {
-                    $this->opts[$value] = true;
-                }
-            } elseif (strpos($value, '=')) {
-                list($n, $v) = explode('=', $value);
-                $this->args[$n] = $v;
-            } else {
-                $this->args[] = $value;
-            }
-        }
-    }
-
-    /**
-     * @param string          $command
-     * @param string|\Closure $handler
-     * @param string          $description
+     * @param string   $command
+     * @param callable $handler
+     * @param string   $description
      * @throws \InvalidArgumentException
      */
-    public function addCommand(string $command, $handler, $description = '')
+    public function addCommand(string $command, callable $handler, string $description = '')
     {
         if (!$command || !$handler) {
             throw new \InvalidArgumentException('Invalid arguments');
         }
 
         $this->commands[$command] = $handler;
-        $this->messages[$command] = trim($description);
+        $this->messages[$command] = \trim($description);
     }
 
     /**
@@ -210,9 +192,9 @@ public function commands(array $commands)
             $des = '';
 
             if (\is_array($handler)) {
-                $conf = array_values($handler);
+                $conf    = \array_values($handler);
                 $handler = $conf[0];
-                $des = $conf[1] ?? '';
+                $des     = $conf[1] ?? '';
             }
 
             $this->addCommand($command, $handler, $des);
@@ -226,28 +208,29 @@ public function commands(array $commands)
     /**
      * @param string $err
      */
-    public function showCommands($err = '')
+    public function displayHelp(string $err = '')
     {
         if ($err) {
             echo Color::render("<red>ERROR</red>: $err\n\n");
         }
 
         $commandWidth = 12;
+        // help
         $help = "Welcome to the Lite Console Application.\n\n<comment>Available Commands:</comment>\n";
 
         foreach ($this->messages as $command => $desc) {
             $command = str_pad($command, $commandWidth, ' ');
-            $desc = $desc ?: 'No description for the command';
-            $help .= "  $command   $desc\n";
+            $desc    = $desc ?: 'No description for the command';
+            $help    .= "  $command   $desc\n";
         }
 
         echo Color::render($help) . PHP_EOL;
         exit(0);
     }
 
     /**
-     * @param string $name
-     * @param mixed  $default
+     * @param string|int $name
+     * @param mixed      $default
      * @return mixed|null
      */
     public function getArg($name, $default = null)
@@ -260,7 +243,7 @@ public function getArg($name, $default = null)
      * @param mixed  $default
      * @return mixed|null
      */
-    public function getOpt($name, $default = null)
+    public function getOpt(string $name, $default = null)
     {
         return $this->opts[$name] ?? $default;
     }
@@ -344,7 +327,7 @@ public function getCommands(): array
     /**
      * @param array $commands
      */
-    public function setCommands(array $commands)
+    public function setCommands(array $commands): void
     {
         $this->commands = $commands;
     }
@@ -360,9 +343,33 @@ public function getMessages(): array
     /**
      * @param array $messages
      */
-    public function setMessages(array $messages)
+    public function setMessages(array $messages): void
     {
         $this->messages = $messages;
     }
 
+    /**
+     * @return int
+     */
+    public function getKeyWidth(): int
+    {
+        return $this->keyWidth;
+    }
+
+    /**
+     * @param int $keyWidth
+     */
+    public function setKeyWidth(int $keyWidth): void
+    {
+        $this->keyWidth = $keyWidth > 1 ? $keyWidth : 12;
+    }
+
+    /**
+     * @return string
+     */
+    public function getPwd(): string
+    {
+        return $this->pwd;
+    }
+
 }