some update

Author: inhere

examples/DemoCommand.php

@@ -21,11 +21,14 @@ class DemoCommand extends Command
     protected static $name = 'demo';
     protected static $description = 'this is a demo independent command. but config use configure(), it like symfony console: argument define by position';
 
+    /**
+     * {@inheritDoc}
+     */
     protected function configure()
     {
         $this->createDefinition()
             ->setDescription(self::getDescription())
-            ->setExample($this->replaceAnnotationVars('{script} {command} john male 43 --opt1 value1'))
+            ->setExample($this->handleAnnotationVars('{script} {command} john male 43 --opt1 value1'))
             ->addArgument('name', Input::ARG_REQUIRED, 'description for the argument [name], is required')
             ->addArgument('sex', Input::ARG_OPTIONAL, 'description for the argument [sex], is optional')
             ->addArgument('age', Input::ARG_OPTIONAL, 'description for the argument [age], is optional')

src/Application.php

@@ -9,6 +9,7 @@
 namespace Inhere\Console;
 
 use Inhere\Console\Base\AbstractApplication;
+use LightCms\Web\App;
 
 /**
  * Class App
@@ -23,38 +24,47 @@ class Application extends AbstractApplication
     /**
      * Register a app group command(by controller)
      * @param string $name The controller name
-     * @param string $controller The controller class
+     * @param string $class The controller class
      * @return static
      */
-    public function controller(string $name, string $controller = null)
+    public function controller(string $name, string $class = null)
     {
-        if (!$controller && class_exists($name)) {
-            /** @var Controller $controller */
-            $controller = $name;
-            $name = $controller::getName();
+        if (!$class && class_exists($name)) {
+            /** @var Controller $class */
+            $class = $name;
+            $name = $class::getName();
         }
 
-        if (!$name || !$controller) {
+        if (!$name || !$class) {
             throw new \InvalidArgumentException(
-                'Group-command "name" and "controller" not allowed to is empty! name: ' . $name . ', controller: ' . $controller
+                'Group-command "name" and "controller" not allowed to is empty! name: ' . $name . ', controller: ' . $class
             );
         }
 
         $this->validateName($name, true);
 
-        if (!class_exists($controller)) {
-            throw new \InvalidArgumentException("The console controller class [$controller] not exists!");
+        if (!class_exists($class)) {
+            throw new \InvalidArgumentException("The console controller class [$class] not exists!");
         }
 
-        if (!is_subclass_of($controller, Controller::class)) {
+        if (!is_subclass_of($class, Controller::class)) {
             throw new \InvalidArgumentException('The console controller class must is subclass of the: ' . Controller::class);
         }
 
-        $this->controllers[$name] = $controller;
+        $this->controllers[$name] = $class;
 
         return $this;
     }
 
+    /**
+     * @see Application::controller()
+     * {@inheritdoc}
+     */
+    public function addController(string $name, string $class = null)
+    {
+        return $this->controller($name, $class);
+    }
+
     /**
      * @param array $controllers
      */

src/Base/AbstractApplication.php

@@ -155,16 +155,29 @@ public function run($exit = true)
     }
 
     /**
+     * dispatch command
      * @param string $command A command name
      * @return int|mixed
      */
     abstract protected function dispatch($command);
 
+    /**
+     * run a independent command
+     * {@inheritdoc}
+     */
+    abstract public function runCommand($name, $believable = false);
+
+    /**
+     * run a controller's action
+     * {@inheritdoc}
+     */
+    abstract public function runAction($name, $action, $believable = false, $standAlone = false);
+
     protected function afterRun()
     {
         // display runtime info
         if ($this->isDebug()) {
-            $title = '------------ Runtime Stats ------------';
+            $title = '---------- Runtime Stats(debug=true) ----------';
             $stats = $this->meta['_stats'];
             $this->meta['_stats'] = Helper::runtime($stats['startTime'], $stats['startMemory'], $stats);
             $this->output->write('');
@@ -315,7 +328,7 @@ public function showHelpInfo($quit = true)
         $sep = $this->delimiter;
 
         $this->output->helpPanel([
-            'usage' => "$script [route|command] [arg0 arg1=value1 arg2=value2 ...] [--opt -v -h ...]",
+            'usage' => "$script {route|command} [arg0 arg1=value1 arg2=value2 ...] [--opt -v -h ...]",
             'example' => [
                 "$script test (run a independent command)",
                 "$script home{$sep}index (run a command of the group)",
@@ -366,6 +379,7 @@ public function showCommandList($quit = true)
         // all console controllers
         $controllers = $this->controllers;
         ksort($controllers);
+
         foreach ($controllers as $name => $controller) {
             /** @var AbstractCommand $controller */
             $controllerArr[$name] = $controller::getDescription() ?: $desPlaceholder;
@@ -383,7 +397,7 @@ public function showCommandList($quit = true)
             } else if ($msg = $this->getCommandMessage($name)) {
                 $desc = $msg;
             } else if (is_string($command)) {
-                $desc = 'A handler: ' . $command;
+                $desc = 'A handler : ' . $command;
             } else if (is_object($command)) {
                 $desc = 'A handler by ' . get_class($command);
             }
@@ -394,14 +408,14 @@ public function showCommandList($quit = true)
         // $this->output->write('There are all console controllers and independent commands.');
         $this->output->mList([
             //'There are all console controllers and independent commands.',
-            'Usage:' => "$script [route|command] [arg0 arg1=value1 arg2=value2 ...] [--opt -v -h ...]",
+            'Usage:' => "$script {route|command} [arg0 arg1=value1 arg2=value2 ...] [--opt -v -h ...]",
             'Group Commands:' => $controllerArr ?: '... No register any group command(controller)',
             'Independent Commands:' => $commandArr ?: '... No register any independent command',
             'Internal Commands:' => $internalCommands,
             'Internal Options:' => self::$internalOptions
         ]);
 
-        $this->output->write("More please see: <cyan>$script [controller|command] -h</cyan>");
+        $this->output->write("More command information, please use: <cyan>$script {command} -h</cyan>");
         $quit && $this->stop();
     }
 

src/Base/AbstractCommand.php

@@ -302,7 +302,7 @@ protected function annotationVars()
      * @param string $str
      * @return string
      */
-    protected function replaceAnnotationVars($str)
+    protected function handleAnnotationVars($str)
     {
         $map = [];
 
@@ -314,16 +314,6 @@ protected function replaceAnnotationVars($str)
         return $map ? strtr($str, $map) : $str;
     }
 
-    /**
-     * get All Command Methods for a group(controller)
-     * @param \ReflectionClass|null $ref
-     * @return \Generator
-     */
-    protected function getAllCommandMethods(\ReflectionClass $ref = null)
-    {
-        // ...
-    }
-
     /**
      * show help by parse method annotation
      * @param string $method
@@ -348,7 +338,7 @@ protected function showHelpByMethodAnnotation($method, $action = null)
         }
 
         $doc = $ref->getMethod($method)->getDocComment();
-        $tags = Annotation::tagList($this->replaceAnnotationVars($doc));
+        $tags = Annotation::tagList($this->handleAnnotationVars($doc));
 
         foreach ($tags as $tag => $msg) {
             if (!$msg || !is_string($msg)) {

src/Base/ApplicationInterface.php

@@ -21,11 +21,35 @@ interface ApplicationInterface
     const ON_STOP_RUN = 'stopRun';
     const ON_NOT_FOUND = 'notFound';
 
+    /**
+     * @param bool $exit
+     * @return int
+     */
     public function run($exit = true);
 
     public function stop($code = 0);
 
+    /**
+     * run a independent command
+     * @param string $name
+     * @param bool $believable
+     * @return mixed
+     */
+    public function runCommand($name, $believable = false);
+
+    /**
+     * run a controller's action
+     * @param string $name Controller name
+     * @param string $action Command
+     * @param bool $believable The `$name` is believable
+     * @param bool $standAlone
+     * @return mixed
+     */
+    public function runAction($name, $action, $believable = false, $standAlone = false);
+
     public function controller(string $name, string $controller = null);
 
     public function command(string $name, $handler = null, $description = null);
+
+    public function showCommandList($quit = true);
 }

src/Base/CommandInterface.php

@@ -33,6 +33,11 @@ public function getDefinition();
      */
     public function getApp(): ApplicationInterface;
 
+    /**
+     * @return string
+     */
+    public static function getName(): string;
+
     /**
      * @return string
      */

src/Base/ControllerInterface.php

@@ -19,6 +19,8 @@ interface ControllerInterface
      */
     public function helpCommand();
 
+    public function showCommandList();
+
     /**
      * @return string
      */
@@ -28,4 +30,9 @@ public function getAction(): string;
      * @return string
      */
     public function getDefaultAction(): string;
+
+    /**
+     * @param string $delimiter
+     */
+    public function setDelimiter(string $delimiter);
 }

src/Controller.php

@@ -74,8 +74,7 @@ protected function configure()
      */
     protected function execute($input, $output)
     {
-        $action = $this->action ?: $this->defaultAction;
-        $action = Helper::camelCase(trim($action, $this->delimiter));
+        $action = Helper::camelCase(trim($this->action ?: $this->defaultAction, $this->delimiter));
         $method = $this->actionSuffix ? $action . ucfirst($this->actionSuffix) : $action;
 
         // the action method exists and only allow access public method.
@@ -87,22 +86,23 @@ protected function execute($input, $output)
         } elseif (($notFoundCallback = $this->notFoundCallback) && method_exists($this, $notFoundCallback)) {
             $status = $this->{$notFoundCallback}($action);
         } else {
+            $group = static::getName();
             $status = -1;
-            $this->output->liteError("Sorry, the console controller command [$action] not exist!");
+            $this->output->liteError("Sorry, The command '$action' not exist of the group '{$group}'!");
 
             // find similar command names by similar_text()
-            $similares = [];
+            $similar = [];
 
             foreach ($this->getAllCommandMethods() as $cmd => $refM) {
                 similar_text($action, $cmd, $percent);
 
                 if (45 <= (int)$percent) {
-                    $similares[] = $cmd;
+                    $similar[] = $cmd;
                 }
             }
 
-            if ($similares) {
-                $this->write(sprintf('Maybe what you mean is: <info>%s</info>', implode(', ', $similares)));
+            if ($similar) {
+                $this->write(sprintf('Maybe what you mean is: <info>%s</info>', implode(', ', $similar)));
             } else {
                 $this->showCommandList();
             }
@@ -155,7 +155,7 @@ final public function helpCommand()
     /**
      * show command list of the controller class
      */
-    final protected function showCommandList()
+    final public function showCommandList()
     {
         $ref = new \ReflectionClass($this);
         $sName = lcfirst(self::getName() ?: $ref->getShortName());
@@ -199,7 +199,6 @@ final protected function showCommandList()
             'Commands:' => $commands,
             'Options:' => [
                 '-h,--help' => 'Show help of the command group or specified command action',
-//                $this->showMore ? "\nMore information please use: <cyan>$script {$name}{command} -h</cyan>" : ''
             ],
         ]);
 

src/IO/OutputInterface.php

@@ -21,5 +21,5 @@ interface OutputInterface
      * @param  int|boolean $quit If is int, setting it is exit code.
      * @return static
      */
-    public function write($messages = '', $nl = true, $quit = false);
+    public function write($messages, $nl = true, $quit = false);
 }

src/Traits/FormatOutputTrait.php

@@ -40,7 +40,7 @@ trait FormatOutputTrait
      * @inheritdoc
      * @see Show::write()
      */
-    public function write($messages = '', $nl = true, $quit = false): int
+    public function write($messages, $nl = true, $quit = false): int
     {
         return Show::write($messages, $nl, $quit, [
             'flush' => true,