Add validation results for directive item types and enhance for directive handling

Author: xterao

src/main/kotlin/org/domaframework/doma/intellij/common/sql/validator/result/ValidationForDirectiveItemTypeResult.kt

@@ -0,0 +1,44 @@
+/*
+ * 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.common.sql.validator.result
+
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.util.TextRange
+import com.intellij.psi.PsiElement
+import org.domaframework.doma.intellij.bundle.MessageBundle
+import org.domaframework.doma.intellij.common.psi.PsiParentClass
+
+class ValidationForDirectiveItemTypeResult(
+    override val identify: PsiElement?,
+    override val shortName: String = "",
+) : ValidationResult(identify, null, shortName) {
+    override fun setHighlight(
+        highlightRange: TextRange,
+        identify: PsiElement,
+        holder: ProblemsHolder,
+        parent: PsiParentClass?,
+        project: Project,
+    ) {
+        val project = identify.project
+        holder.registerProblem(
+            identify,
+            MessageBundle.message("inspection.invalid.sql.iterable"),
+            problemHighlightType(project, shortName),
+            highlightRange,
+        )
+    }
+}

src/main/kotlin/org/domaframework/doma/intellij/common/sql/validator/result/ValidationNotFoundStaticPropertyResult.kt

@@ -0,0 +1,47 @@
+/*
+ * 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.common.sql.validator.result
+
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.util.TextRange
+import com.intellij.psi.PsiElement
+import org.domaframework.doma.intellij.bundle.MessageBundle
+import org.domaframework.doma.intellij.common.psi.PsiParentClass
+
+class ValidationNotFoundStaticPropertyResult(
+    override val identify: PsiElement?,
+    override val shortName: String = "",
+) : ValidationResult(identify, null, shortName) {
+    override fun setHighlight(
+        highlightRange: TextRange,
+        identify: PsiElement,
+        holder: ProblemsHolder,
+        parent: PsiParentClass?,
+        project: Project,
+    ) {
+        val project = identify.project
+        holder.registerProblem(
+            identify,
+            MessageBundle.message(
+                "inspection.invalid.sql.staticProperty",
+                identify.text,
+            ),
+            problemHighlightType(project, shortName),
+            highlightRange,
+        )
+    }
+}

src/main/kotlin/org/domaframework/doma/intellij/common/sql/validator/result/ValidationNotFoundTopTypeResult.kt

@@ -0,0 +1,44 @@
+/*
+ * 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.common.sql.validator.result
+
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.util.TextRange
+import com.intellij.psi.PsiElement
+import org.domaframework.doma.intellij.bundle.MessageBundle
+import org.domaframework.doma.intellij.common.psi.PsiParentClass
+
+class ValidationNotFoundTopTypeResult(
+    override val identify: PsiElement?,
+    override val shortName: String = "",
+) : ValidationResult(identify, null, shortName) {
+    override fun setHighlight(
+        highlightRange: TextRange,
+        identify: PsiElement,
+        holder: ProblemsHolder,
+        parent: PsiParentClass?,
+        project: Project,
+    ) {
+        val project = identify.project
+        holder.registerProblem(
+            identify,
+            MessageBundle.message("inspection.invalid.sql.topType"),
+            problemHighlightType(project, shortName),
+            highlightRange,
+        )
+    }
+}

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

@@ -173,6 +173,7 @@ class ForDirectiveUtil {
         fun getForDirectiveItemClassType(
             project: Project,
             forDirectiveBlocks: List<BlockToken>,
+            targetForItem: PsiElement? = null,
         ): PsiParentClass? {
             // Get the type of the top for directive definition element
             // Defined in Dao parameters or static property calls
@@ -185,6 +186,9 @@ class ForDirectiveUtil {
             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) {
+                    return parentClassType
+                }
                 val forDirectiveExpr = formItem.getParentForDirectiveExpr()
                 val forDirectiveDeclaration = forDirectiveExpr?.getForItemDeclaration()
                 if (forDirectiveDeclaration != null) {

src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/visitor/SqlInspectionVisitor.kt

@@ -31,6 +31,7 @@ import org.domaframework.doma.intellij.common.psi.PsiStaticElement
 import org.domaframework.doma.intellij.common.sql.cleanString
 import org.domaframework.doma.intellij.common.sql.validator.result.ValidationClassPathResult
 import org.domaframework.doma.intellij.common.sql.validator.result.ValidationDaoParamResult
+import org.domaframework.doma.intellij.common.sql.validator.result.ValidationForDirectiveItemTypeResult
 import org.domaframework.doma.intellij.common.sql.validator.result.ValidationPropertyResult
 import org.domaframework.doma.intellij.common.util.ForDirectiveUtil
 import org.domaframework.doma.intellij.extension.expr.accessElements
@@ -92,10 +93,25 @@ class SqlInspectionVisitor(
         PsiTreeUtil.getParentOfType(element, SqlElStaticFieldAccessExpr::class.java)?.let { return }
 
         val forDirectiveExp = PsiTreeUtil.getParentOfType(element, SqlElForDirective::class.java)
-        if (forDirectiveExp != null && forDirectiveExp.getForItem() == element) return
-
-        val forItem = ForDirectiveUtil.findForItem(element)
-        if (forItem != null) return
+        val isSkip = forDirectiveExp != null && forDirectiveExp.getForItem() != element
+
+        var forDirectiveBlocks = ForDirectiveUtil.getForDirectiveBlocks(element, skipSelf = isSkip)
+        val forItem = ForDirectiveUtil.findForItem(element, skipSelf = isSkip, forDirectives = forDirectiveBlocks)
+        if (forItem != null) {
+            val forDeclarationType =
+                ForDirectiveUtil.getForDirectiveItemClassType(
+                    element.project,
+                    forDirectiveBlocks,
+                    forItem,
+                )
+            if (forDeclarationType == null) {
+                ValidationForDirectiveItemTypeResult(
+                    element,
+                    this.shortName,
+                ).highlightElement(holder)
+            }
+            return
+        }
 
         val daoMethod = findDaoMethod(visitFile) ?: return
         val param = daoMethod.findParameter(cleanString(element.text))
@@ -130,10 +146,12 @@ class SqlInspectionVisitor(
         var isBatchAnnotation = false
         val topElementParentClass =
             if (forItem != null) {
-                val result = ForDirectiveUtil.getForDirectiveItemClassType(project, forDirectiveBlocks)
+                val result = ForDirectiveUtil.getForDirectiveItemClassType(project, forDirectiveBlocks, forItem)
                 if (result == null) {
-                    // TODO Add an error message when the type of element used in the For directory is not a List type.
-                    errorHighlight(topElement, daoMethod, holder)
+                    ValidationForDirectiveItemTypeResult(
+                        topElement,
+                        this.shortName,
+                    ).highlightElement(holder)
                     return
                 }
                 val specifiedClassType =

src/main/resources/messages/DomaToolsBundle.properties

@@ -6,5 +6,8 @@ inspector.invalid.class.property=The field or method [{1}] does not exist in the
 inspection.dao.method.variable.error=There are unused parameters in the SQL [{0}]
 inspector.invalid.dao.parameter=The bind variable [{1}] does not exist in the Dao method [{0}]
 config.enable.sql.format=Enable SQL Format
+inspection.invalid.sql.topType=Can't get type of first element
+inspection.invalid.sql.staticProperty=[{0}] is not a public or static property
 inspection.invalid.sql.testdata=Bind variables must be followed by test data
-inspection.invalid.sql.classpath=A non-existent package or class name was specified. [{0}]
+inspection.invalid.sql.classpath=A non-existent package or class name was specified [{0}]
+inspection.invalid.sql.iterable=The type that can be used in the for directive is an Iterable type

src/main/resources/messages/DomaToolsBundle_ja.properties

@@ -3,8 +3,11 @@ jump.to.dao.tooltip.title=Dao\u30E1\u30BD\u30C3\u30C9\u5B9A\u7FA9\u306B\u9077\u7
 generate.sql.quickfix.title=SQL\u30D5\u30A1\u30A4\u30EB\u3092\u4F5C\u6210
 inspection.sql.not.exist.error=SQL\u30D5\u30A1\u30A4\u30EB\u304C\u5B58\u5728\u3057\u307E\u305B\u3093
 inspector.invalid.class.property=\u30AF\u30E9\u30B9[{0}]\u306B\u5B58\u5728\u3057\u306A\u3044\u30D5\u30A3\u30FC\u30EB\u30C9\u3001\u307E\u305F\u306F\u30E1\u30BD\u30C3\u30C9\u304C\u4F7F\u7528\u3055\u308C\u3066\u3044\u307E\u3059:[{1}]
-inspection.dao.method.variable.error=SQL\u3067\u4F7F\u7528\u3055\u308C\u3066\u3044\u306A\u3044\u5F15\u6570\u304C\u3042\u308A\u307E\u3059[{0}]
+inspection.dao.method.variable.error=SQL\u3067\u4F7F\u7528\u3055\u308C\u3066\u3044\u306A\u3044\u5F15\u6570\u304C\u3042\u308A\u307E\u3059:[{0}]
 inspector.invalid.dao.parameter=Dao\u30E1\u30BD\u30C3\u30C9[{0}]\u306B\u5B58\u5728\u3057\u306A\u3044\u30D0\u30A4\u30F3\u30C9\u5909\u6570\u304C\u4F7F\u7528\u3055\u308C\u3066\u3044\u307E\u3059:[{1}]
 config.enable.sql.format=SQL\u30D5\u30A9\u30FC\u30DE\u30C3\u30C8\u3092\u6709\u52B9\u5316
+inspection.invalid.sql.topType=\u6700\u521D\u306E\u8981\u7D20\u306E\u578B\u304C\u53D6\u5F97\u3067\u304D\u307E\u305B\u3093
+inspection.invalid.sql.staticProperty=[{0}]\u306F\u0070\u0075\u0062\u006C\u0069\u0063\u304B\u3064\u0073\u0074\u0061\u0074\u0069\u0063\u30D7\u30ED\u30D1\u30C6\u30A3\u3067\u306F\u3042\u308A\u307E\u305B\u3093
 inspection.invalid.sql.testdata=\u30D0\u30A4\u30F3\u30C9\u5909\u6570\u306E\u5F8C\u308D\u306B\u306F\u30C6\u30B9\u30C8\u30C7\u30FC\u30BF\u304C\u5FC5\u8981\u3067\u3059
-inspection.invalid.sql.classpath=\u0041\u0020\u006E\u006F\u006E\u002D\u0065\u0078\u0069\u0073\u0074\u0065\u006E\u0074\u0020\u0070\u0061\u0063\u006B\u0061\u0067\u0065\u0020\u006F\u0072\u0020\u0063\u006C\u0061\u0073\u0073\u0020\u006E\u0061\u006D\u0065\u0020\u0077\u0061\u0073\u0020\u0073\u0070\u0065\u0063\u0069\u0066\u0069\u0065\u0064\u002E [{0}]
+inspection.invalid.sql.classpath=\u5B58\u5728\u3057\u306A\u3044\u30D1\u30C3\u30B1\u30FC\u30B8\u307E\u305F\u306F\u30AF\u30E9\u30B9\u540D\u304C\u6307\u5B9A\u3055\u308C\u307E\u3057\u305F\u3002:[{0}]
+inspection.invalid.sql.iterable=\u0066\u006F\u0072\u30C7\u30A3\u30EC\u30AF\u30C6\u30A3\u30D6\u306B\u4F7F\u7528\u3067\u304D\u308B\u578B\u306F\u0049\u0074\u0065\u0072\u0061\u0062\u006C\u0065\u578B\u3067\u3059