Merge pull request #52 from kazuki43zoo/gh-51

Support to configure FreeMarker settings using properties file

Author: kazuki43zoo

src/main/java/org/mybatis/scripting/freemarker/FreeMarkerLanguageDriver.java

@@ -22,6 +22,7 @@
 import java.io.IOException;
 import java.io.StringReader;
 
+import freemarker.template.TemplateException;
 import org.apache.ibatis.executor.parameter.ParameterHandler;
 import org.apache.ibatis.mapping.BoundSql;
 import org.apache.ibatis.mapping.MappedStatement;
@@ -71,6 +72,14 @@ public FreeMarkerLanguageDriver(FreeMarkerLanguageDriverConfig driverConfig) {
   protected freemarker.template.Configuration createFreeMarkerConfiguration() {
     freemarker.template.Configuration cfg = new freemarker.template.Configuration(
         driverConfig.getIncompatibleImprovementsVersion());
+    driverConfig.getFreemarkerSettings().forEach((name, value) -> {
+      try {
+        cfg.setSetting(name, value);
+      } catch (TemplateException e) {
+        throw new IllegalStateException(
+            String.format("Fail to configure FreeMarker template setting. name[%s] value[%s]", name, value), e);
+      }
+    });
 
     TemplateLoader templateLoader = new ClassTemplateLoader(this.getClass().getClassLoader(),
         driverConfig.getBasePackage());

src/main/java/org/mybatis/scripting/freemarker/FreeMarkerLanguageDriverConfig.java

@@ -57,9 +57,15 @@ public class FreeMarkerLanguageDriverConfig {
     converters.put(String.class, String::trim);
     converters.put(Version.class, v -> new Version(v.trim()));
     converters.put(Charset.class, v -> Charset.forName(v.trim()));
+    converters.put(Object.class, v -> v);
     TYPE_CONVERTERS = Collections.unmodifiableMap(converters);
   }
 
+  /**
+   * The configuration properties.
+   */
+  private Map<String, String> freemarkerSettings = new HashMap<>();
+
   /**
    * The base directory for reading template resources.
    */
@@ -75,6 +81,25 @@ public class FreeMarkerLanguageDriverConfig {
    */
   private Version incompatibleImprovementsVersion = Configuration.VERSION_2_3_22;
 
+  /**
+   * Get FreeMarker settings.
+   *
+   * @return FreeMarker settings
+   */
+  public Map<String, String> getFreemarkerSettings() {
+    return freemarkerSettings;
+  }
+
+  /**
+   * Set FreeMarker settings.
+   *
+   * @param freemarkerSettings
+   *          FreeMarker settings
+   */
+  public void setFreemarkerSettings(Map<String, String> freemarkerSettings) {
+    this.freemarkerSettings = freemarkerSettings;
+  }
+
   /**
    * Get a base directory for reading template resources.
    * <p>
@@ -168,10 +193,15 @@ public void setIncompatibleImprovementsVersion(Version incompatibleImprovementsV
    * <td>UTF-8</td>
    * </tr>
    * <tr>
-   * <td>freemarker-incompatible-improvements-version</td>
+   * <td>incompatible-improvements-version</td>
    * <td>The incompatible improvements version of freemarker</td>
    * <td>2.3.22</td>
    * </tr>
+   * <tr>
+   * <td>freemarker-settings.*</td>
+   * <td>The settings of freemarker {@link Configuration#setSetting(String, String)}).</td>
+   * <td>-</td>
+   * </tr>
    * </table>
    *
    * @return a configuration instance

src/test/java/org/mybatis/scripting/freemarker/FreeMarkerLanguageDriverConfigTest.java

@@ -75,17 +75,25 @@ void newInstanceWithCustomPropertiesFile() {
     Assertions.assertEquals("sqls", config.getBasePackage());
     Assertions.assertEquals(Charset.forName("Windows-31J"), config.getDefaultEncoding());
     Assertions.assertEquals(Configuration.VERSION_2_3_28, config.getIncompatibleImprovementsVersion());
+    Assertions.assertEquals(2, config.getFreemarkerSettings().size());
+    Assertions.assertEquals("dollar", config.getFreemarkerSettings().get("interpolation_syntax"));
+    Assertions.assertEquals("yes", config.getFreemarkerSettings().get("whitespace_stripping"));
   }
 
   @Test
   void newInstanceWithCustomProperties() {
     Properties properties = new Properties();
     properties.setProperty("defaultEncoding", " " + StandardCharsets.ISO_8859_1.name() + " ");
     properties.setProperty("incompatibleImprovementsVersion", " 2.3.27 ");
+    properties.setProperty("freemarkerSettings.interpolation_syntax", "dollar");
+    properties.setProperty("freemarkerSettings.whitespace_stripping", "yes");
+
     FreeMarkerLanguageDriverConfig config = FreeMarkerLanguageDriverConfig.newInstance(properties);
     Assertions.assertEquals("sql", config.getBasePackage());
     Assertions.assertEquals(StandardCharsets.ISO_8859_1, config.getDefaultEncoding());
     Assertions.assertEquals(Configuration.VERSION_2_3_27, config.getIncompatibleImprovementsVersion());
+    Assertions.assertEquals("dollar", config.getFreemarkerSettings().get("interpolation_syntax"));
+    Assertions.assertEquals("yes", config.getFreemarkerSettings().get("whitespace_stripping"));
   }
 
   @Test

src/test/resources/mybatis-freemarker-custom.properties

@@ -16,4 +16,6 @@
 
 base-package=sqls
 default-encoding=Windows-31J
-incompatible-improvements-version=2.3.28
+incompatible-improvements-version=2.3.28
+freemarker-settings.interpolation_syntax=dollar
+freemarker-settings.whitespace_stripping=yes