refactor(context-builders): replace usage of JavaContextCollection with ClassContextBuilder for improved usability and consistency across language-specific context builders.

Author: phodal

java/src/main/kotlin/cc/unitmesh/idea/context/JavaClassContextBuilder.kt

@@ -18,7 +18,7 @@ class JavaClassContextBuilder : ClassContextBuilder {
         val methods = psiElement.methods.toList()
 
         val usages =
-            if (gatherUsages) JavaContextCollection.findUsages(psiElement as PsiNameIdentifierOwner) else emptyList()
+            if (gatherUsages) ClassContextBuilder.findUsages(psiElement as PsiNameIdentifierOwner) else emptyList()
 
         val annotations: List<String> = psiElement.annotations.mapNotNull {
             it.text

java/src/main/kotlin/cc/unitmesh/idea/context/JavaContextCollection.kt

@@ -1,6 +1,7 @@
 package cc.unitmesh.idea.context
 
 import cc.unitmesh.devti.context.SimpleClassStructure
+import cc.unitmesh.devti.context.builder.ClassContextBuilder
 import com.intellij.openapi.diagnostic.logger
 import com.intellij.openapi.util.NlsSafe
 import com.intellij.psi.*
@@ -12,20 +13,6 @@ import com.intellij.psi.search.searches.ReferencesSearch
 
 object JavaContextCollection {
     private val logger = logger<JavaContextCollection>()
-    fun findUsages(nameIdentifierOwner: PsiNameIdentifierOwner): List<PsiReference> {
-        val project = nameIdentifierOwner.project
-        val searchScope = GlobalSearchScope.allScope(project) as SearchScope
-
-        return when (nameIdentifierOwner) {
-            is PsiMethod -> {
-                MethodReferencesSearch.search(nameIdentifierOwner, searchScope, true)
-            }
-
-            else -> {
-                ReferencesSearch.search((nameIdentifierOwner as PsiElement), searchScope, true)
-            }
-        }.findAll().map { it as PsiReference }
-    }
 
     /**
      * This method takes a PsiClass object as input and builds a tree of the class and its fields, including the fields of the fields, and so on. The resulting tree is represented as a HashMap where the keys are the PsiClass objects and the values are ArrayLists of PsiField objects.
@@ -123,11 +110,13 @@ object JavaContextCollection {
     }
 
     private fun isPopularFrameworks(qualifiedName: @NlsSafe String?): Boolean? {
-        return qualifiedName?.startsWith("org.springframework") == true || qualifiedName?.startsWith("org.apache") == true || qualifiedName?.startsWith(
-            "org.hibernate"
-        ) == true || qualifiedName?.startsWith("org.slf4j") == true || qualifiedName?.startsWith("org.apache") == true || qualifiedName?.startsWith(
-            "org.junit"
-        ) == true || qualifiedName?.startsWith("org.mockito") == true
+        return qualifiedName?.startsWith("org.springframework") == true ||
+                qualifiedName?.startsWith("org.apache") == true ||
+                qualifiedName?.startsWith("org.hibernate") == true ||
+                qualifiedName?.startsWith("org.slf4j") == true ||
+                qualifiedName?.startsWith("org.apache") == true ||
+                qualifiedName?.startsWith("org.junit") == true ||
+                qualifiedName?.startsWith("org.mockito") == true
     }
 
     /**

java/src/main/kotlin/cc/unitmesh/idea/context/JavaMethodContextBuilder.kt

@@ -1,6 +1,7 @@
 package cc.unitmesh.idea.context
 
 import cc.unitmesh.devti.context.MethodContext
+import cc.unitmesh.devti.context.builder.ClassContextBuilder
 import cc.unitmesh.devti.context.builder.MethodContextBuilder
 import cc.unitmesh.idea.service.JavaTypeUtil
 import com.intellij.psi.PsiElement
@@ -21,7 +22,7 @@ class JavaMethodContextBuilder : MethodContextBuilder {
         val variableContextList = parameterList.map { it }
 
         val usagesList = if (gatherUsages) {
-            JavaContextCollection.findUsages(psiElement as PsiNameIdentifierOwner)
+            ClassContextBuilder.findUsages(psiElement as PsiNameIdentifierOwner)
         } else {
             emptyList()
         }

java/src/main/kotlin/cc/unitmesh/idea/context/JavaVariableContextBuilder.kt

@@ -1,6 +1,7 @@
 package cc.unitmesh.idea.context
 
 import cc.unitmesh.devti.context.VariableContext
+import cc.unitmesh.devti.context.builder.ClassContextBuilder
 import cc.unitmesh.devti.context.builder.VariableContextBuilder
 import com.intellij.psi.*
 
@@ -17,7 +18,7 @@ class JavaVariableContextBuilder : VariableContextBuilder {
         val containingClass = psiElement.getContainingClass()
 
         val references =
-            if (gatherUsages) JavaContextCollection.findUsages(psiElement as PsiNameIdentifierOwner) else emptyList()
+            if (gatherUsages) ClassContextBuilder.findUsages(psiElement as PsiNameIdentifierOwner) else emptyList()
 
         return VariableContext(
             psiElement,

kotlin/src/main/kotlin/cc/unitmesh/kotlin/context/KotlinClassContextBuilder.kt

@@ -2,7 +2,6 @@ package cc.unitmesh.kotlin.context
 
 import cc.unitmesh.devti.context.ClassContext
 import cc.unitmesh.devti.context.builder.ClassContextBuilder
-import cc.unitmesh.idea.context.JavaContextCollection
 import cc.unitmesh.kotlin.util.KotlinPsiUtil
 import com.intellij.psi.PsiElement
 import com.intellij.psi.PsiNameIdentifierOwner
@@ -23,7 +22,7 @@ class KotlinClassContextBuilder : ClassContextBuilder {
         val functions = KotlinPsiUtil.getFunctions(psiElement)
         val allFields = getPrimaryConstructorFields(psiElement)
         val usages =
-            if (gatherUsages) JavaContextCollection.findUsages(psiElement as PsiNameIdentifierOwner) else emptyList()
+            if (gatherUsages) ClassContextBuilder.findUsages(psiElement as PsiNameIdentifierOwner) else emptyList()
 
         val annotations: List<String> = psiElement.annotationEntries.mapNotNull {
             it.text

kotlin/src/main/kotlin/cc/unitmesh/kotlin/context/KotlinMethodContextBuilder.kt

@@ -1,8 +1,8 @@
 package cc.unitmesh.kotlin.context
 
 import cc.unitmesh.devti.context.MethodContext
+import cc.unitmesh.devti.context.builder.ClassContextBuilder
 import cc.unitmesh.devti.context.builder.MethodContextBuilder
-import cc.unitmesh.idea.context.JavaContextCollection
 import cc.unitmesh.kotlin.util.KotlinPsiUtil
 import com.intellij.psi.PsiElement
 import com.intellij.psi.PsiNameIdentifierOwner
@@ -24,7 +24,7 @@ class KotlinMethodContextBuilder : MethodContextBuilder {
         val displayName = psiElement.language.displayName
         val valueParameters = psiElement.valueParameters.mapNotNull { it.name }
         val usages =
-            if (gatherUsages) JavaContextCollection.findUsages(psiElement as PsiNameIdentifierOwner) else emptyList()
+            if (gatherUsages) ClassContextBuilder.findUsages(psiElement as PsiNameIdentifierOwner) else emptyList()
 
         return MethodContext(
             psiElement,

kotlin/src/main/kotlin/cc/unitmesh/kotlin/context/KotlinVariableContextBuilder.kt

@@ -1,8 +1,8 @@
 package cc.unitmesh.kotlin.context
 
 import cc.unitmesh.devti.context.VariableContext
+import cc.unitmesh.devti.context.builder.ClassContextBuilder
 import cc.unitmesh.devti.context.builder.VariableContextBuilder
-import cc.unitmesh.idea.context.JavaContextCollection
 import com.intellij.psi.PsiElement
 import com.intellij.psi.PsiNameIdentifierOwner
 import com.intellij.psi.util.PsiTreeUtil
@@ -27,7 +27,7 @@ class KotlinVariableContextBuilder : VariableContextBuilder {
                 val psiNameIdentifierOwner = psiElement as? PsiNameIdentifierOwner
 
                 val usages = if (gatherUsages && psiNameIdentifierOwner != null) {
-                    JavaContextCollection.findUsages(psiNameIdentifierOwner)
+                    ClassContextBuilder.findUsages(psiNameIdentifierOwner)
                 } else {
                     emptyList()
                 }
@@ -43,7 +43,7 @@ class KotlinVariableContextBuilder : VariableContextBuilder {
                 val psiNameIdentifierOwner = psiElement as? PsiNameIdentifierOwner
 
                 val usages = if (gatherUsages && psiNameIdentifierOwner != null) {
-                    JavaContextCollection.findUsages(psiNameIdentifierOwner)
+                    ClassContextBuilder.findUsages(psiNameIdentifierOwner)
                 } else {
                     emptyList()
                 }

scala/src/main/kotlin/cc/unitmesh/scala/context/ScalaClassContextBuilder.kt

@@ -21,7 +21,7 @@ class ScalaClassContextBuilder : ClassContextBuilder {
         val functions = psiElement.methods.toList()
         val allFields = psiElement.fields.toList()
         val superClass = psiElement.supers.mapNotNull { it.qualifiedName }.toList()
-        val usages = findUsages(psiElement as PsiNameIdentifierOwner)
+        val usages = ClassContextBuilder.findUsages(psiElement as PsiNameIdentifierOwner)
 
         val annotations = psiElement.annotations.mapNotNull {
             it.text
@@ -41,18 +41,3 @@ class ScalaClassContextBuilder : ClassContextBuilder {
         )
     }
 }
-
-fun findUsages(nameIdentifierOwner: PsiNameIdentifierOwner): List<PsiReference> {
-    val project = nameIdentifierOwner.project
-    val searchScope = GlobalSearchScope.allScope(project) as SearchScope
-
-    return when (nameIdentifierOwner) {
-        is PsiMethod -> {
-            MethodReferencesSearch.search(nameIdentifierOwner, searchScope, true)
-        }
-
-        else -> {
-            ReferencesSearch.search((nameIdentifierOwner as PsiElement), searchScope, true)
-        }
-    }.findAll().map { it as PsiReference }
-}

src/main/kotlin/cc/unitmesh/devti/context/builder/ClassContextBuilder.kt

@@ -2,6 +2,13 @@ package cc.unitmesh.devti.context.builder
 
 import cc.unitmesh.devti.context.ClassContext
 import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiMethod
+import com.intellij.psi.PsiNameIdentifierOwner
+import com.intellij.psi.PsiReference
+import com.intellij.psi.search.GlobalSearchScope
+import com.intellij.psi.search.SearchScope
+import com.intellij.psi.search.searches.MethodReferencesSearch
+import com.intellij.psi.search.searches.ReferencesSearch
 
 /**
  * The ClassContextBuilder interface provides a method to retrieve the class context for a given PsiElement.
@@ -17,4 +24,21 @@ interface ClassContextBuilder {
      * @return the class context for the given [psiElement], or null if the class context cannot be determined
      */
     fun getClassContext(psiElement: PsiElement, gatherUsages: Boolean): ClassContext?
+
+    companion object {
+        fun findUsages(nameIdentifierOwner: PsiNameIdentifierOwner): List<PsiReference> {
+            val project = nameIdentifierOwner.project
+            val searchScope = GlobalSearchScope.allScope(project) as SearchScope
+
+            return when (nameIdentifierOwner) {
+                is PsiMethod -> {
+                    MethodReferencesSearch.search(nameIdentifierOwner, searchScope, true)
+                }
+
+                else -> {
+                    ReferencesSearch.search((nameIdentifierOwner as PsiElement), searchScope, true)
+                }
+            }.findAll().map { it as PsiReference }
+        }
+    }
 }