feat: add route parameters completion

Author: xepozz

src/main/kotlin/com/github/tempest/framework/common/completion/CompletionWeighter.kt

@@ -0,0 +1,18 @@
+package com.github.tempest.framework.common.completion
+
+import com.intellij.codeInsight.completion.CompletionLocation
+import com.intellij.codeInsight.completion.CompletionWeigher
+import com.intellij.codeInsight.lookup.LookupElement
+
+class CompletionWeighter : CompletionWeigher() {
+    override fun weigh(
+        element: LookupElement,
+        location: CompletionLocation
+    ): Comparable<*>? {
+        println("completion weigher: $element")
+        return when {
+            element is TopPriorityLookupElement -> 10
+            else -> null
+        }.apply { println("weigh: $this") }
+    }
+}

src/main/kotlin/com/github/tempest/framework/common/completion/TopPriorityLookupElement.kt

@@ -0,0 +1,6 @@
+package com.github.tempest.framework.common.completion
+
+import com.intellij.codeInsight.lookup.LookupElement
+import com.intellij.codeInsight.lookup.LookupElementDecorator
+
+class TopPriorityLookupElement(myDelegate: LookupElement) : LookupElementDecorator<LookupElement>(myDelegate)

src/main/kotlin/com/github/tempest/framework/common/insertHandler/InsertTextInsertHandler.kt

@@ -0,0 +1,31 @@
+package com.github.tempest.framework.common.insertHandler
+
+import com.intellij.codeInsight.completion.DeclarativeInsertHandler
+import com.intellij.codeInsight.completion.InsertionContext
+import com.intellij.codeInsight.lookup.LookupElement
+import com.intellij.openapi.editor.Editor
+import com.intellij.openapi.util.TextRange
+
+class InsertTextInsertHandler(
+    private val stringToInsert: String,
+    popupOptions: PopupOptions
+) : DeclarativeInsertHandler(
+    listOf(RelativeTextEdit(0, 0, stringToInsert)),
+    stringToInsert.length,
+    null,
+    null,
+    popupOptions
+) {
+
+    override fun handleInsert(context: InsertionContext, item: LookupElement) {
+        val applyTextOperations = !isValueAlreadyHere(context.editor)
+        conditionalHandleInsert(context, item, applyTextOperations)
+    }
+
+    private fun isValueAlreadyHere(editor: Editor): Boolean {
+        val startOffset = editor.caretModel.offset
+        val valueLength = stringToInsert.length
+        return editor.document.textLength >= startOffset + valueLength &&
+                editor.document.getText(TextRange.create(startOffset, startOffset + valueLength)) == stringToInsert
+    }
+}

src/main/kotlin/com/github/tempest/framework/router/completion/RouteParameterCompletionContributor.kt

