support apache velocity in file name

dengzii · dengzii · commit 23b6523a2eaf · 2023-07-06T12:58:19.000+08:00
diff --git a/resources/META-INF/plugin.xml b/resources/META-INF/plugin.xml
@@ -1,7 +1,7 @@
 <idea-plugin>
     <id>com.dengzii.plugin.template</id>
     <name>Generate Module From Template</name>
-    <version>1.5.4</version>
+    <version>1.6.4</version>
     <vendor email="dengzii@foxmail.com" url="https://github.com/dengzii">dengzi</vendor>
 
     <description><![CDATA[
@@ -10,17 +10,16 @@
 <a href="https://youtu.be/TyeXnbCcBP4">Video Tutorial - YouTube</a>
 <br>
 <b>Feature</b><br>
-0. Create module template from exists project irectory.<br>
 1. Custom directory/file tree structure.<br>
-2. Support placeholders, and replace it when you create a module.<br>
+2. Support placeholders / ApacheVelocity template lang in file name.<br>
 3. Specify file templates from IDE custom/build-in templates.<br>
 4. Passing placeholders to file template as variables.<br>
 5. Output/import template file. share your template with your partner.<br>
 <br>
 <b>Usage</b><br>
 1. Configure template in plugin settings: <b>File > Settings > Tools > Module Template Settings</b>.<br>
 2. Create directories from the 'Structure' tab, click the right mouse button to operate the file tree.<br>
-3. FileTree can use placeholders, the placeholder should like this -> <b>${YOUR_PLACEHOLDER_HERE}</b>.<br>
+3. FileTree can use placeholders or ApacheVelocity template lang, the placeholder should like this -> <b>${YOUR_PLACEHOLDER_HERE}</b>.<br>
 4. The 'File Template' tab lists which template the specified file uses, you can also use placeholders for FileName field.<br>
 5. The 'Placeholder' tab's table defines placeholders for replacing filenames and file templates<br>
 More information: <a href='https://github.com/dengzii/GenerateModuleFromTemplate/blob/master/README.md'>README</a><br>
@@ -43,15 +42,13 @@ Any question please <a href='https://github.com/dengzii/GenerateModuleFromTempla
     ]]></description>
 
     <change-notes><![CDATA[
-    <b>Version 1.5.4 (2022/10/10)</b><br>
-    0. Fix: default placeholder and file template cannot save.<br>
-    1. Feat: support create module template from a directory.<br>
-    2. Feat: support remove directory node and merge children to current's parent node.<br>
+    <b>Version 1.6.4 (2023/07/06)</b><br>
+    1. Feature: Support ApacheVelocity in file name.<br>
     <br>
 ]]>
     </change-notes>
 
-    <idea-version since-build="191.8026.42"/>
+    <idea-version since-build="203.5981.155"/>
 
     <depends>com.intellij.modules.platform</depends>
     <depends>com.intellij.modules.lang</depends>
