What to do when the for directive definition element is used as the top element of a field access

xterao · xterao · commit ea8884bab951 · 2025-05-14T17:52:47.000+09:00
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/common/util/ForDirectiveUtil.kt b/src/main/kotlin/org/domaframework/doma/intellij/common/util/ForDirectiveUtil.kt
@@ -19,6 +19,7 @@ import com.intellij.openapi.project.Project
 import com.intellij.psi.PsiClass
 import com.intellij.psi.PsiClassType
 import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiMethod
 import com.intellij.psi.PsiType
 import com.intellij.psi.PsiTypes
 import com.intellij.psi.util.CachedValue
@@ -34,6 +35,7 @@ import org.domaframework.doma.intellij.common.sql.PsiClassTypeUtil
 import org.domaframework.doma.intellij.common.sql.cleanString
 import org.domaframework.doma.intellij.common.sql.foritem.ForItem
 import org.domaframework.doma.intellij.common.sql.validator.result.ValidationCompleteResult
+import org.domaframework.doma.intellij.common.sql.validator.result.ValidationNotFoundTopTypeResult
 import org.domaframework.doma.intellij.common.sql.validator.result.ValidationPropertyResult
 import org.domaframework.doma.intellij.common.sql.validator.result.ValidationResult
 import org.domaframework.doma.intellij.extension.expr.accessElements
