feat: rewrite routing reference system

xepozz · xepozz · commit 10cd51861e8a · 2025-10-09T18:23:01.000+04:00
diff --git a/src/main/kotlin/com/github/tempest/framework/TempestFrameworkClasses.kt b/src/main/kotlin/com/github/tempest/framework/TempestFrameworkClasses.kt
@@ -2,6 +2,7 @@ package com.github.tempest.framework
 
 object TempestFrameworkClasses {
     const val ConsoleCommand = "\\Tempest\\Console\\ConsoleCommand"
+    const val FUNCTION_URI = "\\Tempest\\uri"
 
     const val ROUTER_GET = "\\Tempest\\Router\\Get"
     const val ROUTER_POST = "\\Tempest\\Router\\Post"
diff --git a/src/main/kotlin/com/github/tempest/framework/common/index/ObjectStreamDataExternalizer.kt b/src/main/kotlin/com/github/tempest/framework/common/index/ObjectStreamDataExternalizer.kt
@@ -0,0 +1,44 @@
+package com.github.tempest.framework.common.index
+
+import com.intellij.util.io.DataExternalizer
+import java.io.ByteArrayInputStream
+import java.io.ByteArrayOutputStream
+import java.io.DataInput
+import java.io.DataOutput
+import java.io.IOException
+import java.io.ObjectInput
+import java.io.ObjectInputStream
+import java.io.ObjectOutput
+import java.io.ObjectOutputStream
+
+class ObjectStreamDataExternalizer<T : Any> : DataExternalizer<T> {
+    @Throws(IOException::class)
+    override fun save(out: DataOutput, value: T?) {
+        val stream = ByteArrayOutputStream()
+        val output: ObjectOutput = ObjectOutputStream(stream)
+
+        output.writeObject(value)
+
+        out.writeInt(stream.size())
+        out.write(stream.toByteArray())
+    }
+
+    @Throws(IOException::class)
+    override fun read(`in`: DataInput): T? {
+        val bufferSize = `in`.readInt()
+        val buffer = ByteArray(bufferSize)
+        `in`.readFully(buffer, 0, bufferSize)
+
+        val stream = ByteArrayInputStream(buffer)
+        val input: ObjectInput = ObjectInputStream(stream)
+
+        var `object`: T? = null
+        try {
+            `object` = input.readObject() as T
+        } catch (ignored: ClassNotFoundException) {
+        } catch (ignored: ClassCastException) {
+        }
+
+        return `object`
+    }
+}
diff --git a/src/main/kotlin/com/github/tempest/framework/common/utils/StringUtils.kt b/src/main/kotlin/com/github/tempest/framework/common/utils/StringUtils.kt
diff --git a/src/main/kotlin/com/github/tempest/framework/php/mixin.kt b/src/main/kotlin/com/github/tempest/framework/php/mixin.kt
@@ -3,6 +3,7 @@ package com.github.tempest.framework.php
 import com.github.tempest.framework.TempestFrameworkClasses
 import com.intellij.openapi.util.text.StringUtil
 import com.intellij.psi.util.PsiTreeUtil
+import com.jetbrains.php.PhpIndex
 import com.jetbrains.php.lang.psi.PhpFile
 import com.jetbrains.php.lang.psi.elements.Method
 import com.jetbrains.php.lang.psi.elements.Variable
@@ -24,4 +25,12 @@ fun Method.getConsoleCommandName(): String? {
         ?.argument
         ?.value
         ?.run { StringUtil.unquoteString(this) }
-}
+}
+
+fun PhpIndex.getMethodsByFQN(fqn:String): Collection<Method> {
+    val (className, methodName) = fqn.split('.')
+    return this
+        .getClassesByFQN(className)
+        .mapNotNull{ it.findMethodByName(methodName) }
+}
+
diff --git a/src/main/kotlin/com/github/tempest/framework/router/StringUtils.kt b/src/main/kotlin/com/github/tempest/framework/router/StringUtils.kt
@@ -0,0 +1,8 @@
+package com.github.tempest.framework.router
+
+object StringUtils {
+    fun findRouterParameters(text: String): List<MatchResult> =
+        Regex("\\{([^:\\/}]+)(?::([^}]+))?(?:[}\\/]|$)")
+            .findAll(text)
+            .toList()
+}
diff --git a/src/main/kotlin/com/github/tempest/framework/router/index/Route.kt b/src/main/kotlin/com/github/tempest/framework/router/index/Route.kt
@@ -0,0 +1,15 @@
+package com.github.tempest.framework.router.index
+
+import java.io.Serializable
+
+data class Route(
+    val pattern: String,
+    val action: String,
+    val method: String,
+    val parameters: Set<RouteParameter>,
+) : Serializable
+
+data class RouteParameter(
+    val name: String,
+    val pattern: String,
+) : Serializable
diff --git a/src/main/kotlin/com/github/tempest/framework/router/index/RouterIndexUtils.kt b/src/main/kotlin/com/github/tempest/framework/router/index/RouterIndexUtils.kt
@@ -0,0 +1,24 @@
+package com.github.tempest.framework.router.index
+
+import com.intellij.openapi.project.Project
+import com.intellij.psi.search.GlobalSearchScope
+import com.intellij.util.indexing.FileBasedIndex
+
+object RouterIndexUtils {
+    fun getAllRoutes(project: Project): Collection<Route> {
+        val fileBasedIndex = FileBasedIndex.getInstance()
+
+        return fileBasedIndex
+            .getAllKeys(RoutesListIndex.key, project)
+            .flatMap { fileBasedIndex.getValues(RoutesListIndex.key, it, GlobalSearchScope.allScope(project)) }
+            .filterNotNull()
+    }
+
+    fun getRoute(pattern: String, project: Project): Collection<Route> {
+        val fileBasedIndex = FileBasedIndex.getInstance()
+
+        return fileBasedIndex
+            .getValues(RoutesListIndex.key, pattern, GlobalSearchScope.allScope(project))
+            .filterNotNull()
+    }
+}
diff --git a/src/main/kotlin/com/github/tempest/framework/router/index/RouterMethodsIndex.kt b/src/main/kotlin/com/github/tempest/framework/router/index/RouterMethodsIndex.kt
diff --git a/src/main/kotlin/com/github/tempest/framework/router/index/RoutesListIndex.kt b/src/main/kotlin/com/github/tempest/framework/router/index/RoutesListIndex.kt
@@ -0,0 +1,75 @@
+package com.github.tempest.framework.router.index
+
+import com.github.tempest.framework.TempestFrameworkClasses
+import com.github.tempest.framework.TempestFrameworkUtil
+import com.github.tempest.framework.common.index.AbstractIndex
+import com.github.tempest.framework.common.index.ObjectStreamDataExternalizer
+import com.github.tempest.framework.router.StringUtils
+import com.intellij.openapi.util.text.StringUtil
+import com.intellij.psi.util.PsiTreeUtil
+import com.intellij.util.indexing.DataIndexer
+import com.intellij.util.indexing.FileBasedIndex
+import com.intellij.util.indexing.FileContent
+import com.intellij.util.indexing.ID
+import com.jetbrains.php.lang.PhpFileType
+import com.jetbrains.php.lang.psi.elements.Method
+import com.jetbrains.php.lang.psi.elements.PhpAttribute
+
+private typealias RoutesListIndexType = Route
+
+/**
+ * Stores uri -> methods association
+ */
+class RoutesListIndex : AbstractIndex<RoutesListIndexType>() {
+    companion object {
+        val key = ID.create<String, RoutesListIndexType>("Tempest.Routes.List")
+    }
+
+    override fun getVersion() = 2
+
+    override fun getName() = key
+
+    override fun getValueExternalizer() = ObjectStreamDataExternalizer<RoutesListIndexType>()
+
+    override fun getInputFilter() = FileBasedIndex.InputFilter {
+        it.fileType == PhpFileType.INSTANCE &&
+                !it.name.endsWith(TempestFrameworkUtil.TEMPLATE_SUFFIX)
+    }
+
+    override fun getIndexer() = DataIndexer<String, RoutesListIndexType, FileContent> { inputData ->
+        inputData
+            .psiFile
+            .let { PsiTreeUtil.findChildrenOfType(it, PhpAttribute::class.java) }
+            .filter { it.fqn in TempestFrameworkClasses.ROUTES }
+            .mapNotNull { attribute ->
+                val httpMethod = attribute.name?.uppercase() ?: return@mapNotNull null
+                val method = attribute.owner as? Method ?: return@mapNotNull null
+                val pattern = attribute.arguments
+                    .firstOrNull { it.name == "uri" || it.name.isEmpty() }
+                    ?.argument
+                    ?.value
+                    ?.let { StringUtil.unquoteString(it) }
+                    ?: return@mapNotNull null
+                val parameters = StringUtils
+                    .findRouterParameters(pattern)
+                    .map {
+                        RouteParameter(
+                            it.groupValues[1],
+                            it.groupValues.getOrNull(2) ?: "",
+                        )
+                    }
+                    .toSet()
+
+                Pair(
+                    pattern,
+                    Route(
+                        pattern = pattern,
+                        action = method.fqn,
+                        method = httpMethod,
+                        parameters = parameters,
+                    ),
+                )
+            }
+            .associate { it.first to it.second }
+    }
+}
diff --git a/src/main/kotlin/com/github/tempest/framework/router/references/RouteParametersReferenceContributor.kt b/src/main/kotlin/com/github/tempest/framework/router/references/RouteParametersReferenceContributor.kt
@@ -1,8 +1,8 @@
 package com.github.tempest.framework.router.references
 
 import com.github.tempest.framework.TempestFrameworkClasses
