Handle screen creation if the screen with the same ID already exists #114

alexander-shustanov · alexander-shustanov · commit 521251ea6c4f · 2018-08-30T10:35:41.000+04:00
diff --git a/src/main/kotlin/com/haulmont/cuba/cli/cubaplugin/ScreenCommandBase.kt b/src/main/kotlin/com/haulmont/cuba/cli/cubaplugin/ScreenCommandBase.kt
@@ -19,6 +19,7 @@ package com.haulmont.cuba.cli.cubaplugin
 import com.haulmont.cuba.cli.ModuleStructure
 import com.haulmont.cuba.cli.commands.GeneratorCommand
 import com.haulmont.cuba.cli.kodein
+import com.haulmont.cuba.cli.prompting.ValidationHelper
 import com.haulmont.cuba.cli.registration.ScreenRegistrationHelper
 import org.kodein.di.generic.instance
 import java.nio.file.Path
@@ -31,7 +32,7 @@ abstract class ScreenCommandBase<out Model : Any> : GeneratorCommand<Model>() {
         webModule.screensXml
     }
 
-    private val screenRegistrationHelper: ScreenRegistrationHelper by kodein.instance()
+    protected val screenRegistrationHelper: ScreenRegistrationHelper by kodein.instance()
 
     protected fun addToMenu(screenId: String, caption: String) {
         screenRegistrationHelper.addToMenu(screenId, caption)
@@ -48,4 +49,24 @@ abstract class ScreenCommandBase<out Model : Any> : GeneratorCommand<Model>() {
     protected fun addToScreensXml(id: String, packageName: String, descriptorName: String) {
         screenRegistrationHelper.addToScreensXml(id, packageName, descriptorName)
     }
+
+    protected fun ValidationHelper<String>.screenIdDoesNotExists(screenId: String) {
+        if (screenRegistrationHelper.isScreenIdExists(screenId))
+            fail("Screen with id $screenId already exists")
+    }
+
+    protected fun ValidationHelper<String>.screenDescriptorDoesNotExists(descriptorName: String, packageName: String = packageName()) {
+        if (screenRegistrationHelper.isDescriptorExists(packageName, descriptorName)) {
+            fail("Such screen descriptor already exists")
+        }
+    }
+
+    protected fun ValidationHelper<String>.screenControllerDoesNotExists(controllerName: String, packageName: String = answers["packageName"] as String) {
+        if (screenRegistrationHelper.isControllerExists(packageName, controllerName)) {
+            fail("Such screen controller already exists")
+        }
+    }
+
+    protected fun ValidationHelper<String>.packageName() =
+            answers["packageName"] as String
 }
diff --git a/src/main/kotlin/com/haulmont/cuba/cli/cubaplugin/browsescreen/CreateBrowseScreenCommand.kt b/src/main/kotlin/com/haulmont/cuba/cli/cubaplugin/browsescreen/CreateBrowseScreenCommand.kt
@@ -68,6 +68,10 @@ class CreateBrowseScreenCommand : ScreenCommandBase<BrowseScreenModel>() {
 
                 projectModel.namespace + "$" + entityName.split('.').last() + ".browse"
             }
+
+            validate {
+                screenIdDoesNotExists(value)
+            }
         }
 
         question("descriptorName", "Descriptor name") {
@@ -79,6 +83,8 @@ class CreateBrowseScreenCommand : ScreenCommandBase<BrowseScreenModel>() {
 
             validate {
                 checkIsScreenDescriptor()
+
+                screenDescriptorDoesNotExists(value)
             }
         }
 
@@ -87,6 +93,8 @@ class CreateBrowseScreenCommand : ScreenCommandBase<BrowseScreenModel>() {
 
             validate {
                 checkIsClass()
+
+                screenControllerDoesNotExists(value)
             }
         }
     }
diff --git a/src/main/kotlin/com/haulmont/cuba/cli/cubaplugin/editscreen/CreateEditScreenCommand.kt b/src/main/kotlin/com/haulmont/cuba/cli/cubaplugin/editscreen/CreateEditScreenCommand.kt
@@ -20,7 +20,10 @@ import com.beust.jcommander.Parameters
 import com.haulmont.cuba.cli.ModuleStructure
 import com.haulmont.cuba.cli.cubaplugin.CubaPlugin
 import com.haulmont.cuba.cli.cubaplugin.ScreenCommandBase
-import com.haulmont.cuba.cli.generation.*
+import com.haulmont.cuba.cli.generation.Properties
+import com.haulmont.cuba.cli.generation.TemplateProcessor
+import com.haulmont.cuba.cli.generation.getChildElements
+import com.haulmont.cuba.cli.generation.parse
 import com.haulmont.cuba.cli.prompting.Answers
 import com.haulmont.cuba.cli.prompting.QuestionsList
 import net.sf.practicalxml.DomUtil
