Use JMustache as a dependency instead of shading it

Closes gh-984

Author: wilkinsona

gradle.properties

@@ -5,5 +5,4 @@ org.gradle.jvmargs=-Xmx2g -Dfile.encoding=UTF-8
 org.gradle.parallel=true
 
 javaFormatVersion=0.0.47
-jmustacheVersion=1.16
 springFrameworkVersion=7.0.0-M8

spring-restdocs-core/build.gradle

@@ -1,39 +1,19 @@
-import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
-
 plugins {
 	id 'org.springframework.restdocs.conventions'
 	id "java-library"
 	id "java-test-fixtures"
 	id "maven-publish"
 	id "org.springframework.restdocs.optional-dependencies"
-	id "com.gradleup.shadow" version "8.3.8" apply false
 }
 
 description = "Spring REST Docs Core"
 
-configurations {
-	jmustache
-	testArtifacts.extendsFrom testRuntime
-}
-
-def jmustacheShadowJar = tasks.register("jmustacheShadowJar", ShadowJar) {
-	archiveBaseName = "restdocs-jmustache"
-	archiveVersion = jmustacheVersion
-	configurations = [ project.configurations.jmustache ]
-	include("*.jar")
-	include("com/samskivert/**/*.class")
-	relocate("com.samskivert", "org.springframework.restdocs")
-}
-
 dependencies {
 	compileOnly("org.apiguardian:apiguardian-api")
 
 	implementation("tools.jackson.core:jackson-databind")
 	implementation("org.springframework:spring-web")
-	implementation(files(jmustacheShadowJar))
-
-	jmustache(platform(project(":spring-restdocs-platform")))
-	jmustache("com.samskivert:jmustache@jar")
+	implementation("com.samskivert:jmustache")
 
 	optional(platform(project(":spring-restdocs-platform")))
 	optional("jakarta.validation:jakarta.validation-api")
@@ -47,7 +27,7 @@ dependencies {
 
 	testFixturesCompileOnly("org.apiguardian:apiguardian-api")
 
-	testFixturesImplementation(files(jmustacheShadowJar))
+	testFixturesImplementation("com.samskivert:jmustache")
 	testFixturesImplementation("org.hamcrest:hamcrest-library")
 	testFixturesImplementation("org.mockito:mockito-core")
 	testFixturesImplementation("org.springframework:spring-core")
@@ -65,10 +45,3 @@ dependencies {
 	testRuntimeOnly("org.apache.tomcat.embed:tomcat-embed-el")
 	testRuntimeOnly("org.junit.platform:junit-platform-engine")
 }
-
-tasks.named("jar") {
-	dependsOn jmustacheShadowJar
-	from(zipTree(jmustacheShadowJar.map { it.archiveFile } )) {
-		include "org/springframework/restdocs/**"
-	}
-}

spring-restdocs-core/src/main/java/org/springframework/restdocs/config/RestDocumentationConfigurer.java

@@ -22,10 +22,10 @@
 import java.util.List;
 import java.util.Map;
 
+import com.samskivert.mustache.Mustache;
 import org.jspecify.annotations.Nullable;
 
 import org.springframework.restdocs.RestDocumentationContext;
-import org.springframework.restdocs.mustache.Mustache;
 import org.springframework.restdocs.snippet.RestDocumentationContextPlaceholderResolverFactory;
 import org.springframework.restdocs.snippet.StandardWriterResolver;
 import org.springframework.restdocs.snippet.WriterResolver;

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

@@ -19,15 +19,15 @@
 import java.io.IOException;
 import java.io.Writer;
 
-import org.springframework.restdocs.mustache.Mustache.Lambda;
-import org.springframework.restdocs.mustache.Template.Fragment;
+import com.samskivert.mustache.Mustache.Lambda;
+import com.samskivert.mustache.Template.Fragment;
 
 /**
  * A {@link Lambda} that escapes {@code |} characters so that the do not break the table's
  * formatting.
  *
  * @author Andy Wilkinson
- * @since 1.1.0
+ * @since 4.0.0
  */
 public final class AsciidoctorTableCellContentLambda implements Lambda {
 

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

@@ -30,27 +30,29 @@
  */
 public class MustacheTemplate implements Template {
 
-	private final org.springframework.restdocs.mustache.Template delegate;
+	private final com.samskivert.mustache.Template delegate;
 
 	private final Map<String, Object> context;
 
 	/**
 	 * Creates a new {@code MustacheTemplate} that adapts the given {@code delegate}.
 	 * @param delegate the delegate to adapt
+	 * @since 4.0.0
 	 */
-	public MustacheTemplate(org.springframework.restdocs.mustache.Template delegate) {
+	public MustacheTemplate(com.samskivert.mustache.Template delegate) {
 		this(delegate, Collections.<String, Object>emptyMap());
 	}
 
 	/**
 	 * Creates a new {@code MustacheTemplate} that adapts the given {@code delegate}.
 	 * During rendering, the given {@code context} and the context passed into
 	 * {@link #render(Map)} will be combined and then passed to the delegate when it is
-	 * {@link org.springframework.restdocs.mustache.Template#execute executed}.
+	 * {@link com.samskivert.mustache.Template#execute executed}.
 	 * @param delegate the delegate to adapt
 	 * @param context the context
+	 * @since 4.0.0
 	 */
-	public MustacheTemplate(org.springframework.restdocs.mustache.Template delegate, Map<String, Object> context) {
+	public MustacheTemplate(com.samskivert.mustache.Template delegate, Map<String, Object> context) {
 		this.delegate = delegate;
 		this.context = context;
 	}

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

@@ -23,18 +23,17 @@
 import java.util.Collections;
 import java.util.Map;
 
+import com.samskivert.mustache.Mustache;
+import com.samskivert.mustache.Mustache.Compiler;
+
 import org.springframework.core.io.Resource;
-import org.springframework.restdocs.mustache.Mustache;
-import org.springframework.restdocs.mustache.Mustache.Compiler;
 import org.springframework.restdocs.templates.Template;
 import org.springframework.restdocs.templates.TemplateEngine;
 import org.springframework.restdocs.templates.TemplateResourceResolver;
 
 /**
  * A <a href="https://mustache.github.io">Mustache</a>-based {@link TemplateEngine}
  * implemented using <a href="https://github.com/samskivert/jmustache">JMustache</a>.
- * <p>
- * Note that JMustache has been repackaged and embedded to prevent classpath conflicts.
  *
  * @author Andy Wilkinson
  */
@@ -76,6 +75,7 @@ public MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver,
 	 * {@code compiler} to compile them. Templates will be read as UTF-8.
 	 * @param templateResourceResolver the resolver to use
 	 * @param compiler the compiler to use
+	 * @since 4.0.0
 	 */
 	public MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver, Compiler compiler) {
 		this(templateResourceResolver, compiler, Collections.<String, Object>emptyMap());
@@ -89,7 +89,7 @@ public MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver,
 	 * @param templateResourceResolver the resolver to use
 	 * @param templateEncoding the charset to use when reading the templates
 	 * @param compiler the compiler to use
-	 * @since 2.0.5
+	 * @since 4.0.0
 	 */
 	public MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver, Charset templateEncoding,
 			Compiler compiler) {
@@ -104,8 +104,8 @@ public MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver,
 	 * @param templateResourceResolver the resolver to use
 	 * @param compiler the compiler to use
 	 * @param context the context to pass to compiled templates
-	 * @see MustacheTemplate#MustacheTemplate(org.springframework.restdocs.mustache.Template,
-	 * Map)
+	 * @since 4.0.0
+	 * @see MustacheTemplate#MustacheTemplate(com.samskivert.mustache.Template, Map)
 	 */
 	public MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver, Compiler compiler,
 			Map<String, Object> context) {
@@ -122,9 +122,8 @@ public MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver,
 	 * @param templateEncoding the charset to use when reading the templates
 	 * @param compiler the compiler to use
 	 * @param context the context to pass to compiled templates
-	 * @since 2.0.5
-	 * @see MustacheTemplate#MustacheTemplate(org.springframework.restdocs.mustache.Template,
-	 * Map)
+	 * @since 4.0.0
+	 * @see MustacheTemplate#MustacheTemplate(com.samskivert.mustache.Template, Map)
 	 */
 	public MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver, Charset templateEncoding,
 			Compiler compiler, Map<String, Object> context) {
@@ -145,6 +144,7 @@ public Template compileTemplate(String name) throws IOException {
 	/**
 	 * Returns the {@link Compiler} used to compile Mustache templates.
 	 * @return the compiler
+	 * @since 4.0.0
 	 */
 	protected final Compiler getCompiler() {
 		return this.compiler;

spring-restdocs-core/src/test/java/org/springframework/restdocs/templates/mustache/AsciidoctorTableCellContentLambdaTests.java

@@ -19,10 +19,9 @@
 import java.io.IOException;
 import java.io.StringWriter;
 
+import com.samskivert.mustache.Template.Fragment;
 import org.junit.jupiter.api.Test;
 
-import org.springframework.restdocs.mustache.Template.Fragment;
-
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.BDDMockito.given;
 import static org.mockito.Mockito.mock;

spring-restdocs-core/src/testFixtures/java/org/springframework/restdocs/testfixtures/jupiter/OperationBuilder.java

@@ -26,13 +26,14 @@
 import java.util.Map;
 import java.util.Set;
 
+import com.samskivert.mustache.Mustache;
+
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpMethod;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.HttpStatusCode;
 import org.springframework.restdocs.ManualRestDocumentation;
 import org.springframework.restdocs.RestDocumentationContext;
-import org.springframework.restdocs.mustache.Mustache;
 import org.springframework.restdocs.operation.Operation;
 import org.springframework.restdocs.operation.OperationRequest;
 import org.springframework.restdocs.operation.OperationRequestFactory;

spring-restdocs-platform/build.gradle

@@ -9,7 +9,7 @@ javaPlatform {
 dependencies {
 	constraints {
 		api("com.google.code.findbugs:jsr305:3.0.2")
-		api("com.samskivert:jmustache:$jmustacheVersion")
+		api("com.samskivert:jmustache:1.16")
 		api("jakarta.servlet:jakarta.servlet-api:6.1.0")
 		api("jakarta.validation:jakarta.validation-api:3.1.0")
 		api("org.apache.pdfbox:pdfbox:3.0.5")