Skip to content

Added better support for partials #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 36 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,40 @@ spring config

<bean id="viewResolver" class="org.springframework.web.servlet.view.mustache.MustacheViewResolver">
<property name="cache" value="${TEMPLATE_CACHE_ENABLED}" />
<property name="prefix" value="" />
<property name="suffix" value=".html" />
<property name="templateLoader">
<bean class="org.springframework.web.servlet.view.mustache.MustacheTemplateLoader"" />
</property>
<!-- The default view path is below -->
<property name="prefix" value="/WEB-INF/views/" />
<!-- The default suffix path is below -->
<property name="suffix" value=".mustache" />
</bean>


layout and partials support
---------------------------

You can now use partials in your templates. The partials are either resolved through aliases
that you supply as URI parameters in your view name or by explicitely putting view name as a partial.
There are two reserved partial aliases called "inner" and "layout". Inner is the actual template
view name (below its 'recruite/submit'). "layout" is the wrapping template. Partial aliases are also
available in the model as a hashmap with the key 'partialAliases'.

Example Java:

@RequestMapping(value="/m", method = RequestMethod.POST)
public String mobilePost(Map<String, Object> model) {
return "recruite/submit?layout=recruite/layout&header=recruite/header";
}

/WEB-INF/views/recruite/submit.mustache:

Hello World!
{{> recruite/explicit }}

/WEB-INF/views/recruite/layout.mustache:

{{> header}}
<body>
{{> inner}}
</body>



Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import java.io.FileNotFoundException;
import java.io.InputStreamReader;
import java.io.Reader;
import java.util.Map;

import org.springframework.context.ResourceLoaderAware;
import org.springframework.core.io.Resource;
Expand All @@ -27,14 +28,35 @@

/**
* @author Sean Scanlon <[email protected]>
*
* @author Adam Gent <[email protected]>
*/
public class MustacheTemplateLoader implements TemplateLoader, ResourceLoaderAware {

private ResourceLoader resourceLoader;
private Map<String, String> partialAliases;

private String suffix = "";
private String prefix = "";

public MustacheTemplateLoader withPartialAliases(Map<String, String> aliases) {
MustacheTemplateLoader loader = cloneTemplateLoader();
return loader;

}

protected MustacheTemplateLoader cloneTemplateLoader() {
MustacheTemplateLoader loader = new MustacheTemplateLoader();
loader.setPrefix(prefix);
loader.setSuffix(suffix);
loader.setResourceLoader(resourceLoader);
loader.setPartialAliases(partialAliases);
return loader;
}

public Reader getTemplate(String filename) throws Exception {
Resource resource = resourceLoader.getResource(filename);
String fn = partialAliases != null && partialAliases.containsKey(filename) ?
partialAliases.get(filename) : filename;
Resource resource = resourceLoader.getResource(getPrefix() + fn + getSuffix());
if (resource.exists()) {
return new InputStreamReader(resource.getInputStream());
}
Expand All @@ -46,4 +68,26 @@ public void setResourceLoader(ResourceLoader resourceLoader) {
this.resourceLoader = resourceLoader;
}

protected String getSuffix() {
return suffix;
}

public void setSuffix(String suffix) {
this.suffix = suffix;
}

protected String getPrefix() {
return prefix;
}

public void setPrefix(String prefix) {
this.prefix = prefix;
}

public Map<String, String> getPartialAliases() {
return partialAliases;
}
public void setPartialAliases(Map<String, String> aliases) {
this.partialAliases = aliases;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -32,25 +32,35 @@
public class MustacheView extends AbstractTemplateView {

private Template template;
private Map<String,String> partialAliases;

@Override
protected void renderMergedTemplateModel(Map<String, Object> model, HttpServletRequest request,
HttpServletResponse response) throws Exception {

model.put("partialAliases", getPartialAliases());
response.setContentType(getContentType());
final Writer writer = response.getWriter();
try {
template.execute(model, writer);
} finally {
writer.flush();
}
renderTemplate(model, getTemplate(), response.getWriter());
}

protected void renderTemplate(Map<String,Object> model, Template template, Writer writer) throws Exception {
try {
template.execute(model, writer);
} finally {
if (writer != null)
writer.flush();
}
}

public void setTemplate(Template template) {
this.template = template;
}

public Template getTemplate() {
return template;
}
public Map<String, String> getPartialAliases() {
return partialAliases;
}
public void setPartialAliases(Map<String, String> templateAliases) {
this.partialAliases = templateAliases;
}
}
Loading