Merge pull request #373 from domaframework/fix/ignore-specific-dao-method-parameters

Exclude Specific DAO Parameter Types from SQL Bind Variable Suggestions

Author: xterao

src/main/kotlin/org/domaframework/doma/intellij/common/util/TypeUtil.kt

@@ -49,7 +49,7 @@ object TypeUtil {
         type: PsiType?,
         project: Project,
     ): Boolean {
-        val clazz = type?.canonicalText?.let { project.getJavaClazz(it) }
+        val clazz = type?.let { project.getJavaClazz(type) }
         return clazz?.isEntity() == true
     }
 

src/main/kotlin/org/domaframework/doma/intellij/extension/ProjectExtensions.kt

@@ -22,8 +22,10 @@ import com.intellij.openapi.roots.ProjectRootManager
 import com.intellij.openapi.vfs.VirtualFile
 import com.intellij.psi.JavaPsiFacade
 import com.intellij.psi.PsiClass
+import com.intellij.psi.PsiClassType
 import com.intellij.psi.PsiFile
 import com.intellij.psi.PsiManager
+import com.intellij.psi.PsiType
 import com.intellij.psi.search.GlobalSearchScope
 
 fun Project.getContentRoot(baseFile: VirtualFile): VirtualFile? =
@@ -40,15 +42,19 @@ fun Project.getModule(virtualFile: VirtualFile): Module? =
 
 fun Project.findFile(file: VirtualFile): PsiFile? = PsiManager.getInstance(this).findFile(file)
 
+fun Project.getJavaClazz(type: PsiType): PsiClass? {
+    val topClassName = (type as? PsiClassType)?.rawType()?.canonicalText ?: type.canonicalText
+    return getJavaClazz(topClassName)
+}
+
 fun Project.getJavaClazz(fqdn: String): PsiClass? {
     val scope = GlobalSearchScope.allScope(this)
-    val topClassName = fqdn.substringBefore("<")
     return JavaPsiFacade
         .getInstance(this)
-        .findClasses(topClassName, scope)
+        .findClasses(fqdn, scope)
         .firstOrNull()
         ?: JavaPsiFacade.getInstance(this).findClass(
-            topClassName,
+            fqdn,
             GlobalSearchScope.allScope(this),
         )
 }

src/main/kotlin/org/domaframework/doma/intellij/extension/psi/PsiMethodExtension.kt

@@ -23,4 +23,8 @@ fun PsiMethod.findParameter(searchName: String): PsiParameter? = this.methodPara
 val PsiMethod.methodParameters: List<PsiParameter>
     get() = this.parameterList.parameters.toList()
 
-fun PsiMethod.searchParameter(searchName: String): List<PsiParameter> = this.methodParameters.filter { it.name.startsWith(searchName) }
+fun PsiMethod.searchParameter(searchName: String): List<PsiParameter> =
+    this.methodParameters.filter {
+        it.name.startsWith(searchName) &&
+            !it.isIgnoreUsageCheck()
+    }

src/main/kotlin/org/domaframework/doma/intellij/inspection/dao/processor/TypeCheckerProcessor.kt

@@ -99,7 +99,7 @@ abstract class TypeCheckerProcessor(
             val paramClassType = paramType as? PsiClassType ?: return false
             val optionalParam = paramClassType.parameters.firstOrNull()
             return optionalParam?.let {
-                val optionalParamClass = project.getJavaClazz(it.canonicalText)
+                val optionalParamClass = project.getJavaClazz(it)
                 optionalParamClass?.isDomain() == true || optionalParamClass?.isDataType() == true || PsiTypeChecker.isBaseClassType(it)
             } == true
         }

src/main/kotlin/org/domaframework/doma/intellij/inspection/dao/processor/cheker/ProcedureFunctionResultSetParamAnnotationTypeChecker.kt

@@ -44,7 +44,7 @@ class ProcedureFunctionResultSetParamAnnotationTypeChecker(
             val paramClassType = paramType as? PsiClassType ?: return false
             val optionalParam = paramClassType.parameters.firstOrNull()
             return optionalParam?.let {
-                val optionalParamClass = project.getJavaClazz(it.canonicalText)
+                val optionalParamClass = project.getJavaClazz(it)
                 optionalParamClass?.isDomain() == true ||
                     optionalParamClass?.isEntity() == true ||
                     optionalParamClass?.isDataType() == true ||
@@ -54,7 +54,7 @@ class ProcedureFunctionResultSetParamAnnotationTypeChecker(
             } == true
         }
 
-        val paramClass = project.getJavaClazz(paramType.canonicalText)
+        val paramClass = project.getJavaClazz(paramType)
         return paramClass?.isDomain() == true || paramClass?.isDataType() == true
     }
 
