update readme. complete a simple template generator

inhere · inhere · commit 6127703e2f3f · 2017-12-24T16:52:33.000+08:00
diff --git a/README.md b/README.md
@@ -114,7 +114,7 @@ $app->command('demo', function (Input $in, Output $out) {
 }, 'this is message for the command');
 ```
 
-### 继承 `Inhere\Console\Command`
+### 独立命令
 
 通过继承 `Inhere\Console\Command` 添加独立命令
 
@@ -165,7 +165,7 @@ $app->command(TestCommand::class);
 // $app->command('test1', TestCommand::class);
 ```
 
-### 继承 `Inhere\Console\Controller`
+### 命令组
 
 通过继承 `Inhere\Console\Controller` 添加一组命令. 即是命令行的控制器
 
@@ -181,13 +181,29 @@ class HomeController extends Controller
     protected static $description = 'default command controller. there are some command usage examples';
 
     /**
-     * this is a command's description message <info>a color text</info>
+     * this is a command's description message, <cyan>color text</cyan>
      * the second line text
-     * @usage usage message
+     * @usage {command} [arg ...] [--opt ...]
+     * @arguments
+     *  arg1        argument description 1
+     *              the second line
+     *  a2,arg2     argument description 2
+     *              the second line
+     * @options
+     *  -s, --long  option description 1
+     *  --opt       option description 2
      * @example example text one
      *  the second line example
      */
-    public function indexCommand()
+    public function testCommand()
+    {
+        $this->write('hello, welcome!! this is ' . __METHOD__);
+    }
+    
+    /**
+     * a example for use color text output on command
+     */
+    public function otherCommand()
     {
         $this->write('hello, welcome!! this is ' . __METHOD__);
     }
@@ -202,13 +218,14 @@ class HomeController extends Controller
 
 - 支持的tag有 `@usage` `@arguments` `@options` `@example`
 - 当你使用 `php examples/app home -h` 时，可以查看到 `HomeController` 的所有命令描述注释信息
-- 当使用 `php examples/app home:index -h` 时，可以查看到关于 `HomeController::indexCommand` 更详细的信息。包括描述注释文本、`@usage` 、`@example`
+  
+  ![group-command-list](docs/screenshots/group-command-list.png)
+- 当使用 `php examples/app home:test -h` 时，可以查看到关于 `HomeController::testCommand` 更详细的信息。包括描述注释文本、`@usage` 、`@example`
 
-> 小提示：注释里面同样支持带颜色的文本输出 `eg: this is a command's description <info>message</info>`
+  ![group-command-list](docs/screenshots/group-command-help.png)
 
-- 运行效果(by `php examples/app home`):
+> 小提示：注释里面同样支持带颜色的文本输出 `eg: this is a command's description <info>message</info>`
 
-![group-command-list](docs/screenshots/group-command-list.png)
 
 更多请查看 [examples](./examples) 中的示例代码和在目录下运行示例 `php examples/app` 来查看效果
 
diff --git a/docs/screenshots/group-command-help.png b/docs/screenshots/group-command-help.png
diff --git a/examples/Controllers/HomeController.php b/examples/Controllers/HomeController.php
@@ -58,7 +58,7 @@ protected function afterExecute()
     /**
      * this is a command's description message
      * the second line text
-     * @usage usage message
+     * @usage {command} [arg ...] [--opt ...]
      * @arguments
      *  arg1        argument description 1
      *              the second line
diff --git a/src/Base/AbstractCommand.php b/src/Base/AbstractCommand.php
@@ -76,13 +76,14 @@ public function __construct(Input $input, Output $output, InputDefinition $defin
     {
         $this->input = $input;
         $this->output = $output;
-        $this->annotationVars = $this->annotationVars();
 
         if ($definition) {
             $this->definition = $definition;
         }
 
         $this->init();
+
+        $this->annotationVars = $this->annotationVars();
     }
 
     protected function init()
@@ -116,12 +117,13 @@ protected function createDefinition()
      */
     public function annotationVars()
     {
-        // e.g: `more info see {name}/index`
+        // e.g: `more info see {name}:index`
         return [
-            'script' => $this->input->getScript(),
-            'command' => $this->input->getCommand(),
-            'fullCommand' => $this->input->getScript() . ' ' . $this->input->getCommand(),
             'name' => self::getName(),
+            'group' => self::getName(),
+            'script' => $this->input->getScript(), // bin/app
+            'command' => $this->input->getCommand(), // demo OR home:test
+            'fullCommand' => $this->input->getScript() . ' ' . $this->input->getCommand(),
         ];
     }
 
