Skip to content

Commit 6c44403

Browse files
inhereinhere
committed
up: update table and json format, add new interact tool: value collector
1 parent 04e5fdb commit 6c44403

File tree

7 files changed

+1017
-24
lines changed

7 files changed

+1017
-24
lines changed

‎src/Component/Formatter/JSONPretty.php‎

Lines changed: 142 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,18 @@
99

1010
namespace Inhere\Console\Component\Formatter;
1111

12-
use JsonException;
1312
use Toolkit\Cli\Color\ColorTag;
1413
use Toolkit\Stdlib\Helper\JsonHelper;
1514
use Toolkit\Stdlib\Obj\AbstractObj;
1615
use Toolkit\Stdlib\Str\StrBuffer;
1716
use function array_merge;
1817
use function explode;
1918
use function is_numeric;
20-
use function json_decode;
2119
use function preg_replace_callback;
2220
use function rtrim;
2321
use function str_contains;
2422
use function str_ends_with;
23+
use function str_replace;
2524
use function trim;
2625

2726
/**
@@ -34,13 +33,15 @@ class JSONPretty extends AbstractObj
3433
'strVal' => 'info',
3534
'intVal' => 'cyan',
3635
'boolVal' => 'red',
36+
'matched' => 'red1',
3737
];
3838

3939
public const THEME_ONE = [
4040
'keyName' => 'blue',
4141
'strVal' => 'cyan',
4242
'intVal' => 'red',
4343
'boolVal' => 'green',
44+
'matched' => 'yellow',
4445
];
4546

4647
// json.cn
@@ -49,10 +50,11 @@ class JSONPretty extends AbstractObj
4950
'strVal' => 'info',
5051
'intVal' => 'hiBlue',
5152
'boolVal' => 'red',
53+
'matched' => 'yellow',
5254
];
5355

5456
/**
55-
* @var array{keyName: string, strVal: string, intVal: string, boolVal: string}
57+
* @var array = DEFAULT_THEME
5658
*/
5759
protected array $theme = self::DEFAULT_THEME;
5860

@@ -61,6 +63,14 @@ class JSONPretty extends AbstractObj
6163
*/
6264
public int $maxDepth = 10;
6365

66+
public bool $noColor = false;
67+
68+
public array $includes = [];
69+
70+
public array $excludes = [];
71+
72+
public array $matches = [];
73+
6474
/**
6575
* @param string $json
6676
*
@@ -110,13 +120,43 @@ public function render(string $json): string
110120
*/
111121
public function renderData(mixed $data): string
112122
{
113-
$buf = StrBuffer::new();
114123
$json = JsonHelper::prettyJSON($data);
115124

125+
if ($this->noColor && !$this->includes && !$this->excludes) {
126+
return $json;
127+
}
128+
129+
$buf = StrBuffer::new();
130+
116131
foreach (explode("\n", $json) as $line) {
117132
$trimmed = trim($line);
118133
// start or end chars. eg: {} []
119134
if (!str_contains($trimmed, ': ')) {
135+
if ($this->noColor) {
136+
$buf->writeln($line);
137+
} else {
138+
$buf->writeln(ColorTag::wrap($line, $this->theme['strVal']));
139+
}
140+
continue;
141+
}
142+
143+
if ($this->includes && !$this->includeFilter($trimmed)) {
144+
continue;
145+
}
146+
147+
if ($this->excludes && !$this->excludeFilter($trimmed)) {
148+
continue;
149+
}
150+
151+
if ($this->noColor) {
152+
$buf->writeln($line);
153+
continue;
154+
}
155+
156+
if ($ms = $this->matchKeywords($line)) {
157+
foreach ($ms as $m) {
158+
$line = str_replace($m, ColorTag::wrap($m, $this->theme['matched']), $line);
159+
}
120160
$buf->writeln($line);
121161
continue;
122162
}
@@ -150,12 +190,110 @@ public function renderData(mixed $data): string
150190
return $buf->getAndClear();
151191
}
152192

193+
/**
194+
* @param string $line
195+
*
196+
* @return bool return false to exclude
197+
*/
198+
protected function includeFilter(string $line): bool
199+
{
200+
if (!$this->includes) {
201+
return true;
202+
}
203+
204+
foreach ($this->includes as $kw) {
205+
if (str_contains($line, $kw)) {
206+
return true;
207+
}
208+
}
209+
return false;
210+
}
211+
212+
/**
213+
* @param string $line
214+
*
215+
* @return bool return false to exclude
216+
*/
217+
protected function excludeFilter(string $line): bool
218+
{
219+
if (!$this->excludes) {
220+
return true;
221+
}
222+
223+
foreach ($this->excludes as $kw) {
224+
if (str_contains($line, $kw)) {
225+
return false;
226+
}
227+
}
228+
return true;
229+
}
230+
231+
/**
232+
* @param string $line
233+
*
234+
* @return array
235+
*/
236+
protected function matchKeywords(string $line): array
237+
{
238+
$matched = [];
239+
foreach ($this->matches as $kw) {
240+
if (str_contains($line, $kw)) {
241+
$matched[] = $kw;
242+
}
243+
}
244+
return $matched;
245+
}
246+
153247
/**
154248
* @param array $theme
155249
*/
156250
public function setTheme(array $theme): void
157251
{
158252
$this->theme = array_merge($this->theme, $theme);
159253
}
254+
255+
/**
256+
* @param array|string $includes
257+
*
258+
* @return JSONPretty
259+
*/
260+
public function setIncludes(array|string $includes): self
261+
{
262+
$this->includes = (array)$includes;
263+
return $this;
264+
}
265+
266+
/**
267+
* @param array|string $excludes
268+
*
269+
* @return JSONPretty
270+
*/
271+
public function setExcludes(array|string $excludes): self
272+
{
273+
$this->excludes = (array)$excludes;
274+
return $this;
275+
}
276+
277+
/**
278+
* @param bool $noColor
279+
*
280+
* @return JSONPretty
281+
*/
282+
public function setNoColor(bool $noColor): self
283+
{
284+
$this->noColor = $noColor;
285+
return $this;
286+
}
287+
288+
/**
289+
* @param array $matches
290+
*
291+
* @return JSONPretty
292+
*/
293+
public function setMatches(array $matches): self
294+
{
295+
$this->matches = $matches;
296+
return $this;
297+
}
160298
}
161299

