Merge pull request #4 from inhere/master

Some small adjustments

src/Bean/Annotation/Command.php

@@ -15,6 +15,11 @@ class Command
      */
     private $name = '';
 
+    /**
+     * @var bool
+     */
+    private $enabled = true;
+
     /**
      * @var bool
      */
@@ -35,12 +40,19 @@ public function __construct(array $values)
         if (isset($values['value'])) {
             $this->name = $values['value'];
         }
+
         if (isset($values['name'])) {
             $this->name = $values['name'];
         }
+
         if (isset($values['coroutine'])) {
             $this->coroutine = $values['coroutine'];
         }
+
+        if (isset($values['enabled'])) {
+            $this->enabled = (bool)$values['enabled'];
+        }
+
         if (isset($values['server'])) {
             $this->server = $values['server'];
         }
@@ -69,4 +81,12 @@ public function isServer(): bool
     {
         return $this->server;
     }
-}
+
+    /**
+     * @return bool
+     */
+    public function isEnabled(): bool
+    {
+        return $this->enabled;
+    }
+}

src/Bean/Collector/CommandCollector.php

@@ -20,7 +20,7 @@ class CommandCollector implements CollectorInterface
      * collect
      *
      * @param string $className
-     * @param object $objectAnnotation
+     * @param mixed $objectAnnotation
      * @param string $propertyName
      * @param string $methodName
      * @param null   $propertyValue
@@ -54,6 +54,7 @@ private static function collectCommand(string $className, Command $objectAnnotat
         $server = $objectAnnotation->isServer();
 
         self::$commandMapping[$className]['name'] = $commandName;
+        self::$commandMapping[$className]['enabled'] = $objectAnnotation->isEnabled();
         self::$commandMapping[$className]['coroutine'] = $coroutine;
         self::$commandMapping[$className]['server'] = $server;
     }
@@ -94,4 +95,4 @@ public static function getCollector(): array
     {
         return self::$commandMapping;
     }
-}
+}

src/Bean/Parser/CommandParser.php

@@ -19,20 +19,21 @@
 class CommandParser extends AbstractParser
 {
     /**
-     * @param string  $className
+     * @param string $className
      * @param Command $objectAnnotation
-     * @param string  $propertyName
-     * @param string  $methodName
+     * @param string $propertyName
+     * @param string $methodName
      *
+     * @param null $propertyValue
      * @return mixed
      */
-    public function parser(string $className, $objectAnnotation = null, string $propertyName = "", string $methodName = "", $propertyValue = null)
+    public function parser(string $className, $objectAnnotation = null, string $propertyName = '', string $methodName = '', $propertyValue = null)
     {
         $beanName = $className;
         $scope    = Scope::SINGLETON;
 
         CommandCollector::collect($className, $objectAnnotation, $propertyName, $methodName, $propertyValue);
 
-        return [$beanName, $scope, ""];
+        return [$beanName, $scope, ''];
     }
-}
+}

src/Bean/Parser/MappingParser.php

@@ -22,15 +22,16 @@ class MappingParser extends AbstractParser
      * @param Mapping $objectAnnotation
      * @param string $propertyName
      * @param string $methodName
+     * @param null $propertyValue
      * @return void
      */
     public function parser(
         string $className,
         $objectAnnotation = null,
-        string $propertyName = "",
-        string $methodName = "",
+        string $propertyName = '',
+        string $methodName = '',
         $propertyValue = null
     ) {
         CommandCollector::collect($className, $objectAnnotation, $propertyName, $methodName, $propertyValue);
     }
-}
+}

src/Command.php

@@ -6,7 +6,6 @@
 use Swoft\Bean\Annotation\Bean;
 use Swoft\Console\Bean\Collector\CommandCollector;
 use Swoft\Console\Helper\DocBlockHelper;
-use Swoft\Helper\DocumentHelper;
 use Swoft\Console\Router\HandlerAdapter;
 use Swoft\Console\Router\HandlerMapping;
 
