Simplify pipe escaping for reference doc tables

dreis2211 · philwebb · commit 9102bad836ec · 2019-09-27T20:06:41.000-07:00
Replace `{vbar}` with an escaped pipe character. Unfortunately `{vbar}` does not render correctly with PDF generation. See gh-18374
diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/CompoundConfigurationTableEntry.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/CompoundConfigurationTableEntry.java
@@ -45,9 +45,9 @@ void addConfigurationKeys(ConfigurationMetadataProperty... properties) {
 
 	@Override
 	void write(AsciidocBuilder builder) {
-		builder.append("¦");
+		builder.append("|");
 		this.configurationKeys.forEach(builder::appendKey);
-		builder.newLine().appendln("¦").appendln("¦+++", this.description, "+++");
+		builder.newLine().appendln("|").appendln("|+++", this.description, "+++");
 	}
 
 }
diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/ConfigurationTable.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/ConfigurationTable.java
@@ -46,9 +46,9 @@ void addEntry(ConfigurationTableEntry... entries) {
 
 	String toAsciidocTable() {
 		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("¦Key¦Default Value¦Description");
+		builder.appendln("|Key|Default Value|Description");
 		builder.appendln();
 		this.entries.forEach((entry) -> {
 			entry.write(builder);
diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/SingleConfigurationTableEntry.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/main/java/org/springframework/boot/configurationdocs/SingleConfigurationTableEntry.java
@@ -54,29 +54,30 @@ private String getDefaultValue(Object defaultValue) {
 
 	@Override
 	void write(AsciidocBuilder builder) {
-		builder.appendln("¦`+", this.key, "+`");
+		builder.appendln("|`+", this.key, "+`");
 		writeDefaultValue(builder);
 		writeDescription(builder);
 		builder.appendln();
 	}
 
 	private void writeDefaultValue(AsciidocBuilder builder) {
 		String defaultValue = (this.defaultValue != null) ? this.defaultValue : "";
-		defaultValue = defaultValue.replace("\\", "\\\\");
+		defaultValue = defaultValue.replace("\\", "\\\\").replace("|", "\\|");
 		if (defaultValue.isEmpty()) {
-			builder.appendln("¦");
+			builder.appendln("|");
 		}
 		else {
-			builder.appendln("¦`+", defaultValue, "+`");
+			builder.appendln("|`+", defaultValue, "+`");
 		}
 	}
 
 	private void writeDescription(AsciidocBuilder builder) {
 		if (this.description == null || this.description.isEmpty()) {
-			builder.append("¦");
+			builder.append("|");
 		}
 		else {
-			builder.append("¦+++", this.description, "+++");
+			String cleanedDescription = this.description.replace("|", "\\|");
+			builder.append("|+++", cleanedDescription, "+++");
 		}
 	}
 
diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/CompoundConfigurationTableEntryTests.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/CompoundConfigurationTableEntryTests.java
@@ -48,8 +48,8 @@ void simpleProperty() {
 		AsciidocBuilder builder = new AsciidocBuilder();
 		entry.write(builder);
 		assertThat(builder.toString()).isEqualTo(
-				"¦`+spring.test.first+` +" + NEWLINE + "`+spring.test.second+` +" + NEWLINE + "`+spring.test.third+` +"
-						+ NEWLINE + NEWLINE + "¦" + NEWLINE + "¦+++This is a description.+++" + NEWLINE);
+				"|`+spring.test.first+` +" + NEWLINE + "`+spring.test.second+` +" + NEWLINE + "`+spring.test.third+` +"
+						+ NEWLINE + NEWLINE + "|" + NEWLINE + "|+++This is a description.+++" + NEWLINE);
 	}
 
 }
diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/ConfigurationTableTests.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/ConfigurationTableTests.java
@@ -46,10 +46,10 @@ void simpleTable() {
 		second.setType("java.lang.String");
 		table.addEntry(new SingleConfigurationTableEntry(first));
 		table.addEntry(new SingleConfigurationTableEntry(second));
-		assertThat(table.toAsciidocTable()).isEqualTo("[cols=\"1,1,2\", separator=¦, options=\"header\"]" + NEWLINE
-				+ "|===" + NEWLINE + "¦Key¦Default Value¦Description" + NEWLINE + NEWLINE + "¦`+spring.test.other+`"
-				+ NEWLINE + "¦`+other value+`" + NEWLINE + "¦+++This is another description.+++" + NEWLINE + NEWLINE
-				+ "¦`+spring.test.prop+`" + NEWLINE + "¦`+something+`" + NEWLINE + "¦+++This is a description.+++"
+		assertThat(table.toAsciidocTable()).isEqualTo("[cols=\"1,1,2\", options=\"header\"]" + NEWLINE + "|==="
+				+ NEWLINE + "|Key|Default Value|Description" + NEWLINE + NEWLINE + "|`+spring.test.other+`" + NEWLINE
+				+ "|`+other value+`" + NEWLINE + "|+++This is another description.+++" + NEWLINE + NEWLINE
+				+ "|`+spring.test.prop+`" + NEWLINE + "|`+something+`" + NEWLINE + "|+++This is a description.+++"
 				+ NEWLINE + NEWLINE + "|===" + NEWLINE);
 	}
 
diff --git a/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/SingleConfigurationTableEntryTests.java b/spring-boot-project/spring-boot-tools/spring-boot-configuration-docs/src/test/java/org/springframework/boot/configurationdocs/SingleConfigurationTableEntryTests.java
@@ -41,8 +41,8 @@ void simpleProperty() {
 		SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property);
 		AsciidocBuilder builder = new AsciidocBuilder();
 		entry.write(builder);
-		assertThat(builder.toString()).isEqualTo("¦`+spring.test.prop+`" + NEWLINE + "¦`+something+`" + NEWLINE
-				+ "¦+++This is a description.+++" + NEWLINE);
+		assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + "|`+something+`" + NEWLINE
+				+ "|+++This is a description.+++" + NEWLINE);
 	}
 
 	@Test
@@ -55,7 +55,7 @@ void noDefaultValue() {
 		AsciidocBuilder builder = new AsciidocBuilder();
 		entry.write(builder);
 		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
@@ -68,8 +68,8 @@ void defaultValueWithPipes() {
 		SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property);
 		AsciidocBuilder builder = new AsciidocBuilder();
 		entry.write(builder);
-		assertThat(builder.toString()).isEqualTo("¦`+spring.test.prop+`" + NEWLINE + "¦`+first|second+`" + NEWLINE
-				+ "¦+++This is a description.+++" + NEWLINE);
+		assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + "|`+first\\|second+`" + NEWLINE
+				+ "|+++This is a description.+++" + NEWLINE);
 	}
 
 	@Test
@@ -82,8 +82,8 @@ void defaultValueWithBackslash() {
 		SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property);
 		AsciidocBuilder builder = new AsciidocBuilder();
 		entry.write(builder);
-		assertThat(builder.toString()).isEqualTo("¦`+spring.test.prop+`" + NEWLINE + "¦`+first\\\\second+`" + NEWLINE
-				+ "¦+++This is a description.+++" + NEWLINE);
+		assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + "|`+first\\\\second+`" + NEWLINE
+				+ "|+++This is a description.+++" + NEWLINE);
 	}
 
 	@Test
