add console help show function

inhere · inhere · commit 861817d15c25 · 2017-02-17T11:37:25.000+08:00
diff --git a/src/console/ConsoleHelper.php b/src/console/ConsoleHelper.php
@@ -37,4 +37,57 @@ public static function isInteractive($fileDescriptor)
     {
         return function_exists('posix_isatty') && @posix_isatty($fileDescriptor);
     }
+
+    /**
+     * get key Max Width
+     *
+     * @param  array  $data
+     * [
+     *     'key1'      => 'value1',
+     *     'key2-test' => 'value2',
+     * ]
+     * @return int
+     */
+    public static function keyMaxWidth(array $data, $expactInt = true)
+    {
+        $keyMaxWidth = 0;
+
+        foreach ($data as $key => $value) {
+            // key is not a integer
+            if ( !$expactInt || !is_numeric($key) ) {
+                $width = mb_strlen($key, 'UTF-8');
+                $keyMaxWidth = $width > $keyMaxWidth ? $width : $keyMaxWidth;
+            }
+        }
+
+        return $keyMaxWidth;
+    }
+
+    /**
+     * spliceArray
+     * @param  array  $data
+     * e.g [
+     *     'system'  => 'Linux',
+     *     'version'  => '4.4.5',
+     * ]
+     * @param  int    $keyMaxWidth
+     * @param  string $sepChar  e.g ' | ' => OUT: key | value
+     * @param  string $leftChar e.g ' * '
+     * @return string
+     */
+    public static function spliceKeyValue($data, $keyMaxWidth, $sepChar = ' ', $leftChar='')
+    {
+        $text = '';
+        foreach ($panelData as $key => $value) {
+            $text .= $leftChar;
+
+            if ($keyMaxWidth) {
+                $text .= str_pad($key, $keyMaxWidth, ' ') . $sepChar;
+            }
+
+            $text .= "$value\n";
+        }
+
+        return $text;
+    }
 }
diff --git a/src/console/Interact.php b/src/console/Interact.php
@@ -24,71 +24,97 @@ class Interact
     const NL_TAB = "\n    ";// new line + tab
 
 /////////////////////////////////////////////////////////////////
-/// Interactive
+/// Interactive method (select/confirm/question/loopAsk)
 /////////////////////////////////////////////////////////////////
 
     /**
      * 多选一
-     * @param  string $question 说明
-     * @param  mixed $option  选项数据
-     * @param  bool $allowExit  有退出选项 默认 true
+     * @param  string  $description 说明
+     * @param  mixed   $options     选项数据
+     * e.g
+     * [
+     *    // option => value
+     *    '1' => 'chengdu',
+     *    '2' => 'beijing'
+     * ]
+     * @param  mixed   $default     默认选项
+     * @param  bool    $allowExit   有退出选项 默认 true
      * @return string
      */