@@ -101,7 +101,7 @@ class ProcedureFunctionResultSetParamAnnotationTypeChecker(
             return
         }
 
-        val paramClass = project.getJavaClazz(listParamType.canonicalText)
+        val paramClass = project.getJavaClazz(listParamType)
 
         if (checkParamType(listParamType) || paramClass?.isEntity() == true || paramClass?.isDataType() == true) return
         result.highlightElement(holder)

src/main/kotlin/org/domaframework/doma/intellij/inspection/dao/processor/option/DaoAnnotationOptionParameterCheckProcessor.kt

@@ -62,7 +62,7 @@ class DaoAnnotationOptionParameterCheckProcessor(
             }
         }
 
-        val entityClass = project.getJavaClazz(entityType.canonicalText) ?: return
+        val entityClass = project.getJavaClazz(entityType) ?: return
         if (!entityClass.isEntity()) {
             return
         }
@@ -110,7 +110,7 @@ class DaoAnnotationOptionParameterCheckProcessor(
                     ?.find { property -> isOptionTargetProperty(property, field, project) }
                     ?.let { f ->
                         preSearchParamClass = searchParamClass
-                        searchParamClass = project.getJavaClazz(f.type.canonicalText) ?: return@map
+                        searchParamClass = project.getJavaClazz(f.type) ?: return@map
                     }
                     ?: run {
                         ValidationAnnotationOptionParameterResult(

src/main/kotlin/org/domaframework/doma/intellij/inspection/dao/processor/paramtype/BatchParamTypeCheckProcessor.kt

@@ -72,7 +72,7 @@ class BatchParamTypeCheckProcessor(
                 shortName,
             )
 
-        project.getJavaClazz(param.type.canonicalText)?.let { paramClass ->
+        project.getJavaClazz(param.type)?.let { paramClass ->
             val paramClassType = paramClass.psiClassType
             if (!PsiClassTypeUtil.isIterableType(
                     paramClassType,

src/main/kotlin/org/domaframework/doma/intellij/inspection/dao/processor/paramtype/MultiInsertParamTypeCheckProcessor.kt

@@ -72,7 +72,7 @@ class MultiInsertParamTypeCheckProcessor(
                 shortName,
             )
 
-        project.getJavaClazz(param.type.canonicalText)?.let { paramClass ->
+        project.getJavaClazz(param.type)?.let { paramClass ->
             val paramClassType = paramClass.psiClassType
             if (!PsiClassTypeUtil.isIterableType(
                     paramClassType,
@@ -87,7 +87,7 @@ class MultiInsertParamTypeCheckProcessor(
         val iterableClassType = param.type as? PsiClassType
         iterableClassType?.parameters?.firstOrNull()?.let { iterableParam ->
             project
-                .getJavaClazz(iterableParam.canonicalText)
+                .getJavaClazz(iterableParam)
                 ?.let {
                     if (!it.isEntity()) {
                         resultParamType.highlightElement(holder)

src/main/kotlin/org/domaframework/doma/intellij/inspection/dao/processor/paramtype/SelectParamTypeCheckProcessor.kt

@@ -47,15 +47,15 @@ class SelectParamTypeCheckProcessor(
             val paramClassType = paramType as? PsiClassType ?: return false
             val optionalParam = paramClassType.parameters.firstOrNull()
             return optionalParam?.let {
-                val optionalParamClass = project.getJavaClazz(it.canonicalText)
+                val optionalParamClass = project.getJavaClazz(it)
                 optionalParamClass?.isDomain() == true ||
                     PsiTypeChecker.isBaseClassType(it) ||
                     optionalParamClass?.isEntity() == true ||
                     optionalParamClass?.isDataType() == true
             } == true
         }
 
-        val paramClass = project.getJavaClazz(paramType.canonicalText)
+        val paramClass = project.getJavaClazz(paramType)
         return paramClass?.isDomain() == true || paramClass?.isEntity() == true || paramClass?.isDataType() == true
     }
 

src/main/kotlin/org/domaframework/doma/intellij/inspection/dao/processor/returntype/UpdateReturnTypeCheckProcessor.kt

@@ -90,7 +90,7 @@ class UpdateReturnTypeCheckProcessor(
 
         val checkReturnType =
             PsiClassTypeUtil.convertOptionalType(returnType, project)
-        val returnTypeClass = project.getJavaClazz(checkReturnType.canonicalText)
+        val returnTypeClass = project.getJavaClazz(checkReturnType)
 
         return if (!validateReturnType(returnTypeClass, paramClass)) {
             ValidationReturnTypeUpdateReturningResult(