Add support for DataType in Doma framework with related utility functions

Author: xterao

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

@@ -67,6 +67,7 @@ enum class DomaClassName(
     SELECT_TYPE("org.seasar.doma.SelectType"),
 
     ENTITY("org.seasar.doma.Entity"),
+    DATATYPE("org.seasar.doma.DataType"),
     ;
 
     fun isTargetClassNameStartsWith(paramTypeCanonicalNames: String): Boolean = paramTypeCanonicalNames.startsWith(this.className)

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

@@ -22,6 +22,7 @@ import com.intellij.psi.PsiType
 import org.domaframework.doma.intellij.common.psi.PsiTypeChecker
 import org.domaframework.doma.intellij.extension.getJavaClazz
 import org.domaframework.doma.intellij.extension.psi.getClassAnnotation
+import org.domaframework.doma.intellij.extension.psi.isDataType
 import org.domaframework.doma.intellij.extension.psi.isDomain
 import org.domaframework.doma.intellij.extension.psi.isEntity
 
@@ -73,6 +74,17 @@ object TypeUtil {
         return clazz?.isDomain() == true
     }
 
+    /**
+     * Checks if the given type is a data type.
+     */
+    fun isDataType(
+        type: PsiType?,
+        project: Project,
+    ): Boolean {
+        val clazz = type?.canonicalText?.let { project.getJavaClazz(it) }
+        return clazz?.isDataType() == true
+    }
+
     /**
      * Checks if the given type is a valid Map<String, Object>.
      */

src/main/kotlin/org/domaframework/doma/intellij/extension/psi/PsiClassExtension.kt

@@ -50,6 +50,8 @@ fun PsiClass.isEntity(): Boolean = this.getClassAnnotation(DomaClassName.ENTITY.
 
 fun PsiClass.isDomain(): Boolean = this.getClassAnnotation(DomaClassName.DOMAIN.className) != null
 
+fun PsiClass.isDataType(): Boolean = this.getClassAnnotation(DomaClassName.DATATYPE.className) != null
+
 fun PsiClassType.getSuperType(superClassName: String): PsiClassType? {
     var parent: PsiClassType? = this
     while (parent != null && !parent.canonicalText.startsWith(superClassName)) {

src/main/kotlin/org/domaframework/doma/intellij/inspection/dao/processor/TypeCheckerProcessor.kt

@@ -26,6 +26,7 @@ import org.domaframework.doma.intellij.common.psi.PsiTypeChecker
 import org.domaframework.doma.intellij.common.util.DomaClassName
 import org.domaframework.doma.intellij.extension.getJavaClazz
 import org.domaframework.doma.intellij.extension.psi.getSuperType
+import org.domaframework.doma.intellij.extension.psi.isDataType
 import org.domaframework.doma.intellij.extension.psi.isDomain
 
 /**
@@ -90,12 +91,12 @@ abstract class TypeCheckerProcessor(
             val optionalParam = paramClassType.parameters.firstOrNull()
             return optionalParam?.let {
                 val optionalParamClass = project.getJavaClazz(it.canonicalText)
-                optionalParamClass?.isDomain() == true || PsiTypeChecker.isBaseClassType(it)
+                optionalParamClass?.isDomain() == true || optionalParamClass?.isDataType() == true || PsiTypeChecker.isBaseClassType(it)
             } == true
         }
 
         val paramClass = project.getJavaClazz(paramType.canonicalText)
-        return paramClass?.isDomain() == true
+        return paramClass?.isDomain() == true || paramClass?.isDataType() == true
     }
 
     protected fun checkMapType(paramTypeCanonicalText: String): Boolean {

src/main/kotlin/org/domaframework/doma/intellij/inspection/dao/processor/cheker/ProcedureFunctionResultSetParamAnnotationTypeChecker.kt

@@ -26,6 +26,7 @@ import org.domaframework.doma.intellij.common.util.DomaClassName
 import org.domaframework.doma.intellij.common.validation.result.ValidationMethodParamsSupportGenericParamResult
 import org.domaframework.doma.intellij.common.validation.result.ValidationMethodProcedureParamTypeResult
 import org.domaframework.doma.intellij.extension.getJavaClazz
+import org.domaframework.doma.intellij.extension.psi.isDataType
 import org.domaframework.doma.intellij.extension.psi.isDomain
 import org.domaframework.doma.intellij.extension.psi.isEntity
 
@@ -46,14 +47,15 @@ class ProcedureFunctionResultSetParamAnnotationTypeChecker(
                 val optionalParamClass = project.getJavaClazz(it.canonicalText)
                 optionalParamClass?.isDomain() == true ||
                     optionalParamClass?.isEntity() == true ||
+                    optionalParamClass?.isDataType() == true ||
                     PsiTypeChecker.isBaseClassType(
                         it,
                     )
             } == true
         }
 
         val paramClass = project.getJavaClazz(paramType.canonicalText)
-        return paramClass?.isDomain() == true
+        return paramClass?.isDomain() == true || paramClass?.isDataType() == true
     }
 
     override fun checkParam(
@@ -101,7 +103,7 @@ class ProcedureFunctionResultSetParamAnnotationTypeChecker(
 
         val paramClass = project.getJavaClazz(listParamType.canonicalText)
 
-        if (checkParamType(listParamType) || paramClass?.isEntity() == true) return
+        if (checkParamType(listParamType) || paramClass?.isEntity() == true || paramClass?.isDataType() == true) return
         result.highlightElement(holder)
     }
 }

src/main/kotlin/org/domaframework/doma/intellij/inspection/dao/processor/paramtype/SelectParamTypeCheckProcessor.kt

@@ -27,6 +27,7 @@ import org.domaframework.doma.intellij.common.validation.result.ValidationMethod
 import org.domaframework.doma.intellij.common.validation.result.ValidationMethodSelectStrategyParamResult
 import org.domaframework.doma.intellij.extension.getJavaClazz
 import org.domaframework.doma.intellij.extension.psi.getSuperClassType
+import org.domaframework.doma.intellij.extension.psi.isDataType
 import org.domaframework.doma.intellij.extension.psi.isDomain
 import org.domaframework.doma.intellij.extension.psi.isEntity
 import org.domaframework.doma.intellij.inspection.dao.processor.StrategyParam
@@ -49,12 +50,13 @@ class SelectParamTypeCheckProcessor(
                 val optionalParamClass = project.getJavaClazz(it.canonicalText)
                 optionalParamClass?.isDomain() == true ||
                     PsiTypeChecker.isBaseClassType(it) ||
-                    optionalParamClass?.isEntity() == true
+                    optionalParamClass?.isEntity() == true ||
+                    optionalParamClass?.isDataType() == true
             } == true
         }
 
         val paramClass = project.getJavaClazz(paramType.canonicalText)
-        return paramClass?.isDomain() == true || paramClass?.isEntity() == true
+        return paramClass?.isDomain() == true || paramClass?.isEntity() == true || paramClass?.isDataType() == true
     }
 
     override fun checkParams(holder: ProblemsHolder) {

src/main/kotlin/org/domaframework/doma/intellij/inspection/dao/processor/returntype/FunctionReturnTypeCheckProcessor.kt

@@ -67,7 +67,7 @@ class FunctionReturnTypeCheckProcessor(
             }
         }
 
-        if (TypeUtil.isDomain(checkType, project) || TypeUtil.isEntity(checkType, project)) {
+        if (TypeUtil.isDomain(checkType, project) || TypeUtil.isEntity(checkType, project) || TypeUtil.isDataType(checkType, project)) {
             return null
         }
 

src/main/kotlin/org/domaframework/doma/intellij/inspection/dao/processor/returntype/SelectReturnTypeCheckProcessor.kt

@@ -91,7 +91,7 @@ class SelectReturnTypeCheckProcessor(
             }
         }
 
-        if (TypeUtil.isDomain(checkType, project) || TypeUtil.isEntity(checkType, project)) {
+        if (TypeUtil.isDomain(checkType, project) || TypeUtil.isEntity(checkType, project) || TypeUtil.isDataType(checkType, project)) {
             return null
         }
 

src/test/kotlin/org/domaframework/doma/intellij/inspection/dao/AnnotationReturnTypeCheckInspectionTest.kt

@@ -32,6 +32,7 @@ class AnnotationReturnTypeCheckInspectionTest : DomaSqlTest() {
             "ProcedureReturnTypeTestDao",
             "FunctionReturnTypeTestDao",
             "FactoryReturnTypeTestDao",
+            "DataTypeReturnTypeTestDao",
         )
     private val daoPackage = "inspection/returntype"
 
@@ -43,6 +44,7 @@ class AnnotationReturnTypeCheckInspectionTest : DomaSqlTest() {
         addEntityJavaFile("Packet.java")
         addEntityJavaFile("Pckt.java")
         addOtherJavaFile("domain", "Hiredate.java")
+        addOtherJavaFile("domain", "Salary.java")
         addOtherJavaFile("collector", "HogeCollector.java")
         addOtherJavaFile("function", "HogeFunction.java")
         addOtherJavaFile("function", "HogeBiFunction.java")
@@ -88,4 +90,9 @@ class AnnotationReturnTypeCheckInspectionTest : DomaSqlTest() {
         val dao = findDaoClass("$daoPackage.FactoryReturnTypeTestDao")
         myFixture.testHighlighting(false, false, false, dao.containingFile.virtualFile)
     }
+
+    fun testDataTypeReturnTypeCheckProcessor() {
+        val dao = findDaoClass("$daoPackage.DataTypeReturnTypeTestDao")
+        myFixture.testHighlighting(false, false, false, dao.containingFile.virtualFile)
+    }
 }

src/test/testData/src/main/java/doma/example/dao/inspection/returntype/DataTypeReturnTypeTestDao.java

@@ -0,0 +1,33 @@
+package doma.example.dao.inspection.returntype;
+
+import org.seasar.doma.*;
+import doma.example.domain.Salary;
+import org.seasar.doma.jdbc.Reference;
+
+import java.util.List;
+import java.util.Optional;
+
+@Dao
+public interface DataTypeReturnTypeTestDao {
+
+  @Select
+  @Sql("select * from salary where id = /*salary.value*/0")
+  Salary selectSalary(Salary salary);
+
+  @Select
+  @Sql("select * from salary where id = /*salary.value*/0")
+  Optional<Salary> selectOptSalary(Salary salary) ;
+
+  @Function
+  Salary calculateAverageSalary();
+  
+  @Function
+  Optional<Salary> getMaxSalary(@InOut Reference<Salary> percentage, @ResultSet List<Salary> resultSet);
+
+  @Procedure
+  void computeBonus(@In Salary employeeId);
+
+  @Procedure
+  void adjustSalaries(@InOut Reference<Salary> percentage, @ResultSet List<Salary> resultSet);
+
+}