-    public static function choice($question, $option, $allowExit=true)
+    public static function select($description, $options, $default = null, $allowExit=true)
     {
-        self::write("  <comment>$question</comment>");
+        self::choice($description, $options, $default, $allowExit);
+    }
+    public static function choice($description, $options, $default = null, $allowExit=true)
+    {
+        if ( !$description = trim($description) ) {
+            self::error('Please provide a description text!', 1);
+        }
+
+        self::write("  <comment>$description</comment>");
 
-        $option    = is_array($option) ? $option : explode(',', $option);
-        // no set key
-        $isNumeric = isset($option[0]);
         $keys = [];
         $optStr = '';
+        $options  = is_array($options) ? $options : explode(',', $options);
 
-        foreach ($option as $key => $value) {
-            $keys[] = $isNumeric ? ++$key : $key;
+        // If defaut option is error
+        if ( null === $default && !isset($options[$default]) ) {
+            self::error("The default option [{$default}] don't exists.", true);
+        }
 
-            $optStr .= "\n    $key) $value";
+        foreach ($options as $key => $value) {
+            $keys[] = $key;
+            $optStr .= "\n    <info>$key</info>) $value";
         }
 
         if ($allowExit) {
             $keys[] = 'q';
             $optStr .= "\n    q) quit";
         }
 
-        self::write($optStr . "\n  You choice : ");
-
-        $r = self::readRow();
+        $r = self::read($optStr . "\n  You choice : ");
 
+        // error, allow try again
         if ( !in_array($r, $keys) ) {
-            self::write("Warning! option <comment>$r<comment>) don't exists! please entry again! :");
+            $r = self::read("Warning! Option <info>$r</info>) don't exists! Please entry again! : ");
+        }
 
-            $r = self::readRow();
+        // exit
+        if ( $r === 'q' ) {
+            self::write("\n  Quit,ByeBye.", true, true);
         }
 
-        if ($r === 'q' || !in_array($r, $keys) ) {
-            exit("\n\n Quit,ByeBye.\n");
+        // error
+        if ( !in_array($r, $keys) ) {
+            if ( null === $default ) {
+                self::write("\n  Select error. Quit,ByeBye.", true, true);
+            }
+
+            $r = $default;
         }
 
         return $r;
     }
 
     /**
-     * 确认, 发出信息要求确认；返回 true | false
-     * @param  string $question 发出的信息
-     * @param bool $yes
+     * 确认, 发出信息要求确认
+     * @param string $question 发出的信息
+     * @param bool   $default  Default value
      * @return bool
      */
-    public static function confirm($question, $yes = true)
+    public static function confirm($question, $default = true)
     {
-        $question = ucfirst(trim($question));
-        $defaultText = $yes ? 'yes' : 'no';
+        if ( !$question = trim($question) ) {
+            self::error('Please provide a question text!', 1);
+        }
 
-        $message = "<comment>$question</comment>\n    Please confirm (yes|no) [default:<info>$defaultText</info>]: ";
-        self::write($message, false);
+        $question = ucfirst($question);
+        $defaultText = (bool)$default ? 'yes' : 'no';
 
-        $answer = self::readRow();
+        $message = " <comment>$question ?</comment>\n Please confirm (yes|no) [default:<info>$defaultText</info>]: ";
+        $answer = self::read($message);
 
-        return $answer ? !strncasecmp($answer, 'y', 1) : (bool)$yes;
+        return $answer ? !strncasecmp($answer, 'y', 1) : (bool)$default;
     }
 
     /**
@@ -231,7 +257,7 @@ public static function loopAsk($question, $default = null, \Closure $validator =
     }
 
 /////////////////////////////////////////////////////////////////
-/// Output Message
+/// Output Format Message(title/section/helpPanel/panel/table)
 /////////////////////////////////////////////////////////////////
 
     /**
@@ -260,31 +286,140 @@ public static function section($msg, $width = 50, $char = '-')
     }
 
     /**
-     * 多行信息展示
+     * Show console help message
+     * @param  string $usage    The usage message text. e.g 'command [options] [arguments]'
+     * @param  array  $commands The command list
+     * e.g
+     * [
+     *     // command => description
+     *     'start'    => 'Start the app server',
+     *     ... ...
+     * ]
+     * @param  array  $options The option list
+     * e.g
+     * [
+     *     // option    => description
+     *     '-d'         => 'Run the server on daemonize.(default: <comment>false</comment>)',
+     *     '-h, --help' => 'Display this help message'
+     *     ... ...
+     * ]
+     * @param  array  $examples The command usage example. e.g 'php server.php {start|reload|restart|stop} [-d]'
+     * @param  string $description The description text. e.g 'Composer version 1.3.2'
+     */
+    public static function consoleHelp($usage, $commands = [], $options = [], $examples = [], $description = '')
+    {
+        self::helpPanel($usage, $commands, $options, $examples, $description);
+    }
+    public static function helpPanel($usage, $commands = [], $options = [], $examples = [], $description = '')
+    {
+        // usage
+        self::write("<comment>Usage</comment>:\n  {$usage}\n");
+
+        // options list
+        if ( $options ) {
+            // translate array to string
+            if ( is_array($options)) {
+                $optionMaxWidth = ConsoleHelper::keyMaxWidth($options);
+                $options = ConsoleHelper::spliceKeyValue($options, $optionMaxWidth);
+            }
+
+            if ( is_string($options) ) {
+                self::write("<comment>Options</comment>:\n  {$options}\n");
+            }
+        }
+
+        // command list
+        if ( $commands ) {
+            // translate array to string
+            if ( is_array($commands)) {
+                $commandMaxWidth = ConsoleHelper::keyMaxWidth($commands);
+                $commands = ConsoleHelper::spliceKeyValue($commands, $commandMaxWidth);
+            }
+
+            if ( is_string($commands) ) {
+                self::write("<comment>Commands</comment>:\n  {$commands}\n");
+            }
+        }
+
+        // examples list
+        if ( $examples ) {
+            $examples = is_array($examples) ? implode(PHP_EOL, $examples) : $examples;
+            self::write("<comment>Examples</comment>:\n  {$examples}\n");
+        }
+    }
+
+    /**
+     * Show information data panel
      * @param  mixed $data
      * @param  string $title
      * @return void
      */
-    public static function panel(array $data, $title='Info panel')
+    public static function panel($data, $title='Info panel', $char = '*')
     {
         $data = is_array($data) ? array_filter($data) : [trim($data)];
-        $title = ucwords(trim($title));
+        $title = trim($title);
+
+        $panelData = []; // [ 'label' => 'value' ]
+        $labelMaxWidth = 0; // if label exists, label max width
+        $valueMaxWidth = 0; // value max width
 
         self::write("\n  " . sprintf(self::STAR_LINE,"<bold>$title</bold>"), false);
 
         foreach ($data as $label => $value) {
-            $line = '  * ';
+            // label exists
+            if ( !is_numeric($label) ) {
+                $width = mb_strlen($label, 'UTF-8');
+                $labelMaxWidth = $width > $labelMaxWidth ? $width : $labelMaxWidth;
+            }
+
+            // translate array to string
+            if ( is_array($value) ) {
+                $temp = '';
 
-            if (!is_numeric($label)) {
-                $line .= "$label: ";
+                foreach ($value as $key => $val) {
+                    $val = (string)$val;
+                    $temp .= (!is_numeric($key) ? "$key: " : '') . "<info>$value</info>, ";
+                }
+
+                $value = rtrim($temp, ' ,');
             }
 
-            self::write("$line  <info>$value</info>");
+            // get value width
+            if ( is_string($value) || is_numeric($value) ) {
+                $value = trim($value);
+                $width = mb_strlen(strip_tags($value), 'UTF-8'); // must clear style tag
+                $valueMaxWidth = $width > $valueMaxWidth ? $width : $valueMaxWidth;
+            } else {
+                throw new \Exception('Panel data value only allow [array|string|number]');
+            }
+
+            $panelData[$label] = $value;
+        }
+
+        $panelWidth = $labelMaxWidth + $valueMaxWidth;
+
+        // output title
+        if ($title) {
+            $title = ucwords($title);
+            $titleLength = mb_strlen($title, 'UTF-8');
+            $indentSpace = str_pad(' ', ceil($panelWidth/2) - ceil($titleLength/2) + 2*2, ' ');
+            self::write("  {$indentSpace}<bold>{$title}</bold>");
         }
 
-        $star = $title ? substr(self::STAR_LINE, 0, strlen($title)): '';
+        // output panel top border
+        $border = str_pad($char, $panelWidth + (2*3), $char);
+        self::write('  ' . $border);
+
+        // output panel body
+        $panelStr = ConsoleHelper::spliceKeyValue($panelData, $labelMaxWidth, ' | ', "  $char ");
+
+        // already exists "\n"
+        self::write($panelStr, false);
+
+        // output panel bottom border
+        self::write("  $border\n");
 
-        self::write('  ' . sprintf(self::STAR_LINE, $star ));
+        unset($data, $panelData);
     }
 
     /**
diff --git a/src/console/Output.php b/src/console/Output.php
@@ -37,39 +37,41 @@ class Output
 /// Output Message
 /////////////////////////////////////////////////////////////////
 
-
     /**
-     * @param $msg
+     * @see Interact::title()
      */
     public function title($msg, $width = null)
     {
         Interact::title($msg, $width);
     }
 
     /**
-     * @param $msg
+     * @see Interact::section()
      */
     public function section($msg, $width = null)
     {
         Interact::section($msg, $width);
     }
 
     /**
-     * 多行信息展示
-     * @param  mixed $data
-     * @param  string $title
-     * @return void
+     * helpPanel
+     * @see Interact::helpPanel()
+     */
+    public function helpPanel($usage, $commands = [], $options = [], $examples = [], $description = '')
+    {
+        Interact::helpPanel($msg, $width);
+    }
+
+    /**
+     * @see Interact::panel()
      */
     public function panel(array $data, $title='Info panel')
     {
         Interact::panel($data, $title);
     }
 
     /**
-     * 表格数据信息展示
-     * @param  array $data
-     * @param  string $title
-     * @return void
+     * @see Interact::table()
      */
     public function table(array $data, $title='Info List', $showBorder = true)
     {
diff --git a/src/helpers/ArrHelper.php b/src/helpers/ArrHelper.php
