update base formatter namespace

inhere · inhere · commit 2d093ba29756 · 2019-02-24T11:18:39.000+08:00
diff --git a/src/Component/Formatter/Alert.php b/src/Component/Formatter/Alert.php
@@ -8,10 +8,12 @@
 
 namespace Inhere\Console\Component\Formatter;
 
+use Inhere\Console\Component\MessageFormatter;
+
 /**
  * Class Alert
  * @package Inhere\Console\Component\Formatter
  */
-class Alert extends Formatter
+class Alert extends MessageFormatter
 {
 }
diff --git a/src/Component/Formatter/Block.php b/src/Component/Formatter/Block.php
@@ -8,11 +8,13 @@
 
 namespace Inhere\Console\Component\Formatter;
 
+use Inhere\Console\Component\MessageFormatter;
+
 /**
  * Class Block
  * @package Inhere\Console\Component\Formatter
  */
-class Block extends Formatter
+class Block extends MessageFormatter
 {
 
 }
diff --git a/src/Component/Formatter/HelpPanel.php b/src/Component/Formatter/HelpPanel.php
@@ -8,6 +8,7 @@
 
 namespace Inhere\Console\Component\Formatter;
 
+use Inhere\Console\Component\MessageFormatter;
 use Inhere\Console\Util\FormatUtil;
 use Inhere\Console\Util\Show;
 
@@ -16,7 +17,7 @@
  * - method version please {@see \Inhere\Console\Util\Show::helpPanel()}
  * @package Inhere\Console\Component\Formatter
  */
