Refactor SQL file path handling to use module resources and improve configuration retrieval

xterao · xterao · commit 8cb806b1f7f4 · 2025-07-02T19:40:01.000+09:00
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/common/config/DomaCompileConfigUtil.kt b/src/main/kotlin/org/domaframework/doma/intellij/common/config/DomaCompileConfigUtil.kt
@@ -15,9 +15,8 @@
  */
 package org.domaframework.doma.intellij.common.config
 
-import com.intellij.openapi.project.Project
-import com.intellij.openapi.vfs.VirtualFile
-import org.domaframework.doma.intellij.common.CommonPathParameterUtil
+import com.intellij.openapi.module.Module
+import org.domaframework.doma.intellij.extension.getResourcesFile
 import java.util.concurrent.ConcurrentHashMap
 
 object DomaCompileConfigUtil {
@@ -30,40 +29,34 @@ object DomaCompileConfigUtil {
 
     /**
      * Get the value of the specified key from doma.compile.config
-     * @param project active project
-     * @param resourcePaths the path to the resource directories
+     * @param module the module to retrieve the configuration from
+     * @param isTest true if the configuration is for test sources, false for main sources
      * @param key the key to retrieve the value for
      * @return the value associated with the key, or null if not found
      */
     fun getConfigValue(
-        project: Project,
-        resourcePaths: List<VirtualFile>,
+        module: Module,
+        isTest: Boolean,
         key: String,
     ): String? {
-        resourcePaths.forEach { resourcePath ->
-            if (resourcePath.isValid) {
-                val configVFile = resourcePath.findChild("doma.compile.config")
-                val cacheKey = "${project.basePath}/${resourcePath.path}/doma.compile.config"
-                val lastModified = configVFile?.timeStamp ?: 0L
-                val cached = configCache[cacheKey]
+        val settingFileName = "doma.compile.config"
+        val settingFile = module.getResourcesFile(settingFileName, isTest)
+        val cacheKey = "${settingFile?.path}/$settingFileName"
+        val lastModified = settingFile?.timeStamp ?: 0L
+        val cached = configCache[cacheKey]
 
-                val props =
-                    if (cached == null || cached.second != lastModified) {
-                        val loadedProps =
-                            configVFile?.inputStream?.use { input ->
-                                java.util.Properties().apply { load(input) }
-                            } ?: java.util.Properties()
-                        configCache[cacheKey] = loadedProps to lastModified
-                        loadedProps
-                    } else {
-                        cached.first
-                    }
-                val propProperty = props.getProperty(key)
-                if (propProperty != null) return propProperty
+        val props =
+            if (cached == null || cached.second != lastModified) {
+                val loadedProps =
+                    settingFile?.inputStream?.use { input ->
+                        java.util.Properties().apply { load(input) }
+                    } ?: java.util.Properties()
+                configCache[cacheKey] = loadedProps to lastModified
+                loadedProps
             } else {
-                CommonPathParameterUtil.clearCache()
+                cached.first
             }
-        }
-        return null
+        val propProperty = props.getProperty(key)
+        return propProperty
     }
 }
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/common/psi/PsiDaoMethod.kt b/src/main/kotlin/org/domaframework/doma/intellij/common/psi/PsiDaoMethod.kt
@@ -39,7 +39,7 @@ import org.domaframework.doma.intellij.common.getExtension
 import org.domaframework.doma.intellij.extension.findFile
 import org.domaframework.doma.intellij.extension.getContentRoot
 import org.domaframework.doma.intellij.extension.getModule
-import org.domaframework.doma.intellij.extension.getResourcesSQLFile
+import org.domaframework.doma.intellij.extension.getResourcesFile
 import org.domaframework.doma.intellij.extension.getSourceRootDir
 import org.domaframework.doma.intellij.extension.psi.DomaAnnotationType
 import org.domaframework.doma.intellij.setting.SqlLanguage
@@ -142,14 +142,10 @@ class PsiDaoMethod(
                 return
             } else {
                 sqlFile =
-                    if (sqlFilePath.isNotEmpty()) {
-                        module.getResourcesSQLFile(
-                            sqlFilePath,
-                            isTest,
-                        )
-                    } else {
-                        null
-                    }
+                    module.getResourcesFile(
+                        sqlFilePath,
+                        isTest,
+                    )
                 return
             }
         }
@@ -185,7 +181,7 @@ class PsiDaoMethod(
             val isTest = CommonPathParameterUtil.isTest(module, daoFile)
 
             val sqlDir = sqlFilePath.replace("/$sqlFileName", "")
-            val existSqlDir = module.getResourcesSQLFile("$RESOURCES_META_INF_PATH/$sqlDir", isTest)
+            val existSqlDir = module.getResourcesFile(sqlDir, isTest)
             val resourceDir = existSqlDir ?.let { psiProject.getSourceRootDir(it) }
             val resourcesDirPath = resourceDir?.nameWithoutExtension ?: "resources"
 
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/common/sql/directive/collector/FunctionCallCollector.kt b/src/main/kotlin/org/domaframework/doma/intellij/common/sql/directive/collector/FunctionCallCollector.kt
@@ -36,23 +36,15 @@ class FunctionCallCollector(
     public override fun collect(): List<LookupElement>? {
         var functions = mutableSetOf<PsiMethod>()
         val project = file?.project
-        val module = file?.module
-        val resourcePaths =
-            if (file?.virtualFile != null && module != null) {
-                CommonPathParameterUtil
-                    .getResources(module, file.virtualFile)
-            } else {
-                emptyList()
-            }
+        val module = file?.module ?: return null
+        val isTest = CommonPathParameterUtil.isTest(module, file.virtualFile)
 
         val customFunctionClassName =
-            project?.let {
-                DomaCompileConfigUtil.getConfigValue(
-                    it,
-                    resourcePaths,
-                    "doma.expr.functions",
-                )
-            }
+            DomaCompileConfigUtil.getConfigValue(
+                module,
+                isTest,
+                "doma.expr.functions",
+            )
 
         val expressionFunctionInterface =
             project?.let { ExpressionFunctionsHelper.setExpressionFunctionsInterface(it) }
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/extension/ModuleExtensions.kt b/src/main/kotlin/org/domaframework/doma/intellij/extension/ModuleExtensions.kt
@@ -34,7 +34,7 @@ fun Module.getPackagePathFromDaoPath(daoFile: VirtualFile): VirtualFile? {
             getRelativeSqlFilePathFromDaoFilePath(daoFile, this)
         } ?: ""
     val isTest = CommonPathParameterUtil.isTest(this, daoFile)
-    return this.getResourcesSQLFile(
+    return this.getResourcesFile(
         packagePath,
         isTest,
     )
@@ -57,7 +57,7 @@ fun Module.getJavaClazz(
  * @param includeTest true: test source, false: main source
  * @return SQL file
  */
-fun Module.getResourcesSQLFile(
+fun Module.getResourcesFile(
     relativePath: String,
     includeTest: Boolean,
 ): VirtualFile? =
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/processor/InspectionFunctionCallVisitorProcessor.kt b/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/processor/InspectionFunctionCallVisitorProcessor.kt
@@ -34,15 +34,13 @@ class InspectionFunctionCallVisitorProcessor(
 ) : InspectionVisitorProcessor(shortName) {
     fun check(holder: ProblemsHolder) {
         val project = element.project
+        val module = element.module ?: return
         val expressionHelper = ExpressionFunctionsHelper
         val expressionFunctionalInterface = expressionHelper.setExpressionFunctionsInterface(project)
         val functionName = element.elIdExpr
 
-        val resources =
-            element.module
-                ?.let { CommonPathParameterUtil.getResources(it, element.containingFile.virtualFile) }
-                ?: emptyList()
-        val customFunctionClassName = DomaCompileConfigUtil.getConfigValue(project, resources, "doma.expr.functions")
+        val isTest = CommonPathParameterUtil.isTest(module, element.containingFile.virtualFile)
+        val customFunctionClassName = DomaCompileConfigUtil.getConfigValue(module, isTest, "doma.expr.functions")
 
         var result: ValidationResult =
             ValidationInvalidFunctionCallResult(
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/refactoring/dao/DaoPackageRenameListenerProcessor.kt b/src/main/kotlin/org/domaframework/doma/intellij/refactoring/dao/DaoPackageRenameListenerProcessor.kt
@@ -33,7 +33,7 @@ import org.domaframework.doma.intellij.common.CommonPathParameterUtil
 import org.domaframework.doma.intellij.common.RESOURCES_META_INF_PATH
 import org.domaframework.doma.intellij.common.dao.getDaoClass
 import org.domaframework.doma.intellij.common.util.PluginLoggerUtil
-import org.domaframework.doma.intellij.extension.getResourcesSQLFile
+import org.domaframework.doma.intellij.extension.getResourcesFile
 import org.jetbrains.kotlin.idea.base.util.module
 import java.io.IOException
 
@@ -149,7 +149,7 @@ class DaoPackageRenameListenerProcessor : RefactoringElementListenerProvider {
                         try {
                             val newDir = VfsUtil.createDirectories(newPath)
                             val oldResourcePath =
-                                module.getResourcesSQLFile(
+                                module.getResourcesFile(
                                     RESOURCES_META_INF_PATH + "/" + oldQualifiedName.replace(".", "/"),
                                     isTest,
                                 )
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/reference/SqlElFunctionCallExprReference.kt b/src/main/kotlin/org/domaframework/doma/intellij/reference/SqlElFunctionCallExprReference.kt
@@ -37,22 +37,20 @@ class SqlElFunctionCallExprReference(
         val variableName = functionCallExpr.elIdExpr.text ?: ""
 
         val project = element.project
-        val module = file.module
+        val module = file.module ?: return null
         val expressionFunctionsInterface =
             ExpressionFunctionsHelper.setExpressionFunctionsInterface(project)
                 ?: return null
 
-        val resourcePaths =
-            module?.let {
-                CommonPathParameterUtil
-                    .getResources(it, file.virtualFile)
-            } ?: emptyList()
-
-        val customFunctionClassName = DomaCompileConfigUtil.getConfigValue(project, resourcePaths, "doma.expr.functions")
+        val isTest =
+            CommonPathParameterUtil
+                .isTest(module, file.virtualFile)
+        val customFunctionClassName = DomaCompileConfigUtil.getConfigValue(module, isTest, "doma.expr.functions")
 
         val implementsClass =
             if (customFunctionClassName != null) {
-                val expressionFunction = project.getJavaClazz(customFunctionClassName)
+                val customFunctionClass = customFunctionClassName
+                val expressionFunction = project.getJavaClazz(customFunctionClass)
                 if (ExpressionFunctionsHelper.isInheritor(expressionFunction)) {
                     expressionFunction
                 } else {
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/setting/DomaToolStartupActivity.kt b/src/main/kotlin/org/domaframework/doma/intellij/setting/DomaToolStartupActivity.kt
@@ -17,6 +17,7 @@ package org.domaframework.doma.intellij.setting
 
 import com.intellij.openapi.application.PathManager
 import com.intellij.openapi.project.Project
+import com.intellij.openapi.roots.ModuleRootListener
 import com.intellij.openapi.startup.ProjectActivity
 import org.domaframework.doma.intellij.common.util.PluginUtil
 
@@ -36,6 +37,9 @@ class DomaToolStartupActivity : ProjectActivity {
     }
 
     private fun registerModuleRootListener(project: Project) {
-        DomaToolsModuleRootListener.updateModuleDirectoryCache(project)
+        project.messageBus.connect().subscribe(
+            ModuleRootListener.TOPIC,
+            DomaToolsModuleRootListener(project),
+        )
     }
 }
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/setting/DomaToolsModuleRootListener.kt b/src/main/kotlin/org/domaframework/doma/intellij/setting/DomaToolsModuleRootListener.kt
@@ -21,9 +21,10 @@ import com.intellij.openapi.roots.ModuleRootEvent
 import com.intellij.openapi.roots.ModuleRootListener
 import org.domaframework.doma.intellij.common.CommonPathParameterUtil
 
-object DomaToolsModuleRootListener : ModuleRootListener {
+class DomaToolsModuleRootListener(
+    private val project: Project,
+) : ModuleRootListener {
     override fun rootsChanged(event: ModuleRootEvent) {
-        val project = event.source as? Project ?: return
         updateModuleDirectoryCache(project)
     }
 
diff --git a/src/main/resources/META-INF/plugin.xml b/src/main/resources/META-INF/plugin.xml
@@ -93,11 +93,6 @@
     <supportsKotlinPluginMode supportsK2="true"/>
   </extensions>
 
-  <projectListeners>
-    <listener class="org.domaframework.doma.intellij.setting.DomaToolsModuleRootListener"
-      topic="com.intellij.openapi.roots.ModuleRootListener" />
-  </projectListeners>
-
   <!-- Action -->
   <actions>
     <group
diff --git a/src/test/kotlin/org/domaframework/doma/intellij/DomaSqlTest.kt b/src/test/kotlin/org/domaframework/doma/intellij/DomaSqlTest.kt
@@ -30,7 +30,7 @@ import com.intellij.testFramework.PsiTestUtil
 import com.intellij.testFramework.fixtures.LightJavaCodeInsightFixtureTestCase
 import org.domaframework.doma.intellij.common.CommonPathParameterUtil
 import org.domaframework.doma.intellij.common.RESOURCES_META_INF_PATH
-import org.domaframework.doma.intellij.extension.getResourcesSQLFile
+import org.domaframework.doma.intellij.extension.getResourcesFile
 import org.jetbrains.jps.model.java.JavaResourceRootType
 import org.jetbrains.jps.model.java.JavaSourceRootType
 import org.junit.Ignore
@@ -231,7 +231,7 @@ open class DomaSqlTest : LightJavaCodeInsightFixtureTestCase() {
     ): VirtualFile? {
         val module = myFixture.module
         val sqlFileName = "$RESOURCES_META_INF_PATH/$packageName/dao/$sqlName"
-        return module?.getResourcesSQLFile(
+        return module?.getResourcesFile(
             sqlFileName,
             false,
         )

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ package org.domaframework.doma.intellij.setting`
`17`	`17`
`18`	`18`	`import com.intellij.openapi.application.PathManager`
`19`	`19`	`import com.intellij.openapi.project.Project`
	`20`	`+import com.intellij.openapi.roots.ModuleRootListener`
`20`	`21`	`import com.intellij.openapi.startup.ProjectActivity`
`21`	`22`	`import org.domaframework.doma.intellij.common.util.PluginUtil`
`22`	`23`
`@@ -36,6 +37,9 @@ class DomaToolStartupActivity : ProjectActivity {`
`36`	`37`	`}`
`37`	`38`
`38`	`39`	`private fun registerModuleRootListener(project: Project) {`
`39`		`- DomaToolsModuleRootListener.updateModuleDirectoryCache(project)`
	`40`	`+ project.messageBus.connect().subscribe(`
	`41`	`+ ModuleRootListener.TOPIC,`
	`42`	`+ DomaToolsModuleRootListener(project),`
	`43`	`+ )`
`40`	`44`	`}`
`41`	`45`	`}`