some logic update, provide command tips

Author: inhere

src/Application.php

@@ -222,7 +222,7 @@ public function runCommand($name, $believable = false)
 
     /**
      * @param string $name Controller name
-     * @param string $action
+     * @param string $action Command
      * @param bool $believable The `$name` is believable
      * @param bool $standAlone
      * @return mixed
@@ -253,7 +253,7 @@ public function runAction($name, $action, $believable = false, $standAlone = fal
         $object->setDelimiter($this->delimiter);
         $object->setStandAlone($standAlone);
 
-        return $object->setAction($action)->run();
+        return $object->run($action);
     }
 
 }

src/Base/AbstractCommand.php

@@ -8,6 +8,7 @@
 
 namespace Inhere\Console\Base;
 
+use Inhere\Console\Application;
 use Inhere\Console\IO\Input;
 use Inhere\Console\IO\InputDefinition;
 use Inhere\Console\IO\Output;
@@ -52,7 +53,7 @@ abstract class AbstractCommand implements CommandInterface
         'example' => true,
     ];
 
-    /** @var ApplicationInterface */
+    /** @var Application */
     protected $app;
 
     /** @var InputDefinition|null  */
@@ -110,9 +111,10 @@ protected function createDefinition()
 
     /**
      * run command
+     * @param string $command
      * @return int
      */
-    public function run()
+    public function run($command = '')
     {
         // load input definition configure
         $this->configure();
@@ -312,6 +314,16 @@ 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
@@ -324,7 +336,7 @@ protected function showHelpByMethodAnnotation($method, $action = null)
         $name = $this->input->getCommand();
 
         if (!$ref->hasMethod($method)) {
-            $this->write("The command [<info>$name</info>] don't exist in the class.");
+            $this->write("The command [<info>$name</info>] don't exist in the group: " . static::getName());
 
             return 0;
         }

src/Base/CommandInterface.php

@@ -18,9 +18,10 @@ interface CommandInterface
 {
     /**
      * run command
+     * @param string $command
      * @return int
      */
-    public function run();
+    public function run($command = '');
 
     /**
      * @return InputDefinition

src/Controller.php

@@ -39,6 +39,19 @@ abstract class Controller extends AbstractCommand implements ControllerInterface
     /** @var bool  */
     private $standAlone = false;
 
+    /**
+     * @param string $command
+     * @return int
+     */
+    public function run($command = '')
+    {
+        if (!$this->action = trim($command)) {
+            return $this->showHelp();
+        }
+
+        return parent::run($command);
+    }
+
     /**
      * load command configure
      */
@@ -76,7 +89,23 @@ protected function execute($input, $output)
         } else {
             $status = -1;
             $this->output->liteError("Sorry, the console controller command [$action] not exist!");
-            $this->showCommandList();
+
+            // find similar command names by similar_text()
+            $similares = [];
+
+            foreach ($this->getAllCommandMethods() as $cmd => $refM) {
+                similar_text($action, $cmd, $percent);
+
+                if (45 <= (int)$percent) {
+                    $similares[] = $cmd;
+                }
+            }
+
+            if ($similares) {
+                $this->write(sprintf('Maybe what you mean is: <info>%s</info>', implode(', ', $similares)));
+            } else {
+                $this->showCommandList();
+            }
         }
 
         return $status;
@@ -119,6 +148,7 @@ final public function helpCommand()
         $action = Helper::camelCase($action);
         $method = $this->actionSuffix ? $action . ucfirst($this->actionSuffix) : $action;
 
+        // show help info for a command.
         return $this->showHelpByMethodAnnotation($method, $action);
     }
 
@@ -134,31 +164,12 @@ final protected function showCommandList()
             $classDes = Annotation::description($ref->getDocComment()) ?: 'No Description for the console controller';
         }
 
-        $suffix = $this->actionSuffix;
-        $suffixLen = Helper::strLen($suffix);
-
         $commands = [];
-        foreach ($ref->getMethods() as $m) {
-            $mName = $m->getName();
+        foreach ($this->getAllCommandMethods($ref) as $cmd => $m) {
+            $desc = Annotation::firstLine($m->getDocComment());
 
-            if ($m->isPublic() && substr($mName, -$suffixLen) === $suffix) {
-                $desc = Annotation::firstLine($m->getDocComment());
-                $length = strlen($this->actionSuffix);
-                $cmd = '';
-
-                if ($length) {
-                    if (substr($mName, -$length) === $this->actionSuffix) {
-                        $cmd = substr($mName, 0, -$length);
-                    }
-
-                } else {
-                    $cmd = $mName;
-                }
-
-                if ($cmd) {
-                    //$this->write("  <info>$cmd</info>  $desc");
-                    $commands[$cmd] = $desc;
-                }
+            if ($cmd) {
+                $commands[$cmd] = $desc;
             }
         }
 
@@ -198,6 +209,29 @@ final protected function showCommandList()
         ));
     }
 
+    /**
+     * @param \ReflectionClass|null $ref
+     * @return \Generator
+     */
+    protected function getAllCommandMethods(\ReflectionClass $ref = null)
+    {
+        $ref = $ref ?: new \ReflectionObject($this);
+
+        $suffix = $this->actionSuffix;
+        $suffixLen = Helper::strLen($suffix);
+
+        foreach ($ref->getMethods() as $m) {
+            $mName = $m->getName();
+
+            if ($m->isPublic() && substr($mName, - $suffixLen) === $suffix) {
+                // suffix is empty ?
+                $cmd = $suffix ? substr($mName, 0, -$suffixLen) : $mName;
+
+                yield $cmd => $m;
+            }
+        }
+    }
+
     /**************************************************************************
      * getter/setter methods
      **************************************************************************/