Update Freemarker and support multiple extensions for views (#2196) (#…

…2213)

* Update Freemarker to 2.3.27-incubating

'-incubating' is just because it's now an incubating Apache project and
has nothing to do with the stability of the version.

* Renamed `ViewRenderer::getSuffix` to `getConfigurationKey`

This will remove ambiguity when multiple file formats for the same
renderer type are implemented (ex: Freemarker supports .ftl as well as
.fltx and .flth).

Keys in the views configuration are now `freemarker` instead of `.ftl`
and `mustache` instead of `.mustache`.

* Use regexes to match view renderers

This allows us to match any valid Freemarker extension (.ftl, .ftlx, or
.ftlh) as well as matching "double extension" (ex: .ftl.html).

docs/source/manual/views.rst

@@ -32,13 +32,15 @@ You can pass configuration through to view renderers by overriding ``getViewConf
         });
     }
 
-The returned map should have, for each extension (such as ``.ftl``), a ``Map<String, String>`` describing how to configure the renderer. Specific keys and their meanings can be found in the FreeMarker and Mustache documentation:
+The returned map should have, for each renderer (such as ``freemarker`` or ``mustache``), a ``Map<String, String>`` describing how to configure the renderer. Specific keys and their meanings can be found in the FreeMarker and Mustache documentation:
 
 .. code-block:: yaml
 
     views:
-      .ftl:
-        strict_syntax: yes
+      freemarker:
+        strict_syntax: true
+      mustache:
+        cache: false
 
 Then, in your :ref:`resource method <man-core-resources>`, add a ``View`` class:
 
@@ -61,7 +63,7 @@ Then, in your :ref:`resource method <man-core-resources>`, add a ``View`` class:
 ``com.example.service.PersonView``, Dropwizard would then look for the file
 ``src/main/resources/com/example/service/person.ftl``.
 
-If your template ends with ``.ftl``, it'll be interpreted as a FreeMarker_ template. If it ends with
+If your template path contains ``.ftl``, ``.flth``, or ``.ftlx``, it'll be interpreted as a FreeMarker_ template. If it contains
 ``.mustache``, it'll be interpreted as a Mustache template.
 
 .. tip::

dropwizard-bom/pom.xml

@@ -196,7 +196,7 @@
             <dependency>
                 <groupId>org.freemarker</groupId>
                 <artifactId>freemarker</artifactId>
-                <version>2.3.23</version>
+                <version>2.3.27-incubating</version>
             </dependency>
             <dependency>
                 <groupId>org.jdbi</groupId>

dropwizard-example/example.yml

@@ -78,9 +78,9 @@ logging:
       timeZone: UTC
       maxFileSize: 10MB
 
-# the key needs to match the suffix of the renderer
+# the key needs to match the configuration key of the renderer (ViewRenderer::getConfigurationKey)
 viewRendererConfiguration:
-    .ftl:
+    freemarker:
         strict_syntax: yes
         whitespace_stripping: yes
 

dropwizard-views-freemarker/src/main/java/io/dropwizard/views/freemarker/FreemarkerViewRenderer.java

@@ -19,12 +19,13 @@
 import java.nio.charset.StandardCharsets;
 import java.util.Locale;
 import java.util.Map;
