Spring/spring-restdocs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Allow a TemplatedSnippet to produce multiple snippets from same template

Browse Source 
Previously a TemplatedSnippet could only write snippets with the
same name as its template. This meant that the same template could
not be used to produce multiple snippets with different names.

This commit separates the snippet name from the template name, thereby
allowing the snippet name to vary while the template name remains the
same. For backwards compatibility, the default behaviour is for the
template name and snippet name to remain the same. The new overloaded
constructor can be used when the names need to differ.

Closes gh-320
This commit is contained in:
Andy Wilkinson
2016-10-25 12:27:03 +01:00
parent a603b9481e
commit 4f19294220
27 changed files with 432 additions and 369 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
spring-restdocs-core/src/main/java/org/springframework/restdocs/snippet/TemplatedSnippet.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2014-2015 the original author or authors.
* Copyright 2014-2016 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.
@@ -38,15 +38,34 @@ public abstract class TemplatedSnippet implements Snippet {
private final String snippetName;
private final String templateName;
/**
* Creates a new {@code TemplatedSnippet} that will produce a snippet with the given
* {@code snippetName}. The given {@code attributes} will be included in the model
* during rendering of the template.
* {@code snippetName}. The {@code snippetName} will also be used as the name of the
* template. The given {@code attributes} will be included in the model during
* rendering of the template.
*
* @param snippetName The name of the snippet
* @param attributes The additional attributes
* @see #TemplatedSnippet(String, String, Map)
*/
protected TemplatedSnippet(String snippetName, Map<String, Object> attributes) {
this(snippetName, snippetName, attributes);
}
/**
* Creates a new {@code TemplatedSnippet} that will produce a snippet with the given
* {@code snippetName} using a template with the given {@code templateName}. The given
* {@code attributes} will be included in the model during rendering of the template.
*
* @param snippetName The name of the snippet
* @param templateName The name of the template
* @param attributes The additional attributes
*/
protected TemplatedSnippet(String snippetName, String templateName,
Map<String, Object> attributes) {
this.templateName = templateName;
this.snippetName = snippetName;
if (attributes != null) {
this.attributes.putAll(attributes);
@@ -65,7 +84,8 @@ public abstract class TemplatedSnippet implements Snippet {
model.putAll(this.attributes);
TemplateEngine templateEngine = (TemplateEngine) operation.getAttributes()
.get(TemplateEngine.class.getName());
writer.append(templateEngine.compileTemplate(this.snippetName).render(model));
writer.append(
templateEngine.compileTemplate(this.templateName).render(model));
}
}