new: add error handle

new: add running sub-command support
update: modify error display
update: some modify for phar build

Author: inhere

examples/Commands/TestCommand.php

@@ -9,13 +9,15 @@
 namespace Inhere\Console\Examples\Commands;
 
 use Inhere\Console\Command;
+use Inhere\Console\IO\Output;
 
 /**
  * Class Test
  * @package Inhere\Console\Examples\Commands
  */
 class TestCommand extends Command
 {
+    protected static $name = 'test';
     protected static $description = 'this is a test independent command';
 
     /**
@@ -28,7 +30,7 @@ class TestCommand extends Command
      *  --long,-s   option description 1
      *  --opt       option description 2
      * @param $input
-     * @param $output
+     * @param Output $output
      */
     public function execute($input, $output)
     {

examples/Controllers/HomeController.php

@@ -26,7 +26,7 @@ class HomeController extends Controller
     /**
      * @return array
      */
-    protected static function commandAliases()
+    protected static function commandAliases(): array
     {
         return [
             // now, 'home:i' is equals to 'home:index'
@@ -98,6 +98,32 @@ public function defArgCommand()
         $this->output->dump($this->input->getArgs(), $this->input->getOpts(), $this->input->getBoolOpt('y'));
     }
 
+    /**
+     * a command for test throw exception
+     */
+    public function exCommand()
+    {
+        throw new \RuntimeException('oo, this is a runtime exception!');
+    }
+
+    /**
+     * a command for test trigger error
+     */
+    public function errorCommand()
+    {
+        trigger_error('oo, this is a runtime error!', E_USER_ERROR);
+    }
+
+    /**
+     * will run other command in the command.
+     */
+    public function subRunCommand()
+    {
+        $this->writeln('hello this is: ' . __METHOD__);
+
+        $this->getApp()->subRun('test', $this->input, $this->output);
+    }
+
     /**
      * dump current env information
      */

examples/Controllers/ProcessController.php

@@ -22,7 +22,7 @@ class ProcessController extends Controller
 
     protected static $description = 'Some simple process to create and use examples';
 
-    protected static function commandAliases()
+    protected static function commandAliases(): array
     {
         return [
             'cpr' => 'childProcess',

examples/app

@@ -8,7 +8,7 @@
 
 define('BASE_PATH', dirname(__DIR__));
 
-require dirname(__DIR__) . '/tests/boot.php';
+require dirname(__DIR__) . '/test/boot.php';
 
 // create app instance
 $app = new \Inhere\Console\Application([

examples/home

@@ -1,17 +1,24 @@
 #!/usr/env/php
 <?php
+/**
+ * only run a controller.
+ */
 
 use Inhere\Console\Examples\Controllers\HomeController;
 
 define('BASE_PATH', dirname(__DIR__));
 
-require dirname(__DIR__) . '/tests/boot.php';
+require dirname(__DIR__) . '/test/boot.php';
 
 $in = new \Inhere\Console\IO\Input();
 $ctrl = new HomeController($in, new \Inhere\Console\IO\Output());
 $ctrl->setStandAlone();
 
-exit($ctrl->run($in->getCommand()));
+try {
+  exit($ctrl->run($in->getCommand()));
+} catch (ReflectionException $e) {
+  // ...
+}
 
 // can also:
 

examples/liteApp

@@ -3,7 +3,7 @@
 
 define('BASE_PATH', dirname(__DIR__));
 
-require dirname(__DIR__) . '/tests/boot.php';
+require dirname(__DIR__) . '/test/boot.php';
 
 // create app instance
 $app = new \Inhere\Console\LiteApp;

phar.build.inc

@@ -14,14 +14,14 @@ $compiler
   ->setShebang(true)
   ->addExclude([
     'demo',
-    'tests',
+    'test',
     'tmp',
   ])
   ->addFile([
     'LICENSE',
     'composer.json',
     'README.md',
-    'tests/boot.php',
+    'test/boot.php',
   ])
   ->setCliIndex('examples/app')
   // ->setWebIndex('web/index.php')

phpunit.xml.dist

@@ -2,7 +2,7 @@
 
 <phpunit backupGlobals="false"
          backupStaticAttributes="false"
-         bootstrap="./tests/boot.php"
+         bootstrap="test/boot.php"
          colors="false"
          convertErrorsToExceptions="true"
          convertNoticesToExceptions="true"
@@ -12,13 +12,13 @@
 >
     <testsuites>
         <testsuite name="Php Console Test Suite">
-            <directory>./tests/</directory>
+            <directory>test</directory>
         </testsuite>
     </testsuites>
 
     <filter>
         <whitelist>
-            <directory suffix=".php">./src</directory>
+            <directory suffix=".php">src</directory>
         </whitelist>
     </filter>
 </phpunit>

src/Application.php

@@ -62,7 +62,7 @@ public function controller(string $name, string $class = null, $option = null)
         if ($aliases = $class::aliases()) {
             $option['aliases'] = isset($option['aliases']) ? array_merge($option['aliases'], $aliases) : $aliases;
         }
-        
+
         $this->controllers[$name] = $class;
 
         if (!$option) {
@@ -299,7 +299,7 @@ protected function dispatch(string $name)
         }
 
         // command not found
-        if (true !== self::fire(self::ON_NOT_FOUND, [$this])) {
+        if (true !== $this->fire(self::ON_NOT_FOUND, [$this])) {
             $this->output->liteError("The command '{$name}' is not exists in the console application!");
 
             $commands = array_merge($this->getControllerNames(), $this->getCommandNames());
@@ -361,8 +361,8 @@ public function runCommand($name, $believable = false)
     }
 
     /**
-     * @param string $name Controller name
-     * @param string $action Command
+     * @param string $name group name
+     * @param string $action Command method, no suffix
      * @param bool $believable The `$name` is believable
      * @param bool $standAlone
      * @return mixed

src/Base/AbstractApplication.php

@@ -9,8 +9,10 @@
 namespace Inhere\Console\Base;
 
 use Inhere\Console\IO\Input;
+use Inhere\Console\IO\InputInterface;
 use Inhere\Console\IO\Output;
 use Inhere\Console\Components\Style\Highlighter;
+use Inhere\Console\IO\OutputInterface;
 use Inhere\Console\Traits\InputOutputAwareTrait;
 use Inhere\Console\Traits\SimpleEventTrait;
 use Inhere\Console\Components\Style\Style;
@@ -111,7 +113,8 @@ protected function init()
         ];
 
         $this->commandName = $this->input->getCommand();
-        set_exception_handler([$this, 'handleException']);
+
+        $this->registerErrorHandle();
     }
 
     /**
@@ -214,6 +217,21 @@ public function stop($code = 0)
         exit((int)$code);
     }
 
+    /**
+     * @param string $command
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return int|mixed
+     */
+    public function subRun(string $command, InputInterface $input, OutputInterface $output)
+    {
+        $app = clone $this;
+        $app->setInput($input);
+        $app->setOutput($output);
+
+        return $app->dispatch($command);
+    }
+
     /**********************************************************
      * helper method for the application
      **********************************************************/
@@ -232,43 +250,67 @@ protected function runtimeCheck()
         }
     }
 
+    /**
+     * register error handle
+     */
+    protected function registerErrorHandle()
+    {
+        set_error_handler([$this, 'handleError']);
+        set_exception_handler([$this, 'handleException']);
+
+        register_shutdown_function(function () {
+            if ($e = error_get_last()) {
+                $this->handleError($e['type'], $e['message'], $e['file'], $e['line']);
+            }
+        });
+    }
+
+    /**
+     * 运行异常处理
+     * @param int $num
+     * @param string $str
+     * @param string $file
+     * @param int $line
+     */
+    public function handleError(int $num, string $str, string $file, int $line)
+    {
+        $this->handleException(new \ErrorException($str, 0, $num, $file, $line));
+        $this->stop(-1);
+    }
+
     /**
      * 运行异常处理
      * @param \Exception|\Throwable $e
      */
     public function handleException($e)
     {
         $class = \get_class($e);
-        $type = $e instanceof \Error ? 'Error' : 'Exception';
-        $title = ":( OO ... An $type Occurred!";
         $this->logError($e);
 
         // open debug, throw exception
         if ($this->isDebug()) {
             $tpl = <<<ERR
-    <danger>$title</danger>
+\n<error> Error </error> <mga>%s</mga>
 
-Message   <magenta>%s</magenta>
-At File   <cyan>%s</cyan> line <cyan>%d</cyan>
+At File <cyan>%s</cyan> line <bold>%d</bold>
 Exception $class
-Catch by  %s()\n
-Code Trace:\n%s\n
+<comment>Code View:</comment>\n\n%s
+<comment>Code Trace:</comment>\n\n%s\n
 ERR;
+            $line = $e->getLine();
+            $file = $e->getFile();
+            $snippet = Highlighter::create()->highlightSnippet(file_get_contents($file), $line, 3, 3);
             $message = sprintf(
                 $tpl,
                 // $e->getCode(),
                 $e->getMessage(),
-                $file = $e->getFile(),
-                $line = $e->getLine(),
-                __METHOD__,
-                $e->getTraceAsString()
+                $file,
+                $line,
+                // __METHOD__,
+                $snippet,
+                str_replace('):', "):\n  -", $e->getTraceAsString())
             );
 
-            $source = file_get_contents($file);
-            $hl = Highlighter::create();
-            $snippet = $hl->highlightSnippet($source, $line, 3, 3);
-            $message .= "\nCode View:\n$snippet";
-
             if ($this->meta['hideRootPath'] && ($rootPath = $this->meta['rootPath'])) {
                 $message = str_replace($rootPath, '{ROOT}', $message);
             }
@@ -539,6 +581,19 @@ protected function getRealCommandName(string $name): string
         return $this->commandAliases[$name] ?? $name;
     }
 
+    /**
+     * @param string $name
+     * @return mixed|null
+     */
+    public function findCommand(string $name)
+    {
+        if (isset($this->commands[$name])) {
+            return $this->commands[$name];
+        }
+
+        return $this->controllers[$name] ?? null;
+    }
+
     /**********************************************************
      * getter/setter methods
      **********************************************************/