+import java.util.regex.Pattern;
 
 /**
- * A {@link ViewRenderer} which renders Freemarker ({@code .ftl}) templates.
+ * A {@link ViewRenderer} which renders Freemarker ({@code .ftl, .ftlh or .ftlx}) templates.
  */
 public class FreemarkerViewRenderer implements ViewRenderer {
-
+    private static final Pattern FILE_PATTERN = Pattern.compile("\\.ftl[hx]?");
     private static final Version FREEMARKER_VERSION = Configuration.getVersion();
     private final TemplateLoader loader;
 
@@ -59,7 +60,7 @@ public FreemarkerViewRenderer() {
 
     @Override
     public boolean isRenderable(View view) {
-        return view.getTemplateName().endsWith(getSuffix());
+        return FILE_PATTERN.matcher(view.getTemplateName()).find();
     }
 
     @Override
@@ -82,7 +83,7 @@ public void configure(Map<String, String> baseConfig) {
     }
 
     @Override
-    public String getSuffix() {
-        return ".ftl";
+    public String getConfigurationKey() {
+        return "freemarker";
     }
 }

dropwizard-views-freemarker/src/test/java/io/dropwizard/views/freemarker/AbsoluteView.java

@@ -6,7 +6,7 @@ public class AbsoluteView extends View {
     private final String name;
 
     public AbsoluteView(String name) {
-        super("/example.ftl");
+        super("/example.ftlh");
         this.name = name;
     }
 

dropwizard-views-freemarker/src/test/java/io/dropwizard/views/freemarker/ErrorView.java

@@ -4,6 +4,6 @@
 
 public class ErrorView extends View {
     protected ErrorView() {
-        super("/example-error.ftl");
+        super("/example-error.ftlx");
     }
 }

dropwizard-views-freemarker/src/test/resources/example.ftl → dropwizard-views-freemarker/src/test/resources/example.ftlh

@@ -1,2 +1,2 @@
 <#-- @ftlvariable name="" type="io.dropwizard.views.freemarker.AbsoluteView" -->
-Woop woop. ${name?html}
+Woop woop. ${name}

dropwizard-views-mustache/src/main/java/io/dropwizard/views/mustache/MustacheViewRenderer.java

@@ -21,11 +21,13 @@
 import java.util.Locale;
 import java.util.Map;
 import java.util.Optional;
+import java.util.regex.Pattern;
 
 /**
  * A {@link ViewRenderer} which renders Mustache ({@code .mustache}) templates.
  */
 public class MustacheViewRenderer implements ViewRenderer {
+    private static final Pattern FILE_PATTERN = Pattern.compile("\\.mustache");
     private final LoadingCache<Class<? extends View>, MustacheFactory> factories;
     private boolean useCache = true;
     private Optional<File> fileRoot = Optional.empty();
@@ -41,7 +43,7 @@ public MustacheFactory load(Class<? extends View> key) throws Exception {
 
     @Override
     public boolean isRenderable(View view) {
-        return view.getTemplateName().endsWith(getSuffix());
+        return FILE_PATTERN.matcher(view.getTemplateName()).find();
     }
 
     @Override
@@ -71,8 +73,8 @@ boolean isUseCache() {
     }
 
     @Override
-    public String getSuffix() {
-        return ".mustache";
+    public String getConfigurationKey() {
+        return "mustache";
     }
 
     private MustacheFactory createNewMustacheFactory(Class<? extends View> key) {

dropwizard-views/src/main/java/io/dropwizard/views/ViewBundle.java

@@ -41,7 +41,7 @@
  * }
  * </code></pre>
  *
- *<p>The {@code "profile.ftl"} or {@code "profile.mustache"} is the path of the template relative to the class name. If
+ *<p>The {@code "profile.ftl[hx]"} or {@code "profile.mustache"} is the path of the template relative to the class name. If
  * this class was {@code com.example.application.PersonView}, Freemarker or Mustache would then look for the file
  * {@code src/main/resources/com/example/application/profile.ftl} or {@code
  * src/main/resources/com/example/application/profile.mustache} respectively. If the template path
@@ -109,7 +109,7 @@ public Map<String, Map<String, String>> getViewConfiguration(T configuration) {
     public void run(T configuration, Environment environment) throws Exception {
         final Map<String, Map<String, String>> options = getViewConfiguration(configuration);
         for (ViewRenderer viewRenderer : viewRenderers) {
-            final Map<String, String> viewOptions = options.get(viewRenderer.getSuffix());
+            final Map<String, String> viewOptions = options.get(viewRenderer.getConfigurationKey());
             viewRenderer.configure(firstNonNull(viewOptions, Collections.emptyMap()));
         }
         environment.jersey().register(new ViewMessageBodyWriter(environment.metrics(), viewRenderers));

dropwizard-views/src/main/java/io/dropwizard/views/ViewRenderer.java

@@ -39,7 +39,7 @@ void render(View view,
     void configure(Map<String, String> options);
 
     /**
-     * @return the suffix of the template type, e.g '.ftl', '.mustache'
+     * @return the key to use in the view configurations, i.e. 'freemarker' or 'mustache'.
      */
-    String getSuffix();
+    String getConfigurationKey();
 }

dropwizard-views/src/test/java/io/dropwizard/views/ViewBundleTest.java

@@ -60,10 +60,10 @@ public void addsTheViewMessageBodyWriterToTheEnvironment() throws Exception {
 
     @Test
     public void addsTheViewMessageBodyWriterWithSingleViewRendererToTheEnvironment() throws Exception {
-        final String viewSuffix = ".ftl";
+        final String configurationKey = "freemarker";
         final String testKey = "testKey";
         final Map<String, String> freeMarkerConfig = Collections.singletonMap(testKey, "yes");
-        final Map<String, Map<String, String>> viewRendererConfig = Collections.singletonMap(viewSuffix, freeMarkerConfig);
+        final Map<String, Map<String, String>> viewRendererConfig = Collections.singletonMap(configurationKey, freeMarkerConfig);
 
         final MyConfiguration myConfiguration = new MyConfiguration();
         myConfiguration.setViewRendererConfiguration(viewRendererConfig);
@@ -85,8 +85,8 @@ public void configure(Map<String, String> options) {
             }
 
             @Override
-            public String getSuffix() {
-                return viewSuffix;
+            public String getConfigurationKey() {
+                return configurationKey;
             }
         };