diff --git a/src/BuiltIn/GenController.php b/src/BuiltIn/GenController.php
@@ -0,0 +1,37 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: Inhere
+ * Date: 2017/12/24 0024
+ * Time: 16:48
+ */
+
+namespace Inhere\Console\BuiltIn;
+
+use Inhere\Console\Controller;
+
+/**
+ * Class GenController
+ * @package Inhere\Console\BuiltIn
+ */
+class GenController extends Controller
+{
+    protected static $name = 'gen';
+    protected static $description = 'generate code template file tool.';
+
+    /**
+     * generate a alone console command class
+     */
+    public function aloneCommand()
+    {
+
+    }
+
+    /**
+     * generate a group commands(console controller) class
+     */
+    public function groupCommand()
+    {
+
+    }
+}
diff --git a/src/Components/AutoComplete/ScriptGenerator.php b/src/Components/AutoComplete/ScriptGenerator.php
@@ -8,6 +8,8 @@
 
 namespace Inhere\Console\Components\AutoComplete;
 
+use Inhere\Console\Components\TextTemplate;
+
 /**
  * Class ScriptGenerator
  * - ref linux system '/etc/bash_completion.d/'
@@ -30,6 +32,9 @@ class ScriptGenerator
     /** @var int The mode */
     private $mode = 1;
 
+    /** @var TextTemplate */
+    private $renderer;
+
     /**
      * @return array
      */
@@ -46,6 +51,28 @@ public static function modeList()
         return [self::MODE_SIMPLE, self::MODE_FULL];
     }
 
+    /**
+     * @param string $tplFile
+     * @param string $dstFile
+     * @param array $vars
+     * @param bool $override
+     * @return bool
+     */
+    public function gen(string $tplFile, string $dstFile, array $vars = [], $override = false)
+    {
+        if (!\is_file($tplFile)) {
+            throw new \InvalidArgumentException("Template file not exists. FILE: $tplFile");
+        }
+
+        if (!$override && is_file($dstFile)) {
+            return true;
+        }
+
+        $tt = $this->getRenderer();
+
+        return $tt->render(file_get_contents($tplFile), $vars, $dstFile);
+    }
+
     /**
      * @return int
      */
@@ -81,4 +108,24 @@ public function setMode(int $mode)
             $this->mode = $mode;
         }
     }
+
+    /**
+     * @return TextTemplate
+     */
+    public function getRenderer(): TextTemplate
+    {
+        if (!$this->renderer) {
+            $this->renderer = new TextTemplate();
+        }
+
+        return $this->renderer;
+    }
+
+    /**
+     * @param TextTemplate $renderer
+     */
+    public function setRenderer(TextTemplate $renderer)
+    {
+        $this->renderer = $renderer;
+    }
 }
diff --git a/src/Components/TextTemplate.php b/src/Components/TextTemplate.php
@@ -23,12 +23,39 @@ class TextTemplate
     /** @var string  */
     private $closeChar = '}';
 
+    /**
+     * TextTemplate constructor.
+     * @param array $vars
+     */
+    public function __construct(array $vars = [])
+    {
+        if ($vars) {
+            $this->setVars($vars);
+        }
+    }
+
+    /**
+     * @param string $tplFile
+     * @param array $vars
+     * @param null|string $saveAs
+     * @return string|bool
+     */
+    public function renderFile(string $tplFile, array $vars = [], $saveAs = null)
+    {
+        if (!\is_file($tplFile)) {
+            throw new \InvalidArgumentException("Template file not exists. FILE: $tplFile");
+        }
+
+        return $this->render(file_get_contents($tplFile), $vars, $saveAs);
+    }
+
     /**
      * @param string $template
      * @param array $vars
+     * @param null|string $saveAs
      * @return string
      */