@@ -95,8 +95,8 @@ void descriptionWithPipe() {
 		SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property);
 		AsciidocBuilder builder = new AsciidocBuilder();
 		entry.write(builder);
-		assertThat(builder.toString()).isEqualTo("¦`+spring.test.prop+`" + NEWLINE + "¦" + NEWLINE
-				+ "¦+++This is a description with a | pipe.+++" + NEWLINE);
+		assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + "|" + NEWLINE
+				+ "|+++This is a description with a \\| pipe.+++" + NEWLINE);
 	}
 
 	@Test
@@ -109,7 +109,7 @@ void mapProperty() {
 		AsciidocBuilder builder = new AsciidocBuilder();
 		entry.write(builder);
 		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
@@ -123,8 +123,8 @@ void listProperty() {
 		SingleConfigurationTableEntry entry = new SingleConfigurationTableEntry(property);
 		AsciidocBuilder builder = new AsciidocBuilder();
 		entry.write(builder);
-		assertThat(builder.toString()).isEqualTo("¦`+spring.test.prop+`" + NEWLINE + "¦`+first," + NEWLINE + "second,"
-				+ NEWLINE + "third+`" + NEWLINE + "¦+++This is a description.+++" + NEWLINE);
+		assertThat(builder.toString()).isEqualTo("|`+spring.test.prop+`" + NEWLINE + "|`+first," + NEWLINE + "second,"
+				+ NEWLINE + "third+`" + NEWLINE + "|+++This is a description.+++" + NEWLINE);
 	}
 
 }

