Skeleton of new general override members implementation. #359

Author: themkat

server/src/main/kotlin/org/javacs/kt/KotlinProtocolExtensionService.kt

@@ -4,6 +4,8 @@ import org.eclipse.lsp4j.*
 import org.javacs.kt.util.AsyncExecutor
 import org.javacs.kt.util.parseURI
 import org.javacs.kt.resolve.resolveMain
+import org.javacs.kt.position.offset
+import org.javacs.kt.listOverridableMembers
 import java.util.concurrent.CompletableFuture
 import java.nio.file.Paths
 
@@ -39,4 +41,12 @@ class KotlinProtocolExtensionService(
             "projectRoot" to workspacePath
         )
     }
+
+    override fun overrideMember(position: TextDocumentPositionParams): CompletableFuture<List<CodeAction>> = async.compute {
+        val fileUri = parseURI(position.textDocument.uri)
+        val compiledFile = sp.currentVersion(fileUri)
+        val cursorOffset = offset(compiledFile.content, position.position)
+
+        listOverridableMembers(compiledFile, cursorOffset)
+    }
 }

server/src/main/kotlin/org/javacs/kt/KotlinProtocolExtensions.kt

@@ -15,4 +15,9 @@ interface KotlinProtocolExtensions {
 
     @JsonRequest
     fun mainClass(textDocument: TextDocumentIdentifier): CompletableFuture<Map<String, Any?>>
+
+    // TODO: what is the best return value in this case? CodeAction?
+    // TODO: should the naming be something like listOverrideableMembers? or something similar instead?
+    @JsonRequest
+    fun overrideMember(position: TextDocumentPositionParams): CompletableFuture<List<CodeAction>>
 }

server/src/main/kotlin/org/javacs/kt/overridemembers/OverrideMembers.kt

@@ -0,0 +1,11 @@
+package org.javacs.kt
+
+import org.eclipse.lsp4j.Range
+import org.eclipse.lsp4j.CodeAction
+
+
+fun listOverridableMembers(file: CompiledFile, cursor: Int): List<CodeAction> {
+    // TODO: implement 
+
+    return listOf()
+}

server/src/test/kotlin/org/javacs/kt/OverrideMemberTest.kt

@@ -0,0 +1,77 @@
+package org.javacs.kt
+
+import com.google.gson.Gson
+import org.eclipse.lsp4j.ExecuteCommandParams
+import org.eclipse.lsp4j.Position
+import org.eclipse.lsp4j.Range
+import org.eclipse.lsp4j.TextDocumentIdentifier
+import org.eclipse.lsp4j.TextDocumentPositionParams
+import org.junit.Test
+import org.hamcrest.Matchers.equalTo
+import org.hamcrest.Matchers.hasSize
+import org.junit.Assert.assertThat
+
+// TODO: what should the title be? just the signature? or the name of the member? should we separate between methods and variables?
+
+class OverrideMemberTest : SingleFileTestFixture("overridemember", "OverrideMembers.kt") {
+
+    val root = testResourcesRoot().resolve(workspaceRoot)
+    val fileUri = root.resolve(file).toUri().toString()
+    
+    @Test
+    fun `should show all overrides for class`() {
+        val result = languageServer.getProtocolExtensionService().overrideMember(TextDocumentPositionParams(TextDocumentIdentifier(fileUri), position(9, 8))).get()
+   
+        assertThat(result, hasSize(2))
+        
+        val firstCodeAction = result[0]
+        assertThat(firstCodeAction.title, equalTo("text"))
+
+        val firstTextEdit = firstCodeAction.edit.changes
+        assertThat(firstTextEdit.containsKey(fileUri), equalTo(true))
+        assertThat(firstTextEdit[fileUri], hasSize(1))
+        
+        val memberToImplementEdit = firstTextEdit[fileUri]?.get(0)
+        assertThat(memberToImplementEdit?.range, equalTo(range(9, 32, 9, 32)))
+        assertThat(memberToImplementEdit?.newText, equalTo(System.lineSeparator() + System.lineSeparator() + "    override val text: String = ???"))
+
+
+        val secondCodeAction = result[1]
+        assertThat(secondCodeAction.title, equalTo("print"))
+
+        val secondTextEdit = secondCodeAction.edit.changes
+        assertThat(secondTextEdit.containsKey(fileUri), equalTo(true))
+        assertThat(secondTextEdit[fileUri], hasSize(1))
+        
+        val functionToImplementEdit = secondTextEdit[fileUri]?.get(0)
+        assertThat(functionToImplementEdit?.range, equalTo(range(9, 32, 9, 32)))
+        assertThat(functionToImplementEdit?.newText, equalTo(System.lineSeparator() + System.lineSeparator() + "    override fun print() {}"))
+    }
+
+    @Test
+    fun `should show one override for class where other alternatives are already implemented`() {
+        val result = languageServer.getProtocolExtensionService().overrideMember(TextDocumentPositionParams(TextDocumentIdentifier(fileUri), position(11, 8))).get()
+   
+        assertThat(result, hasSize(1))
+      
+        val codeAction = result[0]
+        assertThat(codeAction.title, equalTo("print"))
+
+        val textEdit = codeAction.edit.changes
+        assertThat(textEdit.containsKey(fileUri), equalTo(true))
+        assertThat(textEdit[fileUri], hasSize(1)) 
+        
+        val functionToImplementEdit = textEdit[fileUri]?.get(0)
+        assertThat(functionToImplementEdit?.range, equalTo(range(12, 57, 12, 57)))
+        assertThat(functionToImplementEdit?.newText, equalTo(System.lineSeparator() + System.lineSeparator() + "    override fun print() {}"))
+    }
+
+    @Test
+    fun `should show NO overrides for class where all other alternatives are already implemented`() {
+        val result = languageServer.getProtocolExtensionService().overrideMember(TextDocumentPositionParams(TextDocumentIdentifier(fileUri), position(15, 8))).get()
+   
+        assertThat(result, hasSize(0))
+    }
+
+    // TODO: test for kotlin sdk and jdk classes to verify that it works
+}

server/src/test/resources/overridemember/OverrideMembers.kt

@@ -0,0 +1,21 @@
+interface Printable {
+    val text: String
+
+    fun print() {
+        println("not implemented yet yo")
+    }
+}
+
+class MyPrintable: Printable {}
+
+class OtherPrintable: Printable {
+    override val text: String = "you had me at lasagna"
+}
+
+class CompletePrintable: Printable {
+    override val text: String = "something something something darkside"
+
+    override fun print() {
+        println("not implemented yet yo")
+    }
+}