-class HelpPanel extends Formatter
+class HelpPanel extends MessageFormatter
 {
     /**
      * help panel keys
diff --git a/src/Component/Formatter/MultiList.php b/src/Component/Formatter/MultiList.php
@@ -2,13 +2,14 @@
 
 namespace Inhere\Console\Component\Formatter;
 
-use Inhere\Console\Util\Show;
+use Inhere\Console\Component\MessageFormatter;
+use Inhere\Console\Console;
 
 /**
  * Class MultiList
  * @package Inhere\Console\Component\Formatter
  */
-class MultiList extends Formatter
+class MultiList extends MessageFormatter
 {
     /**
      * Format and render multi list
@@ -49,6 +50,6 @@ public static function show(array $data, array $opts = []): void
             $stringList[] = SingleList::show($list, $title, $opts);
         }
 
-        Show::write(\implode("\n", $stringList), $lastNewline);
+        Console::write(\implode("\n", $stringList), $lastNewline);
     }
 }
diff --git a/src/Component/Formatter/Padding.php b/src/Component/Formatter/Padding.php
@@ -2,15 +2,16 @@
 
 namespace Inhere\Console\Component\Formatter;
 
+use Inhere\Console\Component\MessageFormatter;
+use Inhere\Console\Console;
 use Inhere\Console\Util\Helper;
-use Inhere\Console\Util\Show;
 use Toolkit\Cli\ColorTag;
 
 /**
  * Class Padding
  * @package Inhere\Console\Component\Formatter
  */
-class Padding extends Formatter
+class Padding extends MessageFormatter
 {
     /**
      * ```php
@@ -47,6 +48,6 @@ public static function show(array $data, string $title = '', array $opts = []):
             $string .= $opts['indent'] . \str_pad($label, $paddingLen, $opts['char']) . " $value\n";
         }
 
-        Show::write(\trim($string));
+        Console::write(\trim($string));
     }
 }
diff --git a/src/Component/Formatter/Panel.php b/src/Component/Formatter/Panel.php
@@ -8,6 +8,7 @@
 
 namespace Inhere\Console\Component\Formatter;
 
+use Inhere\Console\Component\MessageFormatter;
 use Inhere\Console\Util\FormatUtil;
 use Inhere\Console\Util\Show;
 use Toolkit\StrUtil\StrBuffer;
@@ -17,7 +18,7 @@
  * - method version please {@see \Inhere\Console\Util\Show::panel()}
  * @package Inhere\Console\Component\Formatter
  */
-class Panel extends Formatter
+class Panel extends MessageFormatter
 {
     /** @var string */
     public $title = '';
diff --git a/src/Component/Formatter/Section.php b/src/Component/Formatter/Section.php
@@ -2,15 +2,16 @@
 
 namespace Inhere\Console\Component\Formatter;
 
+use Inhere\Console\Component\MessageFormatter;
+use Inhere\Console\Console;
 use Inhere\Console\Util\FormatUtil;
-use Inhere\Console\Util\Show;
 use Toolkit\StrUtil\Str;
 
 /**
  * Class Section
  * @package Inhere\Console\Component\Formatter
  */
-class Section extends Formatter
+class Section extends MessageFormatter
 {
     /**
      * @param string       $title The title text
@@ -71,6 +72,6 @@ public static function show(string $title, $body, array $opts = []): void
         $body = \is_array($body) ? \implode(\PHP_EOL, $body) : $body;
         $body = FormatUtil::wrapText($body, 4, $opts['width']);
 
-        Show::writef($template, $titleLine, $topBorder, $body, $bottomBorder);
+        Console::writef($template, $titleLine, $topBorder, $body, $bottomBorder);
     }
 }
diff --git a/src/Component/Formatter/SingleList.php b/src/Component/Formatter/SingleList.php
@@ -2,15 +2,16 @@
 
 namespace Inhere\Console\Component\Formatter;
 
+use Inhere\Console\Component\MessageFormatter;
+use Inhere\Console\Console;
 use Inhere\Console\Util\FormatUtil;
-use Inhere\Console\Util\Show;
 use Toolkit\Cli\ColorTag;
 
 /**
  * Class SingleList - Format and render a single list
  * @package Inhere\Console\Component\Formatter
  */
-class SingleList extends Formatter
+class SingleList extends MessageFormatter
 {
     /**
      * Format and render a single list
@@ -55,6 +56,6 @@ public static function show($data, string $title = '', array $opts = [])
             return $string;
         }
 
-        return Show::write($string, $opts['lastNewline']);
+        return Console::write($string, $opts['lastNewline']);
     }
 }
diff --git a/src/Component/Formatter/Table.php b/src/Component/Formatter/Table.php
@@ -8,15 +8,16 @@
 
 namespace Inhere\Console\Component\Formatter;
 
-use Inhere\Console\Util\Show;
+use Inhere\Console\Component\MessageFormatter;
+use Inhere\Console\Console;
 use Toolkit\Cli\ColorTag;
 use Toolkit\StrUtil\StrBuffer;
 
 /**
  * Class Table - Tabular data display
  * @package Inhere\Console\Component\Formatter
  */
-class Table extends Formatter
+class Table extends MessageFormatter
 {
     /** @var array */
     public $data = [];
@@ -212,6 +213,6 @@ public static function show(array $data, string $title = 'Data Table', array $op
             $buf->write($border . "\n");
         }
 
-        return Show::write($buf);
+        return Console::write($buf);
     }
 }
diff --git a/src/Component/Formatter/Title.php b/src/Component/Formatter/Title.php
@@ -2,14 +2,16 @@
 
 namespace Inhere\Console\Component\Formatter;
 
+use Inhere\Console\Component\MessageFormatter;
+use Inhere\Console\Console;
 use Inhere\Console\Util\Show;
 use Toolkit\StrUtil\Str;
 
 /**
  * Class Title
  * @package Inhere\Console\Component\Formatter
  */
-class Title extends Formatter
+class Title extends MessageFormatter
 {
     /**
      * @param string $title The title text
@@ -49,6 +51,6 @@ public static function show(string $title, array $opts = []): void
         $titleLine = "$titleIndent<bold>$title</bold>\n";
         $border    = $indentStr . \str_pad($char, $width, $char);
 
-        Show::write($titleLine . $border);
+        Console::write($titleLine . $border);
     }
 }
diff --git a/src/Component/Formatter/Tree.php b/src/Component/Formatter/Tree.php
@@ -8,15 +8,16 @@
 
 namespace Inhere\Console\Component\Formatter;
 
+use Inhere\Console\Component\MessageFormatter;
+use Inhere\Console\Console;
 use Inhere\Console\Util\FormatUtil;
-use Inhere\Console\Util\Show;
 use Toolkit\Cli\Cli;
 
 /**
  * Class Tree
  * @package Inhere\Console\Component\Formatter
  */
-class Tree extends Formatter
+class Tree extends MessageFormatter
 {
     /** @var int */
     private $counter = 0;
@@ -48,15 +49,15 @@ public static function show(array $data, array $opts = []): void
             $opts['_level']   = 1;
             $opts['_is_main'] = true;
 
-            Show::startBuffer();
+            Console::startBuffer();
         }
 
         foreach ($data as $key => $value) {
             if (\is_scalar($value)) {
                 $counter++;
                 $leftString = $opts['leftPadding'] . \str_pad($opts['prefix'], $opts['_level'] + 1, $opts['char']);
 
-                Show::write($leftString . ' ' . FormatUtil::typeToString($value));
+                Console::write($leftString . ' ' . FormatUtil::typeToString($value));
             } elseif (\is_array($value)) {
                 $newOpts             = $opts;
                 $newOpts['_is_main'] = false;
@@ -67,9 +68,9 @@ public static function show(array $data, array $opts = []): void
         }
 
         if ($opts['_is_main']) {
-            Show::write('node count: ' . $counter);
+            Console::write('node count: ' . $counter);
             // var_dump('f');
-            Show::flushBuffer();
+            Console::flushBuffer();
 
             // reset.
             $counter = $started = 0;
diff --git a/src/Component/MessageFormatter.php b/src/Component/MessageFormatter.php
@@ -6,16 +6,17 @@
  * Time: 21:44
  */
 
-namespace Inhere\Console\Component\Formatter;
+namespace Inhere\Console\Component;
 
-use Inhere\Console\Util\Show;
+use Inhere\Console\Console;
+use Inhere\Console\Contract\FormatterInterface;
 use Toolkit\PhpUtil\PhpHelper;
 
 /**
  * Class Formatter - message formatter
- * @package Inhere\Console\Component\Formatter
+ * @package Inhere\Console\Component
  */
-abstract class Formatter implements FormatterInterface
+abstract class MessageFormatter implements FormatterInterface
 {
     // content align
     public const ALIGN_LEFT   = 'left';
@@ -29,9 +30,9 @@ abstract class Formatter implements FormatterInterface
 
     /**
      * @param array $config
-     * @return Formatter
+     * @return MessageFormatter
      */
-    public static function create(array $config = []): Formatter
+    public static function create(array $config = []): self
     {
         return new static($config);
     }
@@ -80,7 +81,7 @@ public function render(): int
      */
     public function display(): int
     {
-        return Show::write($this->toString());
+        return Console::write($this->toString());
     }
 
     /**
diff --git a/src/Contract/FormatterInterface.php b/src/Contract/FormatterInterface.php
@@ -6,11 +6,11 @@
  * Time: 13:41
  */
 
-namespace Inhere\Console\Component\Formatter;
+namespace Inhere\Console\Contract;
 
 /**
  * Interface FormatterInterface
- * @package Inhere\Console\Component\Formatter
+ * @package Inhere\Console\Contract
  */
 interface FormatterInterface
 {
diff --git a/src/Util/Helper.php b/src/Util/Helper.php
@@ -100,7 +100,7 @@ public static function commandSearch(string $command, array $map): void
      * @param int             $similarPercent
      * @return array
      */
-    public static function findSimilar(string $need, $iterator, $similarPercent = 45): array
+    public static function findSimilar(string $need, $iterator, int $similarPercent = 45): array
     {
         if (!$need) {
             return [];
@@ -161,32 +161,4 @@ public static function formatOptions(string $optsStr): void
     {
 
     }
-
-    /**
-     * this is a command's description message
-     * the second line text
-     * @format
-     * @usage usage message
-     * @arguments(format=true)
-     *  arg1  argument description 1
-     *        the second line
-     *  a2,arg2  argument description 2
-     *        the second line
-     * @arguments(
-     *  arg1="argument description 1
-     *        the second line",
-     *  "a2,arg2"="argument description 2
-     *        the second line"
-     * )
-     * @options
-     *  -s, --long | LONG | option description 1
-     *  --opt  |   OPT |  option description 2
-     * @example example text one
-     *  the second line example
-     * @param string $argsStr
-     */
-    public static function formatArguments(string $argsStr): void
-    {
-
-    }
 }

Original file line number	Diff line number	Diff line change
`@@ -8,10 +8,12 @@`
`8`	`8`
`9`	`9`	`namespace Inhere\Console\Component\Formatter;`
`10`	`10`
	`11`	`+use Inhere\Console\Component\MessageFormatter;`
	`12`	`+`
`11`	`13`	`/**`
`12`	`14`	`* Class Alert`
`13`	`15`	`* @package Inhere\Console\Component\Formatter`
`14`	`16`	`*/`
`15`		`-class Alert extends Formatter`
	`17`	`+class Alert extends MessageFormatter`
`16`	`18`	`{`
`17`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,11 +8,13 @@`
`8`	`8`
`9`	`9`	`namespace Inhere\Console\Component\Formatter;`
`10`	`10`
	`11`	`+use Inhere\Console\Component\MessageFormatter;`
	`12`	`+`
`11`	`13`	`/**`
`12`	`14`	`* Class Block`
`13`	`15`	`* @package Inhere\Console\Component\Formatter`
`14`	`16`	`*/`
`15`		`-class Block extends Formatter`
	`17`	`+class Block extends MessageFormatter`
`16`	`18`	`{`
`17`	`19`
`18`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,13 +2,14 @@`
`2`	`2`
`3`	`3`	`namespace Inhere\Console\Component\Formatter;`
`4`	`4`
`5`		`-use Inhere\Console\Util\Show;`
	`5`	`+use Inhere\Console\Component\MessageFormatter;`
	`6`	`+use Inhere\Console\Console;`
`6`	`7`
`7`	`8`	`/**`
`8`	`9`	`* Class MultiList`
`9`	`10`	`* @package Inhere\Console\Component\Formatter`
`10`	`11`	`*/`
`11`		`-class MultiList extends Formatter`
	`12`	`+class MultiList extends MessageFormatter`
`12`	`13`	`{`
`13`	`14`	`/**`
`14`	`15`	`* Format and render multi list`
`@@ -49,6 +50,6 @@ public static function show(array $data, array $opts = []): void`
`49`	`50`	`$stringList[] = SingleList::show($list, $title, $opts);`
`50`	`51`	`}`
`51`	`52`
`52`		`- Show::write(\implode("\n", $stringList), $lastNewline);`
	`53`	`+ Console::write(\implode("\n", $stringList), $lastNewline);`
`53`	`54`	`}`
`54`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,15 +2,16 @@`
`2`	`2`
`3`	`3`	`namespace Inhere\Console\Component\Formatter;`
`4`	`4`
	`5`	`+use Inhere\Console\Component\MessageFormatter;`
	`6`	`+use Inhere\Console\Console;`
`5`	`7`	`use Inhere\Console\Util\Helper;`
`6`		`-use Inhere\Console\Util\Show;`
`7`	`8`	`use Toolkit\Cli\ColorTag;`
`8`	`9`
`9`	`10`	`/**`
`10`	`11`	`* Class Padding`
`11`	`12`	`* @package Inhere\Console\Component\Formatter`
`12`	`13`	`*/`
`13`		`-class Padding extends Formatter`
	`14`	`+class Padding extends MessageFormatter`
`14`	`15`	`{`
`15`	`16`	`/**`
`16`	`17`	* ```php
`@@ -47,6 +48,6 @@ public static function show(array $data, string $title = '', array $opts = []):`
`47`	`48`	`$string .= $opts['indent'] . \str_pad($label, $paddingLen, $opts['char']) . " $value\n";`
`48`	`49`	`}`
`49`	`50`
`50`		`- Show::write(\trim($string));`
	`51`	`+ Console::write(\trim($string));`
`51`	`52`	`}`
`52`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,15 +8,16 @@`
`8`	`8`
`9`	`9`	`namespace Inhere\Console\Component\Formatter;`
`10`	`10`
`11`		`-use Inhere\Console\Util\Show;`
	`11`	`+use Inhere\Console\Component\MessageFormatter;`
	`12`	`+use Inhere\Console\Console;`
`12`	`13`	`use Toolkit\Cli\ColorTag;`
`13`	`14`	`use Toolkit\StrUtil\StrBuffer;`
`14`	`15`
`15`	`16`	`/**`
`16`	`17`	`* Class Table - Tabular data display`
`17`	`18`	`* @package Inhere\Console\Component\Formatter`
`18`	`19`	`*/`
`19`		`-class Table extends Formatter`
	`20`	`+class Table extends MessageFormatter`
`20`	`21`	`{`
`21`	`22`	`/** @var array */`
`22`	`23`	`public $data = [];`
`@@ -212,6 +213,6 @@ public static function show(array $data, string $title = 'Data Table', array $op`
`212`	`213`	`$buf->write($border . "\n");`
`213`	`214`	`}`
`214`	`215`
`215`		`- return Show::write($buf);`
	`216`	`+ return Console::write($buf);`
`216`	`217`	`}`
`217`	`218`	`}`