From 396fa2f6aed2b56e8b0359995c65fa05472088b8 Mon Sep 17 00:00:00 2001
From: vran <vran_dev@foxmail.com>
Date: Tue, 1 Nov 2022 22:11:19 +0800
Subject: [PATCH] fix: replace new line symbol to <br/> in exported markdown
(#265)
---
.../generator}/markdown/MarkdownBuilder.java | 16 ++-
.../MarkdownDocumentFileGenerator.java | 20 ++-
.../java/com/databasir/core/Databasir.java | 12 --
.../com/databasir/core/render/Render.java | 17 ---
.../databasir/core/render/RenderConfig.java | 65 ----------
.../com/databasir/core/render/html/.gitkeep | 0
.../core/render/markdown/MarkdownRender.java | 114 ------------------
.../markdown/MarkdownTemplateRender.java | 57 ---------
.../com/databasir/core/render/pdf/.gitkeep | 0
.../template/render/markdown/markdown.ftlh | 49 --------
10 files changed, 30 insertions(+), 320 deletions(-)
rename {meta/src/main/java/com/databasir/core/render => core/src/main/java/com/databasir/core/domain/document/generator}/markdown/MarkdownBuilder.java (87%)
rename core/src/main/java/com/databasir/core/domain/document/generator/{ => markdown}/MarkdownDocumentFileGenerator.java (93%)
delete mode 100644 meta/src/main/java/com/databasir/core/render/Render.java
delete mode 100644 meta/src/main/java/com/databasir/core/render/RenderConfig.java
delete mode 100644 meta/src/main/java/com/databasir/core/render/html/.gitkeep
delete mode 100644 meta/src/main/java/com/databasir/core/render/markdown/MarkdownRender.java
delete mode 100644 meta/src/main/java/com/databasir/core/render/markdown/MarkdownTemplateRender.java
delete mode 100644 meta/src/main/java/com/databasir/core/render/pdf/.gitkeep
delete mode 100644 meta/src/main/resources/template/render/markdown/markdown.ftlh
diff --git a/meta/src/main/java/com/databasir/core/render/markdown/MarkdownBuilder.java b/core/src/main/java/com/databasir/core/domain/document/generator/markdown/MarkdownBuilder.java
similarity index 87%
rename from meta/src/main/java/com/databasir/core/render/markdown/MarkdownBuilder.java
rename to core/src/main/java/com/databasir/core/domain/document/generator/markdown/MarkdownBuilder.java
index 1c459b4..534f0cd 100644
--- a/meta/src/main/java/com/databasir/core/render/markdown/MarkdownBuilder.java
+++ b/core/src/main/java/com/databasir/core/domain/document/generator/markdown/MarkdownBuilder.java
@@ -1,4 +1,4 @@
-package com.databasir.core.render.markdown;
+package com.databasir.core.domain.document.generator.markdown;
import java.util.List;
@@ -58,8 +58,8 @@ public class MarkdownBuilder {
// build rows
for (List<String> row : rows) {
builder.append("| ");
- for (String column : row) {
- builder.append(column).append(" | ");
+ for (String data : row) {
+ builder.append(convertNewLineToBr(data)).append(" | ");
}
builder.append(LINE);
}
@@ -102,7 +102,17 @@ public class MarkdownBuilder {
return this;
}
+ private String convertNewLineToBr(String content) {
+ if (content == null) {
+ return "";
+ }
+ return content
+ .replace("\r\n", "<br/>")
+ .replace("\n", "<br/>");
+ }
+
public String build() {
return builder.toString();
}
+
}
diff --git a/core/src/main/java/com/databasir/core/domain/document/generator/MarkdownDocumentFileGenerator.java b/core/src/main/java/com/databasir/core/domain/document/generator/markdown/MarkdownDocumentFileGenerator.java
similarity index 93%
rename from core/src/main/java/com/databasir/core/domain/document/generator/MarkdownDocumentFileGenerator.java
rename to core/src/main/java/com/databasir/core/domain/document/generator/markdown/MarkdownDocumentFileGenerator.java
index 3344dbb..1e6f1a8 100644
--- a/core/src/main/java/com/databasir/core/domain/document/generator/MarkdownDocumentFileGenerator.java
+++ b/core/src/main/java/com/databasir/core/domain/document/generator/markdown/MarkdownDocumentFileGenerator.java
@@ -1,12 +1,13 @@
-package com.databasir.core.domain.document.generator;
+package com.databasir.core.domain.document.generator.markdown;
import com.alibaba.excel.util.StringUtils;
import com.databasir.common.SystemException;
import com.databasir.core.domain.document.data.DatabaseDocumentResponse;
import com.databasir.core.domain.document.data.DocumentTemplatePropertiesResponse;
import com.databasir.core.domain.document.data.TableDocumentResponse;
+import com.databasir.core.domain.document.generator.DocumentFileGenerator;
+import com.databasir.core.domain.document.generator.DocumentFileType;
import com.databasir.core.domain.document.service.DocumentTemplateService;
-import com.databasir.core.render.markdown.MarkdownBuilder;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
@@ -82,10 +83,23 @@ public class MarkdownDocumentFileGenerator implements DocumentFileGenerator {
// table document build
doc.getTables().forEach(table -> {
if (StringUtils.isNotBlank(table.getComment())) {
- builder.secondTitle(table.getName() + " /\\*" + table.getComment() + "\\*/");
+ String convertedComment = table.getComment()
+ .replace("\r\n", " ")
+ .replace("\n", " ");
+ String comment;
+ if (convertedComment.length() > 30) {
+ comment = convertedComment.substring(0, 30) + "...";
+ } else {
+ comment = convertedComment;
+ }
+ builder.secondTitle(table.getName() + " /\\*" + comment + "\\*/");
} else {
builder.secondTitle(table.getName());
}
+ builder.secondTitle(table.getName());
+ if (StringUtils.isNotBlank(table.getComment())) {
+ builder.blockquotes(table.getComment());
+ }
columnBuild(builder, table, columnTitleMap);
indexBuild(builder, table, indexTitleMap);
foreignKeyBuild(builder, table, foreignKeyTitleMap);
diff --git a/meta/src/main/java/com/databasir/core/Databasir.java b/meta/src/main/java/com/databasir/core/Databasir.java
index 16f4c9b..6546d22 100644
--- a/meta/src/main/java/com/databasir/core/Databasir.java
+++ b/meta/src/main/java/com/databasir/core/Databasir.java
@@ -3,13 +3,9 @@ package com.databasir.core;
import com.databasir.core.meta.data.DatabaseMeta;
import com.databasir.core.meta.provider.MetaProviders;
import com.databasir.core.meta.provider.condition.Condition;
-import com.databasir.core.render.Render;
-import com.databasir.core.render.RenderConfig;
import lombok.Getter;
import lombok.RequiredArgsConstructor;
-import java.io.IOException;
-import java.io.OutputStream;
import java.sql.Connection;
import java.util.List;
import java.util.Optional;
@@ -41,14 +37,6 @@ public class Databasir {
.select(connection, condition);
}
- public void renderAsMarkdown(DatabaseMeta meta, OutputStream out) throws IOException {
- renderAsMarkdown(new RenderConfig(), meta, out);
- }
-
- public void renderAsMarkdown(RenderConfig config, DatabaseMeta meta, OutputStream stream) throws IOException {
- Render.markdownRender(config).rendering(meta, stream);
- }
-
public static Databasir of() {
return of(new DatabasirConfig());
}
diff --git a/meta/src/main/java/com/databasir/core/render/Render.java b/meta/src/main/java/com/databasir/core/render/Render.java
deleted file mode 100644
index 53d287a..0000000
--- a/meta/src/main/java/com/databasir/core/render/Render.java
+++ /dev/null
@@ -1,17 +0,0 @@
-package com.databasir.core.render;
-
-import com.databasir.core.meta.data.DatabaseMeta;
-import com.databasir.core.render.markdown.MarkdownTemplateRender;
-
-import java.io.IOException;
-import java.io.OutputStream;
-
-public interface Render {
-
- void rendering(DatabaseMeta meta, OutputStream outputStream) throws IOException;
-
- static Render markdownRender(RenderConfig configuration) {
- return new MarkdownTemplateRender(configuration);
- }
-
-}
diff --git a/meta/src/main/java/com/databasir/core/render/RenderConfig.java b/meta/src/main/java/com/databasir/core/render/RenderConfig.java
deleted file mode 100644
index 185f832..0000000
--- a/meta/src/main/java/com/databasir/core/render/RenderConfig.java
+++ /dev/null
@@ -1,65 +0,0 @@
-package com.databasir.core.render;
-
-import com.databasir.core.meta.data.ColumnMeta;
-import com.databasir.core.meta.data.IndexMeta;
-import com.databasir.core.meta.data.TriggerMeta;
-import lombok.Data;
-
-import java.util.LinkedHashMap;
-import java.util.function.Function;
-
-@Data
-public class RenderConfig {
-
- private Boolean renderTables = true;
-
- private Boolean renderColumns = true;
-
- private Boolean renderIndexes = true;
-
- private Boolean renderTriggers = true;
-
- private LinkedHashMap<String, Function<ColumnMeta, String>> columnTitleAndValueMapping =
- columnTitleAndValueMapping();
-
- private LinkedHashMap<String, Function<IndexMeta, String>> indexTitleAndValueMapping =
- indexTitleAndValueMapping();
-
- private LinkedHashMap<String, Function<TriggerMeta, String>> triggerTitleAndValueMapping =
- triggerTitleAndValueMapping();
-
- protected LinkedHashMap<String, Function<ColumnMeta, String>> columnTitleAndValueMapping() {
- LinkedHashMap<String, Function<ColumnMeta, String>> mapping = new LinkedHashMap<>();
- mapping.put("Name", ColumnMeta::getName);
- mapping.put("Type", column -> {
- String type;
- if (column.getDecimalDigits() == null || column.getDecimalDigits().equals(0)) {
- type = column.getType()
- + "(" + column.getSize().toString() + ")";
- } else {
- type = column.getType()
- + "(" + column.getSize().toString() + ", " + column.getDecimalDigits().toString() + ")";
- }
- return type;
- });
- return mapping;
- }
-
- protected LinkedHashMap<String, Function<IndexMeta, String>> indexTitleAndValueMapping() {
- LinkedHashMap<String, Function<IndexMeta, String>> mapping = new LinkedHashMap<>();
- mapping.put("Name", IndexMeta::getName);
- mapping.put("IsUnique", index -> index.getIsUniqueKey() ? "YES" : "");
- mapping.put("Columns", index -> String.join(", ", index.getColumnNames()));
- return mapping;
- }
-
- protected LinkedHashMap<String, Function<TriggerMeta, String>> triggerTitleAndValueMapping() {
- LinkedHashMap<String, Function<TriggerMeta, String>> mapping = new LinkedHashMap<>();
- mapping.put("Name", TriggerMeta::getName);
- mapping.put("Timing", trigger -> trigger.getTiming() + " " + trigger.getManipulation());
- mapping.put("Statement", trigger -> trigger.getStatement().replace("\n", " ")
- .replace("\r", " "));
- mapping.put("Create At", TriggerMeta::getCreateAt);
- return mapping;
- }
-}
diff --git a/meta/src/main/java/com/databasir/core/render/html/.gitkeep b/meta/src/main/java/com/databasir/core/render/html/.gitkeep
deleted file mode 100644
index e69de29..0000000
diff --git a/meta/src/main/java/com/databasir/core/render/markdown/MarkdownRender.java b/meta/src/main/java/com/databasir/core/render/markdown/MarkdownRender.java
deleted file mode 100644
index c968fe6..0000000
--- a/meta/src/main/java/com/databasir/core/render/markdown/MarkdownRender.java
+++ /dev/null
@@ -1,114 +0,0 @@
-package com.databasir.core.render.markdown;
-
-import com.databasir.core.meta.data.DatabaseMeta;
-import com.databasir.core.meta.data.TableMeta;
-import com.databasir.core.render.Render;
-import com.databasir.core.render.RenderConfig;
-import lombok.Getter;
-
-import java.io.IOException;
-import java.io.OutputStream;
-import java.nio.charset.StandardCharsets;
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.List;
-import java.util.stream.Collectors;
-
-public class MarkdownRender implements Render {
-
- @Getter
- private final RenderConfig config;
-
- protected MarkdownRender(RenderConfig config) {
- this.config = config;
- }
-
- public static MarkdownRender of(RenderConfig config) {
- return new MarkdownRender(config);
- }
-
- @Override
- public void rendering(DatabaseMeta meta,
- OutputStream outputStream) throws IOException {
- MarkdownBuilder contentBuilder = MarkdownBuilder.builder();
- contentBuilder.primaryTitle(meta.getDatabaseName());
- if (config.getRenderTables()) {
- for (TableMeta table : meta.getTables()) {
- buildTableName(contentBuilder, table);
- if (config.getRenderColumns()) {
- buildColumns(contentBuilder, table);
- }
- if (config.getRenderIndexes()) {
- buildIndexes(contentBuilder, table);
- }
- if (config.getRenderTriggers()) {
- buildTriggers(contentBuilder, table);
- }
- }
- }
- outputStream.write(contentBuilder.build().getBytes(StandardCharsets.UTF_8));
- }
-
- private void buildTableName(MarkdownBuilder contentBuilder, TableMeta table) {
- String tableName;
- if (table.getComment().isEmpty()) {
- tableName = table.getName();
- } else {
- tableName = table.getName() + "(" + table.getComment() + ")";
- }
- contentBuilder.secondTitle(tableName);
- }
-
- private void buildColumns(MarkdownBuilder contentBuilder, TableMeta table) {
- contentBuilder.unorderedList(Collections.singletonList("columns"));
- List<List<String>> allColumnRows = table.getColumns()
- .stream()
- .map(column -> config.getColumnTitleAndValueMapping()
- .values()
- .stream()
- .map(mapping -> mapping.apply(column))
- .collect(Collectors.toList()))
- .collect(Collectors.toList());
- contentBuilder.table(tableTitles(), allColumnRows);
- }
-
- private void buildIndexes(MarkdownBuilder contentBuilder, TableMeta table) {
- contentBuilder.unorderedList(Collections.singletonList("indexes"));
- List<List<String>> allIndexRows = table.getIndexes().stream()
- .map(index -> config.getIndexTitleAndValueMapping()
- .values()
- .stream()
- .map(mapping -> mapping.apply(index))
- .collect(Collectors.toList()))
- .collect(Collectors.toList());
- contentBuilder.table(indexTitles(), allIndexRows);
- }
-
- private void buildTriggers(MarkdownBuilder contentBuilder, TableMeta table) {
- if (table.getTriggers() == null || table.getTriggers().isEmpty()) {
- return;
- }
-
- contentBuilder.unorderedList(Collections.singletonList("triggers"));
- List<List<String>> allRows = table.getTriggers().stream()
- .map(trigger -> config.getTriggerTitleAndValueMapping()
- .values()
- .stream()
- .map(mapping -> mapping.apply(trigger))
- .collect(Collectors.toList()))
- .collect(Collectors.toList());
- contentBuilder.table(triggerTitles(), allRows);
- }
-
- private List<String> tableTitles() {
- return new ArrayList<>(config.getColumnTitleAndValueMapping().keySet());
- }
-
- private List<String> indexTitles() {
- return new ArrayList<>(config.getIndexTitleAndValueMapping().keySet());
- }
-
- private List<String> triggerTitles() {
- return new ArrayList<>(config.getTriggerTitleAndValueMapping().keySet());
- }
-}
diff --git a/meta/src/main/java/com/databasir/core/render/markdown/MarkdownTemplateRender.java b/meta/src/main/java/com/databasir/core/render/markdown/MarkdownTemplateRender.java
deleted file mode 100644
index fcf7711..0000000
--- a/meta/src/main/java/com/databasir/core/render/markdown/MarkdownTemplateRender.java
+++ /dev/null
@@ -1,57 +0,0 @@
-package com.databasir.core.render.markdown;
-
-import com.databasir.core.meta.data.DatabaseMeta;
-import com.databasir.core.render.Render;
-import com.databasir.core.render.RenderConfig;
-import freemarker.template.Configuration;
-import freemarker.template.Template;
-import freemarker.template.TemplateException;
-import freemarker.template.TemplateExceptionHandler;
-import lombok.RequiredArgsConstructor;
-
-import java.io.IOException;
-import java.io.OutputStream;
-import java.io.OutputStreamWriter;
-import java.util.HashMap;
-import java.util.Map;
-
-/**
- * use freemarker template to render markdown
- */
-@RequiredArgsConstructor
-public class MarkdownTemplateRender implements Render {
-
- private final RenderConfig renderConfig;
-
- private String templatePath = "template/render/markdown/markdown.ftlh";
-
- public MarkdownTemplateRender(RenderConfig config, String templatePath) {
- this(config);
- this.templatePath = templatePath;
- }
-
- @Override
- public void rendering(DatabaseMeta meta, OutputStream outputStream) throws IOException {
- doRendering(meta, outputStream);
- }
-
- public void doRendering(DatabaseMeta meta, OutputStream outputStream) throws IOException {
- Configuration cfg = new Configuration(Configuration.VERSION_2_3_29);
- cfg.setClassForTemplateLoading(getClass(), "/");
- cfg.setDefaultEncoding("UTF-8");
- cfg.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER);
- cfg.setLogTemplateExceptions(false);
- cfg.setWrapUncheckedExceptions(true);
- cfg.setFallbackOnNullLoopVariable(false);
-
- Map<String, Object> root = new HashMap<>();
- root.put("meta", meta);
- root.put("config", renderConfig);
- Template template = cfg.getTemplate(templatePath);
- try {
- template.process(root, new OutputStreamWriter(outputStream));
- } catch (TemplateException e) {
- throw new IllegalStateException(e);
- }
- }
-}
diff --git a/meta/src/main/java/com/databasir/core/render/pdf/.gitkeep b/meta/src/main/java/com/databasir/core/render/pdf/.gitkeep
deleted file mode 100644
index e69de29..0000000
diff --git a/meta/src/main/resources/template/render/markdown/markdown.ftlh b/meta/src/main/resources/template/render/markdown/markdown.ftlh
deleted file mode 100644
index 4452a48..0000000
--- a/meta/src/main/resources/template/render/markdown/markdown.ftlh
+++ /dev/null
@@ -1,49 +0,0 @@
-# ${meta.databaseName}
-| | |
-| --------------- | ---- |
-| Database name | |
-| Product name | |
-| Product version | |
-
-## Overview
-| | name | type | comment |
-| ---- | --------------- | ------ | ------ |
-<#list meta.tables as table>
-| ${table_index+1} | [${table.name}](#${table.name}) | ${table.type} | ${table.comment!'N/A'} |
-</#list>
-
-<#if config.renderTables>
- <#list meta.tables as table>
-## ${table.name}
- <#if config.renderColumns>
-### Columns
-
-| | name | type | primary Key | nullable | auto increment| default | comment |
-| --- | ---- | ---- | ----------- | -------- | ------------- | ------- | ------- |
- <#list table.columns as column>
-| ${column_index+1} | ${column.name} | ${column.type} | ${column.isPrimaryKey?then('YES','NO')} | ${column.nullable } | ${column.autoIncrement} | ${column.defaultValue!'NULL'} | ${column.comment!''} |
- </#list>
- </#if>
-
-<#if config.renderIndexes>
-### Indexes
-
-| | name | unique | columns |
-| --- | ---- | ------ | ------- |
- <#list table.indexes as index>
-| ${index_index+1} | ${index.name} | ${index.isUniqueKey?then('YES', 'NO')} | ${index.columnNames?join(', ')} |
- </#list>
- </#if>
-
- <#if config.renderTriggers>
-### Triggers
-
-| | name | timing | statement | created |
-| --- | ---- | ------ | --------- | ------- |
- <#list table.triggers as trigger>
-| ${trigger_index} | ${trigger.name} | ${trigger.timing + " " + trigger.manipulation } | ${trigger.statement?replace("\n", "<br>")?replace("\r", " ")} | ${trigger.createAt} |
- </#list>
- </#if>
-
- </#list>
-</#if>
\ No newline at end of file