Add builder for FunSpec which accepts a MemberName (#1574)

square · May 26, 2023 · 1a02180 · 1a02180
1 parent 95e0e58
commit 1a02180
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 0 deletions.
diff --git a/kotlinpoet/api/kotlinpoet.api b/kotlinpoet/api/kotlinpoet.api
@@ -275,6 +275,7 @@ public final class com/squareup/kotlinpoet/FileSpec$Companion {
 
 public final class com/squareup/kotlinpoet/FunSpec : com/squareup/kotlinpoet/Annotatable, com/squareup/kotlinpoet/ContextReceivable, com/squareup/kotlinpoet/Documentable, com/squareup/kotlinpoet/OriginatingElementsHolder, com/squareup/kotlinpoet/Taggable {
 	public static final field Companion Lcom/squareup/kotlinpoet/FunSpec$Companion;
+	public static final fun builder (Lcom/squareup/kotlinpoet/MemberName;)Lcom/squareup/kotlinpoet/FunSpec$Builder;
 	public static final fun builder (Ljava/lang/String;)Lcom/squareup/kotlinpoet/FunSpec$Builder;
 	public static final fun constructorBuilder ()Lcom/squareup/kotlinpoet/FunSpec$Builder;
 	public fun equals (Ljava/lang/Object;)Z
@@ -376,6 +377,7 @@ public final class com/squareup/kotlinpoet/FunSpec$Builder : com/squareup/kotlin
 }
 
 public final class com/squareup/kotlinpoet/FunSpec$Companion {
+	public final fun builder (Lcom/squareup/kotlinpoet/MemberName;)Lcom/squareup/kotlinpoet/FunSpec$Builder;
 	public final fun builder (Ljava/lang/String;)Lcom/squareup/kotlinpoet/FunSpec$Builder;
 	public final fun constructorBuilder ()Lcom/squareup/kotlinpoet/FunSpec$Builder;
 	public final fun getterBuilder ()Lcom/squareup/kotlinpoet/FunSpec$Builder;

diff --git a/kotlinpoet/src/main/java/com/squareup/kotlinpoet/FunSpec.kt b/kotlinpoet/src/main/java/com/squareup/kotlinpoet/FunSpec.kt
@@ -560,6 +560,9 @@ public class FunSpec private constructor(
 
     @JvmStatic public fun builder(name: String): Builder = Builder(name)
 
+    /** Create a new function builder from [MemberName.simpleName] */
+    @JvmStatic public fun builder(memberName: MemberName): Builder = Builder(memberName.simpleName)
+
     @JvmStatic public fun constructorBuilder(): Builder = Builder(CONSTRUCTOR)
 
     @JvmStatic public fun getterBuilder(): Builder = Builder(GETTER)

diff --git a/kotlinpoet/src/test/java/com/squareup/kotlinpoet/FunSpecTest.kt b/kotlinpoet/src/test/java/com/squareup/kotlinpoet/FunSpecTest.kt
@@ -1219,4 +1219,18 @@ class FunSpecTest {
       """.trimMargin(),
     )
   }
+
+  @Test fun memberNameBuilder() {
+    val name = MemberName("com.example", "myCoolFunction")
+    val spec = FunSpec.builder(name)
+      .returns(STRING)
+      .addStatement("""return "hey"""")
+      .build()
+    assertThat(spec.toString()).isEqualTo(
+      """
+      |public fun myCoolFunction(): kotlin.String = "hey"
+      |
+      """.trimMargin(),
+    )
+  }
 }