Polishing for gh-44

Author: kazuki43zoo

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

@@ -21,6 +21,7 @@
 
 import java.io.IOException;
 import java.io.StringReader;
+import java.nio.charset.StandardCharsets;
 
 import freemarker.template.TemplateException;
 import org.apache.ibatis.executor.parameter.ParameterHandler;
@@ -71,15 +72,7 @@ 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);
-      }
-    });
+        freemarker.template.Configuration.VERSION_2_3_22);
 
     TemplateLoader templateLoader = new ClassTemplateLoader(this.getClass().getClassLoader(),
         driverConfig.getBasePackage());
@@ -89,7 +82,16 @@ protected freemarker.template.Configuration createFreeMarkerConfiguration() {
     cfg.setNumberFormat("computer");
 
     // Because it defaults to default system encoding, we should set it always explicitly
-    cfg.setDefaultEncoding(driverConfig.getDefaultEncoding().name());
+    cfg.setDefaultEncoding(StandardCharsets.UTF_8.name());
+
+    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);
+      }
+    });
 
     return cfg;
   }
@@ -147,7 +149,7 @@ public SqlSource createSqlSource(Configuration configuration, String script, Cla
   }
 
   protected SqlSource createSqlSource(Template template, Configuration configuration) {
-    return new FreeMarkerSqlSource(template, configuration, driverConfig.getIncompatibleImprovementsVersion());
+    return new FreeMarkerSqlSource(template, configuration, freemarkerCfg.getIncompatibleImprovements());
   }
 
   private SqlSource createSqlSource(Configuration configuration, String scriptText) {

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

@@ -55,8 +55,6 @@ public class FreeMarkerLanguageDriverConfig {
   static {
     Map<Class<?>, Function<String, Object>> converters = new HashMap<>();
     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);
   }
@@ -71,16 +69,6 @@ public class FreeMarkerLanguageDriverConfig {
    */
   private String basePackage = "";
 
-  /**
-   * The default encoding for reading template resources.
-   */
-  private Charset defaultEncoding = StandardCharsets.UTF_8;
-
-  /**
-   * The incompatible improvements version of freemarker.
-   */
-  private Version incompatibleImprovementsVersion = Configuration.VERSION_2_3_22;
-
   /**
    * Get FreeMarker settings.
    *
@@ -112,50 +100,6 @@ public void setBasePackage(String basePackage) {
     this.basePackage = basePackage;
   }
 
-  /**
-   * Get a default encoding for reading template resources.
-   * <p>
-   * Default is {@code UTF-8}.
-   * </p>
-   *
-   * @return a default encoding for reading template resources
-   */
-  public Charset getDefaultEncoding() {
-    return defaultEncoding;
-  }
-
-  /**
-   * Set a default encoding for reading template resources.
-   *
-   * @param defaultEncoding
-   *          a default encoding for reading template resources
-   */
-  public void setDefaultEncoding(Charset defaultEncoding) {
-    this.defaultEncoding = defaultEncoding;
-  }
-
-  /**
-   * Get an incompatible improvements version of freemarker.
-   * <p>
-   * Default is 2.3.22.
-   * </p>
-   * 
-   * @return an incompatible improvements version of freemarker
-   */
-  public Version getIncompatibleImprovementsVersion() {
-    return incompatibleImprovementsVersion;
-  }
-
-  /**
-   * Set an incompatible improvements version of freemarker.
-   *
-   * @param incompatibleImprovementsVersion
-   *          an incompatible improvements version of freemarker
-   */
-  public void setIncompatibleImprovementsVersion(Version incompatibleImprovementsVersion) {
-    this.incompatibleImprovementsVersion = incompatibleImprovementsVersion;
-  }
-
   /**
    * Create an instance from default properties file. <br>
    * If you want to customize a default {@code TemplateEngine}, you can configure some property using
@@ -178,18 +122,8 @@ public void setIncompatibleImprovementsVersion(Version incompatibleImprovementsV
    * <td>None(just under classpath)</td>
    * </tr>
    * <tr>
-   * <td>default-encoding</td>
-   * <td>The default encoding for reading template resources</td>
-   * <td>UTF-8</td>
-   * </tr>
-   * <tr>
-   * <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>The settings of freemarker {@link freemarker.core.Configurable#setSetting(String, String)}).</td>
    * <td>-</td>
    * </tr>
    * </table>

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

@@ -95,7 +95,7 @@ protected Object preProcessDataContext(Object dataContext, boolean isMap) {
   public static class CustomFreeMarkerLanguageDriver extends FreeMarkerLanguageDriver {
     @Override
     protected SqlSource createSqlSource(Template template, Configuration configuration) {
-      return new CustomSqlSource(template, configuration, driverConfig.getIncompatibleImprovementsVersion());
+      return new CustomSqlSource(template, configuration, freemarkerCfg.getIncompatibleImprovements());
     }
   }
 

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

@@ -55,26 +55,20 @@ void newInstanceWithEmptyPropertiesFile() {
     System.setProperty("mybatis-freemarker.config.file", "mybatis-freemarker-empty.properties");
     FreeMarkerLanguageDriverConfig config = FreeMarkerLanguageDriverConfig.newInstance();
     Assertions.assertEquals("", config.getBasePackage());
-    Assertions.assertEquals(StandardCharsets.UTF_8, config.getDefaultEncoding());
-    Assertions.assertEquals(Configuration.VERSION_2_3_22, config.getIncompatibleImprovementsVersion());
   }
 
   @Test
   void newInstanceWithPropertiesFileNotFound() {
     System.setProperty("mybatis-freemarker.config.file", "mybatis-freemarker-notfound.properties");
     FreeMarkerLanguageDriverConfig config = FreeMarkerLanguageDriverConfig.newInstance();
     Assertions.assertEquals("", config.getBasePackage());
-    Assertions.assertEquals(StandardCharsets.UTF_8, config.getDefaultEncoding());
-    Assertions.assertEquals(Configuration.VERSION_2_3_22, config.getIncompatibleImprovementsVersion());
   }
 
   @Test
   void newInstanceWithCustomPropertiesFile() {
     System.setProperty("mybatis-freemarker.config.file", "mybatis-freemarker-custom.properties");
     FreeMarkerLanguageDriverConfig config = FreeMarkerLanguageDriverConfig.newInstance();
     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"));
@@ -83,15 +77,11 @@ void newInstanceWithCustomPropertiesFile() {
   @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"));
   }
@@ -100,12 +90,8 @@ void newInstanceWithCustomProperties() {
   void newInstanceWithConsumer() {
     FreeMarkerLanguageDriverConfig config = FreeMarkerLanguageDriverConfig.newInstance(c -> {
       c.setBasePackage("sqls");
-      c.setDefaultEncoding(StandardCharsets.UTF_16);
-      c.setIncompatibleImprovementsVersion(Configuration.VERSION_2_3_26);
     });
     Assertions.assertEquals("sql", config.getBasePackage());
-    Assertions.assertEquals(StandardCharsets.UTF_16, config.getDefaultEncoding());
-    Assertions.assertEquals(Configuration.VERSION_2_3_26, config.getIncompatibleImprovementsVersion());
   }
 
 }

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

@@ -15,7 +15,5 @@
 #
 
 base-package=sqls
-default-encoding=Windows-31J
-incompatible-improvements-version=2.3.28
 freemarker-settings.interpolation_syntax=dollar
 freemarker-settings.whitespace_stripping=yes