Skip to content

Return FunSpec.Builder from jvmModifiers to not break chaining #2004

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Return FunSpec.Builder from jvmModifiers to not break chaining #2004

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7b61a96
Return FunSpec.Builder from jvmModifiers to not break chaining
Egorand Oct 15, 2024
c41edf9
Update changelog
Egorand Oct 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Change Log
* Fix: Enum classes that only have an init block now also generate the required semicolon (#1952)
* Fix: Preserve typealiases in `KSAnnotation.toAnnotationSpec()`. (#1945)
* Fix: Preserve nullability in `KSType.toClassName()`. (#1956)
* Fix: Return `FunSpec.Builder` from `FunSpec.Builder.jvmModifiers()` to not break chaining. (#2004)
* New: Add `KSTypeAlias.toClassName()`. (#1956)
* New: Add `KSType.toClassNameOrNull()`. (#1956)

Expand Down
2 changes: 1 addition & 1 deletion kotlinpoet/api/kotlinpoet.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ public final class com/squareup/kotlinpoet/FunSpec$Builder : com/squareup/kotlin
public final fun getParameters ()Ljava/util/List;
public fun getTags ()Ljava/util/Map;
public final fun getTypeVariables ()Ljava/util/List;
public final fun jvmModifiers (Ljava/lang/Iterable;)V
public final fun jvmModifiers (Ljava/lang/Iterable;)Lcom/squareup/kotlinpoet/FunSpec$Builder;
public final fun nextControlFlow (Ljava/lang/String;[Ljava/lang/Object;)Lcom/squareup/kotlinpoet/FunSpec$Builder;
public final fun receiver (Lcom/squareup/kotlinpoet/TypeName;)Lcom/squareup/kotlinpoet/FunSpec$Builder;
public final fun receiver (Lcom/squareup/kotlinpoet/TypeName;Lcom/squareup/kotlinpoet/CodeBlock;)Lcom/squareup/kotlinpoet/FunSpec$Builder;
Expand Down
2 changes: 1 addition & 1 deletion kotlinpoet/src/jvmMain/kotlin/com/squareup/kotlinpoet/FunSpec.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ public class FunSpec private constructor(
this.modifiers += modifiers
}

public fun jvmModifiers(modifiers: Iterable<Modifier>) {
public fun jvmModifiers(modifiers: Iterable<Modifier>): Builder = apply {
var visibility = KModifier.INTERNAL
for (modifier in modifiers) {
when (modifier) {
Expand Down
21 changes: 12 additions & 9 deletions kotlinpoet/src/jvmTest/kotlin/com/squareup/kotlinpoet/FunSpecTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1044,10 +1044,11 @@ class FunSpecTest {
}

@Test fun jvmStaticModifier() {
val builder = FunSpec.builder("staticMethod")
builder.jvmModifiers(listOf(Modifier.STATIC))
val funSpec = FunSpec.builder("staticMethod")
.jvmModifiers(listOf(Modifier.STATIC))
.build()

assertThat(builder.build().toString()).isEqualTo(
assertThat(funSpec.toString()).isEqualTo(
"""
|@kotlin.jvm.JvmStatic
|internal fun staticMethod() {
Expand All @@ -1058,10 +1059,11 @@ class FunSpecTest {
}

@Test fun jvmFinalModifier() {
val builder = FunSpec.builder("finalMethod")
builder.jvmModifiers(listOf(Modifier.FINAL))
val funSpec = FunSpec.builder("finalMethod")
.jvmModifiers(listOf(Modifier.FINAL))
.build()

assertThat(builder.build().toString()).isEqualTo(
assertThat(funSpec.toString()).isEqualTo(
"""
|internal final fun finalMethod() {
|}
Expand All @@ -1071,10 +1073,11 @@ class FunSpecTest {
}

@Test fun jvmSynchronizedModifier() {
val builder = FunSpec.builder("synchronizedMethod")
builder.jvmModifiers(listOf(Modifier.SYNCHRONIZED))
val funSpec = FunSpec.builder("synchronizedMethod")
.jvmModifiers(listOf(Modifier.SYNCHRONIZED))
.build()

assertThat(builder.build().toString()).isEqualTo(
assertThat(funSpec.toString()).isEqualTo(
"""
|@kotlin.jvm.Synchronized
|internal fun synchronizedMethod() {
Expand Down