@@ -178,40 +180,72 @@ class ForDirectiveUtil {
             // Get the type of the top for directive definition element
             // Defined in Dao parameters or static property calls
             if (forDirectiveBlocks.isEmpty()) return null
+            val topDirectiveItem = forDirectiveBlocks.first().item
+            val file = topDirectiveItem.containingFile ?: return null
+            val daoMethod = findDaoMethod(file)
+
             var parentClassType =
                 getTopForDirectiveDeclarationClassType(
                     forDirectiveBlocks.first().item,
                     project,
-                ) ?: return null
+                    daoMethod,
+                )
             forDirectiveBlocks.drop(1).forEach { directive ->
                 // Get the definition type of the target directive
                 val formItem = ForItem(directive.item)
-                if (targetForItem != null &&
-                    formItem.element.textOffset > targetForItem.textOffset
-                ) {
+                if (targetForItem != null && formItem.element.textOffset > targetForItem.textOffset) {
                     return parentClassType
                 }
                 val forDirectiveExpr = formItem.getParentForDirectiveExpr()
                 val forDirectiveDeclaration = forDirectiveExpr?.getForItemDeclaration()
                 if (forDirectiveDeclaration != null) {
-                    val forItemDeclarationBlocks = forDirectiveDeclaration.getDeclarationChildren()
-                    getFieldAccessLastPropertyClassType(
-                        forItemDeclarationBlocks,
-                        project,
-                        parentClassType,
-                        complete = { lastType ->
-                            val classType = lastType.type as? PsiClassType
-                            val nestClass =
-                                if (classType != null &&
-                                    PsiClassTypeUtil.Companion.isIterableType(classType, project)
-                                ) {
-                                    classType.parameters.firstOrNull()
-                                } else {
-                                    null
-                                }
-                            nestClass?.let { parentClassType = PsiParentClass(it) }
-                        },
-                    )
+                    val declarationTopElement =
+                        forDirectiveDeclaration.getDeclarationChildren().first()
+                    val findDeclarationForItem =
+                        findForItem(declarationTopElement, forDirectives = forDirectiveBlocks)
+
+                    if (findDeclarationForItem == null && daoMethod != null) {
+                        val matchParam = daoMethod.findParameter(declarationTopElement.text)
+                        if (matchParam != null) {
+                            val convertOptional =
+                                PsiClassTypeUtil.convertOptionalType(matchParam.type, project)
+                            parentClassType = PsiParentClass(convertOptional)
+                        }
+                    }
+                    if (parentClassType != null) {
+                        val isBatchAnnotation = daoMethod?.let { PsiDaoMethod(project, it).daoType.isBatchAnnotation() } == true
+                        val forItemDeclarationBlocks =
+                            forDirectiveDeclaration.getDeclarationChildren()
+                        getFieldAccessLastPropertyClassType(
+                            forItemDeclarationBlocks,
+                            project,
+                            parentClassType,
+                            isBatchAnnotation = isBatchAnnotation,
+                            complete = { lastType ->
+                                val classType = lastType.type as? PsiClassType
+                                val nestClass =
+                                    if (classType != null &&
+                                        PsiClassTypeUtil.Companion.isIterableType(
+                                            classType,
+                                            project,
+                                        )
+                                    ) {
+                                        classType.parameters.firstOrNull()
+                                    } else {
+                                        null
+                                    }
+                                parentClassType =
+                                    if (nestClass != null) {
+                                        PsiParentClass(nestClass)
+                                    } else {
+                                        null
+                                    }
+                            },
+                        )
+                        if (targetForItem != null && formItem.element.text == targetForItem.text) {
+                            return parentClassType
+                        }
+                    }
                 }
             }
 
@@ -221,6 +255,7 @@ class ForDirectiveUtil {
         fun getTopForDirectiveDeclarationClassType(
             topForDirectiveItem: PsiElement,
             project: Project,
+            daoMethod: PsiMethod?,
         ): PsiParentClass? {
             var result: PsiParentClass? = null
             var fieldAccessTopParentClass: PsiParentClass? = null
@@ -256,8 +291,8 @@ class ForDirectiveUtil {
                         )
                 } else {
                     // Defined by Dao parameter
-                    val file = topForDirectiveItem.containingFile ?: return null
-                    val daoMethod = findDaoMethod(file) ?: return null
+                    if (daoMethod == null) return null
+
                     val topElementText =
                         forDirectiveDeclaration.getDeclarationChildren().firstOrNull()?.text
                             ?: return null
@@ -343,9 +378,10 @@ class ForDirectiveUtil {
                     val convertOptional = PsiClassTypeUtil.convertOptionalType(topParent.type, project)
                     PsiParentClass(convertOptional)
                 }
-            // TODO: Display an error message that the property cannot be called.
             val parentType = PsiClassTypeUtil.convertOptionalType(parent.type, project)
-            val classType = parentType as? PsiClassType ?: return null
+            val classType =
+                parentType as? PsiClassType
+                    ?: return ValidationNotFoundTopTypeResult(blocks.first(), shortName)
 
             var competeResult: ValidationCompleteResult? = null
 
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/processor/InspectionFieldAccessVisitorProcessor.kt b/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/processor/InspectionFieldAccessVisitorProcessor.kt
@@ -13,15 +13,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.inspection.sql.handler
+package org.domaframework.doma.intellij.inspection.sql.processor
 
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.psi.PsiFile
 import org.domaframework.doma.intellij.common.dao.findDaoMethod
 import org.domaframework.doma.intellij.common.psi.PsiDaoMethod
 import org.domaframework.doma.intellij.common.psi.PsiParentClass
 import org.domaframework.doma.intellij.common.sql.cleanString
-import org.domaframework.doma.intellij.common.sql.validator.result.ValidationForDirectiveItemTypeResult
 import org.domaframework.doma.intellij.common.util.ForDirectiveUtil
 import org.domaframework.doma.intellij.extension.expr.accessElements
 import org.domaframework.doma.intellij.extension.psi.findParameter
@@ -54,10 +53,8 @@ class InspectionFieldAccessVisitorProcessor(
             if (forItem != null) {
                 val result = ForDirectiveUtil.getForDirectiveItemClassType(project, forDirectiveBlocks, forItem)
                 if (result == null) {
-                    ValidationForDirectiveItemTypeResult(
-                        topElement,
-                        this.shortName,
-                    ).highlightElement(holder)
+                    // If the for directive definition element of the top element is invalid,
+                    // an error is displayed by InspectionPrimaryVisitorProcessor.
                     return
                 }
                 val specifiedClassType =
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/processor/InspectionForDirectiveVisitorProcessor.kt b/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/processor/InspectionForDirectiveVisitorProcessor.kt
@@ -0,0 +1,41 @@
+/*
+ * Copyright Doma Tools Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.domaframework.doma.intellij.inspection.sql.processor
+
+import com.intellij.codeInspection.ProblemsHolder
+import org.domaframework.doma.intellij.common.sql.validator.result.ValidationForDirectiveItemTypeResult
+import org.domaframework.doma.intellij.common.util.ForDirectiveUtil
+import org.domaframework.doma.intellij.extension.psi.getForItem
+import org.domaframework.doma.intellij.psi.SqlElForDirective
+
+class InspectionForDirectiveVisitorProcessor(
+    val shortName: String,
+    private val element: SqlElForDirective,
+) : InspectionVisitorProcessor(shortName) {
+    fun check(holder: ProblemsHolder) {
+        val forItem = element.getForItem() ?: return
+        val directiveBlocks = ForDirectiveUtil.getForDirectiveBlocks(forItem, false)
+        val declarationType =
+            ForDirectiveUtil.getForDirectiveItemClassType(element.project, directiveBlocks)
+
+        if (declarationType == null) {
+            ValidationForDirectiveItemTypeResult(
+                forItem,
+                this.shortName,
+            ).highlightElement(holder)
+        }
+    }
+}
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/processor/InspectionPrimaryVisitorProcessor.kt b/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/processor/InspectionPrimaryVisitorProcessor.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.inspection.sql.handler
+package org.domaframework.doma.intellij.inspection.sql.processor
 
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.psi.PsiFile
@@ -50,6 +50,8 @@ class InspectionPrimaryVisitorProcessor(
                 skipSelf = isSkip,
                 forDirectives = forDirectiveBlocks,
             )
+        if (forDirectiveExp?.getForItem() == element) return
+
         if (forItem != null) {
             val forDeclarationType =
                 ForDirectiveUtil.getForDirectiveItemClassType(
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/processor/InspectionStaticFieldAccessVisitorProcessor.kt b/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/processor/InspectionStaticFieldAccessVisitorProcessor.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.inspection.sql.handler
+package org.domaframework.doma.intellij.inspection.sql.processor
 
 import com.intellij.codeInspection.ProblemsHolder
 import org.domaframework.doma.intellij.common.psi.PsiStaticElement
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/processor/InspectionVisitorProcessor.kt b/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/processor/InspectionVisitorProcessor.kt
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.inspection.sql.handler
+package org.domaframework.doma.intellij.inspection.sql.processor
 
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.psi.PsiElement
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/visitor/SqlInspectionVisitor.kt b/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/visitor/SqlInspectionVisitor.kt
@@ -23,10 +23,12 @@ import com.intellij.psi.util.elementType
 import org.domaframework.doma.intellij.common.isInjectionSqlFile
 import org.domaframework.doma.intellij.common.isJavaOrKotlinFileType
 import org.domaframework.doma.intellij.extension.psi.isFirstElement
-import org.domaframework.doma.intellij.inspection.sql.handler.InspectionFieldAccessVisitorProcessor
-import org.domaframework.doma.intellij.inspection.sql.handler.InspectionPrimaryVisitorProcessor
-import org.domaframework.doma.intellij.inspection.sql.handler.InspectionStaticFieldAccessVisitorProcessor
+import org.domaframework.doma.intellij.inspection.sql.processor.InspectionFieldAccessVisitorProcessor
+import org.domaframework.doma.intellij.inspection.sql.processor.InspectionForDirectiveVisitorProcessor
+import org.domaframework.doma.intellij.inspection.sql.processor.InspectionPrimaryVisitorProcessor
+import org.domaframework.doma.intellij.inspection.sql.processor.InspectionStaticFieldAccessVisitorProcessor
 import org.domaframework.doma.intellij.psi.SqlElFieldAccessExpr
+import org.domaframework.doma.intellij.psi.SqlElForDirective
 import org.domaframework.doma.intellij.psi.SqlElPrimaryExpr
 import org.domaframework.doma.intellij.psi.SqlElStaticFieldAccessExpr
 import org.domaframework.doma.intellij.psi.SqlTypes
@@ -50,17 +52,23 @@ class SqlInspectionVisitor(
 
     override fun visitElStaticFieldAccessExpr(element: SqlElStaticFieldAccessExpr) {
         super.visitElStaticFieldAccessExpr(element)
-        val handler = InspectionStaticFieldAccessVisitorProcessor(this.shortName)
-        handler.check(element, holder)
+        val processor = InspectionStaticFieldAccessVisitorProcessor(this.shortName)
+        processor.check(element, holder)
     }
 
     override fun visitElFieldAccessExpr(element: SqlElFieldAccessExpr) {
         super.visitElFieldAccessExpr(element)
         if (setFile(element)) return
         val visitFile: PsiFile = file ?: return
 
-        val handler = InspectionFieldAccessVisitorProcessor(shortName, element)
-        handler.check(holder, visitFile)
+        val processor = InspectionFieldAccessVisitorProcessor(shortName, element)
+        processor.check(holder, visitFile)
+    }
+
+    override fun visitElForDirective(element: SqlElForDirective) {
+        super.visitElForDirective(element)
+        val process = InspectionForDirectiveVisitorProcessor(shortName, element)
+        process.check(holder)
     }
 
     override fun visitElPrimaryExpr(element: SqlElPrimaryExpr) {
@@ -69,7 +77,7 @@ class SqlInspectionVisitor(
         if (setFile(element)) return
         val visitFile: PsiFile = file ?: return
 
-        val handler = InspectionPrimaryVisitorProcessor(this.shortName, element)
-        handler.check(holder, visitFile)
+        val processor = InspectionPrimaryVisitorProcessor(this.shortName, element)
+        processor.check(holder, visitFile)
     }
 }
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/reference/SqlElIdExprReference.kt b/src/main/kotlin/org/domaframework/doma/intellij/reference/SqlElIdExprReference.kt
@@ -48,7 +48,7 @@ class SqlElIdExprReference(
         // Refers to an element defined in the for directive
         val isSelfSkip = isSelfSkip(topElm)
         val forDirectiveBlocks = ForDirectiveUtil.getForDirectiveBlocks(element, isSelfSkip)
-        val forItem = ForDirectiveUtil.findForItem(element, forDirectives = forDirectiveBlocks)
+        val forItem = ForDirectiveUtil.findForItem(topElm, forDirectives = forDirectiveBlocks)
         if (forItem != null && element.textOffset == topElm.textOffset) {
             PluginLoggerUtil.countLogging(
                 this::class.java.simpleName,
@@ -69,18 +69,29 @@ class SqlElIdExprReference(
             )
         }
 
-        val tolElementForItem =
-            ForDirectiveUtil.getForDirectiveItemClassType(topElm.project, forDirectiveBlocks)
+        // Reference to field access elements
+        var parentClass: PsiParentClass? = null
         var isBatchAnnotation = false
-        var parentClass =
-            if (tolElementForItem != null) {
-                tolElementForItem
-            } else {
-                val daoMethod = findDaoMethod(file) ?: return null
-                val param = daoMethod.findParameter(topElm.text) ?: return null
-                isBatchAnnotation = PsiDaoMethod(topElm.project, daoMethod).daoType.isBatchAnnotation()
-                PsiParentClass(param.type)
-            }
+        if (forItem != null) {
+            val project = topElm.project
+            val forItemClassType =
+                ForDirectiveUtil.getForDirectiveItemClassType(project, forDirectiveBlocks, forItem)
+                    ?: return null
+            val specifiedClassType =
+                ForDirectiveUtil.resolveForDirectiveItemClassTypeBySuffixElement(topElm.text)
+            parentClass =
+                if (specifiedClassType != null) {
+                    PsiParentClass(specifiedClassType)
+                } else {
+                    forItemClassType
+                }
+        } else {
+            val daoMethod = findDaoMethod(file) ?: return null
+            val param = daoMethod.findParameter(topElm.text) ?: return null
+            parentClass = PsiParentClass(param.type)
+            isBatchAnnotation = PsiDaoMethod(topElm.project, daoMethod).daoType.isBatchAnnotation()
+        }
+
         val result =
             ForDirectiveUtil.getFieldAccessLastPropertyClassType(
                 targetElements,
diff --git a/src/test/testData/src/main/resources/META-INF/doma/example/dao/EmployeeSummaryDao/accessStaticProperty.sql b/src/test/testData/src/main/resources/META-INF/doma/example/dao/EmployeeSummaryDao/accessStaticProperty.sql
@@ -33,7 +33,7 @@ where
      /*%end */
     )
     -- Static field call that does not exist
-    /*%if @doma.example.entity.ProjectDetail@<error descr="The field or method [priority] does not exist in the class [ProjectDetail]">priority</error> >= 3 */
+    /*%if @doma.example.entity.ProjectDetail@<error descr="[priority] is not a public or static property in the class [doma.example.entity.ProjectDetail]">priority</error> >= 3 */
     -- Static method call that does not exist
-    AND pd.limit_date = /* @doma.example.entity.ProjectDetail@<error descr="The field or method [getLimit] does not exist in the class [ProjectDetail]">getLimit</error>() */0
+    AND pd.limit_date = /* @doma.example.entity.ProjectDetail@<error descr="[getLimit] is not a public or static property in the class [doma.example.entity.ProjectDetail]">getLimit</error>() */0
     /*%end */
diff --git a/src/test/testData/src/main/resources/META-INF/doma/example/dao/EmployeeSummaryDao/bindVariableForNonEntityClass.sql b/src/test/testData/src/main/resources/META-INF/doma/example/dao/EmployeeSummaryDao/bindVariableForNonEntityClass.sql
@@ -25,9 +25,9 @@
             AND pe.end_date >= CURRENT_DATE
         /*%end*/
         -- Reference error for a non-existent field
-        /*%for child : employee.<error descr="The field or method [projectIds] does not exist in the class [EmployeeSummary]">projectIds</error> */
+        /*%for <error descr="The type that can be used in the for directive is an Iterable type">child</error> : employee.<error descr="The field or method [projectIds] does not exist in the class [EmployeeSummary]">projectIds</error> */
            -- An error occurred because the referenced element was not correctly defined.
-           AND pe.parent_project = /* <error descr="The bind variable [child] does not exist in the Dao method [bindVariableForNonEntityClass]">child</error>.projectId */0
+           AND pe.parent_project = /* <error descr="The type that can be used in the for directive is an Iterable type">child</error>.projectId */0
            -- Reference error for a non-existent method
           AND pe.member_id IN /* employee.<error descr="The field or method [getTopProject] does not exist in the class [EmployeeSummary]">getTopProject</error>() */(0,1,2)
         /*%end */
diff --git a/src/test/testData/src/main/resources/META-INF/doma/example/dao/EmployeeSummaryDao/callStaticPropertyPackageName.sql b/src/test/testData/src/main/resources/META-INF/doma/example/dao/EmployeeSummaryDao/callStaticPropertyPackageName.sql