@@ -37,6 +36,7 @@ public function annotationVars(): array
 
     /**
      * @return void
+     * @throws \InvalidArgumentException
      * @throws \ReflectionException
      */
     public function run()
@@ -55,7 +55,7 @@ public function run()
         list($className, $method) = $handler;
 
         if ($router->isDefaultCommand($method)) {
-            $this->indexComamnd($className);
+            $this->indexCommand($className);
 
             return;
         }
@@ -77,7 +77,7 @@ public function run()
      * @throws \ReflectionException
      * @return void
      */
-    private function indexComamnd(string $className)
+    private function indexCommand(string $className)
     {
         /* @var HandlerMapping $router */
         $router = App::getBean('commandRoute');
@@ -87,7 +87,7 @@ private function indexComamnd(string $className)
 
         $reflectionClass = new \ReflectionClass($className);
         $classDocument = $reflectionClass->getDocComment();
-        $classDocAry = DocumentHelper::tagList($classDocument);
+        $classDocAry = DocBlockHelper::getTags($classDocument);
         $classDesc = $classDocAry['Description'];
 
         $methodCommands = [];
@@ -106,7 +106,7 @@ private function indexComamnd(string $className)
             }
             $reflectionMethod = $reflectionClass->getMethod($methodName);
             $methodDocument = $reflectionMethod->getDocComment();
-            $methodDocAry = DocumentHelper::tagList($methodDocument);
+            $methodDocAry = DocBlockHelper::getTags($methodDocument);
             $methodCommands[$mappedName] = $methodDocAry['Description'];
         }
 
@@ -137,7 +137,6 @@ private function showCommandHelp(string $controllerClass, string $commandMethod)
         $reflectionMethod = $reflectionClass->getMethod($commandMethod);
         $document = $reflectionMethod->getDocComment();
         $document = $this->parseAnnotationVars($document, $this->annotationVars());
-        // $docs = DocumentHelper::tagList($document);
         $docs = DocBlockHelper::getTags($document);
 
         $commands = [];
@@ -173,7 +172,7 @@ private function showCommandHelp(string $controllerClass, string $commandMethod)
     }
 
     /**
-     * help list
+     * show all commands for the console app
      *
      * @throws \ReflectionException
      */
@@ -182,19 +181,19 @@ private function showCommandList()
         $commands = $this->parserCmdAndDesc();
 
         $commandList = [];
-        $script = input()->getFullScript();
-        $commandList['Usage:'] = ["php $script"];
+        $script = \input()->getFullScript();
+        $commandList['Usage:'] = ["php $script {command} [arguments] [options]"];
         $commandList['Commands:'] = $commands;
         $commandList['Options:'] = [
-            '-h, --help'    => 'show help information',
-            '-v, --version' => 'show version',
+            '-h, --help'    => 'Display help information',
+            '-v, --version' => 'Display version information',
         ];
 
         // show logo
-        output()->writeLogo();
+        \output()->writeLogo();
 
         // output list
-        output()->writeList($commandList, 'comment', 'info');
+        \output()->writeList($commandList, 'comment', 'info');
     }
 
     /**
@@ -208,9 +207,11 @@ private function showVersion()
         $swooleVersion = SWOOLE_VERSION;
 
         // 显示面板
-        output()->writeLogo();
-        output()->writeln("swoft: <info>$swoftVersion</info>, php: <info>$phpVersion</info>, swoole: <info>$swooleVersion</info>", true);
-        output()->writeln('');
+        \output()->writeLogo();
+        \output()->writeln(
+            "swoft: <info>$swoftVersion</info>, php: <info>$phpVersion</info>, swoole: <info>$swooleVersion</info>\n",
+            true
+        );
     }
 
     /**
@@ -227,17 +228,23 @@ private function parserCmdAndDesc(): array
         /* @var \Swoft\Console\Router\HandlerMapping $route */
         $route = App::getBean('commandRoute');
 