‎src/Component/Formatter/Table.php‎

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
use Inhere\Console\Component\MessageFormatter;
1313
use Inhere\Console\Console;
1414
use Toolkit\Cli\Color\ColorTag;
15+
use Toolkit\Stdlib\Helper\DataHelper;
1516
use Toolkit\Stdlib\Str;
1617
use Toolkit\Stdlib\Str\StrBuffer;
1718
use function array_keys;
@@ -112,63 +113,66 @@ public static function show(array $data, string $title = 'Data Table', array $op
112113
$colBorderChar = $opts['colBorderChar'];
113114

114115
$info = [
115-
'rowCount' => count($data),
116+
// 'rowCount' => count($data),
116117
'columnCount' => 0, // how many column in the table.
117118
'columnMaxWidth' => [], // table column max width
118-
'tableWidth' => 0, // table width. equals to all max column width's sum.
119+
// 'tableWidth' => 0, // table width. equals to all max column width's sum.
119120
];
120121

121122
// parse table data
122-
foreach ($data as $row) {
123+
foreach ($data as &$row) {
123124
// collection all field name
124125
if ($rowIndex === 0) {
125126
$head = $tableHead ?: array_keys($row);
126-
//
127+
// column count
127128
$info['columnCount'] = count($row);
128129

129130
foreach ($head as $index => $name) {
130131
if (is_string($name)) {// maybe no column name.
131132
$hasHead = true;
132133
}
133134

134-
$info['columnMaxWidth'][$index] = Str::utf8Len($name, 'UTF-8');
135+
$info['columnMaxWidth'][$index] = Str::utf8Len($name);
135136
}
136137
}
137138

138139
$colIndex = 0;
140+
$rowData = (array)$row;
141+
142+
foreach ($rowData as &$value) {
143+
// always convert to string
144+
$value = DataHelper::toString($value);
139145

140-
foreach ((array)$row as $value) {
141146
// collection column max width
142147
if (isset($info['columnMaxWidth'][$colIndex])) {
143-
if (is_bool($value)) {
144-
$colWidth = $value ? 4 : 5;
145-
} else {
146-
$colWidth = Str::utf8Len($value, 'UTF-8');
147-
}
148+
$colWidth = Str::utf8Len($value);
148149

149150
// If current column width gt old column width. override old width.
150151
if ($colWidth > $info['columnMaxWidth'][$colIndex]) {
151152
$info['columnMaxWidth'][$colIndex] = $colWidth;
152153
}
153154
} else {
154-
$info['columnMaxWidth'][$colIndex] = Str::utf8Len($value, 'UTF-8');
155+
$info['columnMaxWidth'][$colIndex] = Str::utf8Len($value);
155156
}
156157

157158
$colIndex++;
158159
}
160+
unset($value);
159161

160162
$rowIndex++;
163+
$row = $rowData;
161164
}
165+
unset($row);
162166

163-
$tableWidth = $info['tableWidth'] = array_sum($info['columnMaxWidth']);
164167
$columnCount = $info['columnCount'];
168+
$tableWidth = (int)array_sum($info['columnMaxWidth']);
165169

166170
// output title
167171
if ($title) {
168172
$tStyle = $opts['titleStyle'] ?: 'bold';
169173
$title = Str::ucwords(trim($title));
170-
$titleLength = Str::utf8Len($title, 'UTF-8');
171-
$indentSpace = Str::pad(' ', ceil($tableWidth / 2) - ceil($titleLength / 2) + ($columnCount * 2), ' ');
174+
$titleLength = Str::utf8Len($title);
175+
$indentSpace = Str::pad(' ', ceil($tableWidth / 2) - ceil($titleLength / 2) + ($columnCount * 2));
172176
$buf->write(" $indentSpace<$tStyle>$title</$tStyle>\n");
173177
}
174178

@@ -190,7 +194,7 @@ public static function show(array $data, string $title = 'Data Table', array $op
190194
// format head title
191195
// $name = Str::pad($name, $colMaxWidth, ' ');
192196
// use Str::padByWidth support zh-CN words
193-
$name = Str::padByWidth($name, $colMaxWidth, ' ');
197+
$name = Str::padByWidth($name, $colMaxWidth);
194198
$name = ColorTag::wrap($name, $opts['headStyle']);
195199
// join string
196200
$headStr .= " $name $colBorderChar";
@@ -225,7 +229,7 @@ public static function show(array $data, string $title = 'Data Table', array $op
225229

226230
// $value = Str::pad($value, $colMaxWidth, ' ');
227231
// use Str::padByWidth support zh-CN words
228-
$value = Str::padByWidth($value, $colMaxWidth, ' ');
232+
$value = Str::padByWidth($value, $colMaxWidth);
229233
$value = ColorTag::wrap($value, $opts['bodyStyle']);
230234
$rowStr .= " $value $colBorderChar";
231235
$colIndex++;

‎src/Component/Interact/ParamDefinition/AbstractParam.php‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<?php declare(strict_types=1);
2+
3+
namespace Inhere\Console\Component\Interact\ParamDefinition;
4+
5+
use Toolkit\Stdlib\Obj\AbstractObj;
6+
7+
/**
8+
* class AbstractParam
9+
*
10+
* @author inhere
11+
* @date 2022/11/21
12+
*/
13+
abstract class AbstractParam extends AbstractObj
14+
{
15+
/**
16+
* @var string
17+
*/
18+
public string $type = '';
19+
20+
/**
21+
* @var string
22+
*/
23+
public string $name = '';
24+
25+
/**
26+
* @var string
27+
*/
28+
public string $desc = '';
29+
30+
/**
31+
* @var mixed
32+
*/
33+
public mixed $default = null;
34+
35+
/**
36+
* @var null|callable
37+
*/
38+
protected $validator;
39+
40+
/**
41+
* @param callable $validator
42+
*
43+
* @return static
44+
*/
45+
public function setValidator(callable $validator): static
46+
{
47+
$this->validator = $validator;
48+
return $this;
49+
}
50+
}

‎src/Component/Interact/ParamDefinition/ChoiceParam.php‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<?php declare(strict_types=1);
2+
3+
namespace Inhere\Console\Component\Interact\ParamDefinition;
4+
5+
/**
6+
* class ChoiceParam
7+
*
8+
* @author inhere
9+
* @date 2022/11/21
10+
*/
11+
class ChoiceParam extends AbstractParam
12+
{
13+
public array $choices = [];
14+
}

0 commit comments

Comments
 (0)