Merge pull request #230 from domaframework/chore/split-inspection

Refactor: Split inspection logic

Author: xterao

src/main/kotlin/org/domaframework/doma/intellij/inspection/dao/inspector/DaoMethodVariableInspection.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.dao.inspector
+
+import com.intellij.codeHighlighting.HighlightDisplayLevel
+import com.intellij.codeInspection.AbstractBaseJavaLocalInspectionTool
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.psi.PsiElementVisitor
+import org.domaframework.doma.intellij.inspection.dao.visitor.DaoMethodVariableInspectionVisitor
+
+/**
+ * Check if DAO method arguments are used in the corresponding SQL file
+ */
+class DaoMethodVariableInspection : AbstractBaseJavaLocalInspectionTool() {
+    override fun getDisplayName(): String = "Check usage of DAO method arguments in corresponding SQL file."
+
+    override fun getShortName(): String = "org.domaframework.doma.intellij.variablechecker"
+
+    override fun getGroupDisplayName(): String = "DomaTools"
+
+    override fun isEnabledByDefault(): Boolean = true
+
+    override fun getDefaultLevel(): HighlightDisplayLevel = HighlightDisplayLevel.ERROR
+
+    override fun buildVisitor(
+        holder: ProblemsHolder,
+        isOnTheFly: Boolean,
+    ): PsiElementVisitor = DaoMethodVariableInspectionVisitor(holder)
+}

src/main/kotlin/org/domaframework/doma/intellij/inspection/dao/inspector/DaoMethodVariableInspector.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.dao.inspector
+
+import com.intellij.codeHighlighting.HighlightDisplayLevel
+import com.intellij.codeInspection.AbstractBaseJavaLocalInspectionTool
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.psi.PsiElementVisitor
+import org.domaframework.doma.intellij.inspection.dao.visitor.SqlFileExistInspectionVisitor
+
+/**
+ * Check for existence of SQL file
+ */
+class SqlFileExistInspection : AbstractBaseJavaLocalInspectionTool() {
+    override fun getDisplayName(): String = "Ensure the existence of SQL files for DAO methods."
+
+    override fun getShortName(): String = "org.domaframework.doma.intellij.existsqlchecker"
+
+    override fun getGroupDisplayName(): String = "DomaTools"
+
+    override fun isEnabledByDefault(): Boolean = true
+
+    override fun getDefaultLevel(): HighlightDisplayLevel = HighlightDisplayLevel.ERROR
+
+    override fun buildVisitor(
+        holder: ProblemsHolder,
+        isOnTheFly: Boolean,
+    ): PsiElementVisitor = SqlFileExistInspectionVisitor(holder)
+}

src/main/kotlin/org/domaframework/doma/intellij/inspection/dao/inspector/SqlFileExistInspection.kt

@@ -17,11 +17,11 @@ package org.domaframework.doma.intellij.inspection.dao.provider
 
 import com.intellij.codeInspection.InspectionToolProvider
 import com.intellij.codeInspection.LocalInspectionTool
-import org.domaframework.doma.intellij.inspection.dao.inspector.DaoMethodVariableInspector
+import org.domaframework.doma.intellij.inspection.dao.inspector.DaoMethodVariableInspection
 
 class DaoMethodVariableProvider : InspectionToolProvider {
     override fun getInspectionClasses(): Array<Class<out LocalInspectionTool>> =
         arrayOf(
-            DaoMethodVariableInspector::class.java,
+            DaoMethodVariableInspection::class.java,
         )
 }

src/main/kotlin/org/domaframework/doma/intellij/inspection/dao/provider/DaoMethodVariableProvider.kt

@@ -17,11 +17,11 @@ package org.domaframework.doma.intellij.inspection.dao.provider
 
 import com.intellij.codeInspection.InspectionToolProvider
 import com.intellij.codeInspection.LocalInspectionTool
