Refactor: Split inspection logic

xterao · xterao · commit d2a57821a870 · 2025-06-03T15:17:46.000+09:00
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/inspection/dao/inspector/DaoMethodVariableInspector.kt b/src/main/kotlin/org/domaframework/doma/intellij/inspection/dao/inspector/DaoMethodVariableInspector.kt
@@ -53,7 +53,7 @@ class DaoMethodVariableInspector : AbstractBaseJavaLocalInspectionTool() {
         val deplicateForItemElements: List<PsiParameter>,
     )
 
-    override fun getDisplayName(): String = "Method argument usage check"
+    override fun getDisplayName(): String = "Check usage of DAO method arguments in corresponding SQL file."
 
     override fun getShortName(): String = "org.domaframework.doma.intellij.variablechecker"
 
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/inspection/dao/inspector/SqlFileExistInspector.kt b/src/main/kotlin/org/domaframework/doma/intellij/inspection/dao/inspector/SqlFileExistInspector.kt
@@ -32,7 +32,7 @@ import org.domaframework.doma.intellij.inspection.dao.quickfix.GenerateSQLFileQu
  * Check for existence of SQL file
  */
 class SqlFileExistInspector : AbstractBaseJavaLocalInspectionTool() {
-    override fun getDisplayName(): String = "Check for existence of SQL file"
+    override fun getDisplayName(): String = "Ensure the existence of SQL files for DAO methods."
 
     override fun getShortName(): String = "org.domaframework.doma.intellij.existsqlchecker"
 
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/inspector/SqlBindVariableValidInspector.kt b/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/inspector/SqlBindVariableValidInspector.kt
@@ -25,7 +25,7 @@ import org.domaframework.doma.intellij.psi.SqlVisitor
  * Code inspection for SQL bind variables
  */
 class SqlBindVariableValidInspector : LocalInspectionTool() {
-    override fun getDisplayName(): String = "Match checking between SQL bind variables and Declaration"
+    override fun getDisplayName(): String = "Check where SQL bind variables are defined."
 
     override fun getShortName(): String = "org.domaframework.doma.intellij.validBindVariable"
 
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/inspector/SqlFunctionCallInspector.kt b/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/inspector/SqlFunctionCallInspector.kt
@@ -0,0 +1,45 @@
+/*
+ * 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.inspector
+
+import com.intellij.codeHighlighting.HighlightDisplayLevel
+import com.intellij.codeInspection.LocalInspectionTool
+import com.intellij.codeInspection.ProblemsHolder
+import org.domaframework.doma.intellij.inspection.sql.visitor.SqlFunctionCallVisitor
+import org.domaframework.doma.intellij.psi.SqlVisitor
+
+class SqlFunctionCallInspector : LocalInspectionTool() {
+    override fun getDisplayName(): String =
+        "This inspection checks whether the function name called " +
+            "in a function call is defined in the implementation class specified " +
+            "by the `doma.expr.functions` property of doma.compile.config," +
+            " or in org.seasar.doma.expr.ExpressionFunctions."
+
+    override fun getShortName(): String = "org.domaframework.doma.intellij.functionCall"
+
+    override fun getGroupDisplayName(): String = "DomaTools"
+
+    override fun isEnabledByDefault(): Boolean = true
+
+    override fun getDefaultLevel(): HighlightDisplayLevel = HighlightDisplayLevel.Companion.ERROR
+
+    override fun runForWholeFile(): Boolean = true
+
+    override fun buildVisitor(
+        holder: ProblemsHolder,
+        isOnTheFly: Boolean,
+    ): SqlVisitor = SqlFunctionCallVisitor(holder, this.shortName)
+}
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/inspector/SqlLoopDirectiveTypeInspector.kt b/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/inspector/SqlLoopDirectiveTypeInspector.kt
@@ -0,0 +1,42 @@
+/*
+ * 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.inspector
+
+import com.intellij.codeHighlighting.HighlightDisplayLevel
+import com.intellij.codeInspection.LocalInspectionTool
+import com.intellij.codeInspection.ProblemsHolder
+import org.domaframework.doma.intellij.inspection.sql.visitor.SqlLoopDirectiveVisitor
+import org.domaframework.doma.intellij.psi.SqlVisitor
+
+class SqlLoopDirectiveTypeInspector : LocalInspectionTool() {
+    override fun getDisplayName(): String =
+        "This inspection checks whether the base type of the element defined in a loop directive is of an Iterable type."
+
+    override fun getShortName(): String = "org.domaframework.doma.intellij.loopDirectiveType"
+
+    override fun getGroupDisplayName(): String = "DomaTools"
+
+    override fun isEnabledByDefault(): Boolean = true
+
+    override fun getDefaultLevel(): HighlightDisplayLevel = HighlightDisplayLevel.Companion.ERROR
+
+    override fun runForWholeFile(): Boolean = true
+
+    override fun buildVisitor(
+        holder: ProblemsHolder,
+        isOnTheFly: Boolean,
+    ): SqlVisitor = SqlLoopDirectiveVisitor(holder, this.shortName)
+}
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/inspector/SqlTestDataAfterBlockCommentValidValidInspector.kt b/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/inspector/SqlTestDataAfterBlockCommentValidValidInspector.kt
@@ -25,7 +25,7 @@ import org.domaframework.doma.intellij.psi.SqlVisitor
  * Code inspection for SQL bind variables
  */
 class SqlTestDataAfterBlockCommentValidValidInspector : LocalInspectionTool() {
-    override fun getDisplayName(): String = "Check whether test data exists after the bind variable"
+    override fun getDisplayName(): String = "Verify the presence of test data after SQL bind variables"
 
     override fun getShortName(): String = "org.domaframework.doma.intellij.existaftertestdata"
 
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/provider/SqlFunctionCallProvider.kt b/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/provider/SqlFunctionCallProvider.kt
@@ -0,0 +1,27 @@
+/*
+ * 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.provider
+
+import com.intellij.codeInspection.InspectionToolProvider
+import com.intellij.codeInspection.LocalInspectionTool
+import org.domaframework.doma.intellij.inspection.sql.inspector.SqlFunctionCallInspector
+
+class SqlFunctionCallProvider : InspectionToolProvider {
+    override fun getInspectionClasses(): Array<Class<out LocalInspectionTool>> =
+        arrayOf(
+            SqlFunctionCallInspector::class.java,
+        )
+}
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/provider/SqlLoopDirectiveTypeProvider.kt b/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/provider/SqlLoopDirectiveTypeProvider.kt
@@ -0,0 +1,27 @@
+/*
+ * 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.provider
+
+import com.intellij.codeInspection.InspectionToolProvider
+import com.intellij.codeInspection.LocalInspectionTool
+import org.domaframework.doma.intellij.inspection.sql.inspector.SqlLoopDirectiveTypeInspector
+
+class SqlLoopDirectiveTypeProvider : InspectionToolProvider {
+    override fun getInspectionClasses(): Array<Class<out LocalInspectionTool>> =
+        arrayOf(
+            SqlLoopDirectiveTypeInspector::class.java,
+        )
+}
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/visitor/SqlFunctionCallVisitor.kt b/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/visitor/SqlFunctionCallVisitor.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.inspection.sql.visitor
+
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiLiteralExpression
+import org.domaframework.doma.intellij.common.isInjectionSqlFile
+import org.domaframework.doma.intellij.common.isJavaOrKotlinFileType
+import org.domaframework.doma.intellij.inspection.sql.processor.InspectionFunctionCallVisitorProcessor
+import org.domaframework.doma.intellij.psi.SqlElFunctionCallExpr
+
+class SqlFunctionCallVisitor(
+    private val holder: ProblemsHolder,
+    private val shortName: String,
+) : SqlVisitorBase() {
+    override fun visitElement(element: PsiElement) {
+        val file = element.containingFile ?: return
+        if (isJavaOrKotlinFileType(file) && element is PsiLiteralExpression) {
+            val injectionFile = initInjectionElement(file, element.project, element) ?: return
+            injectionFile.accept(this)
+            super.visitElement(element)
+        }
+        if (isInjectionSqlFile(file)) {
+            element.acceptChildren(this)
+        }
+    }
+
+    override fun visitElFunctionCallExpr(element: SqlElFunctionCallExpr) {
+        super.visitElFunctionCallExpr(element)
+        val processor = InspectionFunctionCallVisitorProcessor(this.shortName, element)
+        processor.check(holder)
+    }
+}
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,13 +23,9 @@ 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.processor.InspectionFieldAccessVisitorProcessor
-import org.domaframework.doma.intellij.inspection.sql.processor.InspectionForDirectiveVisitorProcessor
-import org.domaframework.doma.intellij.inspection.sql.processor.InspectionFunctionCallVisitorProcessor
 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.SqlElFunctionCallExpr
 import org.domaframework.doma.intellij.psi.SqlElPrimaryExpr
 import org.domaframework.doma.intellij.psi.SqlElStaticFieldAccessExpr
 import org.domaframework.doma.intellij.psi.SqlTypes
@@ -50,12 +46,6 @@ class SqlInspectionVisitor(
         }
     }
 
-    override fun visitElFunctionCallExpr(element: SqlElFunctionCallExpr) {
-        super.visitElFunctionCallExpr(element)
-        val processor = InspectionFunctionCallVisitorProcessor(this.shortName, element)
-        processor.check(holder)
-    }
-
     override fun visitElStaticFieldAccessExpr(element: SqlElStaticFieldAccessExpr) {
         super.visitElStaticFieldAccessExpr(element)
         val processor = InspectionStaticFieldAccessVisitorProcessor(this.shortName)
@@ -69,12 +59,6 @@ class SqlInspectionVisitor(
         processor.check(holder, file)
     }
 
-    override fun visitElForDirective(element: SqlElForDirective) {
-        super.visitElForDirective(element)
-        val process = InspectionForDirectiveVisitorProcessor(shortName, element)
-        process.check(holder)
-    }
-
     override fun visitElPrimaryExpr(element: SqlElPrimaryExpr) {
         val file = element.containingFile ?: return
         if (!element.isFirstElement() || element.prevSibling?.elementType == SqlTypes.AT_SIGN) return
diff --git a/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/visitor/SqlLoopDirectiveVisitor.kt b/src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/visitor/SqlLoopDirectiveVisitor.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.inspection.sql.visitor
+
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiLiteralExpression
+import org.domaframework.doma.intellij.common.isInjectionSqlFile
+import org.domaframework.doma.intellij.common.isJavaOrKotlinFileType
+import org.domaframework.doma.intellij.inspection.sql.processor.InspectionForDirectiveVisitorProcessor
+import org.domaframework.doma.intellij.psi.SqlElForDirective
+
+class SqlLoopDirectiveVisitor(
+    private val holder: ProblemsHolder,
+    private val shortName: String,
+) : SqlVisitorBase() {
+    override fun visitElement(element: PsiElement) {
+        val file = element.containingFile ?: return
+        if (isJavaOrKotlinFileType(file) && element is PsiLiteralExpression) {
+            val injectionFile = initInjectionElement(file, element.project, element) ?: return
+            injectionFile.accept(this)
+            super.visitElement(element)
+        }
+        if (isInjectionSqlFile(file)) {
+            element.acceptChildren(this)
+        }
+    }
+
+    override fun visitElForDirective(element: SqlElForDirective) {
+        super.visitElForDirective(element)
+        val process = InspectionForDirectiveVisitorProcessor(shortName, element)
+        process.check(holder)
+    }
+}
diff --git a/src/main/resources/META-INF/plugin.xml b/src/main/resources/META-INF/plugin.xml
@@ -49,8 +49,10 @@
 
     <!-- Inspection -->
     <inspectionToolProvider implementation="org.domaframework.doma.intellij.inspection.dao.provider.SqlFileExistProvider" />
-    <inspectionToolProvider implementation="org.domaframework.doma.intellij.inspection.sql.provider.SqlBindVariableValidProvider" />
     <inspectionToolProvider implementation="org.domaframework.doma.intellij.inspection.dao.provider.DaoMethodVariableProvider" />
+    <inspectionToolProvider implementation="org.domaframework.doma.intellij.inspection.sql.provider.SqlBindVariableValidProvider" />
+    <inspectionToolProvider implementation="org.domaframework.doma.intellij.inspection.sql.provider.SqlLoopDirectiveTypeProvider" />
+    <inspectionToolProvider implementation="org.domaframework.doma.intellij.inspection.sql.provider.SqlFunctionCallProvider" />
     <inspectionToolProvider implementation="org.domaframework.doma.intellij.inspection.sql.provider.SqlTestDataAfterBlockCommentValidProvider" />
 
     <!-- Completion -->
diff --git a/src/main/resources/inspectionDescriptions/org.domaframework.doma.intellij.functionCall.html b/src/main/resources/inspectionDescriptions/org.domaframework.doma.intellij.functionCall.html
@@ -0,0 +1,25 @@
+<html lang="en">
+<body>
+<p>
+  Checks whether the configuration for the custom function's defining class is properly set.
+</p>
+<p>
+  This inspection ensures that the required Doma configuration file and properties are correctly defined, and that the specified class implements <code>org.seasar.doma.expr.ExpressionFunctions</code>.
+</p>
+<p>
+  Conditions:
+</p>
+<ul>
+  <li>The Doma configuration file <code>doma.compile.config</code> exists directly under the resource directory.</li>
+  <li>The configuration file contains the property <code>doma.expr.functions</code>.</li>
+  <li>The class specified in the property implements <code>org.seasar.doma.expr.ExpressionFunctions</code>.</li>
+</ul>
+<p>
+  Example:
+</p>
+<pre><code>
+// doma.compile.config
+doma.expr.functions=com.example.CustomExpressionFunctions
+</code></pre>
+</body>
+</html>
diff --git a/src/main/resources/inspectionDescriptions/org.domaframework.doma.intellij.loopDirectiveType.html b/src/main/resources/inspectionDescriptions/org.domaframework.doma.intellij.loopDirectiveType.html
@@ -0,0 +1,19 @@
+<html lang="en">
+<body>
+<p>
+  Detects cases where the basic type of element defined in a loop directive is not Iterable.
+</p>
+<p>
+  This inspection ensures that elements used in loop directives are of type Iterable, which is required for proper iteration.
+</p>
+<p>
+  Example:
+</p>
+<pre><code>
+-- Checks that 'employees' is of type Iterable
+/*%for employee : employees */
+  /* employee */
+/*%end */
+</code></pre>
+</body>
+</html>
diff --git a/src/test/kotlin/org/domaframework/doma/intellij/inspection/sql/ParameterDefinedTest.kt b/src/test/kotlin/org/domaframework/doma/intellij/inspection/sql/ParameterDefinedTest.kt
@@ -17,6 +17,8 @@ package org.domaframework.doma.intellij.inspection.sql
 
 import org.domaframework.doma.intellij.DomaSqlTest
 import org.domaframework.doma.intellij.inspection.sql.inspector.SqlBindVariableValidInspector
+import org.domaframework.doma.intellij.inspection.sql.inspector.SqlFunctionCallInspector
+import org.domaframework.doma.intellij.inspection.sql.inspector.SqlLoopDirectiveTypeInspector
 
 /**
  * A test that inspects whether a bind variable's parameters are defined.
@@ -43,7 +45,11 @@ class ParameterDefinedTest : DomaSqlTest() {
             "$testDaoName/invalidImplementCustomFunctions.sql",
             "$testDaoName/emptyImplementCustomFunctions.sql",
         )
-        myFixture.enableInspections(SqlBindVariableValidInspector())
+        myFixture.enableInspections(
+            SqlBindVariableValidInspector(),
+            SqlLoopDirectiveTypeInspector(),
+            SqlFunctionCallInspector(),
+        )
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ class DaoMethodVariableInspector : AbstractBaseJavaLocalInspectionTool() {`
`53`	`53`	`val deplicateForItemElements: List<PsiParameter>,`
`54`	`54`	`)`
`55`	`55`
`56`		`- override fun getDisplayName(): String = "Method argument usage check"`
	`56`	`+ override fun getDisplayName(): String = "Check usage of DAO method arguments in corresponding SQL file."`
`57`	`57`
`58`	`58`	`override fun getShortName(): String = "org.domaframework.doma.intellij.variablechecker"`
`59`	`59`