@@ -65,6 +68,10 @@ class CreateEditScreenCommand : ScreenCommandBase<EditScreenModel>() {
 
                 projectModel.namespace + "$" + entityName.split('.').last() + ".edit"
             }
+
+            validate {
+                screenIdDoesNotExists(value)
+            }
         }
 
         question("descriptorName", "Descriptor name") {
@@ -76,6 +83,8 @@ class CreateEditScreenCommand : ScreenCommandBase<EditScreenModel>() {
 
             validate {
                 checkIsScreenDescriptor()
+
+                screenDescriptorDoesNotExists(value)
             }
         }
 
@@ -84,6 +93,8 @@ class CreateEditScreenCommand : ScreenCommandBase<EditScreenModel>() {
 
             validate {
                 checkIsClass()
+
+                screenControllerDoesNotExists(value)
             }
         }
     }
diff --git a/src/main/kotlin/com/haulmont/cuba/cli/cubaplugin/screenextension/ExtendDefaultScreenCommand.kt b/src/main/kotlin/com/haulmont/cuba/cli/cubaplugin/screenextension/ExtendDefaultScreenCommand.kt
@@ -36,6 +36,46 @@ class ExtendDefaultScreenCommand : ScreenCommandBase<ScreenExtensionModel>() {
         question("packageName", "Package name") {
             default(projectModel.rootPackage + ".web.screens")
         }
+        question("screenId", "Screen with default id already exists. Specify new id.") {
+            askIf {
+                if (it["screen"] == "login") {
+                    screenRegistrationHelper.isScreenIdExists("loginWindow")
+                } else {
+                    screenRegistrationHelper.isScreenIdExists("mainWindow")
+                }
+            }
+            validate {
+                screenIdDoesNotExists(value)
+            }
+        }
+
+        question("descriptorName", "Descriptor name") {
+            askIf {
+                if (it["screen"] == "login") {
+                    screenRegistrationHelper.isDescriptorExists(it["packageName"] as String, "ext-loginWindow")
+                } else {
+                    screenRegistrationHelper.isDescriptorExists(it["packageName"] as String, "ext-mainwindow")
+                }
+            }
+            validate {
+                checkIsScreenDescriptor()
+                screenDescriptorDoesNotExists(value)
+            }
+        }
+
+        question("controllerName", "Controller name") {
+            askIf {
+                if (it["screen"] == "login") {
+                    screenRegistrationHelper.isControllerExists(it["packageName"] as String, "ExtAppLoginWindow")
+                } else {
+                    screenRegistrationHelper.isDescriptorExists(it["packageName"] as String, "ExtAppMainWindow")
+                }
+            }
+            validate {
+                checkIsClass()
+                screenControllerDoesNotExists(value)
+            }
+        }
     }
 
     override fun createModel(answers: Answers): ScreenExtensionModel = ScreenExtensionModel(answers)
