Merge pull request #530 from Johnny Lim

* gh-530:
  Polish "Consistently use ID-based equality check for TemplateFormat"
  Consistently use ID-based equality check for TemplateFormat

Author: wilkinsona

spring-restdocs-core/src/main/java/org/springframework/restdocs/templates/TemplateFormats.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2016 the original author or authors.
+ * Copyright 2014-2018 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,7 +17,7 @@
 package org.springframework.restdocs.templates;
 
 /**
- * An enumeration of the built-in formats for which templates are provuded.
+ * An enumeration of the built-in formats for which templates are provided.
  *
  * @author Andy Wilkinson
  * @since 1.1.0

spring-restdocs-core/src/test/java/org/springframework/restdocs/config/RestDocumentationConfigurerTests.java

@@ -86,8 +86,8 @@ public void defaultConfiguration() {
 		SnippetConfiguration snippetConfiguration = (SnippetConfiguration) configuration
 				.get(SnippetConfiguration.class.getName());
 		assertThat(snippetConfiguration.getEncoding(), is(equalTo("UTF-8")));
-		assertThat(snippetConfiguration.getTemplateFormat(),
-				is(equalTo(TemplateFormats.asciidoctor())));
+		assertThat(snippetConfiguration.getTemplateFormat().getId(),
+				is(equalTo(TemplateFormats.asciidoctor().getId())));
 	}
 
 	@Test
@@ -168,8 +168,8 @@ public void customTemplateFormat() {
 				instanceOf(SnippetConfiguration.class)));
 		SnippetConfiguration snippetConfiguration = (SnippetConfiguration) configuration
 				.get(SnippetConfiguration.class.getName());
-		assertThat(snippetConfiguration.getTemplateFormat(),
-				is(equalTo(TemplateFormats.markdown())));
+		assertThat(snippetConfiguration.getTemplateFormat().getId(),
+				is(equalTo(TemplateFormats.markdown().getId())));
 	}
 
 	@SuppressWarnings("unchecked")

spring-restdocs-core/src/test/java/org/springframework/restdocs/headers/RequestHeadersSnippetTests.java

@@ -173,7 +173,7 @@ public void tableCellContentIsEscapedWhenNecessary() throws IOException {
 	}
 
 	private String escapeIfNecessary(String input) {
-		if (this.templateFormat.equals(TemplateFormats.markdown())) {
+		if (this.templateFormat.getId().equals(TemplateFormats.markdown().getId())) {
 			return input;
 		}
 		return input.replace("|", "\\|");

spring-restdocs-core/src/test/java/org/springframework/restdocs/headers/ResponseHeadersSnippetTests.java

@@ -164,7 +164,7 @@ public void tableCellContentIsEscapedWhenNecessary() throws IOException {
 	}
 
 	private String escapeIfNecessary(String input) {
-		if (this.templateFormat.equals(TemplateFormats.markdown())) {
+		if (this.templateFormat.getId().equals(TemplateFormats.markdown().getId())) {
 			return input;
 		}
 		return input.replace("|", "\\|");

spring-restdocs-core/src/test/java/org/springframework/restdocs/hypermedia/LinksSnippetTests.java

@@ -178,7 +178,7 @@ public void tableCellContentIsEscapedWhenNecessary() throws IOException {
 	}
 
 	private String escapeIfNecessary(String input) {
-		if (this.templateFormat.equals(TemplateFormats.markdown())) {
+		if (this.templateFormat.getId().equals(TemplateFormats.markdown().getId())) {
 			return input;
 		}
 		return input.replace("|", "\\|");

spring-restdocs-core/src/test/java/org/springframework/restdocs/payload/RequestFieldsSnippetTests.java

@@ -461,7 +461,7 @@ public void typeDeterminationDoesNotSetTypeOnDescriptor() throws IOException {
 	}
 
 	private String escapeIfNecessary(String input) {
-		if (this.templateFormat.equals(TemplateFormats.markdown())) {
+		if (this.templateFormat.getId().equals(TemplateFormats.markdown().getId())) {
 			return input;
 		}
 		return input.replace("|", "\\|");

spring-restdocs-core/src/test/java/org/springframework/restdocs/payload/ResponseFieldsSnippetTests.java

@@ -472,7 +472,7 @@ public void typeDeterminationDoesNotSetTypeOnDescriptor() throws IOException {
 	}
 
 	private String escapeIfNecessary(String input) {
-		if (this.templateFormat.equals(TemplateFormats.markdown())) {
+		if (this.templateFormat.getId().equals(TemplateFormats.markdown().getId())) {
 			return input;
 		}
 		return input.replace("|", "\\|");

spring-restdocs-core/src/test/java/org/springframework/restdocs/request/PathParametersSnippetTests.java

@@ -85,11 +85,9 @@ public void allUndocumentedPathParametersCanBeIgnored() throws IOException {
 
 	@Test
 	public void missingOptionalPathParameter() throws IOException {
-		this.snippets.expectPathParameters()
-				.withContents(tableWithTitleAndHeader(
-						this.templateFormat == TemplateFormats.asciidoctor() ? "+/{a}+"
-								: "`/{a}`",
-						"Parameter", "Description").row("`a`", "one").row("`b`", "two"));
+		this.snippets.expectPathParameters().withContents(
+				tableWithTitleAndHeader(getTitle("/{a}"), "Parameter", "Description")
+						.row("`a`", "one").row("`b`", "two"));
 		new PathParametersSnippet(Arrays.asList(parameterWithName("a").description("one"),
 				parameterWithName("b").description("two").optional()))
 						.document(this.operationBuilder.attribute(
@@ -99,11 +97,9 @@ public void missingOptionalPathParameter() throws IOException {
 
 	@Test
 	public void presentOptionalPathParameter() throws IOException {
-		this.snippets.expectPathParameters()
-				.withContents(tableWithTitleAndHeader(
-						this.templateFormat == TemplateFormats.asciidoctor() ? "+/{a}+"
-								: "`/{a}`",
-						"Parameter", "Description").row("`a`", "one"));
+		this.snippets.expectPathParameters().withContents(
+				tableWithTitleAndHeader(getTitle("/{a}"), "Parameter", "Description")
+						.row("`a`", "one"));
 		new PathParametersSnippet(
 				Arrays.asList(parameterWithName("a").description("one").optional()))
 						.document(this.operationBuilder.attribute(
@@ -208,7 +204,7 @@ public void pathParametersWithEscapedContent() throws IOException {
 	}
 
 	private String escapeIfNecessary(String input) {
-		if (this.templateFormat.equals(TemplateFormats.markdown())) {
+		if (this.templateFormat.getId().equals(TemplateFormats.markdown().getId())) {
 			return input;
 		}
 		return input.replace("|", "\\|");
@@ -219,7 +215,7 @@ private String getTitle() {
 	}
 
 	private String getTitle(String title) {
-		if (this.templateFormat.equals(TemplateFormats.asciidoctor())) {
+		if (this.templateFormat.getId().equals(TemplateFormats.asciidoctor().getId())) {
 			return "+" + title + "+";
 		}
 		return "`" + title + "`";

spring-restdocs-core/src/test/java/org/springframework/restdocs/request/RequestParametersSnippetTests.java

@@ -200,7 +200,7 @@ public void requestParametersWithEscapedContent() throws IOException {
 	}
 
 	private String escapeIfNecessary(String input) {
-		if (this.templateFormat.equals(TemplateFormats.markdown())) {
+		if (this.templateFormat.getId().equals(TemplateFormats.markdown().getId())) {
 			return input;
 		}
 		return input.replace("|", "\\|");

spring-restdocs-core/src/test/java/org/springframework/restdocs/request/RequestPartsSnippetTests.java

@@ -191,7 +191,7 @@ public void requestPartsWithEscapedContent() throws IOException {
 	}
 
 	private String escapeIfNecessary(String input) {
-		if (this.templateFormat.equals(TemplateFormats.markdown())) {
+		if (this.templateFormat.getId().equals(TemplateFormats.markdown().getId())) {
 			return input;
 		}
 		return input.replace("|", "\\|");