Generate Kotlin-esque build function for using closures rather than B…

…uilders
square · Oct 11, 2023 · 094fa67 · 094fa67
1 parent b9f6835
commit 094fa67
Show file tree

Hide file tree

Showing 14 changed files with 844 additions and 0 deletions.
diff --git a/gen-tests.gradle.kts b/gen-tests.gradle.kts
@@ -249,6 +249,7 @@ val generateKotlinBuildersOnlyTests by tasks.creating(JavaExec::class) {
     "--kotlin_out=wire-tests/src/commonTest/proto-kotlin",
     "--kotlin_builders_only",
     "redacted_test_builders_only.proto",
+    "simple_message_builders_only.proto",
   )
 }
 

diff --git a/wire-kotlin-generator/src/main/java/com/squareup/wire/kotlin/KotlinGenerator.kt b/wire-kotlin-generator/src/main/java/com/squareup/wire/kotlin/KotlinGenerator.kt
@@ -28,10 +28,12 @@ import com.squareup.kotlinpoet.INT
 import com.squareup.kotlinpoet.KModifier
 import com.squareup.kotlinpoet.KModifier.ABSTRACT
 import com.squareup.kotlinpoet.KModifier.CONST
+import com.squareup.kotlinpoet.KModifier.INLINE
 import com.squareup.kotlinpoet.KModifier.OVERRIDE
 import com.squareup.kotlinpoet.KModifier.PRIVATE
 import com.squareup.kotlinpoet.KModifier.PUBLIC
 import com.squareup.kotlinpoet.LONG
+import com.squareup.kotlinpoet.LambdaTypeName
 import com.squareup.kotlinpoet.MemberName
 import com.squareup.kotlinpoet.MemberName.Companion.member
 import com.squareup.kotlinpoet.NOTHING
@@ -548,6 +550,7 @@ class KotlinGenerator private constructor(
 
     addDefaultFields(type, companionBuilder, nameAllocator)
     addAdapter(type, companionBuilder)
+    if (buildersOnly || javaInterOp) addBuildClosure(type, companionBuilder, builderClassName)
 
     val classBuilder = TypeSpec.classBuilder(className)
       .apply {
@@ -1968,6 +1971,22 @@ class KotlinGenerator private constructor(
     }
   }
 
+  private fun addBuildClosure(type: MessageType, companionBuilder: TypeSpec.Builder, builderClassName: ClassName) {
+    val buildFn = FunSpec.builder("build")
+      .addModifiers(INLINE)
+      .addParameter("body",
+        LambdaTypeName.get(
+          receiver = builderClassName,
+          returnType = Unit::class.asClassName()
+        )
+      )
+      .addStatement("return %T().apply(body).build()", builderClassName)
+      .returns(generatedTypeName(type))
+      .build()
+
+    companionBuilder.addFunction(buildFn)
+  }
+
   private fun redactFun(message: MessageType): FunSpec {
     val className = typeToKotlinName.getValue(message.type) as ClassName
     val nameAllocator = nameAllocator(message)

diff --git a/wire-kotlin-generator/src/test/java/com/squareup/wire/kotlin/KotlinGeneratorTest.kt b/wire-kotlin-generator/src/test/java/com/squareup/wire/kotlin/KotlinGeneratorTest.kt
@@ -1960,6 +1960,32 @@ class KotlinGeneratorTest {
     assertThat(code).doesNotContain("InnerMessage public constructor(")
   }
 
+  @Test
+  fun buildersOnlyOrJavaInteropGeneratesKotlinBuildClosure() {
+    val schema = buildSchema {
+      add(
+        "message.proto".toPath(),
+        """
+        |syntax = "proto2";
+        |message SomeMessage {
+        |  optional string a = 1;
+        |  optional string b = 2;
+        |}
+        |
+        """.trimMargin(),
+      )
+    }
+    val code = KotlinWithProfilesGenerator(schema)
+      .generateKotlin("SomeMessage", buildersOnly = false, javaInterop = false)
+    assertThat(code).doesNotContain("fun build(body: Builder.() -> Unit): SomeMessage {")
+    val buildersOnlyCode = KotlinWithProfilesGenerator(schema)
+      .generateKotlin("SomeMessage", buildersOnly = true)
+    assertThat(buildersOnlyCode).contains("fun build(body: Builder.() -> Unit): SomeMessage {")
+    val javaInteropCode = KotlinWithProfilesGenerator(schema)
+      .generateKotlin("SomeMessage", javaInterop = true)
+    assertThat(javaInteropCode).contains("fun build(body: Builder.() -> Unit): SomeMessage {")
+  }
+
   @Test
   fun javaInteropAndBuildersOnly() {
     val schema = buildSchema {

diff --git a/wire-tests/src/commonTest/kotlin/com/squareup/wire/KotlinBuildTest.kt b/wire-tests/src/commonTest/kotlin/com/squareup/wire/KotlinBuildTest.kt
@@ -0,0 +1,28 @@
+package com.squareup.wire
+
+import com.squareup.wire.protos.kotlin.simple.buildersonly.SimpleMessage
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class KotlinBuildTest {
+  @Test fun kotlinBuildEquivalentToBuilderResult() {
+    val bb = 100
+
+    val kotlinBuildResult = SimpleMessage.build {
+      required_int32 = 4
+      optional_int32 = 5
+      optional_nested_msg = SimpleMessage.NestedMessage.build {
+        this.bb = bb
+      }
+    }
+    val builderResult = SimpleMessage.Builder()
+      .required_int32(4)
+      .optional_int32(5)
+      .optional_nested_msg(SimpleMessage.NestedMessage.Builder()
+        .bb(bb)
+        .build()
+      ).build()
+
+    assertEquals(kotlinBuildResult, builderResult)
+  }
+}
diff --git a/...monTest/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/NotRedacted.kt b/...monTest/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/NotRedacted.kt
@@ -17,6 +17,7 @@ import kotlin.Boolean
 import kotlin.Int
 import kotlin.Long
 import kotlin.String
+import kotlin.Unit
 import okio.ByteString
 
 public class NotRedacted private constructor(
@@ -148,5 +149,7 @@ public class NotRedacted private constructor(
     }
 
     private const val serialVersionUID: Long = 0L
+
+    public inline fun build(body: Builder.() -> Unit): NotRedacted = Builder().apply(body).build()
   }
 }
diff --git a/...nTest/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedChild.kt b/...nTest/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedChild.kt
@@ -17,6 +17,7 @@ import kotlin.Boolean
 import kotlin.Int
 import kotlin.Long
 import kotlin.String
+import kotlin.Unit
 import okio.ByteString
 
 public class RedactedChild private constructor(
@@ -174,5 +175,7 @@ public class RedactedChild private constructor(
     }
 
     private const val serialVersionUID: Long = 0L
+
+    public inline fun build(body: Builder.() -> Unit): RedactedChild = Builder().apply(body).build()
   }
 }
diff --git a/...Test/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedCycleA.kt b/...Test/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedCycleA.kt
@@ -16,6 +16,7 @@ import kotlin.Boolean
 import kotlin.Int
 import kotlin.Long
 import kotlin.String
+import kotlin.Unit
 import okio.ByteString
 
 public class RedactedCycleA private constructor(
@@ -124,5 +125,8 @@ public class RedactedCycleA private constructor(
     }
 
     private const val serialVersionUID: Long = 0L
+
+    public inline fun build(body: Builder.() -> Unit): RedactedCycleA =
+        Builder().apply(body).build()
   }
 }
diff --git a/...Test/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedCycleB.kt b/...Test/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedCycleB.kt
@@ -16,6 +16,7 @@ import kotlin.Boolean
 import kotlin.Int
 import kotlin.Long
 import kotlin.String
+import kotlin.Unit
 import okio.ByteString
 
 public class RedactedCycleB private constructor(
@@ -124,5 +125,8 @@ public class RedactedCycleB private constructor(
     }
 
     private const val serialVersionUID: Long = 0L
+
+    public inline fun build(body: Builder.() -> Unit): RedactedCycleB =
+        Builder().apply(body).build()
   }
 }
