Skip to content

Commit

Permalink
json-to-markdown 生成格式调整，去掉必填列，内嵌字段使用树形结构展示
Browse files Browse the repository at this point in the history
  • Loading branch information
@mylxsw
mylxsw committed Mar 22, 2023
1 parent 465740b commit 951d77a
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 52 deletions.
119 changes: 68 additions & 51 deletions app/helpers.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
* 生成路由url
*
* @param string $name
* @param array $parameters
* @param bool $absolute
* @param array $parameters
* @param bool $absolute
*
* @return string
*/
Expand All @@ -44,9 +44,9 @@ function wzRoute($name, $parameters = [], $absolute = false)
function documentType($type): string
{
$types = [
Document::TYPE_DOC => 'markdown',
Document::TYPE_DOC => 'markdown',
Document::TYPE_SWAGGER => 'swagger',
Document::TYPE_TABLE => 'table',
Document::TYPE_TABLE => 'table',
];

return $types[$type] ?? '';
Expand All @@ -57,17 +57,18 @@ function documentType($type): string
*
* 必须保证pages是按照pid进行asc排序的，否则可能会出现菜单丢失
*
* @param int $projectID 当前项目ID
* @param int $pageID 选中的文档ID
* @param array $exclude 排除的文档ID列表
* @param int $projectID 当前项目ID
* @param int $pageID 选中的文档ID
* @param array $exclude 排除的文档ID列表
*
* @return array
*/
function navigator(
int $projectID,
int $pageID = 0,
$exclude = []
) {
$exclude = []
)
{
static $cached = [];

$key = "{$projectID}:{$pageID}:" . implode(':', $exclude);
Expand All @@ -94,13 +95,13 @@ function navigator(
}

$navigators[$page->id] = [
'id' => (int)$page->id,
'name' => $page->title,
'pid' => (int)$page->pid,
'url' => wzRoute('project:home', ['id' => $projectID, 'p' => $page->id]),
'selected' => $pageID === (int)$page->id,
'type' => documentType($page->type),
'status' => $page->status,
'id' => (int)$page->id,
'name' => $page->title,
'pid' => (int)$page->pid,
'url' => wzRoute('project:home', ['id' => $projectID, 'p' => $page->id]),
'selected' => $pageID === (int)$page->id,
'type' => documentType($page->type),
'status' => $page->status,
'created_at' => $page->created_at,
'sort_level' => $page->sort_level ?? 1000,
];
Expand Down Expand Up @@ -132,7 +133,7 @@ function ($nav) {
* 导航排序，排序后，文件夹靠前，普通文件靠后
*
* @param array $navItems
* @param int $sortStyle
* @param int $sortStyle
*
* @return array
*/
Expand Down Expand Up @@ -164,7 +165,7 @@ function ($a, $b) use ($sortItem, $sortStyle) {
$aIsFolder = !empty($a['nodes']);
$bIsFolder = !empty($b['nodes']);

$bothIsFolder = $aIsFolder && $bIsFolder;
$bothIsFolder = $aIsFolder && $bIsFolder;
$bothNotFolder = !$aIsFolder && !$bIsFolder;

if ($bothIsFolder || $bothNotFolder) {
Expand All @@ -185,7 +186,7 @@ function ($a, $b) use ($sortItem, $sortStyle) {
/**
* 文档模板
*
* @param int $type
* @param int $type
* @param User|null $user
*
* @return array
Expand All @@ -209,16 +210,28 @@ function wzTemplates($type = Template::TYPE_DOC, User $user = null): array
function convertJsonToMarkdownTable(string $json): string
{
$markdowns = [
['参数名', '类型', '是否必须', '说明'],
['---', '---', '---', '---'],
['参数名', '类型', '说明'],
['---', '---', '---'],
];

foreach (jsonFlatten($json) as $key => $type) {
$markdowns[] = [$key, $type, '', ''];
$segs = explode('.', $key);
$prefix = str_repeat('    ', count($segs) - 1);
$markdowns[] = [count($segs) > 1 ? $prefix . '┣ ' . $segs[count($segs) - 1] : $segs[count($segs) - 1], $type, ''];
}

$lastEmp = '';
$rev = array_reverse($markdowns);
foreach ($rev as $index => $item) {
$empPart = explode('┣', $item[0])[0];
if ($empPart !== '' && $empPart !== $lastEmp) {
$rev[$index][0] = str_replace('┣', '┗', $item[0]);
}

$lastEmp = $empPart;
}

$html = '';
foreach ($markdowns as $line) {
foreach (array_reverse($rev) as $line) {
$html .= '| ' . implode(' | ', $line) . ' | ' . "\n";
}

Expand Down Expand Up @@ -342,7 +355,7 @@ function resourceVersion()
* 创建一个JWT Token
*
* @param array $payloads
* @param int $expire
* @param int $expire
*
* @return \Lcobucci\JWT\Token
*/
Expand All @@ -354,9 +367,9 @@ function jwt_create_token(array $payloads, $expire = 3600 * 2)
}

return $builder->setIssuedAt(time())
->setExpiration(time() + $expire)
->sign(new \Lcobucci\JWT\Signer\Hmac\Sha256(), config('wizard.jwt_secret'))
->getToken();
->setExpiration(time() + $expire)
->sign(new \Lcobucci\JWT\Signer\Hmac\Sha256(), config('wizard.jwt_secret'))
->getToken();
}

/**
Expand Down Expand Up @@ -414,7 +427,7 @@ function users()
* 用户名列表（js数组）
*
* @param Collection $users
* @param bool $actived
* @param bool $actived
*
* @return string
*/
Expand Down Expand Up @@ -649,7 +662,7 @@ function convertSqlTo(string $sql, $callback)

// \Log::error('xxx', ['struct' => $parsed]);
if ($parsed['CREATE']['expr_type'] === 'table') {
$fields = $parsed['TABLE']['create-def']['sub_tree'];
$fields = $parsed['TABLE']['create-def']['sub_tree'];
$tableName = $parsed['TABLE']['base_expr'];

$markdowns = [];
Expand All @@ -667,26 +680,26 @@ function convertSqlTo(string $sql, $callback)
$type = $length = '';
foreach ($field['sub_tree'][1]['sub_tree'] as $item) {
if ($item['expr_type'] == 'data-type') {
$type = $item['base_expr'] ?? '';
$type = $item['base_expr'] ?? '';
$length = $item['length'] ?? '';
}
}

$name = $field['sub_tree'][0]['base_expr'];
$comment = trim($field['sub_tree'][1]['comment'] ?? '', "'");
$name = $field['sub_tree'][0]['base_expr'];
$comment = trim($field['sub_tree'][1]['comment'] ?? '', "'");
$nullable = $field['sub_tree'][1]['nullable'] ?? false;

// $autoInc = $field['sub_tree'][1]['auto_inc'] ?? false;
// $primary = $field['sub_tree'][1]['primary'] ?? false;
// $defaultValue = $field['sub_tree'][1]['default'] ?? '-';

$type = empty($length) ? $type : "{$type} ($length)";
$type = empty($length) ? $type : "{$type} ($length)";
$markdowns[] = [trim($name, '`'), $type, $nullable ? 'Y' : 'N', $comment];
}


$tableComment = '-';
$options = $parsed['TABLE']['options'] ?? [];
$options = $parsed['TABLE']['options'] ?? [];
if (!$options || empty($options)) {
$options = [];
}
Expand Down Expand Up @@ -716,8 +729,10 @@ function convertSqlTo(string $sql, $callback)
*/
function processMarkdown(string $markdown = null): string
{
if (is_null($markdown)) {$markdown = '';}

if (is_null($markdown)) {
$markdown = '';
}

$defaultTOC = config('wizard.markdown.default_toc');
if (!in_array($defaultTOC, ['TOC', 'TOCM'])) {
return $markdown;
Expand Down Expand Up @@ -750,7 +765,7 @@ function processSpreedSheet(string $content): string
if (Str::startsWith($content, '[')) {
$maxColsLen = $maxRowsLen = 0;
foreach ($contentArray as $k => $arr) {
$cur = processSpreedSheetSingle($arr, $minRow, $minCol);
$cur = processSpreedSheetSingle($arr, $minRow, $minCol);
$contentArray[$k] = $cur;
if ($cur['cols']['len'] > $maxColsLen) {
$maxColsLen = $cur['cols']['len'];
Expand Down Expand Up @@ -792,7 +807,7 @@ function processSpreedSheetSingle($contentArray, $minRow, $minCol)
})
// 列过滤，去掉每一行最后多余的空列
->map(function ($item) {
$cells = $item['cells'] ?? [];
$cells = $item['cells'] ?? [];
$lastIndex = count($cells);
if ($lastIndex === 0) {
return $item;
Expand Down Expand Up @@ -895,17 +910,18 @@ function markdownCompatibilityStrict($pageItem = null)
/**
* 遍历导航项
*
* @param array $navigators
* @param array $navigators
* @param Closure $callback
* @param array $parents
* @param bool $callbackWithFullNavItem 是否在回调函数中传递完整的nav对象
* @param array $parents
* @param bool $callbackWithFullNavItem 是否在回调函数中传递完整的nav对象
*/
function traverseNavigators(
array $navigators,
array $navigators,
\Closure $callback,
array $parents = [],
$callbackWithFullNavItem = false
) {
array $parents = [],
$callbackWithFullNavItem = false
)
{
foreach ($navigators as $nav) {
$callback($callbackWithFullNavItem ? $nav : $nav['id'], $parents);

Expand Down Expand Up @@ -944,7 +960,7 @@ function cdn_resource(string $resourceUrl)
// 这里替换的目的是，如果使用 七牛 CDN，是无法自己配置跨域的，必须提交工单才行
// 这里用公共 CDN，可以避免字体跨域
$replace = [
'/assets/vendor/font-awesome4/css/font-awesome.min.css' => 'https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css',
'/assets/vendor/font-awesome4/css/font-awesome.min.css' => 'https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css',
'/assets/vendor/material-design-icons/material-icons.css' => 'https://cdnjs.cloudflare.com/ajax/libs/material-design-icons/3.0.1/iconfont/material-icons.min.css',
];

Expand Down Expand Up @@ -991,7 +1007,7 @@ function impersonateUser()
* 文档按照指定 ID 顺序排列
*
* @param LengthAwarePaginator $docs
* @param array|null $sortIds
* @param array|null $sortIds
*
* @return mixed
*/
Expand All @@ -1008,15 +1024,16 @@ function sortDocumentBySortIds(LengthAwarePaginator $docs, array $sortIds = null

/**
* 关键字高亮
*
*
* TODO：采用简单的关键词替换会出现 Markdown 代码段中包含关键词时，代码段内容被插入的 span 标签破坏问题，因此暂时不进行高亮展示。
*
* @param string $content
* @param string $content
* @param string|null $keyword
*
* @return string
*/
function highlight(string $content, string $keyword = null) :string {
function highlight(string $content, string $keyword = null): string
{
// if (empty($keyword)) {
// return $content;
// }
Expand Down
3 changes: 2 additions & 1 deletion tests/Unit/ExampleTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ class ExampleTest extends TestCase
*/
public function testBasicTest()
{
$this->assertTrue(true);
$table = convertJsonToMarkdownTable('{"_id":"641971e0559d700574e0aaa7","automationId":"MhwaKyN8AxI96lGlcmM3JUndHvFzc45F","nodeId":"root","createTime":"2023-03-21T08:59:12.596+0000","finishedTime":"2023-03-21T08:59:12.769+0000","enterpriseId":5072,"userId":236988,"nodeName":"root","executeStatus":"EXECUTED","nodeType":"ROOT","executionId":"484fa34945b142d19ebf24679a496201","processInstanceId":"484fa34945b142d19ebf24679a496201","contextData":{"triggerName":"新增触发","form":{"formId":"5e7792cd-f400-43db-a246-70ced9853198","formInstanceId":"beffe072cd20477492e87bd599c3d26f","enterpriseId":5072,"creatorId":236988,"operatorId":236988,"creatorName":"谢小勤","operatorName":"谢小勤","_class":"com.yunsom.mid.business.automation.runtime.form.impl.FormImpl"},"_class":"com.yunsom.mid.business.automation.runtime.engine.impl.AutTriggerEvtImpl"},"version":5,"tranceId":"116983d7-ea71-4f0f-97a9-9fd047647b83","triggerMethod":1,"order":1,"submitTest":2,"_class":"com.yunsom.mid.business.automation.runtime.dao.entity.AutomationLog"}');
echo $table;
}
}

0 comments on commit 951d77a

Please sign in to comment.