-import com.github.tempest.framework.common.utils.StringUtils
 import com.github.tempest.framework.php.patterns.AttributeFqnCondition
+import com.github.tempest.framework.router.StringUtils
 import com.intellij.openapi.util.TextRange
 import com.intellij.patterns.PlatformPatterns
 import com.intellij.patterns.StandardPatterns
@@ -38,11 +38,12 @@ class RouteParametersReferenceContributor : PsiReferenceContributor() {
                     val parameters = method.parameters
                     if (parameters.isEmpty()) return emptyArray()
 
-                    return StringUtils.findTextBetweenParenthesis(element.text)
-                        .map { alias ->
+                    return StringUtils.findRouterParameters(element.text)
+                        .mapNotNull { alias ->
+                            val nameGroup = alias.groups[1] ?: return@mapNotNull null
                             val rangeInElement = TextRange(
-                                alias.range.first + 1,
-                                alias.range.last
+                                nameGroup.range.first,
+                                nameGroup.range.last+1
                             )
 
                             val parameter = method.getParameter(alias.groupValues[1])
diff --git a/src/main/kotlin/com/github/tempest/framework/router/references/RouteReference.kt b/src/main/kotlin/com/github/tempest/framework/router/references/RouteReference.kt
@@ -0,0 +1,42 @@
+package com.github.tempest.framework.router.references
+
+import com.github.tempest.framework.TempestIcons
+import com.github.tempest.framework.php.getMethodsByFQN
+import com.github.tempest.framework.router.index.RouterIndexUtils
+import com.intellij.codeInsight.lookup.LookupElementBuilder
+import com.intellij.openapi.util.TextRange
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiElementResolveResult
+import com.intellij.psi.PsiPolyVariantReferenceBase
+import com.intellij.psi.ResolveResult
+import com.jetbrains.php.PhpIndexImpl
+import com.jetbrains.php.lang.PhpLangUtil
+import com.jetbrains.php.lang.psi.elements.StringLiteralExpression
+
+class RouteReference(
+    val myElement: StringLiteralExpression,
+    textRange: TextRange,
+) : PsiPolyVariantReferenceBase<PsiElement>(myElement, textRange) {
+    override fun getVariants() =
+        RouterIndexUtils
+            .getAllRoutes(element.project)
+            .map { route ->
+                val methodFqn = PhpLangUtil.toPresentableFQN(route.action.replace('.', ':'))
+                LookupElementBuilder
+                    .create(route.pattern)
+                    .withIcon(TempestIcons.TEMPEST)
+                    .withTailText(" [$methodFqn]")
+                    .withTypeText(route.method)
+            }
+            .toTypedArray()
+
+    override fun multiResolve(incompleteCode: Boolean): Array<out ResolveResult?> {
+        val project = element.project
+        val phpIndex = PhpIndexImpl.getInstance(project)
+
+        return RouterIndexUtils
+            .getRoute(myElement.contents, project)
+            .flatMap { phpIndex.getMethodsByFQN(it.action) }
+            .let { PsiElementResolveResult.createResults(it) }
+    }
+}
diff --git a/src/main/kotlin/com/github/tempest/framework/router/references/UriFunctionReferenceContributor.kt b/src/main/kotlin/com/github/tempest/framework/router/references/UriFunctionReferenceContributor.kt
@@ -0,0 +1,48 @@
+package com.github.tempest.framework.router.references
+
+import com.github.tempest.framework.TempestFrameworkClasses
+import com.intellij.patterns.PlatformPatterns
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiReference
+import com.intellij.psi.PsiReferenceContributor
+import com.intellij.psi.PsiReferenceProvider
+import com.intellij.psi.PsiReferenceRegistrar
+import com.intellij.psi.impl.source.tree.injected.changesHandler.contentRange
+import com.intellij.psi.util.startOffset
+import com.intellij.util.ProcessingContext
+import com.jetbrains.php.lang.psi.elements.FunctionReference
+import com.jetbrains.php.lang.psi.elements.ParameterList
+import com.jetbrains.php.lang.psi.elements.StringLiteralExpression
+
+class UriFunctionReferenceContributor : PsiReferenceContributor() {
+    override fun registerReferenceProviders(registrar: PsiReferenceRegistrar) {
+        registrar.registerReferenceProvider(
+            PlatformPatterns.psiElement(StringLiteralExpression::class.java)
+                .withParent(PlatformPatterns.psiElement(ParameterList::class.java))
+                .withSuperParent(
+                    2,
+                    PlatformPatterns.psiElement(FunctionReference::class.java)
+                ),
+            object : PsiReferenceProvider() {
+                override fun getReferencesByElement(
+                    element: PsiElement,
+                    context: ProcessingContext
+                ): Array<out PsiReference> {
+                    val element = element as? StringLiteralExpression ?: return emptyArray()
+                    val parameterList = element.parent as? ParameterList ?: return emptyArray()
+                    val function = parameterList.parent as? FunctionReference ?: return emptyArray()
+                    if (function.fqn != TempestFrameworkClasses.FUNCTION_URI) return emptyArray()
+                    if (parameterList.parameters.isEmpty()) return emptyArray()
+                    if (parameterList.parameters[0] != element) return emptyArray()
+
+                    return arrayOf(
+                        RouteReference(
+                            element,
+                            element.contentRange.shiftLeft(element.startOffset),
+                        )
+                    )
+                }
+            }
+        )
+    }
+}
diff --git a/src/main/resources/META-INF/plugin.xml b/src/main/resources/META-INF/plugin.xml