-import org.domaframework.doma.intellij.inspection.dao.inspector.SqlFileExistInspector
+import org.domaframework.doma.intellij.inspection.dao.inspector.SqlFileExistInspection
 
 class SqlFileExistProvider : InspectionToolProvider {
     override fun getInspectionClasses(): Array<Class<out LocalInspectionTool>> =
         arrayOf(
-            SqlFileExistInspector::class.java,
+            SqlFileExistInspection::class.java,
         )
 }

src/main/kotlin/org/domaframework/doma/intellij/inspection/dao/provider/SqlFileExistProvider.kt

@@ -0,0 +1,92 @@
+/*
+ * 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.dao.visitor
+
+import com.intellij.codeInspection.ProblemHighlightType
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.psi.JavaElementVisitor
+import com.intellij.psi.PsiFile
+import com.intellij.psi.PsiMethod
+import com.intellij.psi.PsiParameter
+import com.intellij.psi.impl.source.PsiParameterImpl
+import org.domaframework.doma.intellij.bundle.MessageBundle
+import org.domaframework.doma.intellij.common.dao.getDaoClass
+import org.domaframework.doma.intellij.common.isJavaOrKotlinFileType
+import org.domaframework.doma.intellij.common.psi.PsiDaoMethod
+import org.domaframework.doma.intellij.extension.findFile
+import org.domaframework.doma.intellij.extension.psi.isCollector
+import org.domaframework.doma.intellij.extension.psi.isFunctionClazz
+import org.domaframework.doma.intellij.extension.psi.isSelectOption
+import org.domaframework.doma.intellij.extension.psi.methodParameters
+
+class DaoMethodVariableInspectionVisitor(
+    private val holder: ProblemsHolder,
+) : JavaElementVisitor() {
+    override fun visitMethod(method: PsiMethod) {
+        super.visitMethod(method)
+        val file = method.containingFile
+        if (!isJavaOrKotlinFileType(file) || getDaoClass(file) == null) return
+
+        val psiDaoMethod = PsiDaoMethod(method.project, method)
+        if (!psiDaoMethod.useSqlAnnotation() && !psiDaoMethod.isUseSqlFileMethod()) return
+
+        val methodParameters =
+            method.methodParameters
+                .filter { !it.isFunctionClazz && !it.isSelectOption && !(it.isCollector && psiDaoMethod.isSelectTypeCollect()) }
+        val sqlFileManager =
+            psiDaoMethod.sqlFile?.let {
+                method.project.findFile(it)
+            } ?: return
+
+        val params = methodParameters.toList()
+        val result = findElementsInSqlFile(sqlFileManager, params)
+        params.forEach { param ->
+            if (!result.elements.contains(param)) {
+                val message =
+                    if (result.deplicateForItemElements.contains(param)) {
+                        MessageBundle.message("inspection.invalid.dao.duplicate")
+                    } else {
+                        MessageBundle.message(
+                            "inspection.invalid.dao.paramUse",
+                            param.name,
+                        )
+                    }
+                holder.registerProblem(
+                    (param.originalElement as PsiParameterImpl).nameIdentifier,
+                    message,
+                    ProblemHighlightType.ERROR,
+                )
+            }
+        }
+    }
+
+    private data class DaoMethodVariableVisitorResult(
+        val elements: List<PsiParameter>,
+        val deplicateForItemElements: List<PsiParameter>,
+    )
+
+    private fun findElementsInSqlFile(
+        sqlFile: PsiFile,
+        args: List<PsiParameter>,
+    ): DaoMethodVariableVisitorResult {
+        val elements = mutableListOf<PsiParameter>()
+        val deplicateForItemElements = mutableListOf<PsiParameter>()
+
+        sqlFile.accept(DaoMethodVariableSqlVisitor(args, elements, deplicateForItemElements))
+        val result = DaoMethodVariableVisitorResult(elements, deplicateForItemElements)
+        return result
+    }
+}