Allow to use context parameters as Names (#2114) (#2117)

IRus · Egorand · web-flow · commit da275475e983 · 2025-04-18T10:54:48.000+02:00
* Allow to use context parameters as Names (#2114) * Allow to use context parameters as Names (#2114) Co-authored-by: Egor Andreevich <github@egorand.dev> * Allow to use context parameters as Names (#2114) Co-authored-by: Egor Andreevich <github@egorand.dev> * Allow to use context parameters as Names (#2114) * Allow to use context parameters as Names (#2114) --------- Co-authored-by: Egor Andreevich <github@egorand.dev>
diff --git a/docs/context-parameters.md b/docs/context-parameters.md
@@ -22,10 +22,16 @@ public fun greet() {
 You can add multiple context parameters:
 
 ```kotlin
+val loggerType = ClassName("java.util.logging", "Logger")
+val configType = ClassName("com.example", "Config")
+
+val logger = ContextParameter("logger", loggerType)
+val config = ContextParameter("config", configType)
+
 val processData = FunSpec.builder("processData")
-  .contextParameter("logger", ClassName("com.example", "Logger"))
-  .contextParameter("config", ClassName("com.example", "Config"))
-  .addStatement("logger.info(\"Processing with config: ${'$'}config\")")
+  .contextParameter(logger)
+  .contextParameter(config)
+  .addStatement("%N.info(\"Processing with config: ${'$'}%N\")", logger, config)
   .build()
 ```
 
diff --git a/kotlinpoet/api/kotlinpoet.api b/kotlinpoet/api/kotlinpoet.api
@@ -392,8 +392,6 @@ public final class com/squareup/kotlinpoet/FunSpec$Builder : com/squareup/kotlin
 	public final fun callThisConstructor ([Ljava/lang/String;)Lcom/squareup/kotlinpoet/FunSpec$Builder;
 	public static synthetic fun callThisConstructor$default (Lcom/squareup/kotlinpoet/FunSpec$Builder;[Lcom/squareup/kotlinpoet/CodeBlock;ILjava/lang/Object;)Lcom/squareup/kotlinpoet/FunSpec$Builder;
 	public final fun clearBody ()Lcom/squareup/kotlinpoet/FunSpec$Builder;
-	public synthetic fun contextParameter (Lcom/squareup/kotlinpoet/TypeName;)Lcom/squareup/kotlinpoet/ContextParameterizable$Builder;
-	public synthetic fun contextParameter (Ljava/lang/String;Lcom/squareup/kotlinpoet/TypeName;)Lcom/squareup/kotlinpoet/ContextParameterizable$Builder;
 	public synthetic fun contextParameters (Ljava/lang/Iterable;)Lcom/squareup/kotlinpoet/ContextParameterizable$Builder;
 	public synthetic fun contextReceivers (Ljava/lang/Iterable;)Lcom/squareup/kotlinpoet/ContextReceivable$Builder;
 	public final fun endControlFlow ()Lcom/squareup/kotlinpoet/FunSpec$Builder;
@@ -795,9 +793,6 @@ public final class com/squareup/kotlinpoet/PropertySpec$Builder : com/squareup/k
 	public final fun addTypeVariable (Lcom/squareup/kotlinpoet/TypeVariableName;)Lcom/squareup/kotlinpoet/PropertySpec$Builder;
 	public final fun addTypeVariables (Ljava/lang/Iterable;)Lcom/squareup/kotlinpoet/PropertySpec$Builder;
 	public final fun build ()Lcom/squareup/kotlinpoet/PropertySpec;
-	public synthetic fun contextParameter (Lcom/squareup/kotlinpoet/TypeName;)Lcom/squareup/kotlinpoet/ContextParameterizable$Builder;
-	public synthetic fun contextParameter (Ljava/lang/String;Lcom/squareup/kotlinpoet/TypeName;)Lcom/squareup/kotlinpoet/ContextParameterizable$Builder;
-	public synthetic fun contextParameters (Ljava/lang/Iterable;)Lcom/squareup/kotlinpoet/ContextParameterizable$Builder;
 	public final fun delegate (Lcom/squareup/kotlinpoet/CodeBlock;)Lcom/squareup/kotlinpoet/PropertySpec$Builder;
 	public final fun delegate (Ljava/lang/String;[Ljava/lang/Object;)Lcom/squareup/kotlinpoet/PropertySpec$Builder;
 	public fun getAnnotations ()Ljava/util/List;
diff --git a/kotlinpoet/src/jvmMain/kotlin/com/squareup/kotlinpoet/CodeBlock.kt b/kotlinpoet/src/jvmMain/kotlin/com/squareup/kotlinpoet/CodeBlock.kt
@@ -362,6 +362,7 @@ public class CodeBlock private constructor(
       is FunSpec -> o.name
       is TypeSpec -> o.name!!
       is MemberName -> o.simpleName
+      is ContextParameter -> if (o.name == "_") throw IllegalStateException("Named context parameter required") else o.name
       else -> throw IllegalArgumentException("expected name but was $o")
     }
 
diff --git a/kotlinpoet/src/jvmMain/kotlin/com/squareup/kotlinpoet/ContextParameter.kt b/kotlinpoet/src/jvmMain/kotlin/com/squareup/kotlinpoet/ContextParameter.kt
@@ -91,6 +91,13 @@ public interface ContextParameterizable {
     public fun contextParameter(type: TypeName): T =
       contextParameters(listOf(ContextParameter(type)))
 
+    /**
+     * Adds the given [ContextParameter] to this type's list of context parameters.
+     */
+    @ExperimentalKotlinPoetApi
+    public fun contextParameter(contextParameter: ContextParameter): T =
+      contextParameters(listOf(contextParameter))
+
     /**
      * Adds a context parameter with the given [name] and [type] to this type's list of context parameters.
      */
diff --git a/kotlinpoet/src/jvmMain/kotlin/com/squareup/kotlinpoet/FunSpec.kt b/kotlinpoet/src/jvmMain/kotlin/com/squareup/kotlinpoet/FunSpec.kt
@@ -304,6 +304,7 @@ public class FunSpec private constructor(
     builder.tags += tagMap.tags
     builder.originatingElements += originatingElements
     builder.contextReceiverTypes += contextReceiverTypes
+    builder.contextParameters += contextParameters
     return builder
   }
 
@@ -379,24 +380,6 @@ public class FunSpec private constructor(
       contextReceiverTypes += receiverTypes
     }
 
-    /**
-     * Adds a context parameter with the given [name] and [type] to this function.
-     */
-    @ExperimentalKotlinPoetApi
-    override fun contextParameter(name: String, type: TypeName): Builder = apply {
-      checkContextParametersAllowed()
-      contextParameters += ContextParameter(name, type)
-    }
-
-    /**
-     * Adds a context parameter with the name "_" and [type] to this type's list of context parameters.
-     */
-    @ExperimentalKotlinPoetApi
-    override fun contextParameter(type: TypeName): Builder = apply {
-      checkContextParametersAllowed()
-      contextParameters += ContextParameter(type)
-    }
-
     /**
      * Adds context parameters to this function.
      */
diff --git a/kotlinpoet/src/jvmMain/kotlin/com/squareup/kotlinpoet/PropertySpec.kt b/kotlinpoet/src/jvmMain/kotlin/com/squareup/kotlinpoet/PropertySpec.kt
@@ -172,6 +172,7 @@ public class PropertySpec private constructor(
     builder.tags += tagMap.tags
     builder.originatingElements += originatingElements
     builder.contextReceiverTypes += contextReceiverTypes
+    builder.contextParameters += contextParameters
     return builder
   }
 
@@ -205,30 +206,6 @@ public class PropertySpec private constructor(
     @ExperimentalKotlinPoetApi
     override val contextParameters: MutableList<ContextParameter> = mutableListOf()
 
-    /**
-     * Adds a context parameter with the given [name] and [type] to this property.
-     */
-    @ExperimentalKotlinPoetApi
-    override fun contextParameter(name: String, type: TypeName): Builder = apply {
-      contextParameters += ContextParameter(name, type)
-    }
-
-    /**
-     * Adds a context parameter with the name "_" and [type] to this type's list of context parameters.
-     */
-    @ExperimentalKotlinPoetApi
-    override fun contextParameter(type: TypeName): Builder = apply {
-      contextParameters += ContextParameter(type)
-    }
-
-    /**
-     * Adds context parameters to this property.
-     */
-    @ExperimentalKotlinPoetApi
-    override fun contextParameters(parameters: Iterable<ContextParameter>): Builder = apply {
-      contextParameters += parameters
-    }
-
     /** True to create a `var` instead of a `val`. */
     public fun mutable(mutable: Boolean = true): Builder = apply {
       this.mutable = mutable
diff --git a/kotlinpoet/src/jvmTest/kotlin/com/squareup/kotlinpoet/CodeBlockTest.kt b/kotlinpoet/src/jvmTest/kotlin/com/squareup/kotlinpoet/CodeBlockTest.kt
@@ -681,4 +681,23 @@ class CodeBlockTest {
 
     Locale.setDefault(defaultLocale)
   }
+
+  @Test fun nameFromContextParameter() {
+    val logger = ContextParameter("logger", ClassName("java.util.logging", "Logger"))
+    assertThat(CodeBlock.of("%N", logger).toString()).isEqualTo("logger")
+  }
+
+  @Test fun nameFromMultipleContextParameters() {
+    val logger = ContextParameter("logger", ClassName("java.util.logging", "Logger"))
+    val config = ContextParameter("config", ClassName("com.example", "Config"))
+    assertThat(CodeBlock.of("%N.info(\"Processing with config: ${'$'}%N\")", logger, config).toString())
+      .isEqualTo("logger.info(\"Processing with config: ${'$'}config\")")
+  }
+
+  @Test fun nameFromUnnamedContextParameter() {
+    val unnamed = ContextParameter(ClassName("java.util.logging", "Logger"))
+    assertThrows<IllegalStateException> {
+      CodeBlock.of("%N", unnamed)
+    }.hasMessageThat().isEqualTo("Named context parameter required")
+  }
 }
diff --git a/kotlinpoet/src/jvmTest/kotlin/com/squareup/kotlinpoet/FunSpecTest.kt b/kotlinpoet/src/jvmTest/kotlin/com/squareup/kotlinpoet/FunSpecTest.kt
@@ -702,6 +702,30 @@ class FunSpecTest {
     }.hasMessageThat().isEqualTo("Using both context receivers and context parameters is not allowed")
   }
 
+  @Test fun contextParameterInAddStatement() {
+    val loggerType = ClassName("java.util.logging", "Logger")
+    val configType = ClassName("com.example", "Config")
+
+    val logger = ContextParameter("logger", loggerType)
+    val config = ContextParameter("config", configType)
+
+    val processData = FunSpec.builder("processData")
+      .contextParameter(logger)
+      .contextParameter(config)
+      .addStatement("%N.info(\"Processing with config: ${'$'}%N\")", logger, config)
+      .build()
+
+    assertThat(processData.toString()).isEqualTo(
+      """
+      |context(logger: java.util.logging.Logger, config: com.example.Config)
+      |public fun processData() {
+      |  logger.info("Processing with config: ${'$'}config")
+      |}
+      |
+      """.trimMargin(),
+    )
+  }
+
   @Test fun constructorWithContextParameter() {
     assertThrows<IllegalStateException> {
       FunSpec.constructorBuilder()
diff --git a/kotlinpoet/src/jvmTest/kotlin/com/squareup/kotlinpoet/PropertySpecTest.kt b/kotlinpoet/src/jvmTest/kotlin/com/squareup/kotlinpoet/PropertySpecTest.kt
@@ -288,6 +288,7 @@ class PropertySpecTest {
       .addModifiers(KModifier.PUBLIC)
       .addTypeVariable(TypeVariableName("T"))
       .delegate("Delegates.notNull()")
+      .contextParameter("user", STRING)
       .receiver(Int::class)
       .getter(
         FunSpec.getterBuilder()

Original file line number	Diff line number	Diff line change
`@@ -362,6 +362,7 @@ public class CodeBlock private constructor(`
`362`	`362`	`is FunSpec -> o.name`
`363`	`363`	`is TypeSpec -> o.name!!`
`364`	`364`	`is MemberName -> o.simpleName`
	`365`	`+ is ContextParameter -> if (o.name == "_") throw IllegalStateException("Named context parameter required") else o.name`
`365`	`366`	`else -> throw IllegalArgumentException("expected name but was $o")`
`366`	`367`	`}`
`367`	`368`