Skip to content

Commit 391938b

Browse files
inhereinhere
committed
refeator: command and subcommand help render by flags parser
1 parent 661a36b commit 391938b

11 files changed

+280
-162
lines changed

‎.github/workflows/php.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,4 +53,4 @@ jobs:
5353
# Docs: https://getcomposer.org/doc/articles/scripts.md
5454

5555
- name: Run unit tests
56-
run: phpunit -vv
56+
run: phpunit -v --debug

‎phpunit.xml

+9-7
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,25 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
3-
<phpunit backupGlobals="false"
2+
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
colors="true"
4+
backupGlobals="false"
45
backupStaticAttributes="false"
56
bootstrap="test/bootstrap.php"
6-
colors="false"
77
convertErrorsToExceptions="true"
88
convertNoticesToExceptions="true"
99
convertWarningsToExceptions="true"
1010
stopOnFailure="false"
11+
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
1112
>
13+
1214
<testsuites>
1315
<testsuite name="Php Console Test Suite">
1416
<directory>test</directory>
1517
</testsuite>
1618
</testsuites>
1719

18-
<filter>
19-
<whitelist>
20+
<coverage>
21+
<include>
2022
<directory suffix=".php">src</directory>
21-
</whitelist>
22-
</filter>
23+
</include>
24+
</coverage>
2325
</phpunit>

‎src/AbstractHandler.php

+14-133
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
use Inhere\Console\IO\Input;
2121
use Inhere\Console\IO\InputDefinition;
2222
use Inhere\Console\IO\Output;
23-
use Inhere\Console\Util\FormatUtil;
2423
use Inhere\Console\Util\Helper;
2524
use InvalidArgumentException;
2625
use ReflectionException;
@@ -32,17 +31,10 @@
3231
use Toolkit\PFlag\SFlags;
3332
use Toolkit\Stdlib\Helper\PhpHelper;
3433
use Toolkit\Stdlib\Obj\ConfigObject;
35-
use Toolkit\Stdlib\Util\PhpDoc;
3634
use function array_merge;
3735
use function cli_set_process_title;
3836
use function error_get_last;
3937
use function function_exists;
40-
use function implode;
41-
use function is_string;
42-
use function preg_replace;
43-
use function sprintf;
44-
use function ucfirst;
45-
use const PHP_EOL;
4638
use const PHP_OS;
4739

4840
/**
@@ -252,8 +244,8 @@ protected function annotationVars(): array
252244
protected function initForRun(Input $input): void
253245
{
254246
$input->setFs($this->flags);
247+
$this->flags->setDesc(self::getDesc());
255248
$this->flags->setScriptName(self::getName());
256-
$this->flags->setDesc(self::getDescription());
257249

258250
// load built in options
259251
// $builtInOpts = GlobalOption::getAloneOptions();
@@ -507,6 +499,7 @@ public function loadRulesByDocblock(string $method, FlagsParser $fs): void
507499
$dr = DocblockRules::newByDocblock($rftMth->getDocComment());
508500
$dr->parse();
509501

502+
$fs->setDesc($dr->getTagValue('desc') ?: self::getDesc());
510503
$fs->addArgsByRules($dr->getArgRules());
511504
$fs->addOptsByRules($dr->getOptRules());
512505
}
@@ -522,111 +515,26 @@ public function loadRulesByDocblock(string $method, FlagsParser $fs): void
522515
*/
523516
abstract protected function showHelp(): bool;
524517

