Refactor template path for handlebars and freemarker

Author: jknack

docs/asciidoc/modules/freemarker.adoc

@@ -54,7 +54,8 @@ import io.jooby.freemarker.Freemarker
 Template location is set to `views`. The `views` folder/location is expected to be at the current
 user directory or at root of classpath.
 
-You can override the default location by setting the `freemarker.templatePath` property.
+You can override the default location by setting the `templates.path` property in the application
+configuration file or programmatically at creation time.
 
 === Template Cache
 
@@ -79,7 +80,7 @@ Custom Configuration object can be provided it programmatically:
 .Java
 [source, java, role="primary"]
 ----
-import io.jooby.handlebars.hbs;
+import io.jooby.freemarker.Freemarker;
 
 {
   Configuration freemarker = new Configuration();

docs/asciidoc/modules/handlebars.adoc

@@ -54,7 +54,8 @@ import io.jooby.handlebars.Hbs
 Template location is set to `views`. The `views` folder/location is expected to be at the current
 user directory or at root of classpath.
 
-You can override the default location by setting the `handlebars.templatePath` property.
+You can override the default location by setting the `templates.path` property in the application
+configuration file or programmatically at creation time.
 
 === Template Cache
 
@@ -68,10 +69,12 @@ Custom Handlebars object can be provided it programmatically:
 .Java
 [source, java, role="primary"]
 ----
-import io.jooby.handlebars.hbs;
+import io.jooby.handlebars.Hbs;
 
 {
   Handlebars handlebars = new Handlebars();
+  
+  // Apply custom configuration
 
   install(new Hbs(handlebars));
 }
@@ -80,11 +83,13 @@ import io.jooby.handlebars.hbs;
 .Kotlin
 [source, kt, role="secondary"]
 ----
-import io.jooby.freemarker.Freemarker
+import io.jooby.handlebars.Hbs
 
 {
-  val handlebars = Handlebars();
+  val handlebars = Handlebars()
  
+  // Apply custom configuration
+
   install(Hbs(handlebars))
 }
 ----

jooby/src/main/java/io/jooby/Environment.java

@@ -72,6 +72,20 @@ public Environment(@Nonnull ClassLoader classLoader, @Nonnull Config conf, @Nonn
     this.conf = conf;
   }
 
+  public @Nonnull String getProperty(@Nonnull String key, @Nonnull String defaults) {
+    if (conf.hasPath(key)) {
+      return conf.getString(key);
+    }
+    return defaults;
+  }
+
+  public @Nullable String getProperty(@Nonnull String key) {
+    if (conf.hasPath(key)) {
+      return conf.getString(key);
+    }
+    return getProperty(key, null);
+  }
+
   /**
    * Application configuration.
    *

jooby/src/main/java/io/jooby/TemplateEngine.java

@@ -16,6 +16,12 @@
  */
 public interface TemplateEngine extends Renderer {
 
+  /** Name of application property that defines the template path. */
+  String TEMPLATE_PATH = "templates.path";
+
+  /** Default template path. */
+  String PATH = "views";
+
   /**
    * Render a model and view instance as String.
    *
@@ -31,4 +37,8 @@ public interface TemplateEngine extends Renderer {
     String output = apply(ctx, (ModelAndView) value);
     return output.getBytes(StandardCharsets.UTF_8);
   }
+
+  static @Nonnull String normalizePath(@Nonnull String templatesPath) {
+    return templatesPath.startsWith("/") ? templatesPath.substring(1) : templatesPath;
+  }
 }

modules/jooby-freemarker/src/main/java/io/jooby/freemarker/Freemarker.java

@@ -12,25 +12,24 @@
 import freemarker.core.HTMLOutputFormat;
 import freemarker.core.OutputFormat;
 import freemarker.template.Configuration;
-import freemarker.template.DefaultObjectWrapper;
 import freemarker.template.DefaultObjectWrapperBuilder;
 import freemarker.template.TemplateException;
-import freemarker.template.Version;
 import io.jooby.Environment;
 import io.jooby.Extension;
 import io.jooby.Jooby;
 import io.jooby.MediaType;
 import io.jooby.ServiceRegistry;
 import io.jooby.Sneaky;
+import io.jooby.TemplateEngine;
 
 import javax.annotation.Nonnull;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
-import java.util.Optional;
 import java.util.Properties;
 
-import static io.jooby.Sneaky.throwingConsumer;
+import static io.jooby.TemplateEngine.TEMPLATE_PATH;
+import static io.jooby.TemplateEngine.normalizePath;
 
 public class Freemarker implements Extension {
 
@@ -42,7 +41,7 @@ public static class Builder {
 
     private OutputFormat outputFormat = HTMLOutputFormat.INSTANCE;
 
-    private String templatePath;
+    private String templatesPath = TemplateEngine.PATH;
 
     public @Nonnull Builder setTemplateLoader(@Nonnull TemplateLoader loader) {
       this.templateLoader = loader;
@@ -59,12 +58,8 @@ public static class Builder {
       return this;
     }
 
-    public @Nonnull Builder setTemplatePath(@Nonnull String templatePath) {
-      if (templatePath.startsWith("/")) {
-        this.templatePath = templatePath.substring(1);
-      } else {
-        this.templatePath = templatePath;
-      }
+    public @Nonnull Builder setTemplatesPath(@Nonnull String templatesPath) {
+        this.templatesPath = templatesPath;
       return this;
     }
 
@@ -80,8 +75,7 @@ public static class Builder {
           conf.getConfig("freemarker").root().unwrapped()
               .forEach((k, v) -> settings.put(k, v.toString()));
         }
-        String templatePath = Optional.ofNullable((String) settings.remove("templatePath"))
-            .orElse(Optional.ofNullable(this.templatePath).orElse("views"));
+        String templatesPath = normalizePath(env.getProperty(TEMPLATE_PATH, this.templatesPath));
 
         settings.putIfAbsent("defaultEncoding", "UTF-8");
         /** Cache storage: */
@@ -92,12 +86,9 @@ public static class Builder {
 
         freemarker.setSettings(settings);
 
-        /** Template path: */
-        setTemplatePath(templatePath);
-
         /** Template loader: */
         if (templateLoader == null) {
-          templateLoader = defaultTemplateLoader(env);
+          templateLoader = defaultTemplateLoader(env, templatesPath);
         }
         freemarker.setTemplateLoader(templateLoader);
 
@@ -116,13 +107,13 @@ public static class Builder {
       }
     }
 
-    private TemplateLoader defaultTemplateLoader(Environment env) {
+    private TemplateLoader defaultTemplateLoader(Environment env, String templatesPath) {
       try {
-        Path templateDir = Paths.get(System.getProperty("user.dir"), templatePath);
+        Path templateDir = Paths.get(System.getProperty("user.dir"), templatesPath);
         if (Files.exists(templateDir)) {
           return new FileTemplateLoader(templateDir.toFile());
         }
-        return new ClassTemplateLoader(env.getClassLoader(), "/" + templatePath);
+        return new ClassTemplateLoader(env.getClassLoader(), "/" + templatesPath);
       } catch (Exception x) {
         throw Sneaky.propagate(x);
       }
@@ -131,16 +122,23 @@ private TemplateLoader defaultTemplateLoader(Environment env) {
 
   private Configuration freemarker;
 
+  private String templatesPath;
+
   public Freemarker(@Nonnull Configuration freemarker) {
     this.freemarker = freemarker;
   }
 
+  public Freemarker(@Nonnull String templatesPath) {
+    this.templatesPath = templatesPath;
+  }
+
   public Freemarker() {
+    this(TemplateEngine.PATH);
   }
 
   @Override public void install(@Nonnull Jooby application) {
     if (freemarker == null) {
-      freemarker = create().build(application.getEnvironment());
+      freemarker = create().setTemplatesPath(templatesPath).build(application.getEnvironment());
     }
     application.renderer(MediaType.html, new FreemarkerTemplateEngine(freemarker));
 

modules/jooby-freemarker/src/test/java/io/jooby/freemarker/FreemarkerTest.java

@@ -73,7 +73,7 @@ public void publicField() throws Exception {
   @Test
   public void customTemplatePath() throws Exception {
     Configuration freemarker = Freemarker.create()
-        .build(new Environment(getClass().getClassLoader(), ConfigFactory.empty().withValue("freemarker.templatePath",
+        .build(new Environment(getClass().getClassLoader(), ConfigFactory.empty().withValue("templates.path",
             ConfigValueFactory.fromAnyRef("foo"))));
     FreemarkerTemplateEngine engine = new FreemarkerTemplateEngine(freemarker);
     MockContext ctx = new MockContext();

modules/jooby-handlebars/src/main/java/io/jooby/handlebars/Hbs.java

@@ -14,12 +14,12 @@
 import com.github.jknack.handlebars.io.ClassPathTemplateLoader;
 import com.github.jknack.handlebars.io.FileTemplateLoader;
 import com.github.jknack.handlebars.io.TemplateLoader;
-import com.typesafe.config.Config;
 import io.jooby.Environment;
 import io.jooby.Extension;
 import io.jooby.Jooby;
 import io.jooby.MediaType;
 import io.jooby.ServiceRegistry;
+import io.jooby.TemplateEngine;
 
 import javax.annotation.Nonnull;
 import java.io.File;
@@ -32,7 +32,9 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
-import java.util.Optional;
+
+import static io.jooby.TemplateEngine.TEMPLATE_PATH;
+import static io.jooby.TemplateEngine.normalizePath;
 
 public class Hbs implements Extension {
 
@@ -44,7 +46,7 @@ public static class Builder {
 
     private TemplateCache cache;
 
-    private String templatePath;
+    private String templatesPath = TemplateEngine.PATH;
 
     public Builder() {
       handlebars = new Handlebars();
@@ -56,8 +58,8 @@ public Builder() {
       return this;
     }
 
-    public @Nonnull Builder setTemplatePath(@Nonnull String templatePath) {
-      this.templatePath = templatePath.startsWith("/") ? templatePath.substring(1) : templatePath;
+    public @Nonnull Builder setTemplatesPath(@Nonnull String templatesPath) {
+      this.templatesPath = templatesPath;
       return this;
     }
 
@@ -121,14 +123,8 @@ public Builder() {
 
     public @Nonnull Handlebars build(@Nonnull Environment env) {
       if (loader == null) {
-        Config config = env.getConfig();
-        String defaultTemplatePath = config.hasPath("handlebars.templatePath")
-            ? config.getString("handlebars.templatePath")
-            : "views";
-        String templatePath = Optional.ofNullable(this.templatePath)
-            .orElse(defaultTemplatePath);
-        setTemplatePath(templatePath);
-        loader = defaultTemplateLoader(env, this.templatePath);
+        String templatesPath = normalizePath(env.getProperty(TEMPLATE_PATH, this.templatesPath));
+        loader = defaultTemplateLoader(env, templatesPath);
       }
       handlebars.with(loader);
 
@@ -160,16 +156,23 @@ private static TemplateLoader defaultTemplateLoader(Environment env, String temp
 
   private Handlebars handlebars;
 
+  private String templatesPath;
+
   public Hbs(@Nonnull Handlebars handlebars) {
     this.handlebars = handlebars;
   }
 
+  public Hbs(@Nonnull String templatesPath) {
+    this.templatesPath = templatesPath;
+  }
+
   public Hbs() {
+    this(TemplateEngine.PATH);
   }
 
   @Override public void install(@Nonnull Jooby application) throws Exception {
     if (handlebars == null) {
-      handlebars = create().build(application.getEnvironment());
+      handlebars = create().setTemplatesPath(templatesPath).build(application.getEnvironment());
     }
     application.renderer(MediaType.html, new HbsTemplateEngine(handlebars));
 

modules/jooby-handlebars/src/test/java/io/jooby/handlebars/HbsTest.java

@@ -48,7 +48,7 @@ public void render() throws Exception {
   @Test
   public void renderFileSystem() throws Exception {
     Handlebars handlebars = Hbs.create()
-        .setTemplatePath(Paths.get("src", "test", "resources", "views").toString())
+        .setTemplatesPath(Paths.get("src", "test", "resources", "views").toString())
         .build(new Environment(getClass().getClassLoader(), ConfigFactory.empty()));
     HbsTemplateEngine engine = new HbsTemplateEngine(handlebars);
     MockContext ctx = new MockContext();