-        foreach ($collector as $className => $comamnd) {
+        foreach ($collector as $className => $command) {
+            if (!$command['enabled']) {
+                continue;
+            }
+
             $rc = new \ReflectionClass($className);
             $docComment = $rc->getDocComment();
-            $docAry = DocumentHelper::tagList($docComment);
-            $desc = $docAry['Description'];
+            $docAry = DocBlockHelper::getTags($docComment);
 
-            $prefix = $comamnd['name'];
+            $prefix = $command['name'];
             $prefix = $route->getPrefix($prefix, $className);
-            $commands[$prefix] = $desc;
+            $commands[$prefix] = \ucfirst($docAry['Description']);
         }
 
+        // sort commands
+        ksort($commands);
+
         return $commands;
     }
 
@@ -258,26 +265,6 @@ private function baseCommand()
         $this->showCommandList();
     }
 
-    /**
-     * 解析命令key和描述
-     *
-     * @param string $document 注解文档
-     * @return array
-     */
-    private function parserKeyAndDesc(string $document): array
-    {
-        $keyAndDesc = [];
-        $items = explode("\n", $document);
-        foreach ($items as $item) {
-            $pos = strpos($item, ' ');
-            $key = substr($item, 0, $pos);
-            $desc = substr($item, $pos + 1);
-            $keyAndDesc[$key] = $desc;
-        }
-
-        return $keyAndDesc;
-    }
-
     /**
      * 替换注解中的变量为对应的值
      * @param string $str

src/Console.php

@@ -30,8 +30,8 @@ public function run()
             $command = App::getBean('command');
             $command->run();
         } catch (\Throwable $e) {
-            output()->writeln(sprintf('<error>%s</error>', $e->getMessage()), true, false);
-            output()->writeln(sprintf('<error>%s</error>', $e->getTraceAsString()), true, true);
+            \output()->writeln(sprintf('<error>%s</error>', $e->getMessage()), true, false);
+            \output()->writeln(sprintf("Trace:\n%s", $e->getTraceAsString()), true, true);
         }
     }
 

src/Helper/CommandHelper.php

@@ -178,4 +178,49 @@ public static function nextIsValue($val): bool
         // it isn't option or named argument
         return $val{0} !== '-' && false === strpos($val, '=');
     }
+
+
+    /**
+     * Returns true if STDOUT supports colorization.
+     * This code has been copied and adapted from
+     * \Symfony\Component\Console\Output\OutputStream.
+     * @return boolean
+     */
+    public static function supportColor(): bool
+    {
+        if (DIRECTORY_SEPARATOR === '\\') {
+            return
+                '10.0.10586' === PHP_WINDOWS_VERSION_MAJOR . '.' . PHP_WINDOWS_VERSION_MINOR . '.' . PHP_WINDOWS_VERSION_BUILD ||
+                // 0 == strpos(PHP_WINDOWS_VERSION_MAJOR . '.' . PHP_WINDOWS_VERSION_MINOR . PHP_WINDOWS_VERSION_BUILD, '10.') ||
+                false !== getenv('ANSICON') ||
+                'ON' === getenv('ConEmuANSI') ||
+                'xterm' === getenv('TERM')// || 'cygwin' === getenv('TERM')
+                ;
+        }
+
+        if (!\defined('STDOUT')) {
+            return false;
+        }
+
+        return self::isInteractive(STDOUT);
+    }
+
+    /**
+     * @return bool
+     */
+    public static function isSupport256Color(): bool
+    {
+        return DIRECTORY_SEPARATOR === '/' && strpos(getenv('TERM'), '256color') !== false;
+    }
+
+    /**
+     * Returns if the file descriptor is an interactive terminal or not.
+     * @param  int|resource $fileDescriptor
+     * @return boolean
+     */
+    public static function isInteractive($fileDescriptor): bool
+    {
+        return \function_exists('posix_isatty') && @posix_isatty($fileDescriptor);
+    }
+
 }