Merge pull request #247 from domaframework/feature/check-dao-method-return-type

Check DAO Method Return Type

Author: xterao

README.md

@@ -35,12 +35,15 @@ The plugin also provides quick fixes for DAO methods where the required SQL file
   ![quickfix.png](images/quickfix.png)
 - Checks for unused DAO method arguments.
   ![inspection.png](images/inspection.png)
+- Checks that the return type of DAO method matches the expected type based on its annotation.
+  ![returnTypeInspection.png](images/returnTypeInspection.png)
 - Checks for undefined bind variable names.
 - Checks the class name and package name for static property calls.
   ![inspectionPackageName.png](images/inspectionPackageName.png)
 - Optional types are recognized as their element type (e.g., a parameter of type `Optional<String>` is treated as type `String`).
 - For custom functions, checks for methods that are not defined in the configured ExpressionFunctions implementation class.
 
+
 ## Completion
 Code completion is available to assist you in coding within directives.
 

images/returnTypeInspection.png

@@ -61,7 +61,7 @@ class PsiDaoMethod(
         psiMethod.containingFile.virtualFile
             ?: psiMethod.containingFile.originalFile.virtualFile
     var daoType: DomaAnnotationType = DomaAnnotationType.Unknown
-    private var sqlFileOption: Boolean = false
+    var sqlFileOption: Boolean = false
 
     init {
         setDaoAnnotationType()
@@ -77,8 +77,7 @@ class PsiDaoMethod(
 
     private fun setSqlFileOption() {
         val useSqlFileOptionAnnotation = daoType.getPsiAnnotation(psiMethod) ?: return
-        val isSqlFile = daoType.getSqlFileVal(useSqlFileOptionAnnotation)
-        sqlFileOption = isSqlFile == true
+        sqlFileOption = daoType.getSqlFileVal(useSqlFileOptionAnnotation)
     }
 
     @OptIn(ExperimentalStdlibApi::class)

src/main/kotlin/org/domaframework/doma/intellij/common/psi/PsiDaoMethod.kt

@@ -34,10 +34,10 @@ import org.domaframework.doma.intellij.common.psi.PsiStaticElement
 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.common.validation.result.ValidationCompleteResult
+import org.domaframework.doma.intellij.common.validation.result.ValidationNotFoundTopTypeResult
+import org.domaframework.doma.intellij.common.validation.result.ValidationPropertyResult
+import org.domaframework.doma.intellij.common.validation.result.ValidationResult
 import org.domaframework.doma.intellij.extension.expr.accessElements
 import org.domaframework.doma.intellij.extension.psi.findParameter
 import org.domaframework.doma.intellij.extension.psi.findStaticField

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

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.common.sql.validator.result
+package org.domaframework.doma.intellij.common.validation.result
 
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.openapi.util.TextRange

src/main/kotlin/org/domaframework/doma/intellij/common/sql/validator/result/ValidationClassPathResult.kt renamed to src/main/kotlin/org/domaframework/doma/intellij/common/validation/result/ValidationClassPathResult.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.common.sql.validator.result
+package org.domaframework.doma.intellij.common.validation.result
 
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.openapi.util.TextRange

src/main/kotlin/org/domaframework/doma/intellij/common/sql/validator/result/ValidationCompleteResult.kt renamed to src/main/kotlin/org/domaframework/doma/intellij/common/validation/result/ValidationCompleteResult.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.common.sql.validator.result
+package org.domaframework.doma.intellij.common.validation.result
 
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.openapi.util.TextRange

src/main/kotlin/org/domaframework/doma/intellij/common/sql/validator/result/ValidationDaoParamResult.kt renamed to src/main/kotlin/org/domaframework/doma/intellij/common/validation/result/ValidationDaoParamResult.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.common.sql.validator.result
+package org.domaframework.doma.intellij.common.validation.result
 
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.openapi.util.TextRange

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

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.common.sql.validator.result
+package org.domaframework.doma.intellij.common.validation.result
 
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.openapi.util.TextRange

src/main/kotlin/org/domaframework/doma/intellij/common/sql/validator/result/ValidationInvalidExpressionFunctionsResult.kt renamed to src/main/kotlin/org/domaframework/doma/intellij/common/validation/result/ValidationInvalidExpressionFunctionsResult.kt

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.common.sql.validator.result
+package org.domaframework.doma.intellij.common.validation.result
 
 import com.intellij.codeInspection.ProblemsHolder
 import com.intellij.openapi.util.TextRange