Refactor ActiveProjectHelper to manage current active project state and update usages

Author: xterao

src/main/kotlin/org/domaframework/doma/intellij/common/helper/ActiveProjectHelper.kt

@@ -20,18 +20,29 @@ import com.intellij.openapi.project.ProjectManager
 import com.intellij.openapi.wm.IdeFocusManager
 
 object ActiveProjectHelper {
-    val activeProject: Project?
-        get() {
-            val openProjects: Array<out Project> = ProjectManager.getInstance().openProjects
-            var activeProject: Project? = null
+    private var activeProject: Project? = null
 
-            for (project in openProjects) {
-                if (IdeFocusManager.getInstance(project).focusOwner != null) {
-                    activeProject = project
-                    break
-                }
-            }
+    fun setCurrentActiveProject(value: Project?) {
+        activeProject = value
+    }
+
+    fun getCurrentActiveProject(): Project? {
+        val initProject = activeProject
+        val active = getActiveUIProject()
+        return active ?: initProject
+    }
+
+    private fun getActiveUIProject(): Project? {
+        val openProjects: Array<out Project> = ProjectManager.getInstance().openProjects
+        var active: Project? = null
 
-            return activeProject
+        for (project in openProjects) {
+            if (IdeFocusManager.getInstance(project).focusOwner != null) {
+                active = project
+                break
+            }
         }
+
+        return active
+    }
 }

src/main/kotlin/org/domaframework/doma/intellij/formatter/SqlFormattingModelBuilder.kt

@@ -34,10 +34,9 @@ import org.domaframework.doma.intellij.setting.state.DomaToolsFormatEnableSettin
 class SqlFormattingModelBuilder : FormattingModelBuilder {
     override fun createModel(formattingContext: FormattingContext): FormattingModel {
         val codeStyleSettings = formattingContext.codeStyleSettings
-        val project = ActiveProjectHelper.activeProject
+        val project = ActiveProjectHelper.getCurrentActiveProject()
         val setting = project?.let { DomaToolsFormatEnableSettings.getInstance(it) }
         val isEnableFormat = setting?.state?.isEnableSqlFormat == true
-
         val spacingBuilder =
             if (!isEnableFormat) {
                 SpacingBuilder(codeStyleSettings, SqlLanguage.INSTANCE)

src/main/kotlin/org/domaframework/doma/intellij/setting/DomaToolsConfigurable.kt

@@ -24,7 +24,7 @@ import javax.swing.JComponent
 
 class DomaToolsConfigurable : Configurable {
     private var mySettingsComponent: SettingComponent? = SettingComponent()
-    private val project = ActiveProjectHelper.activeProject
+    private val project = ActiveProjectHelper.getCurrentActiveProject()
 
     private var formatSettings: DomaToolsFormatEnableSettings? = null
     private var customFunctionsSettings: DomaToolsCustomFunctionSettings? = null

src/main/kotlin/org/domaframework/doma/intellij/setting/SettingComponent.kt

@@ -44,7 +44,7 @@ class SettingComponent {
             ToolbarDecorator
                 .createDecorator(customFunctionClassList)
                 .setAddAction { actionButton ->
-                    val project = ActiveProjectHelper.activeProject
+                    val project = ActiveProjectHelper.getCurrentActiveProject()
                     if (project != null) {
                         val expressionFunction = ExpressionFunctionsHelper
                         val expressionFunctionInterface =
@@ -87,7 +87,7 @@ class SettingComponent {
                 .createPanel()
 
         // Disable customFunctionPanel if no active project is available
-        if (ActiveProjectHelper.activeProject == null) {
+        if (ActiveProjectHelper.getCurrentActiveProject() == null) {
             setEnabledRecursively(customFunctionPanel, false)
         }
 

src/test/kotlin/org/domaframework/doma/intellij/DomaSqlTest.kt

@@ -29,6 +29,8 @@ import com.intellij.psi.PsiClass
 import com.intellij.testFramework.PsiTestUtil
 import com.intellij.testFramework.fixtures.LightJavaCodeInsightFixtureTestCase
 import org.domaframework.doma.intellij.extension.getResourcesSQLFile
+import org.domaframework.doma.intellij.setting.SettingComponent
+import org.domaframework.doma.intellij.setting.state.DomaToolsCustomFunctionSettings
 import org.jetbrains.jps.model.java.JavaResourceRootType
 import org.jetbrains.jps.model.java.JavaSourceRootType
 import org.junit.Ignore
@@ -97,7 +99,8 @@ open class DomaSqlTest : LightJavaCodeInsightFixtureTestCase() {
     }
 
     private fun setUpJdk(module: Module) {
-        val newJdk = JavaSdk.getInstance().createJdk("Doma Test JDK", System.getProperty("java.home"), false)
+        val newJdk =
+            JavaSdk.getInstance().createJdk("Doma Test JDK", System.getProperty("java.home"), false)
 
         WriteAction.runAndWait<RuntimeException> {
             ProjectJdkTable.getInstance().addJdk(newJdk)
@@ -181,4 +184,20 @@ open class DomaSqlTest : LightJavaCodeInsightFixtureTestCase() {
         assertNotNull("Not Found [$testDaoName]", dao)
         return dao
     }
+
+    protected fun addExpressionJavaFile(fileName: String) {
+        val file = File("$testDataPath/java/$packagePath/expression/$fileName")
+        myFixture.addFileToProject(
+            "main/java/$packagePath/entity/$fileName",
+            file.readText(),
+        )
+    }
+
+    protected fun settingCustomFunctions(newClassNames: MutableList<String>) {
+        val settings = DomaToolsCustomFunctionSettings.getInstance(project)
+        val component = SettingComponent()
+        component.customFunctionClassNames = newClassNames.toMutableList()
+        settings.apply(component)
+        assertEquals(newClassNames, settings.getState().customFunctionClassNames)
+    }
 }

src/test/kotlin/org/domaframework/doma/intellij/formatter/SqlFormatterTest.kt

@@ -19,6 +19,8 @@ import com.intellij.openapi.command.WriteCommandAction
 import com.intellij.psi.codeStyle.CodeStyleManager
 import com.intellij.testFramework.fixtures.BasePlatformTestCase
 import com.intellij.util.ThrowableRunnable
+import org.domaframework.doma.intellij.common.helper.ActiveProjectHelper
+import org.domaframework.doma.intellij.setting.SettingComponent
 import org.domaframework.doma.intellij.setting.state.DomaToolsFormatEnableSettings
 
 class SqlFormatterTest : BasePlatformTestCase() {
@@ -28,56 +30,66 @@ class SqlFormatterTest : BasePlatformTestCase() {
 
     override fun setUp() {
         super.setUp()
-        val settings = DomaToolsFormatEnableSettings.getInstance(myFixture.project)
-        settings.state.isEnableSqlFormat = true
+        settingSqlFormat(true)
+        if (project != null) {
+            ActiveProjectHelper.setCurrentActiveProject(project)
+        }
+    }
+
+    private fun settingSqlFormat(enabled: Boolean) {
+        val settings = DomaToolsFormatEnableSettings.getInstance(project)
+        val component = SettingComponent()
+        component.enableFormat = enabled
+        settings.apply(component)
+        assertEquals(enabled, settings.getState().isEnableSqlFormat)
     }
 
     override fun tearDown() {
         try {
-            val settings = DomaToolsFormatEnableSettings.getInstance(myFixture.project)
-            settings.state.isEnableSqlFormat = false
+            settingSqlFormat(false)
+            ActiveProjectHelper.setCurrentActiveProject(null)
         } finally {
             super.tearDown()
         }
     }
 
     fun testSelectFormatter() {
-        formatSqlFime("Select.sql", "FormattedSelect.sql")
+        formatSqlFile("Select.sql", "FormattedSelect.sql")
     }
 
     fun testCreateTableFormatter() {
-        formatSqlFime("CreateTable.sql", "FormattedCreateTable.sql")
+        formatSqlFile("CreateTable.sql", "FormattedCreateTable.sql")
     }
 
     fun testCreateViewFormatter() {
-        formatSqlFime("CreateView.sql", "FormattedCreateView.sql")
+        formatSqlFile("CreateView.sql", "FormattedCreateView.sql")
     }
 
     fun testInsertFormatter() {
-        formatSqlFime("Insert.sql", "FormattedInsert.sql")
+        formatSqlFile("Insert.sql", "FormattedInsert.sql")
     }
 
     fun testInsertWithBindVariableFormatter() {
-        formatSqlFime("InsertWithBindVariable.sql", "FormattedInsertWithBindVariable.sql")
+        formatSqlFile("InsertWithBindVariable.sql", "FormattedInsertWithBindVariable.sql")
     }
 
     fun testUpdateFormatter() {
-        formatSqlFime("Update.sql", "FormattedUpdate.sql")
+        formatSqlFile("Update.sql", "FormattedUpdate.sql")
     }
 
     fun testUpdateBindVariableFormatter() {
-        formatSqlFime("UpdateBindVariable.sql", "FormattedUpdateBindVariable.sql")
+        formatSqlFile("UpdateBindVariable.sql", "FormattedUpdateBindVariable.sql")
     }
 
     fun testUpdateTupleAssignmentFormatter() {
-        formatSqlFime("UpdateTupleAssignment.sql", "FormattedUpdateTupleAssignment.sql")
+        formatSqlFile("UpdateTupleAssignment.sql", "FormattedUpdateTupleAssignment.sql")
     }
 
     fun testDeleteFormatter() {
-        formatSqlFime("Delete.sql", "FormattedDelete.sql")
+        formatSqlFile("Delete.sql", "FormattedDelete.sql")
     }
 
-    private fun formatSqlFime(
+    private fun formatSqlFile(
         beforeFile: String,
         afterFile: String,
     ) {