root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 6 Packages Projects Releases Wiki Activity

Simplify pipe escaping for reference doc tables 

Replace `{vbar}` with an escaped pipe character. Unfortunately
`{vbar}` does not render correctly with PDF generation.

See gh-18374
This commit is contained in:
dreis2211 2019-09-27 17:52:40 +02:00 committed by Phillip Webb
parent 8a6e254465
commit 370998e91e
6 changed files with 29 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/CompoundConfigurationTableEntry.java
View File

@ -45,9 +45,9 @@ class CompoundConfigurationTableEntry extends ConfigurationTableEntry {
@Override @Override
void write(AsciidocBuilder builder) { void write(AsciidocBuilder builder) {
builder.append("¦"); builder.append("|");
this.configurationKeys.forEach(builder::appendKey); this.configurationKeys.forEach(builder::appendKey);
builder.newLine().appendln("¦").appendln("¦+++", this.description, "+++"); builder.newLine().appendln("|").appendln("|+++", this.description, "+++");
} }
} }

4
spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/ConfigurationTable.java
View File

@ -46,9 +46,9 @@ class ConfigurationTable {
String toAsciidocTable() { String toAsciidocTable() {
AsciidocBuilder builder = new AsciidocBuilder(); AsciidocBuilder builder = new AsciidocBuilder();
builder.appendln("[cols=\"1,1,2\", separator=¦, options=\"header\"]"); builder.appendln("[cols=\"1,1,2\", options=\"header\"]");
builder.appendln("|==="); builder.appendln("|===");
builder.appendln("¦Key¦Default Value¦Description"); builder.appendln("|Key|Default Value|Description");
builder.appendln(); builder.appendln();
this.entries.forEach((entry) -> { this.entries.forEach((entry) -> {
entry.write(builder); entry.write(builder);

13
spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/SingleConfigurationTableEntry.java
View File

@ -54,7 +54,7 @@ class SingleConfigurationTableEntry extends ConfigurationTableEntry {
@Override @Override
void write(AsciidocBuilder builder) { void write(AsciidocBuilder builder) {
builder.appendln("¦`+", this.key, "+`"); builder.appendln("|`+", this.key, "+`");
writeDefaultValue(builder); writeDefaultValue(builder);
writeDescription(builder); writeDescription(builder);
builder.appendln(); builder.appendln();
@ -62,21 +62,22 @@ class SingleConfigurationTableEntry extends ConfigurationTableEntry {
private void writeDefaultValue(AsciidocBuilder builder) { private void writeDefaultValue(AsciidocBuilder builder) {
String defaultValue = (this.defaultValue != null) ? this.defaultValue : ""; String defaultValue = (this.defaultValue != null) ? this.defaultValue : "";
defaultValue = defaultValue.replace("\\", "\\\\"); defaultValue = defaultValue.replace("\\", "\\\\").replace("|", "\\|");
if (defaultValue.isEmpty()) { if (defaultValue.isEmpty()) {
builder.appendln("¦"); builder.appendln("|");
} }
else { else {
builder.appendln("¦`+", defaultValue, "+`"); builder.appendln("|`+", defaultValue, "+`");
} }
} }
private void writeDescription(AsciidocBuilder builder) { private void writeDescription(AsciidocBuilder builder) {
if (this.description == null || this.description.isEmpty()) { if (this.description == null || this.description.isEmpty()) {
builder.append("¦"); builder.append("|");
} }
else { else {
builder.append("¦+++", this.description, "+++"); String cleanedDescription = this.description.replace("|", "\\|");
builder.append("|+++", cleanedDescription, "+++");
} }
} }

4
spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/CompoundConfigurationTableEntryTests.java
View File

@ -48,8 +48,8 @@ class CompoundConfigurationTableEntryTests {
AsciidocBuilder builder = new AsciidocBuilder(); AsciidocBuilder builder = new AsciidocBuilder();
entry.write(builder); entry.write(builder);
assertThat(builder.toString()).isEqualTo( assertThat(builder.toString()).isEqualTo(
"¦`+spring.test.first+` +" + NEWLINE + "`+spring.test.second+` +" + NEWLINE + "`+spring.test.third+` +" "|`+spring.test.first+` +" + NEWLINE + "`+spring.test.second+` +" + NEWLINE + "`+spring.test.third+` +"
+ NEWLINE + NEWLINE + "¦" + NEWLINE + "¦+++This is a description.+++" + NEWLINE); + NEWLINE + NEWLINE + "|" + NEWLINE + "|+++This is a description.+++" + NEWLINE);
} }
} }

8
spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/ConfigurationTableTests.java
View File

@ -46,10 +46,10 @@ class ConfigurationTableTests {
second.setType("java.lang.String"); second.setType("java.lang.String");
table.addEntry(new SingleConfigurationTableEntry(first)); table.addEntry(new SingleConfigurationTableEntry(first));
table.addEntry(new SingleConfigurationTableEntry(second)); table.addEntry(new SingleConfigurationTableEntry(second));
assertThat(table.toAsciidocTable()).isEqualTo("[cols=\"1,1,2\", separator=¦, options=\"header\"]" + NEWLINE assertThat(table.toAsciidocTable()).isEqualTo("[cols=\"1,1,2\", options=\"header\"]" + NEWLINE + "|==="
+ "|===" + NEWLINE + "¦Key¦Default Value¦Description" + NEWLINE + NEWLINE + "¦`+spring.test.other+`" + NEWLINE + "|Key|Default Value|Description" + NEWLINE + NEWLINE + "|`+spring.test.other+`" + NEWLINE
+ NEWLINE + "¦`+other value+`" + NEWLINE + "¦+++This is another description.+++" + NEWLINE + NEWLINE + "|`+other value+`" + NEWLINE + "|+++This is another description.+++" + NEWLINE + NEWLINE
+ "¦`+spring.test.prop+`" + NEWLINE + "¦`+something+`" + NEWLINE + "¦+++This is a description.+++" + "|`+spring.test.prop+`" + NEWLINE + "|`+something+`" + NEWLINE + "|+++This is a description.+++"
+ NEWLINE + NEWLINE + "|===" + NEWLINE); + NEWLINE + NEWLINE + "|===" + NEWLINE);
} }

24
spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/SingleConfigurationTableEntryTests.java
View File

@ -41,8 +41,8 @@ class SingleConfigurationTableEntryTests {
SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property); SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property);
AsciidocBuilder builder = new AsciidocBuilder(); AsciidocBuilder builder = new AsciidocBuilder();
entry.write(builder); entry.write(builder);
assertThat(builder.toString()).isEqualTo("¦`+spring.test.prop+`" + NEWLINE + "¦`+something+`" + NEWLINE assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + "|`+something+`" + NEWLINE
+ "¦+++This is a description.+++" + NEWLINE); + "|+++This is a description.+++" + NEWLINE);
} }
@Test @Test
@ -55,7 +55,7 @@ class SingleConfigurationTableEntryTests {
AsciidocBuilder builder = new AsciidocBuilder(); AsciidocBuilder builder = new AsciidocBuilder();
entry.write(builder); entry.write(builder);
assertThat(builder.toString()).isEqualTo( assertThat(builder.toString()).isEqualTo(
"¦`+spring.test.prop+`" + NEWLINE + "¦" + NEWLINE + "¦+++This is a description.+++" + NEWLINE); "|`+spring.test.prop+`" + NEWLINE + "|" + NEWLINE + "|+++This is a description.+++" + NEWLINE);
} }
@Test @Test
@ -68,8 +68,8 @@ class SingleConfigurationTableEntryTests {
SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property); SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property);
AsciidocBuilder builder = new AsciidocBuilder(); AsciidocBuilder builder = new AsciidocBuilder();
entry.write(builder); entry.write(builder);
assertThat(builder.toString()).isEqualTo("¦`+spring.test.prop+`" + NEWLINE + "¦`+first|second+`" + NEWLINE assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + "|`+first\\|second+`" + NEWLINE
+ "¦+++This is a description.+++" + NEWLINE); + "|+++This is a description.+++" + NEWLINE);
} }
@Test @Test
@ -82,8 +82,8 @@ class SingleConfigurationTableEntryTests {
SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property); SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property);
AsciidocBuilder builder = new AsciidocBuilder(); AsciidocBuilder builder = new AsciidocBuilder();
entry.write(builder); entry.write(builder);
assertThat(builder.toString()).isEqualTo("¦`+spring.test.prop+`" + NEWLINE + "¦`+first\\\\second+`" + NEWLINE assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + "|`+first\\\\second+`" + NEWLINE
+ "¦+++This is a description.+++" + NEWLINE); + "|+++This is a description.+++" + NEWLINE);
} }
@Test @Test
@ -95,8 +95,8 @@ class SingleConfigurationTableEntryTests {
SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property); SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property);
AsciidocBuilder builder = new AsciidocBuilder(); AsciidocBuilder builder = new AsciidocBuilder();
entry.write(builder); entry.write(builder);
assertThat(builder.toString()).isEqualTo("¦`+spring.test.prop+`" + NEWLINE + "¦" + NEWLINE assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + "|" + NEWLINE
+ "¦+++This is a description with a | pipe.+++" + NEWLINE); + "|+++This is a description with a \\| pipe.+++" + NEWLINE);
} }
@Test @Test
@ -109,7 +109,7 @@ class SingleConfigurationTableEntryTests {
AsciidocBuilder builder = new AsciidocBuilder(); AsciidocBuilder builder = new AsciidocBuilder();
entry.write(builder); entry.write(builder);
assertThat(builder.toString()).isEqualTo( assertThat(builder.toString()).isEqualTo(
"¦`+spring.test.prop.*+`" + NEWLINE + "¦" + NEWLINE + "¦+++This is a description.+++" + NEWLINE); "|`+spring.test.prop.*+`" + NEWLINE + "|" + NEWLINE + "|+++This is a description.+++" + NEWLINE);
} }
@Test @Test
@ -123,8 +123,8 @@ class SingleConfigurationTableEntryTests {
SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property); SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property);
AsciidocBuilder builder = new AsciidocBuilder(); AsciidocBuilder builder = new AsciidocBuilder();
entry.write(builder); entry.write(builder);
assertThat(builder.toString()).isEqualTo("¦`+spring.test.prop+`" + NEWLINE + "¦`+first," + NEWLINE + "second," assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + "|`+first," + NEWLINE + "second,"
+ NEWLINE + "third+`" + NEWLINE + "¦+++This is a description.+++" + NEWLINE); + NEWLINE + "third+`" + NEWLINE + "|+++This is a description.+++" + NEWLINE);
} }
} }