diff --git a/src/com/dengzii/plugin/template/Config.kt b/src/com/dengzii/plugin/template/Config.kt
@@ -31,11 +31,8 @@ object Config {
         val arr = STORE.getValues(KEY_TEMPLATES)
 
         if (STORE.getBoolean(KEY_INIT)) {
-            Logger.i(TAG, "INIT... load AucFrame template")
-            result.add(Module.getAucModule())
-            result.add(Module.getAucApp())
-            result.add(Module.getAucExport())
-            result.add(Module.getAucPkg())
+            Logger.i(TAG, "INIT... load sample template")
+            result.add(Module.getAndroidApplication())
         }
         if (arr.isNullOrEmpty()) {
             return result
diff --git a/src/com/dengzii/plugin/template/FileWriteCommand.kt b/src/com/dengzii/plugin/template/FileWriteCommand.kt
@@ -9,6 +9,8 @@ import com.intellij.openapi.command.UndoConfirmationPolicy
 import com.intellij.openapi.command.WriteCommandAction
 import com.intellij.openapi.vfs.VirtualFile
 import com.intellij.util.ThrowableRunnable
+import org.apache.velocity.VelocityContext
+import org.apache.velocity.util.StringUtils
 
 /**
  * Create file tree.
@@ -21,9 +23,9 @@ class FileWriteCommand(private var kit: PluginKit, private var module: Module) :
         private val TAG = FileWriteCommand::class.java.simpleName
         fun startAction(kit: PluginKit, module: Module) {
             WriteCommandAction.writeCommandAction(kit.project)
-                    .withGlobalUndo()
-                    .withUndoConfirmationPolicy(UndoConfirmationPolicy.REQUEST_CONFIRMATION)
-                    .run(FileWriteCommand(kit, module))
+                .withGlobalUndo()
+                .withUndoConfirmationPolicy(UndoConfirmationPolicy.REQUEST_CONFIRMATION)
+                .run(FileWriteCommand(kit, module))
         }
     }
 
@@ -39,46 +41,64 @@ class FileWriteCommand(private var kit: PluginKit, private var module: Module) :
         fileTreeNode.expandPath()
         fileTreeNode.expandPkgName(true)
 
+        var context: VelocityContext? = null
+        if (module.enableApacheVelocity) {
+            context = VelocityContext().apply {
+                put("StringUtils", StringUtils::class.java)
+                fileTreeNode.getPlaceholderInherit()?.forEach { (k, v) ->
+                    put(k, v)
+                }
+            }
+        }
+
         val failedList = mutableListOf<FileTreeNode>()
         fileTreeNode.children.forEach {
-            failedList.addAll(createFileTree(it, current))
+            failedList.addAll(createFileTree(context, it, current))
         }
         if (failedList.isNotEmpty()) {
             val msg = failedList.joinToString("\n") { it.getRealName() }
-            NotificationUtils.showError(msg, "The following file creation failed.")
+            NotificationUtils.showError(msg, "The following files creation failed.")
         }
     }
 
-    private fun createFileTree(treeNode: FileTreeNode, currentDirectory: VirtualFile): List<FileTreeNode> {
+    private fun createFileTree(
+        context: VelocityContext?,
+        treeNode: FileTreeNode,
+        currentDirectory: VirtualFile
+    ): List<FileTreeNode> {
         Logger.d(TAG, "create node $treeNode")
         val failedList = mutableListOf<FileTreeNode>()
         if (treeNode.isDir) {
             Logger.d(TAG, "create dir ${treeNode.getPath()}")
-            val dir = kit.createDir(treeNode.getRealName(), currentDirectory)
+            val dir = kit.createDir(treeNode.getRealName(context), currentDirectory)
             if (dir == null) {
                 failedList.add(treeNode)
-                Logger.e(TAG, "create directory failure: ${treeNode.getRealName()}")
+                Logger.e(TAG, "create directory failure: ${treeNode.getRealName(context)}")
             } else {
                 treeNode.children.forEach {
-                    failedList.addAll(createFileTree(it, dir))
+                    failedList.addAll(createFileTree(context, it, dir))
                 }
             }
         } else {
             val template = treeNode.getTemplateFile()
             if (template?.isNotBlank() == true) {
                 val result = kit.createFileFromTemplate(
-                        treeNode.getRealName(),
-                        template,
-                        treeNode.getPlaceholderInherit().orEmpty(),
-                        currentDirectory)
+                    treeNode.getRealName(context),
+                    template,
+                    treeNode.getPlaceholderInherit().orEmpty(),
+                    currentDirectory
+                )
                 if (result == null || !result.isValid) {
                     failedList.add(treeNode)
-                    Logger.e(TAG, "create file from template failed, file: ${treeNode.getRealName()} template:$template")
+                    Logger.e(
+                        TAG,
+                        "create file from template failed, file: ${treeNode.getRealName(context)} template:$template"
+                    )
                 } else {
-                    Logger.d(TAG, "create file from template ${treeNode.getRealName()}")
+                    Logger.d(TAG, "create file from template ${treeNode.getRealName(context)}")
                 }
             } else {
-                if (!kit.createFile(treeNode.getRealName(), currentDirectory)) {
+                if (!kit.createFile(treeNode.getRealName(context), currentDirectory)) {
                     failedList.add(treeNode)
                 }
                 Logger.d(TAG, "create file ${treeNode.getPath()}")
diff --git a/src/com/dengzii/plugin/template/model/FileTreeNode.kt b/src/com/dengzii/plugin/template/model/FileTreeNode.kt
@@ -3,7 +3,10 @@
 package com.dengzii.plugin.template.model
 
 import com.dengzii.plugin.template.utils.Logger
+import org.apache.velocity.VelocityContext
+import org.apache.velocity.app.Velocity
 import java.io.File
+import java.io.StringWriter
 import java.util.*
 import java.util.regex.Pattern
 
@@ -141,17 +144,17 @@ open class FileTreeNode() {
     /**
      * get the real name replace with placeholder
      */
-    fun getRealName(): String {
-        return getRealName(this.name)
+    fun getRealName(velocityContext: VelocityContext? = null): String {
+        return getRealNameInternal(velocityContext, this.name)
     }
 
-    private fun getRealName(fileName: String = this.name): String {
+    private fun getRealNameInternal(velocityContext: VelocityContext? = null, fileName: String = this.name): String {
         return if (isDir) {
-            val rn = replacePlaceholder(fileName, getPlaceholderInherit(), false)
+            val rn = replacePlaceholder(velocityContext, fileName, getPlaceholderInherit(), false)
             if (getModuleInherit()?.lowercaseDir == true) rn.lowercase() else rn
         } else {
             val capitalize = getModuleInherit()?.capitalizeFile ?: false
-            replacePlaceholder(fileName, getPlaceholderInherit(), capitalize)
+            replacePlaceholder(velocityContext, fileName, getPlaceholderInherit(), capitalize)
         }
     }
 
@@ -422,8 +425,8 @@ open class FileTreeNode() {
      *
      * @return The tree graph of node
      */
-    fun getTreeGraph(): String {
-        return getNodeGraph().toString()
+    fun getTreeGraph(context: VelocityContext? = null): String {
+        return getNodeGraph(context).toString()
     }
 
     /**
@@ -451,7 +454,11 @@ open class FileTreeNode() {
         return null
     }
 
-    private fun getNodeGraph(head: Stack<String> = Stack(), str: StringBuilder = StringBuilder()): StringBuilder {
+    private fun getNodeGraph(
+        context: VelocityContext?,
+        head: Stack<String> = Stack(),
+        str: StringBuilder = StringBuilder()
+    ): StringBuilder {
 
         head.forEach {
             str.append(it)
@@ -468,13 +475,13 @@ open class FileTreeNode() {
                 }
             }
         )
-        str.append(getRealName())
+        str.append(getRealName(context))
         if (isDir) {
 //            str.append("\tplaceholder: ").append(placeholders)
         }
         str.append("\n")
 
-        if (!realChildren.isEmpty()) {
+        if (realChildren.isNotEmpty()) {
             head.push(
                 when {
                     parent == null -> ""
@@ -483,7 +490,7 @@ open class FileTreeNode() {
                 }
             )
             realChildren.forEach {
-                str.append(it.getNodeGraph(head))
+                str.append(it.getNodeGraph(context, head))
             }
             head.pop()
         }
@@ -535,10 +542,17 @@ open class FileTreeNode() {
     }
 
     private fun replacePlaceholder(
+        velocityContext: VelocityContext? = null,
         origin: String,
         placeholders: Map<String, String>?,
         capitalize: Boolean = false
     ): String {
+        if (velocityContext != null) {
+            val writer = StringWriter()
+            Velocity.evaluate(velocityContext, writer, "FileTreeNode", origin)
+            return writer.toString()
+        }
+
         var after = origin
         if (placeholders.isNullOrEmpty()) {
             return origin
@@ -556,7 +570,7 @@ open class FileTreeNode() {
         return if (after == origin || !after.contains('$')) {
             after
         } else {
-            replacePlaceholder(after, placeholders, capitalize)
+            replacePlaceholder(velocityContext, after, placeholders, capitalize)
         }
     }
 }
diff --git a/src/com/dengzii/plugin/template/model/Module.kt b/src/com/dengzii/plugin/template/model/Module.kt
@@ -11,7 +11,8 @@ class Module(
     var templateName: String,
     var lowercaseDir: Boolean = true,
     var capitalizeFile: Boolean = true,
-    var packageNameToDir: Boolean = true
+    var packageNameToDir: Boolean = true,
+    var enableApacheVelocity: Boolean = false,
 ) {
 
     companion object {
diff --git a/src/com/dengzii/plugin/template/ui/ConfigurePanel.form b/src/com/dengzii/plugin/template/ui/ConfigurePanel.form
@@ -200,6 +200,13 @@
                       <text value="Replace placeholder"/>
                     </properties>
                   </component>
+                  <component id="a98e" class="javax.swing.JCheckBox" binding="cbEnableVelocity">
+                    <constraints/>
+                    <properties>
+                      <text value="Enable ApacheVelocity (?)"/>
+                      <toolTipText value="Caclculate the file name use ApacheVelocity"/>
+                    </properties>
+                  </component>
                 </children>
               </grid>
             </children>
diff --git a/src/com/dengzii/plugin/template/ui/ConfigurePanel.java b/src/com/dengzii/plugin/template/ui/ConfigurePanel.java
@@ -29,4 +29,5 @@ public class ConfigurePanel extends JPanel {
     JCheckBox cbLowercaseDir;
     JCheckBox cbCapitalizeFile;
     JCheckBox cbExpandPkgName;
+    JCheckBox cbEnableVelocity;
 }
diff --git a/src/com/dengzii/plugin/template/ui/FileDialog.java b/src/com/dengzii/plugin/template/ui/FileDialog.java
@@ -66,6 +66,16 @@ private void initFileTemplateList() {
                 && PluginKit.Companion.getFileTemplate(fileNode.getTemplateFile()) != null) {
             cbTemplate.setSelectedItem(fileNode.getTemplateFile());
         }
+        cbTemplate.addItemListener(e -> {
+            if (cbTemplate.getSelectedIndex() == 0 || fileTemplates.length == 0) {
+                tfName.setText("");
+                return;
+            }
+            FileTemplate selected = fileTemplates[cbTemplate.getSelectedIndex() - 1];
+            if (selected != null && !selected.getFileName().isBlank()) {
+                tfName.setText(selected.getFileName() + "." + selected.getExtension());
+            }
+        });
     }
 
     private void onConfirm() {
diff --git a/src/com/dengzii/plugin/template/ui/PreviewPanel.kt b/src/com/dengzii/plugin/template/ui/PreviewPanel.kt
@@ -12,6 +12,7 @@ import com.intellij.ui.ColoredTreeCellRenderer
 import com.intellij.ui.components.JBCheckBox
 import com.intellij.ui.components.JBScrollPane
 import com.intellij.ui.treeStructure.Tree
+import org.apache.velocity.VelocityContext
 import java.awt.BorderLayout
 import java.awt.event.KeyAdapter
 import java.awt.event.KeyEvent
@@ -34,6 +35,10 @@ class PreviewPanel(preview: Boolean) : JPanel() {
     private var onTreeUpdateListener: (() -> Unit)? = null
     private var onPlaceholderUpdateListener: (() -> Unit)? = null
 
+    private var context: VelocityContext = VelocityContext().apply {
+        put("StringUtils", org.apache.velocity.util.StringUtils::class.java)
+    }
+
     // render tree node icon, title
     private val treeCellRenderer = object : ColoredTreeCellRenderer() {
         override fun customizeCellRenderer(
@@ -43,7 +48,7 @@ class PreviewPanel(preview: Boolean) : JPanel() {
                 val node = value.userObject
                 if (node is FileTreeNode) {
                     val name = if (replacePlaceholder) {
-                        node.getRealName()
+                        node.getRealName(context)
                     } else {
                         node.name
                     }
@@ -94,6 +99,12 @@ class PreviewPanel(preview: Boolean) : JPanel() {
         Logger.i("PreviewPanel", "setModuleConfig")
         this.module = module
         fileTree.model = getTreeModel(this.module.template)
+        context.apply {
+            put("StringUtils", org.apache.velocity.util.StringUtils::class.java)
+            module.template.getPlaceholderInherit()?.forEach {
+                put(it.key, it.value)
+            }
+        }
         fileTree.doLayout()
         fileTree.updateUI()
         expandAll(fileTree, TreePath(fileTree.model.root), true)
@@ -107,7 +118,8 @@ class PreviewPanel(preview: Boolean) : JPanel() {
     }
 
     private fun getIconByFileName(fileName: String): Icon {
-        return FileTypeManager.getInstance().getFileTypeByExtension(fileName.split(".").last()).icon ?: AllIcons.FileTypes.Text
+        return FileTypeManager.getInstance().getFileTypeByExtension(fileName.split(".").last()).icon
+            ?: AllIcons.FileTypes.Text
     }
 
     /**
diff --git a/src/com/dengzii/plugin/template/ui/RealConfigurePanel.kt b/src/com/dengzii/plugin/template/ui/RealConfigurePanel.kt
@@ -121,6 +121,10 @@ class RealConfigurePanel : ConfigurePanel() {
             currentConfig?.capitalizeFile = cbCapitalizeFile.isSelected
             panelPreview.updateTree()
         }
+        cbEnableVelocity.addChangeListener {
+            currentConfig?.enableApacheVelocity = cbEnableVelocity.isSelected
+            panelPreview.updateTree()
+        }
         cbExpandPkgName.addChangeListener {
             currentConfig?.packageNameToDir = cbExpandPkgName.isSelected
         }
@@ -215,6 +219,7 @@ class RealConfigurePanel : ConfigurePanel() {
             cbCapitalizeFile.isSelected = capitalizeFile
             cbLowercaseDir.isSelected = lowercaseDir
             cbExpandPkgName.isSelected = packageNameToDir
+            cbEnableVelocity.isSelected = enableApacheVelocity
             // update tree, file template and placeholder table
             panelPreview.setModuleConfig(this)
             tableFileTemp.setPairData(template.fileTemplates)
diff --git a/src/com/dengzii/plugin/template/utils/PluginKit.kt b/src/com/dengzii/plugin/template/utils/PluginKit.kt
diff --git a/test/FileTreeDslTest.kt b/test/FileTreeDslTest.kt

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,10 @@`
`3`	`3`	`package com.dengzii.plugin.template.model`
`4`	`4`
`5`	`5`	`import com.dengzii.plugin.template.utils.Logger`
	`6`	`+import org.apache.velocity.VelocityContext`
	`7`	`+import org.apache.velocity.app.Velocity`
`6`	`8`	`import java.io.File`
	`9`	`+import java.io.StringWriter`
`7`	`10`	`import java.util.*`
`8`	`11`	`import java.util.regex.Pattern`
`9`	`12`
`@@ -141,17 +144,17 @@ open class FileTreeNode() {`
`141`	`144`	`/**`
`142`	`145`	`* get the real name replace with placeholder`
`143`	`146`	`*/`
`144`		`- fun getRealName(): String {`
`145`		`- return getRealName(this.name)`
	`147`	`+ fun getRealName(velocityContext: VelocityContext? = null): String {`
	`148`	`+ return getRealNameInternal(velocityContext, this.name)`
`146`	`149`	`}`
`147`	`150`
`148`		`- private fun getRealName(fileName: String = this.name): String {`
	`151`	`+ private fun getRealNameInternal(velocityContext: VelocityContext? = null, fileName: String = this.name): String {`
`149`	`152`	`return if (isDir) {`
`150`		`- val rn = replacePlaceholder(fileName, getPlaceholderInherit(), false)`
	`153`	`+ val rn = replacePlaceholder(velocityContext, fileName, getPlaceholderInherit(), false)`
`151`	`154`	`if (getModuleInherit()?.lowercaseDir == true) rn.lowercase() else rn`
`152`	`155`	`} else {`
`153`	`156`	`val capitalize = getModuleInherit()?.capitalizeFile ?: false`
`154`		`- replacePlaceholder(fileName, getPlaceholderInherit(), capitalize)`
	`157`	`+ replacePlaceholder(velocityContext, fileName, getPlaceholderInherit(), capitalize)`
`155`	`158`	`}`
`156`	`159`	`}`
`157`	`160`
`@@ -422,8 +425,8 @@ open class FileTreeNode() {`
`422`	`425`	`*`
`423`	`426`	`* @return The tree graph of node`
`424`	`427`	`*/`
`425`		`- fun getTreeGraph(): String {`
`426`		`- return getNodeGraph().toString()`
	`428`	`+ fun getTreeGraph(context: VelocityContext? = null): String {`
	`429`	`+ return getNodeGraph(context).toString()`
`427`	`430`	`}`
`428`	`431`
`429`	`432`	`/**`
`@@ -451,7 +454,11 @@ open class FileTreeNode() {`
`451`	`454`	`return null`
`452`	`455`	`}`
`453`	`456`
`454`		`- private fun getNodeGraph(head: Stack<String> = Stack(), str: StringBuilder = StringBuilder()): StringBuilder {`
	`457`	`+ private fun getNodeGraph(`
	`458`	`+ context: VelocityContext?,`
	`459`	`+ head: Stack<String> = Stack(),`
	`460`	`+ str: StringBuilder = StringBuilder()`
	`461`	`+ ): StringBuilder {`
`455`	`462`
`456`	`463`	`head.forEach {`
`457`	`464`	`str.append(it)`
`@@ -468,13 +475,13 @@ open class FileTreeNode() {`
`468`	`475`	`}`
`469`	`476`	`}`
`470`	`477`	`)`
`471`		`- str.append(getRealName())`
	`478`	`+ str.append(getRealName(context))`
`472`	`479`	`if (isDir) {`
`473`	`480`	`// str.append("\tplaceholder: ").append(placeholders)`
`474`	`481`	`}`
`475`	`482`	`str.append("\n")`
`476`	`483`
`477`		`- if (!realChildren.isEmpty()) {`
	`484`	`+ if (realChildren.isNotEmpty()) {`
`478`	`485`	`head.push(`
`479`	`486`	`when {`
`480`	`487`	`parent == null -> ""`
`@@ -483,7 +490,7 @@ open class FileTreeNode() {`
`483`	`490`	`}`
`484`	`491`	`)`
`485`	`492`	`realChildren.forEach {`
`486`		`- str.append(it.getNodeGraph(head))`
	`493`	`+ str.append(it.getNodeGraph(context, head))`
`487`	`494`	`}`
`488`	`495`	`head.pop()`
`489`	`496`	`}`
`@@ -535,10 +542,17 @@ open class FileTreeNode() {`
`535`	`542`	`}`
`536`	`543`
`537`	`544`	`private fun replacePlaceholder(`
	`545`	`+ velocityContext: VelocityContext? = null,`
`538`	`546`	`origin: String,`
`539`	`547`	`placeholders: Map<String, String>?,`
`540`	`548`	`capitalize: Boolean = false`
`541`	`549`	`): String {`
	`550`	`+ if (velocityContext != null) {`
	`551`	`+ val writer = StringWriter()`
	`552`	`+ Velocity.evaluate(velocityContext, writer, "FileTreeNode", origin)`
	`553`	`+ return writer.toString()`
	`554`	`+ }`
	`555`	`+`
`542`	`556`	`var after = origin`
`543`	`557`	`if (placeholders.isNullOrEmpty()) {`
`544`	`558`	`return origin`
`@@ -556,7 +570,7 @@ open class FileTreeNode() {`
`556`	`570`	`return if (after == origin \|\| !after.contains('$')) {`
`557`	`571`	`after`
`558`	`572`	`} else {`
`559`		`- replacePlaceholder(after, placeholders, capitalize)`
	`573`	`+ replacePlaceholder(velocityContext, after, placeholders, capitalize)`
`560`	`574`	`}`
`561`	`575`	`}`
`562`	`576`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,4 +29,5 @@ public class ConfigurePanel extends JPanel {`
`29`	`29`	`JCheckBox cbLowercaseDir;`
`30`	`30`	`JCheckBox cbCapitalizeFile;`
`31`	`31`	`JCheckBox cbExpandPkgName;`
	`32`	`+ JCheckBox cbEnableVelocity;`
`32`	`33`	`}`