diff --git a/...t/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedExtension.kt b/...t/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedExtension.kt
@@ -17,6 +17,7 @@ import kotlin.Boolean
 import kotlin.Int
 import kotlin.Long
 import kotlin.String
+import kotlin.Unit
 import okio.ByteString
 
 public class RedactedExtension private constructor(
@@ -150,5 +151,8 @@ public class RedactedExtension private constructor(
     }
 
     private const val serialVersionUID: Long = 0L
+
+    public inline fun build(body: Builder.() -> Unit): RedactedExtension =
+        Builder().apply(body).build()
   }
 }
diff --git a/...Test/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedFields.kt b/...Test/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedFields.kt
@@ -17,6 +17,7 @@ import kotlin.Boolean
 import kotlin.Int
 import kotlin.Long
 import kotlin.String
+import kotlin.Unit
 import okio.ByteString
 
 public class RedactedFields private constructor(
@@ -202,5 +203,8 @@ public class RedactedFields private constructor(
     }
 
     private const val serialVersionUID: Long = 0L
+
+    public inline fun build(body: Builder.() -> Unit): RedactedFields =
+        Builder().apply(body).build()
   }
 }
diff --git a/...st/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedRepeated.kt b/...st/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedRepeated.kt
@@ -19,6 +19,7 @@ import kotlin.Boolean
 import kotlin.Int
 import kotlin.Long
 import kotlin.String
+import kotlin.Unit
 import kotlin.collections.List
 import okio.ByteString
 
@@ -168,5 +169,8 @@ public class RedactedRepeated private constructor(
     }
 
     private const val serialVersionUID: Long = 0L
+
+    public inline fun build(body: Builder.() -> Unit): RedactedRepeated =
+        Builder().apply(body).build()
   }
 }
diff --git a/...st/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedRequired.kt b/...st/proto-kotlin/com/squareup/wire/protos/kotlin/redacted/buildersonly/RedactedRequired.kt
@@ -16,6 +16,7 @@ import kotlin.Boolean
 import kotlin.Int
 import kotlin.Long
 import kotlin.String
+import kotlin.Unit
 import kotlin.UnsupportedOperationException
 import okio.ByteString
 
@@ -124,5 +125,8 @@ public class RedactedRequired private constructor(
     }
 
     private const val serialVersionUID: Long = 0L
+
+    public inline fun build(body: Builder.() -> Unit): RedactedRequired =
+        Builder().apply(body).build()
   }
 }