-    public function render(string $template, array $vars = [])
+    public function render(string $template, array $vars = [], $saveAs = null)
     {
         if (!$template || false === strpos($template, $this->openChar)) {
             return $template;
@@ -38,14 +65,47 @@ public function render(string $template, array $vars = [])
             $vars = array_merge($this->vars, $vars);
         }
 
-        $pairs = [];
+        $pairs = $map = [];
+        $this->expandVars($vars, $map);
 
-        foreach ($vars as $name => $value) {
+        foreach ($map as $name => $value) {
             $key = $this->openChar . $name . $this->closeChar;
             $pairs[$key] = $value;
         }
 
-        return strtr($template, $pairs);
+        // replace vars to values.
+        $rendered = strtr($template, $pairs);
+
+        if (!$saveAs) {
+            return $rendered;
+        }
+
+        $dstDir = \dirname($saveAs);
+
+        if (!is_dir($dstDir) && !mkdir($dstDir, 0775, true) && !is_dir($dstDir)) {
+            throw new \RuntimeException(sprintf('Directory "%s" was not created', $dstDir));
+        }
+
+        return (bool)file_put_contents($saveAs, $rendered);
+    }
+
+    /**
+     * Multidimensional array expansion to one dimension array
+     * @param array $vars
+     * @param null|string $prefix
+     * @param array $map
+     */
+    protected function expandVars(array $vars, array &$map = [], $prefix = null)
+    {
+        foreach ($vars as $name => $value) {
+            $key = $prefix !== null ? $prefix . '.' . $name : $name;
+
+            if (is_scalar($value)) {
+                $map[$key] = $value;
+            } elseif (\is_array($value)) {
+                $this->expandVars($value, $map, (string)$key);
+            }
+        }
     }
 
     /**
diff --git a/tests/Components/TextTemplateTest.php b/tests/Components/TextTemplateTest.php
@@ -0,0 +1,45 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: Inhere
+ * Date: 2017/12/24 0024
+ * Time: 15:32
+ */
+
+namespace Inhere\Console\Tests\Components;
+
+use Inhere\Console\Components\TextTemplate;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Class TextTemplateTest
+ * @package Inhere\Console\Tests\Components
+ * @covers TextTemplate
+ */
+class TextTemplateTest extends TestCase
+{
+    public function testRender()
+    {
+        $tpl = <<<EOF
+test tpl on date {\$date}
+
+use array {\$map.0} {\$map.key1}
+EOF;
+        $date = date('Ymd');
+
+        $tt = new TextTemplate([
+            'name' => 'test',
+            'date' => $date,
+            'map' => [
+                'VAL0',
+                'key1' => 'VAL1',
+            ],
+        ]);
+
+        $ret = $tt->render($tpl);
+        $this->assertNotEmpty($ret);
+        $this->assertTrue((bool)strpos($ret, $date));
+        $this->assertTrue((bool)strpos($ret, 'VAL0'));
+        $this->assertStringEndsWith('VAL1', $ret);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -76,13 +76,14 @@ public function __construct(Input $input, Output $output, InputDefinition $defin`
`76`	`76`	`{`
`77`	`77`	`$this->input = $input;`
`78`	`78`	`$this->output = $output;`
`79`		`- $this->annotationVars = $this->annotationVars();`
`80`	`79`
`81`	`80`	`if ($definition) {`
`82`	`81`	`$this->definition = $definition;`
`83`	`82`	`}`
`84`	`83`
`85`	`84`	`$this->init();`
	`85`	`+`
	`86`	`+ $this->annotationVars = $this->annotationVars();`
`86`	`87`	`}`
`87`	`88`
`88`	`89`	`protected function init()`
`@@ -116,12 +117,13 @@ protected function createDefinition()`
`116`	`117`	`*/`
`117`	`118`	`public function annotationVars()`
`118`	`119`	`{`
`119`		- // e.g: `more info see {name}/index`
	`120`	+ // e.g: `more info see {name}:index`
`120`	`121`	`return [`
`121`		`- 'script' => $this->input->getScript(),`
`122`		`- 'command' => $this->input->getCommand(),`
`123`		`- 'fullCommand' => $this->input->getScript() . ' ' . $this->input->getCommand(),`
`124`	`122`	`'name' => self::getName(),`
	`123`	`+ 'group' => self::getName(),`
	`124`	`+ 'script' => $this->input->getScript(), // bin/app`
	`125`	`+ 'command' => $this->input->getCommand(), // demo OR home:test`
	`126`	`+ 'fullCommand' => $this->input->getScript() . ' ' . $this->input->getCommand(),`
`125`	`127`	`];`
`126`	`128`	`}`
`127`	`129`