Merge pull request #57 from kazuki43zoo/gh-56

Add SQL provider class that help detecting a template file automatically

Author: kazuki43zoo

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

@@ -32,6 +32,7 @@
 import org.apache.ibatis.scripting.LanguageDriver;
 import org.apache.ibatis.scripting.defaults.DefaultParameterHandler;
 import org.apache.ibatis.session.Configuration;
+import org.mybatis.scripting.freemarker.support.TemplateFilePathProvider;
 
 /**
  * Adds FreeMarker templates support to scripting in MyBatis. If you want to change or extend template loader
@@ -64,6 +65,7 @@ public FreeMarkerLanguageDriver() {
   public FreeMarkerLanguageDriver(FreeMarkerLanguageDriverConfig driverConfig) {
     this.driverConfig = driverConfig;
     this.freemarkerCfg = createFreeMarkerConfiguration();
+    TemplateFilePathProvider.setLanguageDriverConfig(driverConfig);
   }
 
   /**
@@ -75,7 +77,7 @@ protected freemarker.template.Configuration createFreeMarkerConfiguration() {
         freemarker.template.Configuration.VERSION_2_3_22);
 
     TemplateLoader templateLoader = new ClassTemplateLoader(this.getClass().getClassLoader(),
-        driverConfig.getBasePackage());
+        driverConfig.getTemplateFile().getBaseDir());
     cfg.setTemplateLoader(templateLoader);
 
     // To avoid formatting numbers using spaces and commas in SQL

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

@@ -34,6 +34,8 @@
 import freemarker.template.Version;
 import org.apache.commons.text.WordUtils;
 import org.apache.ibatis.io.Resources;
+import org.apache.ibatis.logging.Log;
+import org.apache.ibatis.logging.LogFactory;
 import org.apache.ibatis.reflection.DefaultReflectorFactory;
 import org.apache.ibatis.reflection.MetaObject;
 import org.apache.ibatis.reflection.factory.DefaultObjectFactory;
@@ -46,28 +48,30 @@
  * @since 1.2.0
  */
 public class FreeMarkerLanguageDriverConfig {
-
   private static final String PROPERTY_KEY_CONFIG_FILE = "mybatis-freemarker.config.file";
   private static final String PROPERTY_KEY_CONFIG_ENCODING = "mybatis-freemarker.config.encoding";
   private static final String DEFAULT_PROPERTIES_FILE = "mybatis-freemarker.properties";
-  private static Map<Class<?>, Function<String, Object>> TYPE_CONVERTERS;
+  private static final Map<Class<?>, Function<String, Object>> TYPE_CONVERTERS;
 
   static {
     Map<Class<?>, Function<String, Object>> converters = new HashMap<>();
     converters.put(String.class, String::trim);
+    converters.put(boolean.class, v -> Boolean.valueOf(v.trim()));
     converters.put(Object.class, v -> v);
     TYPE_CONVERTERS = Collections.unmodifiableMap(converters);
   }
 
+  private static final Log log = LogFactory.getLog(FreeMarkerLanguageDriverConfig.class);
+
   /**
    * The configuration properties.
    */
   private final Map<String, String> freemarkerSettings = new HashMap<>();
 
   /**
-   * The base directory for reading template resources.
+   * Template file configuration.
    */
-  private String basePackage = "";
+  private final TemplateFileConfig templateFile = new TemplateFileConfig();
 
   /**
    * Get FreeMarker settings.
@@ -85,19 +89,228 @@ public Map<String, String> getFreemarkerSettings() {
    * </p>
    *
    * @return a base directory for reading template resources
+   * @deprecated Recommend to use the {@link TemplateFileConfig#getBaseDir()}} because this method defined for keeping
+   *             backward compatibility (There is possibility that this method removed at a future version)
    */
+  @Deprecated
   public String getBasePackage() {
-    return basePackage;
+    return templateFile.getBaseDir();
   }
 
   /**
    * Set a base directory for reading template resources.
    *
    * @param basePackage
    *          a base directory for reading template resources
+   * @deprecated Recommend to use the {@link TemplateFileConfig#setBaseDir(String)} because this method defined for
+   *             keeping backward compatibility (There is possibility that this method removed at a future version)
    */
+  @Deprecated
   public void setBasePackage(String basePackage) {
-    this.basePackage = basePackage;
+    log.warn("The 'basePackage' has been deprecated since 1.2.0. Please use the 'templateFile.baseDir'.");
+    templateFile.setBaseDir(basePackage);
+  }
+
+  /**
+   * Get a template file configuration.
+   *
+   * @return a template file configuration
+   */
+  public TemplateFileConfig getTemplateFile() {
+    return templateFile;
+  }
+
+  /**
+   * Template file configuration.
+   */
+  public static class TemplateFileConfig {
+
+    /**
+     * The base directory for reading template resources.
+     */
+    private String baseDir = "";
+
+    /**
+     * The template file path provider configuration.
+     */
+    private final PathProviderConfig pathProvider = new PathProviderConfig();
+
+    /**
+     * Get the base directory for reading template resource file.
+     * <p>
+     * Default is {@code ""}(none).
+     * </p>
+     *
+     * @return the base directory for reading template resource file
+     */
+    public String getBaseDir() {
+      return baseDir;
+    }
+
+    /**
+     * Set the base directory for reading template resource file.
+     *
+     * @param baseDir
+     *          the base directory for reading template resource file
+     */
+    public void setBaseDir(String baseDir) {
+      this.baseDir = baseDir;
+    }
+
+    /**
+     * Get the template file path provider configuration.
+     *
+     * @return the template file path provider configuration
+     */
+    public PathProviderConfig getPathProvider() {
+      return pathProvider;
+    }
+
+    /**
+     * The template file path provider configuration.
+     */
+    public static class PathProviderConfig {
+
+      /**
+       * The prefix for adding to template file path.
+       */
+      private String prefix = "";
+
+      /**
+       * Whether includes package path part.
+       */
+      private boolean includesPackagePath = true;
+
+      /**
+       * Whether separate directory per mapper.
+       */
+      private boolean separateDirectoryPerMapper = true;
+
+      /**
+       * Whether includes mapper name into file name when separate directory per mapper.
+       */
+      private boolean includesMapperNameWhenSeparateDirectory = true;
+
+      /**
+       * Whether cache a resolved template file path.
+       */
+      private boolean cacheEnabled = true;
+
+      /**
+       * Get a prefix for adding to template file path.
+       * <p>
+       * Default is {@code ""}.
+       * </p>
+       *
+       * @return a prefix for adding to template file path
+       */
+      public String getPrefix() {
+        return prefix;
+      }
+
+      /**
+       * Set the prefix for adding to template file path.
+       *
+       * @param prefix
+       *          The prefix for adding to template file path
+       */
+      public void setPrefix(String prefix) {
+        this.prefix = prefix;
+      }
+
+      /**
+       * Get whether includes package path part.
+       * <p>
+       * Default is {@code true}.
+       * </p>
+       *
+       * @return If includes package path, return {@code true}
+       */
+      public boolean isIncludesPackagePath() {
+        return includesPackagePath;
+      }
+
+      /**
+       * Set whether includes package path part.
+       *
+       * @param includesPackagePath
+       *          If want to includes, set {@code true}
+       */
+      public void setIncludesPackagePath(boolean includesPackagePath) {
+        this.includesPackagePath = includesPackagePath;
+      }
+
+      /**
+       * Get whether separate directory per mapper.
+       *
+       * @return If separate directory per mapper, return {@code true}
+       */
+      public boolean isSeparateDirectoryPerMapper() {
+        return separateDirectoryPerMapper;
+      }
+
+      /**
+       * Set whether separate directory per mapper.
+       * <p>
+       * Default is {@code true}.
+       * </p>
+       *
+       * @param separateDirectoryPerMapper
+       *          If want to separate directory, set {@code true}
+       */
+      public void setSeparateDirectoryPerMapper(boolean separateDirectoryPerMapper) {
+        this.separateDirectoryPerMapper = separateDirectoryPerMapper;
+      }
+
+      /**
+       * Get whether includes mapper name into file name when separate directory per mapper.
+       * <p>
+       * Default is {@code true}.
+       * </p>
+       *
+       * @return If includes mapper name, return {@code true}
+       */
+      public boolean isIncludesMapperNameWhenSeparateDirectory() {
+        return includesMapperNameWhenSeparateDirectory;
+      }
+
+      /**
+       * Set whether includes mapper name into file name when separate directory per mapper.
+       * <p>
+       * Default is {@code true}.
+       * </p>
+       *
+       * @param includesMapperNameWhenSeparateDirectory
+       *          If want to includes, set {@code true}
+       */
+      public void setIncludesMapperNameWhenSeparateDirectory(boolean includesMapperNameWhenSeparateDirectory) {
+        this.includesMapperNameWhenSeparateDirectory = includesMapperNameWhenSeparateDirectory;
+      }
+
+      /**
+       * Get whether cache a resolved template file path.
+       * <p>
+       * Default is {@code true}.
+       * </p>
+       *
+       * @return If cache a resolved template file path, return {@code true}
+       */
+      public boolean isCacheEnabled() {
+        return cacheEnabled;
+      }
+
+      /**
+       * Set whether cache a resolved template file path.
+       *
+       * @param cacheEnabled
+       *          If want to cache, set {@code true}
+       */
+      public void setCacheEnabled(boolean cacheEnabled) {
+        this.cacheEnabled = cacheEnabled;
+      }
+
+    }
+
   }
 
   /**