@@ -0,0 +1,83 @@
+package com.github.tempest.framework.router.completion
+
+import com.github.tempest.framework.TempestFrameworkClasses
+import com.github.tempest.framework.common.completion.TopPriorityLookupElement
+import com.github.tempest.framework.common.insertHandler.InsertTextInsertHandler
+import com.github.tempest.framework.router.index.RouterIndexUtils
+import com.intellij.codeInsight.completion.CompletionContributor
+import com.intellij.codeInsight.completion.CompletionParameters
+import com.intellij.codeInsight.completion.CompletionProvider
+import com.intellij.codeInsight.completion.CompletionResultSet
+import com.intellij.codeInsight.completion.CompletionType
+import com.intellij.codeInsight.completion.DeclarativeInsertHandler
+import com.intellij.codeInsight.completion.PrioritizedLookupElement
+import com.intellij.codeInsight.lookup.LookupElementBuilder
+import com.intellij.patterns.PlatformPatterns
+import com.intellij.util.ProcessingContext
+import com.jetbrains.php.PhpIcons
+import com.jetbrains.php.lang.psi.elements.ConstantReference
+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 RouteParameterCompletionContributor : CompletionContributor() {
+    init {
+        extend(
+            CompletionType.BASIC,
+            PlatformPatterns.psiElement()
+                .withParent(
+                    PlatformPatterns.or(
+                        PlatformPatterns.psiElement(ConstantReference::class.java)
+                            .withParent(PlatformPatterns.psiElement(ParameterList::class.java))
+                            .withSuperParent(
+                                2,
+                                PlatformPatterns.psiElement(FunctionReference::class.java),
+                            ),
+                        PlatformPatterns.psiElement(ParameterList::class.java)
+                            .withParent(PlatformPatterns.psiElement(FunctionReference::class.java)),
+                    )
+                ),
+            object : CompletionProvider<CompletionParameters>() {
+                override fun addCompletions(
+                    parameters: CompletionParameters,
+                    context: ProcessingContext,
+                    result: CompletionResultSet
+                ) {
+                    val element = when (parameters.position.parent) {
+                        is ConstantReference -> parameters.position.parent
+                        is ParameterList -> parameters.position
+                        else -> return
+                    }
+                    val parameterList = element.parent as? ParameterList ?: return
+                    val function = parameterList.parent as? FunctionReference ?: return
+                    if (function.fqn != TempestFrameworkClasses.FUNCTION_URI) return
+                    if (parameterList.parameters.isEmpty()) return
+                    if (parameterList.parameters[0] == element) return
+
+                    val routePattern = function.parameters[0] as? StringLiteralExpression ?: return
+
+                    RouterIndexUtils.getRoutes(routePattern.contents, element.project)
+                        .flatMap { it.parameters }
+                        .map { parameter ->
+                            LookupElementBuilder.create(parameter.name)
+                                .withIcon(PhpIcons.PARAMETER)
+                                .withTailText(" Pattern: ${parameter.pattern}".takeIf { parameter.pattern.isNotEmpty() })
+                                .withTypeText(routePattern.contents)
+                                .withInsertHandler { context, element ->
+                                    InsertTextInsertHandler(
+                                        ": ",
+                                        DeclarativeInsertHandler.PopupOptions.MemberLookup
+                                    )
+                                        .handleInsert(context, element)
+                                }
+                                .let { PrioritizedLookupElement.withPriority(it, 10000.0) }
+                                .let { PrioritizedLookupElement.withExplicitProximity(it, 10000) }
+                                .let { TopPriorityLookupElement(it) }
+                        }
+                        .apply { result.addAllElements(this) }
+                        .apply { if (isNotEmpty()) result.stopHere() }
+                }
+            }
+        )
+    }
+}

src/main/kotlin/com/github/tempest/framework/router/index/RouterIndexUtils.kt

@@ -14,7 +14,7 @@ object RouterIndexUtils {
             .filterNotNull()
     }
 
-    fun getRoute(pattern: String, project: Project): Collection<Route> {
+    fun getRoutes(pattern: String, project: Project): Collection<Route> {
         val fileBasedIndex = FileBasedIndex.getInstance()
 
         return fileBasedIndex

src/main/kotlin/com/github/tempest/framework/router/references/RouteReference.kt

@@ -35,7 +35,7 @@ class RouteReference(
         val phpIndex = PhpIndexImpl.getInstance(project)
 
         return RouterIndexUtils
-            .getRoute(myElement.contents, project)
+            .getRoutes(myElement.contents, project)
             .flatMap { phpIndex.getMethodsByFQN(it.action) }
             .let { PsiElementResolveResult.createResults(it) }
     }

src/main/resources/META-INF/plugin.xml

@@ -41,6 +41,13 @@
         <lang.inspectionSuppressor
                 language="HTML"
                 implementationClass="com.github.tempest.framework.views.TempestComponentsInspectionSuppressor"/>
+        <completion.contributor
+                language="PHP"
+                implementationClass="com.github.tempest.framework.router.completion.RouteParameterCompletionContributor"/>
+        <weigher
+                order="first"
+                implementationClass="com.github.tempest.framework.common.completion.CompletionWeighter"
+                key="completion" />
 
         <fileBasedIndex
                 implementation="com.github.tempest.framework.console.index.ConsoleCommandsIndex" />