518+
/**************************************************************************
519+
* getter/setter methods
520+
**************************************************************************/
521+
525522
/**
526-
* Display command/action help by parse method annotations
527-
*
528-
* @param string $method
529-
* @param string $action action of an group
530-
* @param array $aliases
531-
*
532-
* @return int
533-
* @throws ReflectionException
523+
* @return string
534524
*/
535-
protected function showHelpByAnnotations(string $method, string $action = '', array $aliases = []): int
525+
public function getGroupName(): string
536526
{
537-
$name = $this->input->getCommand();
538-
539-
// subcommand: is a console controller subcommand
540-
$rftMth = PhpHelper::reflectMethod($this, $method);
541-
if ($action && !$rftMth->isPublic()) {
542-
$this->write("The command [<info>$name</info>] don't allow access in the class.");
543-
return 0;
544-
}
545-
546-
$allowedTags = DocblockRules::getAllowedTags();
547-
$this->logf(Console::VERB_DEBUG, "render help for the command: %s", $this->input->getCommandId());
548-
549-
$help = [];
550-
$doc = $this->parseCommentsVars((string)$rftMth->getDocComment());
551-
$tags = PhpDoc::getTags($doc, [
552-
'allow' => $allowedTags,
553-
]);
554-
555-
if ($aliases) {
556-
$realName = $action ?: static::getName();
557-
// command name
558-
$help['Command:'] = sprintf('%s(alias: <info>%s</info>)', $realName, implode(',', $aliases));
559-
}
560-
561-
$binName = $this->input->getBinName();
562-
563-
$path = $binName . ' ' . $name;
564-
if ($action) {
565-
$group = static::getName();
566-
$path = "$binName $group $action";
567-
}
568-
569-
// is an command object
570-
$isCommand = $this->isCommand();
571-
foreach ($allowedTags as $tag) {
572-
if (empty($tags[$tag]) || !is_string($tags[$tag])) {
573-
// for alone command
574-
if ($tag === 'description' && $isCommand) {
575-
$help['Description:'] = static::getDesc();
576-
continue;
577-
}
578-
579-
if ($tag === 'usage') {
580-
$help['Usage:'] = "$path [--options ...] [arguments ...]";
581-
}
582-
583-
continue;
584-
}
585-
586-
// $msg = trim($tags[$tag]);
587-
$message = $tags[$tag];
588-
$labelName = ucfirst($tag) . ':';
589-
590-
// for alone command
591-
if ($tag === 'description' && $isCommand) {
592-
$message = static::getDescription();
593-
} else {
594-
$message = preg_replace('#(\n)#', '$1 ', $message);
595-
}
596-
597-
$help[$labelName] = $message;
598-
}
599-
600-
if (isset($help['Description:'])) {
601-
$description = $help['Description:'] ?: 'No description message for the command';
602-
$this->write(ucfirst($this->parseCommentsVars($description)) . PHP_EOL);
603-
unset($help['Description:']);
604-
}
605-
606-
$help['Group Options:'] = null;
607-
608-
$this->beforeRenderCommandHelp($help);
609-
610-
if ($app = $this->getApp()) {
611-
$help['Global Options:'] = FormatUtil::alignOptions($app->getFlags()->getOptSimpleDefines());
612-
}
613-
614-
$this->output->mList($help, [
615-
'sepChar' => ' ',
616-
'lastNewline' => 0,
617-
]);
618-
619-
return 0;
527+
return '';
620528
}
621529

622-
protected function beforeRenderCommandHelp(array &$help): void
530+
/**
531+
* @return string
532+
*/
533+
public function getRealName(): string
623534
{
535+
return self::getName();
624536
}
625537

626-
/**************************************************************************
627-
* getter/setter methods
628-
**************************************************************************/
629-
630538
/**
631539
* @return array
632540
*/
@@ -706,33 +614,6 @@ public static function setCoroutine($coroutine): void
706614
static::$coroutine = (bool)$coroutine;
707615
}
708616

709-
/**
710-
* @return array
711-
*/
712-
final public static function getAnnotationTags(): array
713-
{
714-
return self::$annotationTags;
715-
}
716-
717-
/**
718-
* @param string $name
719-
*/
720-
public static function addAnnotationTag(string $name): void
721-
{
722-
if (!isset(self::$annotationTags[$name])) {
723-
self::$annotationTags[$name] = true;
724-
}
725-
}
726-
727-
/**
728-
* @param array $annotationTags
729-
* @param bool $replace
730-
*/
731-
public static function setAnnotationTags(array $annotationTags, $replace = false): void
732-
{
733-
self::$annotationTags = $replace ? $annotationTags : array_merge(self::$annotationTags, $annotationTags);
734-
}
735-
736617
/**
737618
* @return string
738619
*/

