Merge pull request #160 from domaframework/feature/add-suggestion-for-directive-item

Completion for directive items

Author: xterao

src/main/kotlin/org/domaframework/doma/intellij/contributor/sql/provider/SqlParameterCompletionProvider.kt

@@ -275,7 +275,7 @@ class SqlParameterCompletionProvider : CompletionProvider<CompletionParameters>(
         val searchText = cleanString(getSearchElementText(position))
         var topElementType: PsiType? = null
         if (elements.isEmpty() && daoMethod != null) {
-            getElementTypeByFieldAccess(originalFile, elements, daoMethod, result)
+            getElementTypeByFieldAccess(originalFile, position, elements, daoMethod, result)
             return
         }
         val top = elements.first()
@@ -301,7 +301,7 @@ class SqlParameterCompletionProvider : CompletionProvider<CompletionParameters>(
             isBatchAnnotation = psiDaoMethod.daoType.isBatchAnnotation()
             if (isFieldAccessByForItem(top, elements, searchText, isBatchAnnotation, result)) return
             topElementType =
-                getElementTypeByFieldAccess(originalFile, elements, daoMethod, result) ?: return
+                getElementTypeByFieldAccess(originalFile, position, elements, daoMethod, result) ?: return
         }
 
         setCompletionFieldAccess(
@@ -351,18 +351,22 @@ class SqlParameterCompletionProvider : CompletionProvider<CompletionParameters>(
      */
     private fun getElementTypeByFieldAccess(
         originalFile: PsiFile,
+        position: PsiElement,
         elements: List<PsiElement>,
         daoMethod: PsiMethod,
         result: CompletionResultSet,
     ): PsiType? {
-        val topText = cleanString(getSearchElementText(elements.firstOrNull()))
+        val topElement = elements.firstOrNull()
+        val topText = cleanString(getSearchElementText(topElement))
         val matchParams = daoMethod.searchParameter(topText)
         val findParam = matchParams.find { it.name == topText }
         if (elements.size <= 1 && findParam == null) {
-            // TODO Add For Directive Items
             matchParams.map { match ->
                 result.addElement(LookupElementBuilder.create(match.name))
             }
+            // Add ForDirective Items
+            val forDirectives = ForDirectiveUtil.getForDirectiveBlocks(position)
+            addForDirectiveSuggestions(forDirectives, result)
             return null
         }
         if (findParam == null) {
@@ -372,6 +376,17 @@ class SqlParameterCompletionProvider : CompletionProvider<CompletionParameters>(
         return PsiClassTypeUtil.convertOptionalType(immediate, originalFile.project)
     }
 
+    private fun addForDirectiveSuggestions(
+        forDirectives: List<ForDirectiveUtil.BlockToken>,
+        result: CompletionResultSet,
+    ) {
+        forDirectives.forEach {
+            result.addElement(LookupElementBuilder.create(it.item.text))
+            result.addElement(LookupElementBuilder.create("${it.item.text}_has_next"))
+            result.addElement(LookupElementBuilder.create("${it.item.text}_index"))
+        }
+    }
+
     private fun getRefClazz(
         top: PsiElement,
         fqdnGetter: () -> String,

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

@@ -58,6 +58,7 @@ class SqlCompleteTest : DomaSqlTest() {
             "$testDapName/completeOptionalStaticProperty.sql",
             "$testDapName/completeOptionalByForItem.sql",
             "$testDapName/completeOptionalBatchAnnotation.sql",
+            "$testDapName/completeForDirectiveItem.sql",
         )
         myFixture.enableInspections(SqlBindVariableValidInspector())
     }
@@ -391,6 +392,14 @@ class SqlCompleteTest : DomaSqlTest() {
         )
     }
 
+    fun testCompleteForDirectiveItem() {
+        innerDirectiveCompleteTest(
+            "$testDapName/completeForDirectiveItem.sql",
+            listOf("projects", "project", "project_has_next", "project_index"),
+            listOf("get()", "size()", "toString()", "projectId"),
+        )
+    }
+
     private fun innerDirectiveCompleteTest(
         sqlFileName: String,
         expectedSuggestions: List<String>,

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

@@ -97,4 +97,7 @@ interface SqlCompleteTestDao {
   @BatchDelete(sqlFile = true)
   int completeOptionalBatchAnnotation(Optional<List<Optional<Project>>> projects);
 
+  @Select
+  Employee completeForDirectiveItem(List<Project> projects);
+
 }

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

@@ -0,0 +1,11 @@
+SELECT id
+       , name
+       , age
+  FROM employees
+ WHERE
+/*%for project : projects */
+  id = /* <caret> */0
+/*%if project_has_next */
+/*# "OR" */
+/*%end */
+/*%end */