@@ -53,7 +93,7 @@ class ExtendDefaultScreenCommand : ScreenCommandBase<ScreenExtensionModel>() {
 
         val webModule = projectStructure.getModule(WEB_MODULE)
 
-        addToScreensXml(model.id, model.packageName, model.descriptor)
+        addToScreensXml(model.id, model.packageName, model.descriptorName)
 
         val messages = webModule.resolvePackagePath(model.packageName).resolve("messages.properties")
 
diff --git a/src/main/kotlin/com/haulmont/cuba/cli/cubaplugin/screenextension/ScreenExtensionModel.kt b/src/main/kotlin/com/haulmont/cuba/cli/cubaplugin/screenextension/ScreenExtensionModel.kt
@@ -22,15 +22,18 @@ class ScreenExtensionModel(answers: Answers) {
     val screen: String by answers
     val packageName: String by answers
     val id: String
-    val descriptor: String
+    val descriptorName: String
+    val controllerName: String
 
     init {
         if (screen == "login") {
-            id = "loginWindow"
-            descriptor = "ext-loginWindow"
+            id = answers["screenId"] as String? ?: "loginWindow"
+            descriptorName = answers["descriptorName"] as String? ?: "ext-loginWindow"
+            controllerName = answers["controllerName"] as String? ?: "ExtAppLoginWindow"
         } else {
-            id = "mainWindow"
-            descriptor = "ext-mainwindow"
+            id = answers["screenId"] as String? ?: "mainWindow"
+            descriptorName = answers["descriptorName"] as String? ?: "ext-mainwindow"
+            controllerName = answers["controllerName"] as String? ?: "ExtAppMainWindow"
         }
     }
 
diff --git a/src/main/kotlin/com/haulmont/cuba/cli/registration/ScreenRegistrationHelper.kt b/src/main/kotlin/com/haulmont/cuba/cli/registration/ScreenRegistrationHelper.kt
@@ -42,24 +42,37 @@ class ScreenRegistrationHelper {
         }
     }
 
-    fun checkScreenId(screenId: String) {
-        parse(screensXml).documentElement
+    fun isScreenIdExists(screenId: String): Boolean {
+        return parse(screensXml).documentElement
                 .xpath("//screen[@id=\"$screenId\"]")
-                .firstOrNull()?.let {
-                    throw CommandExecutionException("Screen with id \"$screenId\" already exists")
-                }
+                .firstOrNull() != null
     }
 
-    fun checkExistence(packageName: String, descriptor: String? = null, controller: String? = null) {
+    fun isDescriptorExists(packageName: String, descriptor: String): Boolean {
+        val packagePath = ProjectStructure().getModule(ModuleStructure.WEB_MODULE).resolvePackagePath(packageName)
+
+        return Files.exists(packagePath.resolve("$descriptor.xml"))
+    }
+
+    fun isControllerExists(packageName: String, controller: String): Boolean {
         val packagePath = ProjectStructure().getModule(ModuleStructure.WEB_MODULE).resolvePackagePath(packageName)
 
+        return Files.exists(packagePath.resolve("$controller.java"))
+    }
+
+    fun checkScreenId(screenId: String) {
+        if (isScreenIdExists(screenId))
+            throw CommandExecutionException("Screen with id \"$screenId\" already exists")
+    }
+
+    fun checkExistence(packageName: String, descriptor: String? = null, controller: String? = null) {
         descriptor?.let {
-            ensureFileAbsence(packagePath.resolve("$descriptor.xml"),
-                    cause = "Screen descriptor $packageName.$descriptor.xml already exists")
+            if (isDescriptorExists(packageName, descriptor))
+                throw CommandExecutionException("Screen descriptor $packageName.$descriptor.xml already exists")
         }
         controller?.let {
-            ensureFileAbsence(packagePath.resolve("$controller.java"),
-                    cause = "Screen controller $packageName.$controller already exists")
+            if (isControllerExists(packageName, controller))
+                throw CommandExecutionException("Screen controller $packageName.$controller already exists")
         }
     }
 
@@ -84,10 +97,4 @@ class ScreenRegistrationHelper {
             set("menu-config.$screenId", caption)
         }
     }
-
-    private fun ensureFileAbsence(file: Path, cause: String, silent: Boolean = false) {
-        if (Files.exists(file))
-            throw CommandExecutionException(cause, silent = silent)
-    }
-
 }
diff --git a/src/main/resources/com/haulmont/cuba/cli/cubaplugin/templates/screenExtension/login/modules/web/src/$[screen.packageName]/${screen.controllerName}.java b/src/main/resources/com/haulmont/cuba/cli/cubaplugin/templates/screenExtension/login/modules/web/src/$[screen.packageName]/${screen.controllerName}.java
@@ -2,5 +2,5 @@
 
 import com.haulmont.cuba.web.app.loginwindow.AppLoginWindow;
 
-public class ExtAppLoginWindow extends AppLoginWindow {
+public class ${screen.controllerName} extends AppLoginWindow {
 }
diff --git a/src/main/resources/com/haulmont/cuba/cli/cubaplugin/templates/screenExtension/login/modules/web/src/$[screen.packageName]/${screen.descriptorName}.xml b/src/main/resources/com/haulmont/cuba/cli/cubaplugin/templates/screenExtension/login/modules/web/src/$[screen.packageName]/${screen.descriptorName}.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <window xmlns="http://schemas.haulmont.com/cuba/window.xsd"
-        class="${screen.packageName}.ExtAppLoginWindow"
+        class="${screen.packageName}.${screen.controllerName}"
         extends="/com/haulmont/cuba/web/app/loginwindow/loginwindow.xml"
         messagesPack="${screen.packageName}">
     <dialogMode height="600"
diff --git a/src/main/resources/com/haulmont/cuba/cli/cubaplugin/templates/screenExtension/main/modules/web/src/$[screen.packageName]/${screen.controllerName}.java b/src/main/resources/com/haulmont/cuba/cli/cubaplugin/templates/screenExtension/main/modules/web/src/$[screen.packageName]/${screen.controllerName}.java
diff --git a/src/main/resources/com/haulmont/cuba/cli/cubaplugin/templates/screenExtension/main/modules/web/src/$[screen.packageName]/${screen.descriptorName}.xml b/src/main/resources/com/haulmont/cuba/cli/cubaplugin/templates/screenExtension/main/modules/web/src/$[screen.packageName]/${screen.descriptorName}.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <window xmlns="http://schemas.haulmont.com/cuba/window.xsd"
-        class="${screen.packageName}.ExtAppMainWindow"
+        class="${screen.packageName}.${screen.controllerName}"
         extends="/com/haulmont/cuba/web/app/mainwindow/mainwindow.xml"
         messagesPack="${screen.packageName}"
         xmlns:main="http://schemas.haulmont.com/cuba/mainwindow.xsd">

Original file line number	Diff line number	Diff line change
`@@ -68,6 +68,10 @@ class CreateBrowseScreenCommand : ScreenCommandBase<BrowseScreenModel>() {`
`68`	`68`
`69`	`69`	`projectModel.namespace + "$" + entityName.split('.').last() + ".browse"`
`70`	`70`	`}`
	`71`	`+`
	`72`	`+ validate {`
	`73`	`+ screenIdDoesNotExists(value)`
	`74`	`+ }`
`71`	`75`	`}`
`72`	`76`
`73`	`77`	`question("descriptorName", "Descriptor name") {`
`@@ -79,6 +83,8 @@ class CreateBrowseScreenCommand : ScreenCommandBase<BrowseScreenModel>() {`
`79`	`83`
`80`	`84`	`validate {`
`81`	`85`	`checkIsScreenDescriptor()`
	`86`	`+`
	`87`	`+ screenDescriptorDoesNotExists(value)`
`82`	`88`	`}`
`83`	`89`	`}`
`84`	`90`
`@@ -87,6 +93,8 @@ class CreateBrowseScreenCommand : ScreenCommandBase<BrowseScreenModel>() {`
`87`	`93`
`88`	`94`	`validate {`
`89`	`95`	`checkIsClass()`
	`96`	`+`
	`97`	`+ screenControllerDoesNotExists(value)`
`90`	`98`	`}`
`91`	`99`	`}`
`92`	`100`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,10 @@ import com.beust.jcommander.Parameters`
`20`	`20`	`import com.haulmont.cuba.cli.ModuleStructure`
`21`	`21`	`import com.haulmont.cuba.cli.cubaplugin.CubaPlugin`
`22`	`22`	`import com.haulmont.cuba.cli.cubaplugin.ScreenCommandBase`
`23`		`-import com.haulmont.cuba.cli.generation.*`
	`23`	`+import com.haulmont.cuba.cli.generation.Properties`
	`24`	`+import com.haulmont.cuba.cli.generation.TemplateProcessor`
	`25`	`+import com.haulmont.cuba.cli.generation.getChildElements`
	`26`	`+import com.haulmont.cuba.cli.generation.parse`
`24`	`27`	`import com.haulmont.cuba.cli.prompting.Answers`
`25`	`28`	`import com.haulmont.cuba.cli.prompting.QuestionsList`
`26`	`29`	`import net.sf.practicalxml.DomUtil`
`@@ -65,6 +68,10 @@ class CreateEditScreenCommand : ScreenCommandBase<EditScreenModel>() {`
`65`	`68`
`66`	`69`	`projectModel.namespace + "$" + entityName.split('.').last() + ".edit"`
`67`	`70`	`}`
	`71`	`+`
	`72`	`+ validate {`
	`73`	`+ screenIdDoesNotExists(value)`
	`74`	`+ }`
`68`	`75`	`}`
`69`	`76`
`70`	`77`	`question("descriptorName", "Descriptor name") {`
`@@ -76,6 +83,8 @@ class CreateEditScreenCommand : ScreenCommandBase<EditScreenModel>() {`
`76`	`83`
`77`	`84`	`validate {`
`78`	`85`	`checkIsScreenDescriptor()`
	`86`	`+`
	`87`	`+ screenDescriptorDoesNotExists(value)`
`79`	`88`	`}`
`80`	`89`	`}`
`81`	`90`
`@@ -84,6 +93,8 @@ class CreateEditScreenCommand : ScreenCommandBase<EditScreenModel>() {`
`84`	`93`
`85`	`94`	`validate {`
`86`	`95`	`checkIsClass()`
	`96`	`+`
	`97`	`+ screenControllerDoesNotExists(value)`
`87`	`98`	`}`
`88`	`99`	`}`
`89`	`100`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,5 +2,5 @@`
`2`	`2`
`3`	`3`	`import com.haulmont.cuba.web.app.loginwindow.AppLoginWindow;`
`4`	`4`
`5`		`-public class ExtAppLoginWindow extends AppLoginWindow {`
	`5`	`+public class ${screen.controllerName} extends AppLoginWindow {`
`6`	`6`	`}`