Skip to content

Fix to not display Dao parameter information in the document for elements defined with the for directive. #167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 15, 2025
Merged

Fix to not display Dao parameter information in the document for elements defined with the for directive. #167

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions ...otlin/org/domaframework/doma/intellij/document/generator/DocumentDaoParameterGenerator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ import org.domaframework.doma.intellij.common.psi.PsiParentClass
import org.domaframework.doma.intellij.common.util.ForDirectiveUtil
import org.domaframework.doma.intellij.extension.expr.accessElementsPrevOriginalElement
import org.domaframework.doma.intellij.extension.psi.findParameter
import org.domaframework.doma.intellij.extension.psi.getForItem
import org.domaframework.doma.intellij.psi.SqlElFieldAccessExpr
import org.domaframework.doma.intellij.psi.SqlElForDirective

class DocumentDaoParameterGenerator(
val originalElement: PsiElement,
Expand Down Expand Up @@ -59,6 +61,15 @@ class DocumentDaoParameterGenerator(
forItemClassType
}
} else {
val forDirectiveExpr =
PsiTreeUtil.getParentOfType(
searchElement,
SqlElForDirective::class.java,
)
if (forDirectiveExpr != null && forDirectiveExpr.getForItem() == searchElement) {
// For elements defined with the for directive, Dao parameters are not searched.
return
}
val daoMethod = findDaoMethod(originalElement.containingFile) ?: return
val param = daoMethod.findParameter(originalElement.text) ?: return
isBatchAnnotation = PsiDaoMethod(project, daoMethod).daoType.isBatchAnnotation()
Expand Down
8 changes: 8 additions & 0 deletions src/test/kotlin/org/domaframework/doma/intellij/document/SqlSymbolDocumentTestCase.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ class SqlSymbolDocumentTestCase : DomaSqlTest() {
addSqlFile("$testPackage/$testDaoName/documentForItemIndex.sql")
addSqlFile("$testPackage/$testDaoName/documentForItemOptionalForItem.sql")
addSqlFile("$testPackage/$testDaoName/documentForItemOptionalProperty.sql")
addSqlFile("$testPackage/$testDaoName/documentForItemInvalidPrimary.sql")
}

fun testDocumentForItemDaoParam() {
Expand Down Expand Up @@ -145,6 +146,13 @@ class SqlSymbolDocumentTestCase : DomaSqlTest() {
documentationFindTextTest(sqlName, "project", result)
}

fun testDocumentForItemInvalidPrimary() {
val sqlName = "documentForItemInvalidPrimary"
val result = " item"

documentationFindTextTest(sqlName, "item", result)
}

private fun documentationTest(
sqlName: String,
result: String?,
Expand Down
3 changes: 3 additions & 0 deletions src/test/testData/src/main/java/doma/example/dao/document/DocumentTestDao.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,7 @@ public interface DocumentTestDao {
@Select
Project documentForItemOptionalProperty(Optional<List<Optional<Project>>> optionalProjects);

@Select
int documentForItemInvalidPrimary(Principal item, Principal principal);

}
8 changes: 8 additions & 0 deletions ...rces/META-INF/doma/example/dao/document/DocumentTestDao/documentForItemInvalidPrimary.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
select count(*) from principal
where
/*%for item : principal */
name = /* ite<caret>m.name */'name'
/*%if item_has_next */
/*# "or" */
/*%end */
/*%end */