update, complete progress bar

Author: inhere

examples/baks/auto_complete.php

@@ -10,12 +10,13 @@
 
 function your_callback($input, $index) {
     // Get info about the current buffer
-    $rl_info = readline_info();
-
+    $info = readline_info();
     // Figure out what the entire input is
-//    $full_input = substr($rl_info['line_buffer'], 0, $rl_info['end']);
+    $line = substr($info['line_buffer'], 0, $info['end']);
+    $tokens = token_get_all('<?php ' . $line);
+
+    var_dump($input, $index, $info, $line, $tokens);
 
-    //var_dump($input, $index, $rl_info);die;
     $matches = array();
 
     // Get all matches based on the entire input buffer

examples/routes.php

@@ -12,13 +12,30 @@
 use inhere\console\examples\TestCommand;
 use inhere\console\io\Input;
 use inhere\console\io\Output;
+use inhere\console\utils\ProgressBar;
 
+$app->command(\inhere\console\examples\DemoCommand::class);
 $app->command('exam', function (Input $in, Output $out) {
     $cmd = $in->getCommand();
 
     $out->info('hello, this is a test command: ' . $cmd);
 });
 
 $app->command('test', TestCommand::class);
-$app->command(\inhere\console\examples\DemoCommand::class);
+$app->command('prg', function () {
+    $i = 0;
+    $total = 120;
+    $bar = new ProgressBar();
+    $bar->start(120);
+
+    while ($i <= $total) {
+        $bar->advance();
+        usleep(50000);
+        $i++;
+    }
+
+    $bar->finish();
+
+}, 'a description message');
+
 $app->controller('home', HomeController::class);

src/AbstractApp.php

@@ -17,7 +17,7 @@
  * Class AbstractApp
  * @package inhere\console
  */
-abstract class AbstractApp
+abstract class AbstractApp implements AppInterface
 {
     use InputOutputTrait;
     use SimpleEventStaticTrait;
@@ -84,6 +84,11 @@ abstract class AbstractApp
      */
     protected $commands = [];
 
+    /**
+     * @var array
+     */
+    private $commandMessages = [];
+
     /**
      * @var string
      */
@@ -135,6 +140,7 @@ protected function init()
     protected function prepareRun()
     {
         // date_default_timezone_set($this->config('timeZone', 'UTC'));
+        //new AutoCompletion(array_merge($this->getCommandNames(), $this->getControllerNames()));
     }
 
     /**
@@ -241,9 +247,10 @@ public function controllers(array $controllers)
      * Register a app independent console command
      * @param string $name
      * @param string|\Closure $handler
+     * @param null|string $description
      * @return $this
      */
-    public function command(string $name, $handler = null)
+    public function command(string $name, $handler = null, $description = null)
     {
         if (!$handler && class_exists($name)) {
             /** @var Command $handler */
@@ -279,6 +286,10 @@ public function command(string $name, $handler = null)
         // is an class name string
         $this->commands[$name] = $handler;
 
+        if ($description) {
+            $this->addCommandMessage($name, $description);
+        }
+
         return $this;
     }
 
@@ -455,6 +466,8 @@ public function showCommandList($quit = true)
             /** @var AbstractCommand $command */
             if (is_subclass_of($command, Command::class)) {
                 $desc = $command::getDescription() ?: $desPlaceholder;
+            } else if ($msg = $this->getCommandMessage($name)) {
+                $desc = $msg;
             } else if (is_string($command)) {
                 $desc = 'A handler: ' . $command;
             } else if (is_object($command)) {
@@ -478,6 +491,26 @@ public function showCommandList($quit = true)
         $quit && $this->stop();
     }
 
+    /**
+     * @param string $name
+     * @param string $default
+     * @return string
+     */
+    public function getCommandMessage($name, $default = null)
+    {
+        return $this->commandMessages[$name] ?? $default;
+    }
+
+    /**
+     * @param string $name The command name
+     * @param string $message
+     * @return string
+     */
+    public function addCommandMessage($name, $message)
+    {
+        return $this->commandMessages[$name] = $message;
+    }
+
     /**********************************************************
      * getter/setter methods
      **********************************************************/
@@ -490,6 +523,22 @@ public static function isNoColor(): bool
         return self::$noColor;
     }
 
+    /**
+     * @return array
+     */
+    public function getControllerNames()
+    {
+        return array_keys($this->controllers);
+    }
+
+    /**
+     * @return array
+     */
+    public function getCommandNames()
+    {
+        return array_keys($this->commands);
+    }
+
     /**
      * @param array $controllers
      */
@@ -591,4 +640,20 @@ public function isDebug()
     {
         return $this->input->getOpt('debug');
     }
+
+    /**
+     * @return array
+     */
+    public function getCommandMessages(): array
+    {
+        return $this->commandMessages;
+    }
+
+    /**
+     * @param array $commandMessages
+     */
+    public function setCommandMessages(array $commandMessages)
+    {
+        $this->commandMessages = $commandMessages;
+    }
 }

src/AppInterface.php

@@ -0,0 +1,21 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: inhere
+ * Date: 2017-08-14
+ * Time: 16:51
+ */
+
+namespace inhere\console;
+
+/**
+ * Interface AppInterface
+ * @package inhere\console
+ */
+interface AppInterface
+{
+    public function run($exit = true);
+    public function stop($code = 0);
+
+    public function controller(string $name, string $controller = null);
+}

src/utils/AutoCompleter.php

@@ -0,0 +1,139 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: inhere
+ * Date: 2017-08-11
+ * Time: 17:56
+ */
+
+namespace inhere\console\utils;
+
+/**
+ * Class AutoCompletion - a simple command auto-completion tool
+ *
+ * @todo not available
+ * @package inhere\console\utils
+ */
+class AutoCompletion
+{
+    /**
+     * @var callable
+     */
+    private $matcher;
+
+    /**
+     * @var array
+     */
+    private $data;
+
+    /**
+     * AutoCompletion constructor.
+     * @param array $data
+     * @param bool $enable
+     */
+    public function __construct(array $data = [], $enable = true)
+    {
+        $this->data = $data;
+
+        if ($enable) {
+            $this->register();
+        }
+    }
+
+    /**
+     * Activate readline tab completion.
+     */
+    public function register()
+    {
+        readline_completion_function([&$this, 'completionHandler']);
+    }
+
+    /**
+     * The readline_completion_function callback handler.
+     * @param string $input the user input
+     * @param $index
+     *
+     * @return array
+     */
+    public function completionHandler($input, $index)
+    {
+        $info = readline_info();
+        $line = substr($info['line_buffer'], 0, $info['end']);
+        $tokens = token_get_all('<?php ' . $line);
+        $input = trim($input);
+
+        if (!$input) {
+            return $this->data;
+        }
+
+        $matches = [];
+        $matcher = $this->matcher;
+
+        foreach ($this->data as $item) {
+            if ($matcher && $matcher($input, $item)) {
+                $matches[] = $item;
+            } elseif ($this->internalMatcher($input, $item)) {
+                $matches[] = $item;
+            }
+        }
+
+        if (!$matches) {
+            return [];
+        }
+
+        $matches = array_unique($matches);
+        return $matches ?: [''];
+    }
+
+    /**
+     * @param $input
+     * @param $target
+     * @return bool
+     */
+    protected function internalMatcher($input, $target)
+    {
+        return stripos($target, $input) !== false;
+    }
+
+    /**
+     * @return callable
+     */
+    public function getMatcher()
+    {
+        return $this->matcher;
+    }
+
+    /**
+     * @param callable $matcher
+     */
+    public function setMatcher(callable $matcher)
+    {
+        $this->matcher = $matcher;
+    }
+
+    /**
+     * @return array
+     */
+    public function getData(): array
+    {
+        return $this->data;
+    }
+
+    /**
+     * @param array $data
+     */
+    public function setData(array $data)
+    {
+        $this->data = $data;
+    }
+
+    /**
+     * @return $this
+     */
+    public function reset()
+    {
+        $this->data = [];
+
+        return $this;
+    }
+}