‎src/Annotate/DocblockRules.php

+21
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
use Toolkit\Stdlib\Str;
66
use Toolkit\Stdlib\Util\PhpDoc;
77
use function array_keys;
8+
use function array_merge;
89
use function explode;
910
use function preg_match;
1011
use function trim;
@@ -200,6 +201,26 @@ public static function getAllowedTags(bool $onlyName = true): array
200201
return $onlyName ? array_keys(self::$allowedTags) : self::$allowedTags;
201202
}
202203

204+
205+
/**
206+
* @param string $name
207+
*/
208+
public static function addAllowedTag(string $name): void
209+
{
210+
if (!isset(self::$allowedTags[$name])) {
211+
self::$allowedTags[$name] = true;
212+
}
213+
}
214+
215+
/**
216+
* @param array $allowedTags
217+
* @param bool $replace
218+
*/
219+
public static function setAllowedTags(array $allowedTags, bool $replace = false): void
220+
{
221+
self::$allowedTags = $replace ? $allowedTags : array_merge(self::$allowedTags, $allowedTags);
222+
}
223+
203224
/**
204225
* @return array
205226
*/

‎src/Command.php

+24-13
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,26 @@ abstract class Command extends AbstractHandler implements CommandInterface
3636
*/
3737
protected $parent;
3838

39+
/**
40+
* @var string
41+
*/
42+
protected $commandName = '';
43+
44+
protected function init(): void
45+
{
46+
$this->commandName = self::getName();
47+
48+
parent::init();
49+
}
50+
3951
/**
4052
* @throws ReflectionException
4153
*/
4254
protected function initForRun(Input $input): void
4355
{
4456
parent::initForRun($input);
4557

58+
$this->flags->setStopOnFistArg(false);
4659
// old mode: options and arguments at method annotations
4760
if ($this->compatible) {
4861
$this->flags->setSkipOnUndefined(true);
@@ -111,20 +124,18 @@ protected function showHelp(): bool
111124
{
112125
$aliases = $this->getAliases();
113126

114-
// render help by input definition.
115-
// if ($definition = $this->getDefinition()) {
116-
// $this->showHelpByDefinition($definition, $aliases);
117-
// return true;
118-
// }
127+
$this->logf(Console::VERB_CRAZY, "display help info for the command: %s", $this->commandName);
119128

120-
// TODO show help by flags
121-
// if ($this->flags->isNotEmpty()) {
122-
// }
123-
124-
$execMethod = self::METHOD;
125-
126-
$this->logf(Console::VERB_CRAZY, "display help info for the command: %s", self::getName());
129+
// $execMethod = self::METHOD;
130+
// return $this->showHelpByAnnotations($execMethod, '', $aliases) !== 0;
131+
return $this->showHelpByFlagsParser($this->flags, $aliases) !== 0;
132+
}
127133

128-
return $this->showHelpByAnnotations($execMethod, '', $aliases) !== 0;
134+
/**
135+
* @return string
136+
*/
137+
public function getCommandName(): string
138+
{
139+
return $this->commandName;
129140
}
130141
}

‎src/Concern/ApplicationHelpTrait.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ public function showHelpInfo(string $command = ''): void
131131

132132
// built in options
133133
// $globalOptions = self::$globalOptions;
134-
$globalOptions = $this->flags->getOptSimpleDefines();
134+
$globalOptions = $this->flags->getOptsHelpData();
135135
// append generate options:
136136
// php examples/app --auto-completion --shell-env zsh --gen-file
137137
// php examples/app --auto-completion --shell-env zsh --gen-file stdout
@@ -286,7 +286,7 @@ public function showCommandList(): void
286286

287287
// built in options
288288
// $globOpts = self::$globalOptions;
289-
$globOpts = $this->flags->getOptSimpleDefines();
289+
$globOpts = $this->flags->getOptsHelpData();
290290

291291
Show::mList([
292292
'Usage:' => "$scriptName <info>{COMMAND}</info> [--opt -v -h ...] [arg0 arg1 arg2=value2 ...]",

0 commit comments

Comments
 (0)