Original file line number	Diff line number	Diff line change
`@@ -45,9 +45,9 @@ void addConfigurationKeys(ConfigurationMetadataProperty... properties) {`
`45`	`45`
`46`	`46`	`@Override`
`47`	`47`	`void write(AsciidocBuilder builder) {`
`48`		`- builder.append("¦");`
	`48`	`+ builder.append("\|");`
`49`	`49`	`this.configurationKeys.forEach(builder::appendKey);`
`50`		`- builder.newLine().appendln("¦").appendln("¦+++", this.description, "+++");`
	`50`	`+ builder.newLine().appendln("\|").appendln("\|+++", this.description, "+++");`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,29 +54,30 @@ private String getDefaultValue(Object defaultValue) {`
`54`	`54`
`55`	`55`	`@Override`
`56`	`56`	`void write(AsciidocBuilder builder) {`
`57`		- builder.appendln("¦`+", this.key, "+`");
	`57`	+ builder.appendln("\|`+", this.key, "+`");
`58`	`58`	`writeDefaultValue(builder);`
`59`	`59`	`writeDescription(builder);`
`60`	`60`	`builder.appendln();`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`private void writeDefaultValue(AsciidocBuilder builder) {`
`64`	`64`	`String defaultValue = (this.defaultValue != null) ? this.defaultValue : "";`
`65`		`- defaultValue = defaultValue.replace("\\", "\\\\");`
	`65`	`+ defaultValue = defaultValue.replace("\\", "\\\\").replace("\|", "\\\|");`
`66`	`66`	`if (defaultValue.isEmpty()) {`
`67`		`- builder.appendln("¦");`
	`67`	`+ builder.appendln("\|");`
`68`	`68`	`}`
`69`	`69`	`else {`
`70`		- builder.appendln("¦`+", defaultValue, "+`");
	`70`	+ builder.appendln("\|`+", defaultValue, "+`");
`71`	`71`	`}`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`private void writeDescription(AsciidocBuilder builder) {`
`75`	`75`	`if (this.description == null \|\| this.description.isEmpty()) {`
`76`		`- builder.append("¦");`
	`76`	`+ builder.append("\|");`
`77`	`77`	`}`
`78`	`78`	`else {`
`79`		`- builder.append("¦+++", this.description, "+++");`
	`79`	`+ String cleanedDescription = this.description.replace("\|", "\\\|");`
	`80`	`+ builder.append("\|+++", cleanedDescription, "+++");`
`80`	`81`	`}`
`81`	`82`	`}`
`82`	`83`
Original file line number	Diff line number	Diff line change
`@@ -48,8 +48,8 @@ void simpleProperty() {`
`48`	`48`	`AsciidocBuilder builder = new AsciidocBuilder();`
`49`	`49`	`entry.write(builder);`
`50`	`50`	`assertThat(builder.toString()).isEqualTo(`
`51`		- "¦`+spring.test.first+` +" + NEWLINE + "`+spring.test.second+` +" + NEWLINE + "`+spring.test.third+` +"
`52`		`- + NEWLINE + NEWLINE + "¦" + NEWLINE + "¦+++This is a description.+++" + NEWLINE);`
	`51`	+ "\|`+spring.test.first+` +" + NEWLINE + "`+spring.test.second+` +" + NEWLINE + "`+spring.test.third+` +"
	`52`	`+ + NEWLINE + NEWLINE + "\|" + NEWLINE + "\|+++This is a description.+++" + NEWLINE);`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`}`