Skip to content

Rename CleanProperties to ReproducibleProperties #1869

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

Merged
Goooler merged 1 commit into from
Nov 19, 2025
+9 −9
Merged

Rename CleanProperties to ReproducibleProperties #1869

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion ...lugins/shadow/internal/CleanProperties.kt → ...shadow/internal/ReproducibleProperties.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import java.util.Properties
/**
* Provides functionality for reproducible serialization.
*/
internal class CleanProperties : Properties() {
internal class ReproducibleProperties : Properties() {
override fun store(writer: Writer, comments: String) {
throw UnsupportedOperationException("use writeWithoutComments()")
}
Expand Down
6 changes: 3 additions & 3 deletions ...tlin/com/github/jengelman/gradle/plugins/shadow/transformers/PropertiesFileTransformer.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package com.github.jengelman.gradle.plugins.shadow.transformers

import com.github.jengelman.gradle.plugins.shadow.internal.CleanProperties
import com.github.jengelman.gradle.plugins.shadow.internal.ReproducibleProperties
import com.github.jengelman.gradle.plugins.shadow.internal.mapProperty
import com.github.jengelman.gradle.plugins.shadow.internal.property
import com.github.jengelman.gradle.plugins.shadow.internal.setProperty
Expand Down Expand Up @@ -108,7 +108,7 @@ public open class PropertiesFileTransformer @Inject constructor(
internal val conflicts: MutableMap<String, MutableMap<String, Int>> = mutableMapOf()

@get:Internal
internal val propertiesEntries = mutableMapOf<String, CleanProperties>()
internal val propertiesEntries = mutableMapOf<String, ReproducibleProperties>()

@get:Input
public open val paths: SetProperty<String> = objectFactory.setProperty()
Expand Down Expand Up @@ -149,7 +149,7 @@ public open class PropertiesFileTransformer @Inject constructor(
}

override fun transform(context: TransformerContext) {
val props = propertiesEntries.computeIfAbsent(context.path) { CleanProperties() }
val props = propertiesEntries.computeIfAbsent(context.path) { ReproducibleProperties() }
loadAndTransformKeys(context.inputStream) { key, value ->
if (props.containsKey(key)) {
when (MergeStrategy.from(mergeStrategyFor(context.path))) {
Expand Down
10 changes: 5 additions & 5 deletions ...ns/shadow/internal/CleanPropertiesTest.kt → ...ow/internal/ReproduciblePropertiesTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@ import java.nio.charset.StandardCharsets
import org.junit.jupiter.params.ParameterizedTest
import org.junit.jupiter.params.provider.MethodSource

class CleanPropertiesTest {
class ReproduciblePropertiesTest {
@ParameterizedTest
@MethodSource("generalCharsetsProvider")
fun emptyProperties(charset: Charset) {
val output = CleanProperties().writeToString(charset)
val output = ReproducibleProperties().writeToString(charset)

assertThat(output).isEqualTo("")
}

@ParameterizedTest
@MethodSource("generalCharsetsProvider")
fun asciiProps(charset: Charset) {
val output = CleanProperties().also { props ->
val output = ReproducibleProperties().also { props ->
props["key"] = "value"
props["key2"] = "value2"
props["a"] = "b"
Expand Down Expand Up @@ -50,7 +50,7 @@ class CleanPropertiesTest {
@ParameterizedTest
@MethodSource("utfCharsetsProvider")
fun utfProps(charset: Charset) {
val output = CleanProperties().also { props ->
val output = ReproducibleProperties().also { props ->
props["äöüß"] = "aouss"
props["áèô"] = "aeo"
props["€²³"] = "x"
Expand Down Expand Up @@ -81,7 +81,7 @@ class CleanPropertiesTest {
StandardCharsets.UTF_16,
)

fun CleanProperties.writeToString(charset: Charset): String {
fun ReproducibleProperties.writeToString(charset: Charset): String {
return ByteArrayOutputStream().also { writeWithoutComments(charset, it) }
.toString(charset.name()).invariantEolString
}
Expand Down