Add FunSpec#jvmModifiers overload to fix chaining

Resolves square#638
ZacSweers · Mar 27, 2019 · 7dfa776 · 7dfa776
1 parent a313063
commit 7dfa776
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 1 deletion.
diff --git a/src/main/java/com/squareup/kotlinpoet/FunSpec.kt b/src/main/java/com/squareup/kotlinpoet/FunSpec.kt
@@ -28,6 +28,7 @@ import javax.lang.model.type.DeclaredType
 import javax.lang.model.type.ExecutableType
 import javax.lang.model.type.TypeVariable
 import javax.lang.model.util.Types
+import kotlin.DeprecationLevel.HIDDEN
 import kotlin.reflect.KClass
 
 /** A generated function declaration.  */
@@ -286,7 +287,19 @@ class FunSpec private constructor(
       this.modifiers += modifiers
     }
 
-    fun jvmModifiers(modifiers: Iterable<Modifier>) {
+    @JvmName("jvmModifiers")
+    @Deprecated(
+        message = "This API was missing the Builder return type and breaks chaining. " +
+            "https://github.com/square/kotlinpoet/issues/638",
+        replaceWith = ReplaceWith("jvmModifiers(modifiers)"),
+        level = HIDDEN
+    )
+    fun jvmModifersOld(modifiers: Iterable<Modifier>) {
+      jvmModifiers(modifiers)
+    }
+
+    @JvmName("jvmModifiersNew")
+    fun jvmModifiers(modifiers: Iterable<Modifier>) = apply {
       var visibility = KModifier.INTERNAL
       for (modifier in modifiers) {
         when (modifier) {

diff --git a/src/test/java/com/squareup/kotlinpoet/FunSpecTest.kt b/src/test/java/com/squareup/kotlinpoet/FunSpecTest.kt
@@ -671,6 +671,7 @@ class FunSpecTest {
   @Test fun jvmFinalModifier() {
     val builder = FunSpec.builder("finalMethod")
     builder.jvmModifiers(listOf(Modifier.FINAL))
+        .returns(Unit::class) // Ensure chaining works https://github.com/square/kotlinpoet/issues/638
 
     assertThat(builder.build().toString()).isEqualTo("""
       |internal final fun finalMethod() {
@@ -688,4 +689,16 @@ class FunSpecTest {
       |}
       |""".trimMargin())
   }
+
+  /** Ensure chaining jvmModifiers() works - https://github.com/square/kotlinpoet/issues/638 */
+  @Test fun newJvmModifierChaining() {
+    val builder = FunSpec.builder("finalMethod")
+    builder.jvmModifiers(listOf(Modifier.FINAL))
+        .returns(Unit::class)
+
+    assertThat(builder.build().toString()).isEqualTo("""
+      |internal final fun finalMethod() {
+      |}
+      |""".trimMargin())
+  }
 }