Add test case support for optional parameters in SQL document generation and completion

Author: xterao

src/test/kotlin/org/domaframework/doma/intellij/complate/sql/SqlCompleteTest.kt

@@ -53,6 +53,9 @@ class SqlCompleteTest : DomaSqlTest() {
             "$testDapName/completeCallStaticPropertyClass.sql",
             "$testDapName/completeForItemHasNext.sql",
             "$testDapName/completeForItemIndex.sql",
+            "$testDapName/completeOptionalDaoParam.sql",
+            "$testDapName/completeOptionalStaticProperty.sql",
+            "$testDapName/completeOptionalByForItem.sql",
         )
         myFixture.enableInspections(SqlBindVariableValidInspector())
     }
@@ -329,6 +332,30 @@ class SqlCompleteTest : DomaSqlTest() {
         )
     }
 
+    fun testCompleteOptionalDaoParam() {
+        innerDirectiveCompleteTest(
+            "$testDapName/completeOptionalDaoParam.sql",
+            listOf("manager", "projectNumber", "getFirstEmployee()"),
+            listOf("get()", "orElseGet()", "isPresent()"),
+        )
+    }
+
+    fun testCompleteOptionalStaticProperty() {
+        innerDirectiveCompleteTest(
+            "$testDapName/completeOptionalStaticProperty.sql",
+            listOf("userId", "userName", "email", "getUserNameFormat()"),
+            listOf("get()", "orElseGet()", "isPresent()"),
+        )
+    }
+
+    fun testCompleteOptionalByForItem() {
+        innerDirectiveCompleteTest(
+            "$testDapName/completeOptionalByForItem.sql",
+            listOf("manager", "projectNumber", "getFirstEmployee()"),
+            listOf("get()", "orElseGet()", "isPresent()"),
+        )
+    }
+
     private fun innerDirectiveCompleteTest(
         sqlFileName: String,
         expectedSuggestions: List<String>,

src/test/kotlin/org/domaframework/doma/intellij/document/SqlSymbolDocumentTestCase.kt

@@ -15,8 +15,12 @@
  */
 package org.domaframework.doma.intellij.document
 
+import com.intellij.openapi.vfs.VirtualFile
 import com.intellij.psi.PsiElement
 import org.domaframework.doma.intellij.DomaSqlTest
+import org.domaframework.doma.intellij.psi.SqlBlockComment
+import org.domaframework.doma.intellij.psi.SqlElFieldAccessExpr
+import org.domaframework.doma.intellij.psi.SqlElForDirective
 import org.domaframework.doma.intellij.psi.SqlElIdExpr
 
 class SqlSymbolDocumentTestCase : DomaSqlTest() {
@@ -37,6 +41,8 @@ class SqlSymbolDocumentTestCase : DomaSqlTest() {
         addSqlFile("$testPackage/$testDaoName/documentForItemStaticProperty.sql")
         addSqlFile("$testPackage/$testDaoName/documentForItemHasNext.sql")
         addSqlFile("$testPackage/$testDaoName/documentForItemIndex.sql")
+        addSqlFile("$testPackage/$testDaoName/documentForItemOptionalForItem.sql")
+        addSqlFile("$testPackage/$testDaoName/documentForItemOptionalProperty.sql")
     }
 
     fun testDocumentForItemDaoParam() {
@@ -55,6 +61,22 @@ class SqlSymbolDocumentTestCase : DomaSqlTest() {
         documentationTest(sqlName, result)
     }
 
+    fun testDocumentForItemOptionalForItem() {
+        val sqlName = "documentForItemOptionalForItem"
+        val result =
+            "<a href=\"psi_element://java.util.List\">List</a><<a href=\"psi_element://doma.example.entity.Project\">Project</a>> optionalProjects"
+
+        documentationTest(sqlName, result)
+    }
+
+    fun testDocumentForItemOptionalForItemProperty() {
+        val sqlName = "documentForItemOptionalProperty"
+        val result =
+            "<a href=\"psi_element://java.util.List\">List</a><<a href=\"psi_element://java.lang.Integer\">Integer</a>> optionalIds"
+
+        documentationFindTextTest(sqlName, "optionalIds", result)
+    }
+
     fun testDocumentForItemElement() {
         val sqlName = "documentForItemElement"
         val result =
@@ -146,8 +168,34 @@ class SqlSymbolDocumentTestCase : DomaSqlTest() {
         if (sqlFile == null) return
 
         myFixture.configureFromExistingVirtualFile(sqlFile)
-        var originalElement: PsiElement = myFixture.findElementByText(originalElementName, SqlElIdExpr::class.java)
+        var originalElement: PsiElement? =
+            myFixture.findElementByText(originalElementName, SqlElIdExpr::class.java)
+                ?: fundForDirectiveDeclarationElement(sqlFile, originalElementName)
+        assertNotNull("Not Found Element [$originalElementName]", originalElement)
+        if (originalElement == null) return
+
         val resultDocument = myDocumentationProvider.generateDoc(originalElement, originalElement)
         assertEquals("Documentation should contain expected text", result, resultDocument)
     }
+
+    private fun fundForDirectiveDeclarationElement(
+        sqlFile: VirtualFile,
+        searchElementName: String,
+    ): PsiElement? {
+        myFixture.configureFromExistingVirtualFile(sqlFile)
+        val topElement = myFixture.findElementByText(searchElementName, PsiElement::class.java)
+        val forDirectiveBlock =
+            topElement.children
+                .firstOrNull { it is SqlBlockComment && it.text.contains(searchElementName) }
+
+        val forDirective =
+            forDirectiveBlock?.children?.find { it is SqlElForDirective } as? SqlElForDirective
+                ?: return null
+        val fieldAccessExpr = forDirective.elExprList[1] as? SqlElFieldAccessExpr
+        if (fieldAccessExpr == null) {
+            return forDirective.elExprList.firstOrNull { it.text == searchElementName }
+        }
+
+        return fieldAccessExpr.elExprList.firstOrNull { it.text == searchElementName }
+    }
 }

src/test/kotlin/org/domaframework/doma/intellij/inspection/sql/ParameterDefinedTest.kt

@@ -38,6 +38,7 @@ class ParameterDefinedTest : DomaSqlTest() {
             "$testDaoName/bindVariableInFunctionParameters.sql",
             "$testDaoName/callStaticPropertyPackageName.sql",
             "$testDaoName/bindVariableForItemHasNextAndIndex.sql",
+            "$testDaoName/optionalDaoParameterFieldAccess.sql",
         )
         myFixture.enableInspections(SqlBindVariableValidInspector())
     }
@@ -70,6 +71,15 @@ class ParameterDefinedTest : DomaSqlTest() {
         myFixture.testHighlighting(false, false, false, sqlFile)
     }
 
+    fun testOptionalDaoParameterFieldAccess() {
+        val sqlFile =
+            findSqlFile("$testDaoName/optionalDaoParameterFieldAccess.sql")
+        assertNotNull("Not Found SQL File", sqlFile)
+        if (sqlFile == null) return
+
+        myFixture.testHighlighting(false, false, false, sqlFile)
+    }
+
     fun testAccessStaticProperty() {
         val sqlFile = findSqlFile("$testDaoName/accessStaticProperty.sql")
         assertNotNull("Not Found SQL File", sqlFile)

src/test/testData/src/main/java/doma/example/dao/EmployeeSummaryDao.java

@@ -5,6 +5,7 @@
 import org.seasar.doma.jdbc.Config;
 import org.seasar.doma.jdbc.PreparedSql;
 import org.seasar.doma.jdbc.SelectOptions;
+import java.util.*;
 
 import java.util.List;
 import java.util.function.BiFunction;
@@ -35,4 +36,7 @@ interface EmployeeSummaryDao {
 
   @Select
   List<Employee> bindVariableForItemHasNextAndIndex(List<Employee> employees);
+
+  @Select
+  Project optionalDaoParameterFieldAccess(Optional<Project> project, OptionalInt id, OptionalLong longId, OptionalDouble doubleId);
 }

src/test/testData/src/main/java/doma/example/dao/SqlCompleteTestDao.java

@@ -8,6 +8,7 @@
 
 import java.util.List;
 import java.util.function.BiFunction;
+import java.util.Optional;
 
 @Dao
 interface SqlCompleteTestDao {
@@ -81,4 +82,13 @@ interface SqlCompleteTestDao {
   @Select
   Principal completeForItemIndex(Principal principal);
 
+  @Select
+  Project completeOptionalDaoParam(Optional<Project> project);
+
+  @Select
+  Project completeOptionalStaticProperty();
+
+  @Select
+  Project completeOptionalByForItem(List<Project> projects);
+
 }

src/test/testData/src/main/java/doma/example/dao/document/DocumentTestDao.java

@@ -4,6 +4,7 @@
 import java.util.HashSet;
 import doma.example.entity.*;
 import org.seasar.doma.*;
+import java.util.Optional;
 
 @Dao
 public interface DocumentTestDao {
@@ -35,4 +36,10 @@ public interface DocumentTestDao {
   @Select
   int documentForItemHasNext(Principal principal);
 
+  @Select
+  Project documentForItemOptionalForItem(Optional<List<Optional<Project>>> optionalProjects);
+
+  @Select
+  Project documentForItemOptionalProperty(Optional<List<Optional<Project>>> optionalProjects);
+
 }

src/test/testData/src/main/java/doma/example/dao/inspection/TestDataCheckDao.java

@@ -29,4 +29,5 @@ interface TestDataCheckDao {
 
   @Insert(sqlFile=true)
   int invalidTestData(Employee employee);
+
 }

src/test/testData/src/main/java/doma/example/entity/Project.java

@@ -5,6 +5,7 @@
 import org.seasar.doma.Id;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Optional;
 
 @Entity
 public class Project {
@@ -15,6 +16,9 @@ public class Project {
   private static String status;
   private Integer rank;
 
+  public static Optional<List<Optional<Integer>>> optionalIds;
+  public static Optional<User> manager;
+
   // Accessible static fields
   public static Integr projectNumber;
   private static String projectCategory;

src/test/testData/src/main/resources/META-INF/doma/example/dao/EmployeeSummaryDao/optionalDaoParameterFieldAccess.sql

@@ -0,0 +1,14 @@
+select * from projects
+-- project : Optional<Project> -> Project
+where id = /* project.projectId */0
+  and project_name = /* project.<error descr="The field or method [flatMap] does not exist in the class [Project]">flatMap</error>() */'projectName'
+  and sa_number = /* id.<error descr="The field or method [flatMap] does not exist in the class [Integer]">flatMap</error>() */0
+  and number = /* id.MAX_VALUE */0
+  and as_long = /* longId.<error descr="The field or method [getAsLong] does not exist in the class [Long]">getAsLong</error>() */0
+  and long = /* longId.doubleValue() */0
+  and as_double = /* doubleId.<error descr="The field or method [getAsDouble] does not exist in the class [Double]">getAsDouble</error>() */0
+  and doubles = /* longId.doubleValue() */0
+  -- optId : Optional<Integer> -> Integer
+ /*%for optId : project.optionalIds */
+  OR  sub_id = /* optId.MAX_VALUE */0
+ /*%end */

src/test/testData/src/main/resources/META-INF/doma/example/dao/SqlCompleteTestDao/completeOptionalByForItem.sql

@@ -0,0 +1,5 @@
+select * from project
+ where
+ /*%for project : projects */
+  or user_id = /* project.<caret> */0
+ /*%end */