add phpunit config file. Enhance 'help' command

Author: inhere

README.md

@@ -690,6 +690,12 @@ $answer = Interact::limitedAsk('please input you age?', null, function($age)
 });
 ```
 
+## Unit testing
+
+```bash
+phpunit
+```
+
 ## License
 
 MIT

composer.json

@@ -1,8 +1,8 @@
 {
   "name": "inhere/console",
   "type": "library",
-  "description": "a php console application library.",
-  "keywords": ["library","console","console-color","command", "console-application"],
+  "description": "a php console library, provide console argument parse,color style,user interactive, information show.",
+  "keywords": ["library","console","console-color", "command", "command-line", "cli", "console-application"],
   "homepage": "https://github.com/inhere/php-console",
   "license": "MIT",
   "authors": [
@@ -20,6 +20,11 @@
       "Inhere\\Console\\" : "src/"
     }
   },
+  "autoload-dev": {
+    "psr-4": {
+      "Inhere\\Console\\Tests\\" : "tests/"
+    }
+  },
   "suggest": {
     "inhere/simple-print-tool": "Very lightweight data printing tools"
   }

examples/s-autoload.php

@@ -11,20 +11,21 @@
 
 spl_autoload_register(function($class)
 {
+    $file = null;
+
     if (0 === strpos($class,'Inhere\Console\Examples\\')) {
         $path = str_replace('\\', '/', substr($class, strlen('Inhere\Console\examples\\')));
         $file =__DIR__ . "/{$path}.php";
 
-        if (is_file($file)) {
-            include $file;
-        }
-
+    } elseif (0 === strpos($class,'Inhere\Console\Tests\\')) {
+        $path = str_replace('\\', '/', substr($class, strlen('Inhere\Console\Tests\\')));
+        $file = dirname(__DIR__) . "/tests/{$path}.php";
     } elseif (0 === strpos($class,'Inhere\Console\\')) {
         $path = str_replace('\\', '/', substr($class, strlen('Inhere\Console\\')));
         $file = dirname(__DIR__) . "/src/{$path}.php";
+    }
 
-        if (is_file($file)) {
-            include $file;
-        }
+    if ($file && is_file($file)) {
+        include $file;
     }
 });

phpunit.xml.dist

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="./tests/boot.php"
+         colors="false"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         stopOnFailure="false"
+         syntaxCheck="false"
+>
+    <testsuites>
+        <testsuite name="Php Console Test Suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist>
+            <directory suffix=".php">./examples</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/Base/AbstractApplication.php

@@ -287,7 +287,7 @@ protected function filterSpecialCommand($command)
 
         switch ($command) {
             case 'help':
-                $this->showHelpInfo();
+                $this->showHelpInfo(true, $this->input->getFirstArg());
                 break;
             case 'list':
                 $this->showCommandList();
@@ -316,16 +316,26 @@ protected function validateName(string $name, $isGroup = false)
         }
     }
 
-    /**********************************************************
+    /***************************************************************************
      * some information for the application
-     **********************************************************/
+     ***************************************************************************/
 
     /**
      * show the application help information
      * @param bool $quit
+     * @param string $command
      */
-    public function showHelpInfo($quit = true)
+    public function showHelpInfo($quit = true, string $command = null)
     {
+        // display help for a special command
+        if ($command) {
+            $this->input->setCommand($command);
+            $this->input->setSOpt('h', true);
+            $this->input->clearArgs();
+            $this->dispatch($command);
+            $this->stop();
+        }
+
         $script = $this->input->getScript();
         $sep = $this->delimiter;
 
@@ -334,6 +344,7 @@ public function showHelpInfo($quit = true)
             'example' => [
                 "$script test (run a independent command)",
                 "$script home{$sep}index (run a command of the group)",
+                "$script help {command} (see a command help information)",
                 "$script home{$sep}index -h (see a command help of the group)",
             ]
         ], $quit);

src/IO/Input.php

@@ -259,6 +259,11 @@ public function getSameArg(array $names, $default = null)
         return $this->sameArg($names, $default);
     }
 
+    /**
+     * @param array $names
+     * @param mixed $default
+     * @return mixed
+     */
     public function sameArg(array $names, $default = null)
     {
         foreach ($names as $name) {
@@ -270,9 +275,17 @@ public function sameArg(array $names, $default = null)
         return $default;
     }
 
-/////////////////////////////////////////////////////////////////////////////////////////
-/// long/short options (eg: -d --help)
-/////////////////////////////////////////////////////////////////////////////////////////
+    /**
+     * clear args
+     */
+    public function clearArgs()
+    {
+        $this->args = [];
+    }
+
+    /***************************************************************************
+     * long/short options (eg: -d --help)
+     ***************************************************************************/
 
     /**
      * get (long/short)opt value
@@ -372,7 +385,15 @@ public function sameOpt(array $names, $default = null)
         return $default;
     }
 
-    /////////////////// short-opts /////////////////////
+    /**
+     * clear (l/s)opts
+     */
+    public function clearOpts()
+    {
+        $this->sOpts = $this->lOpts = [];
+    }
+
+    /************************** short-opts **********************/
 
     /**
      * get short-opt value
@@ -421,6 +442,15 @@ public function getShortOpts(): array
         return $this->sOpts;
     }
 
+    /**
+     * @param string $name
+     * @param $value
+     */
+    public function setSOpt(string $name, $value)
+    {
+        $this->sOpts[$name] = $value;
+    }
+
     /**
      * @return array
      */
@@ -438,7 +468,15 @@ public function setSOpts(array $sOpts, $replace = false)
         $this->sOpts = $replace ? $sOpts : array_merge($this->sOpts, $sOpts);
     }
 
-    /////////////////// long-opts /////////////////////
+    /**
+     * clear s-opts
+     */
+    public function clearSOpts()
+    {
+        $this->sOpts = [];
+    }
+
+    /************************** long-opts **********************/
 
     /**
      * get long-opt value
@@ -495,6 +533,15 @@ public function getLOpts(): array
         return $this->lOpts;
     }
 
+    /**
+     * @param string $name
+     * @param $value
+     */
+    public function setLOpt(string $name, $value)
+    {
+        $this->lOpts[$name] = $value;
+    }
+
     /**
      * @param array $lOpts
      * @param bool $replace
@@ -512,6 +559,14 @@ public function getOpts(): array
         return array_merge($this->sOpts, $this->lOpts);
     }
 
+    /**
+     * clear l-opts
+     */
+    public function clearLOpts()
+    {
+        $this->lOpts = [];
+    }
+
 /////////////////////////////////////////////////////////////////////////////////////////
 /// getter/setter
 /////////////////////////////////////////////////////////////////////////////////////////

tests/ApplicationTest.php

@@ -1,5 +1,7 @@
 <?php
 
+use Inhere\Console\IO\InputInterface;
+use Inhere\Console\IO\OutputInterface;
 use PHPUnit\Framework\TestCase;
 use Inhere\Console\Application;
 
@@ -8,5 +10,18 @@
  */
 class ApplicationTest extends TestCase
 {
+    public function testApp()
+    {
+        $app = new Application([
+            'name' => 'Tests',
+            'debug' => 1,
+            'version' => '1.0.0',
+        ]);
 
+        $this->assertArrayHasKey('name', $app->getMeta());
+        $this->assertEquals('Tests', $app->getMeta('name'));
+
+        $this->assertInstanceOf(InputInterface::class, $app->getInput());
+        $this->assertInstanceOf(OutputInterface::class, $app->getOutput());
+    }
 }

tests/bootstap.php renamed to tests/boot.php

@@ -1,4 +1,4 @@
 #!/bin/bash
 
 # phpunit6.phar --colors --coverage-html ./coverage/
-phpunit6.phar --colors --bootstrap tests/bootstap.php tests
+phpunit6.phar --colors --bootstrap tests/boot.php tests