Skip to content

Rename const values #1130

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
Jan 6, 2025
Merged

Rename const values #1130

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
12 changes: 6 additions & 6 deletions api/shadow.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -435,14 +435,14 @@ public class com/github/jengelman/gradle/plugins/shadow/transformers/DontInclude

public class com/github/jengelman/gradle/plugins/shadow/transformers/GroovyExtensionModuleTransformer : com/github/jengelman/gradle/plugins/shadow/transformers/Transformer {
public static final field Companion Lcom/github/jengelman/gradle/plugins/shadow/transformers/GroovyExtensionModuleTransformer$Companion;
public static final field EXTENSION_CLASSES_KEY Ljava/lang/String;
public static final field GROOVY_EXTENSION_MODULE_DESCRIPTOR_PATH Ljava/lang/String;
public static final field GROOVY_LEGACY_EXTENSION_MODULE_DESCRIPTOR_PATH Ljava/lang/String;
public static final field KEY_EXTENSION_CLASSES Ljava/lang/String;
public static final field KEY_MODULE_NAME Ljava/lang/String;
public static final field KEY_MODULE_VERSION Ljava/lang/String;
public static final field KEY_STATIC_EXTENSION_CLASSES Ljava/lang/String;
public static final field MERGED_MODULE_NAME Ljava/lang/String;
public static final field MERGED_MODULE_VERSION Ljava/lang/String;
public static final field MODULE_NAME_KEY Ljava/lang/String;
public static final field MODULE_VERSION_KEY Ljava/lang/String;
public static final field STATIC_EXTENSION_CLASSES_KEY Ljava/lang/String;
public static final field PATH_GROOVY_EXTENSION_MODULE_DESCRIPTOR Ljava/lang/String;
public static final field PATH_LEGACY_GROOVY_EXTENSION_MODULE_DESCRIPTOR Ljava/lang/String;
public fun <init> ()V
public fun canTransformResource (Lorg/gradle/api/file/FileTreeElement;)Z
public fun hasTransformedResource ()Z
Expand Down
50 changes: 25 additions & 25 deletions ...thub/jengelman/gradle/plugins/shadow/transformers/GroovyExtensionModuleTransformerTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ package com.github.jengelman.gradle.plugins.shadow.transformers

import assertk.assertThat
import assertk.assertions.isEqualTo
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.EXTENSION_CLASSES_KEY
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.GROOVY_EXTENSION_MODULE_DESCRIPTOR_PATH
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.GROOVY_LEGACY_EXTENSION_MODULE_DESCRIPTOR_PATH
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.KEY_EXTENSION_CLASSES
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.KEY_MODULE_NAME
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.KEY_MODULE_VERSION
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.KEY_STATIC_EXTENSION_CLASSES
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.MERGED_MODULE_NAME
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.MERGED_MODULE_VERSION
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.MODULE_NAME_KEY
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.MODULE_VERSION_KEY
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.STATIC_EXTENSION_CLASSES_KEY
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.PATH_GROOVY_EXTENSION_MODULE_DESCRIPTOR
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.PATH_LEGACY_GROOVY_EXTENSION_MODULE_DESCRIPTOR
import java.nio.file.Path
import java.util.Properties
import kotlin.io.path.appendText
Expand All @@ -26,7 +26,7 @@ class GroovyExtensionModuleTransformerTest : BaseTransformerTest() {

run(shadowJarTask)

val props = outputShadowJar.getContent(GROOVY_EXTENSION_MODULE_DESCRIPTOR_PATH).toProperties()
val props = outputShadowJar.getContent(PATH_GROOVY_EXTENSION_MODULE_DESCRIPTOR).toProperties()
commonAssertions(props)
}

Expand All @@ -35,15 +35,15 @@ class GroovyExtensionModuleTransformerTest : BaseTransformerTest() {
projectScriptPath.appendText(
transform<GroovyExtensionModuleTransformer>(
shadowJarBlock = fromJar(
buildJarFoo(GROOVY_LEGACY_EXTENSION_MODULE_DESCRIPTOR_PATH),
buildJarBar(GROOVY_LEGACY_EXTENSION_MODULE_DESCRIPTOR_PATH),
buildJarFoo(PATH_LEGACY_GROOVY_EXTENSION_MODULE_DESCRIPTOR),
buildJarBar(PATH_LEGACY_GROOVY_EXTENSION_MODULE_DESCRIPTOR),
),
),
)

run(shadowJarTask)

val props = outputShadowJar.getContent(GROOVY_LEGACY_EXTENSION_MODULE_DESCRIPTOR_PATH).toProperties()
val props = outputShadowJar.getContent(PATH_LEGACY_GROOVY_EXTENSION_MODULE_DESCRIPTOR).toProperties()
commonAssertions(props)
}

Expand All @@ -60,34 +60,34 @@ class GroovyExtensionModuleTransformerTest : BaseTransformerTest() {

run(shadowJarTask)

val props = outputShadowJar.getContent(GROOVY_EXTENSION_MODULE_DESCRIPTOR_PATH).toProperties()
val props = outputShadowJar.getContent(PATH_GROOVY_EXTENSION_MODULE_DESCRIPTOR).toProperties()
commonAssertions(props)
}

private fun buildJarFoo(
path: String = GROOVY_EXTENSION_MODULE_DESCRIPTOR_PATH,
path: String = PATH_GROOVY_EXTENSION_MODULE_DESCRIPTOR,
): Path = buildJar("foo.jar") {
insert(
path,
"""
$MODULE_NAME_KEY=foo
$MODULE_VERSION_KEY=1.0.5
$EXTENSION_CLASSES_KEY=$EXTENSION_CLASSES_FOO
$STATIC_EXTENSION_CLASSES_KEY=$STATIC_EXTENSION_CLASSES_FOO
$KEY_MODULE_NAME=foo
$KEY_MODULE_VERSION=1.0.5
$KEY_EXTENSION_CLASSES=$EXTENSION_CLASSES_FOO
$KEY_STATIC_EXTENSION_CLASSES=$STATIC_EXTENSION_CLASSES_FOO
""".trimIndent(),
)
}

private fun buildJarBar(
path: String = GROOVY_EXTENSION_MODULE_DESCRIPTOR_PATH,
path: String = PATH_GROOVY_EXTENSION_MODULE_DESCRIPTOR,
): Path = buildJar("bar.jar") {
insert(
path,
"""
$MODULE_NAME_KEY=bar
$MODULE_VERSION_KEY=2.3.5
$EXTENSION_CLASSES_KEY=$EXTENSION_CLASSES_BAR
$STATIC_EXTENSION_CLASSES_KEY=$STATIC_EXTENSION_CLASSES_BAR
$KEY_MODULE_NAME=bar
$KEY_MODULE_VERSION=2.3.5
$KEY_EXTENSION_CLASSES=$EXTENSION_CLASSES_BAR
$KEY_STATIC_EXTENSION_CLASSES=$STATIC_EXTENSION_CLASSES_BAR
""".trimIndent(),
)
}
Expand All @@ -99,11 +99,11 @@ class GroovyExtensionModuleTransformerTest : BaseTransformerTest() {
const val STATIC_EXTENSION_CLASSES_BAR = "com.acme.bar.SomeStaticExtension"

fun commonAssertions(properties: Properties) {
assertThat(properties.getProperty(MODULE_NAME_KEY)).isEqualTo(MERGED_MODULE_NAME)
assertThat(properties.getProperty(MODULE_VERSION_KEY)).isEqualTo(MERGED_MODULE_VERSION)
assertThat(properties.getProperty(EXTENSION_CLASSES_KEY))
assertThat(properties.getProperty(KEY_MODULE_NAME)).isEqualTo(MERGED_MODULE_NAME)
assertThat(properties.getProperty(KEY_MODULE_VERSION)).isEqualTo(MERGED_MODULE_VERSION)
assertThat(properties.getProperty(KEY_EXTENSION_CLASSES))
.isEqualTo("$EXTENSION_CLASSES_FOO,$EXTENSION_CLASSES_BAR")
assertThat(properties.getProperty(STATIC_EXTENSION_CLASSES_KEY))
assertThat(properties.getProperty(KEY_STATIC_EXTENSION_CLASSES))
.isEqualTo("$STATIC_EXTENSION_CLASSES_FOO,$STATIC_EXTENSION_CLASSES_BAR")
}
}
Expand Down
28 changes: 15 additions & 13 deletions ...m/github/jengelman/gradle/plugins/shadow/transformers/GroovyExtensionModuleTransformer.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,27 +36,27 @@ public open class GroovyExtensionModuleTransformer : Transformer {

override fun canTransformResource(element: FileTreeElement): Boolean {
val path = element.relativePath.pathString
if (path == GROOVY_EXTENSION_MODULE_DESCRIPTOR_PATH) {
if (path == PATH_GROOVY_EXTENSION_MODULE_DESCRIPTOR) {
// Groovy 2.5+
legacy = false
return true
}
return path == GROOVY_LEGACY_EXTENSION_MODULE_DESCRIPTOR_PATH
return path == PATH_LEGACY_GROOVY_EXTENSION_MODULE_DESCRIPTOR
}

override fun transform(context: TransformerContext) {
val props = Properties()
props.load(context.inputStream)
props.forEach { key, value ->
when (key as String) {
MODULE_NAME_KEY -> handle(key, value as String) {
KEY_MODULE_NAME -> handle(key, value as String) {
module.setProperty(key, MERGED_MODULE_NAME)
}
MODULE_VERSION_KEY -> handle(key, value as String) {
KEY_MODULE_VERSION -> handle(key, value as String) {
module.setProperty(key, MERGED_MODULE_VERSION)
}
EXTENSION_CLASSES_KEY,
STATIC_EXTENSION_CLASSES_KEY,
KEY_EXTENSION_CLASSES,
KEY_STATIC_EXTENSION_CLASSES,
-> handle(key, value as String) { existingValue ->
module.setProperty(key, "$existingValue,$value")
}
Expand All @@ -76,7 +76,7 @@ public open class GroovyExtensionModuleTransformer : Transformer {
override fun hasTransformedResource(): Boolean = module.isNotEmpty()

override fun modifyOutputStream(os: ZipOutputStream, preserveFileTimestamps: Boolean) {
val name = if (legacy) GROOVY_LEGACY_EXTENSION_MODULE_DESCRIPTOR_PATH else GROOVY_EXTENSION_MODULE_DESCRIPTOR_PATH
val name = if (legacy) PATH_LEGACY_GROOVY_EXTENSION_MODULE_DESCRIPTOR else PATH_GROOVY_EXTENSION_MODULE_DESCRIPTOR
val entry = ZipEntry(name)
entry.time = getEntryTimestamp(preserveFileTimestamps, entry.time)
os.putNextEntry(entry)
Expand All @@ -87,14 +87,16 @@ public open class GroovyExtensionModuleTransformer : Transformer {
}

public companion object {
public const val GROOVY_LEGACY_EXTENSION_MODULE_DESCRIPTOR_PATH: String =
public const val PATH_LEGACY_GROOVY_EXTENSION_MODULE_DESCRIPTOR: String =
"META-INF/services/org.codehaus.groovy.runtime.ExtensionModule"
public const val GROOVY_EXTENSION_MODULE_DESCRIPTOR_PATH: String =
public const val PATH_GROOVY_EXTENSION_MODULE_DESCRIPTOR: String =
"META-INF/groovy/org.codehaus.groovy.runtime.ExtensionModule"
public const val MODULE_NAME_KEY: String = "moduleName"
public const val MODULE_VERSION_KEY: String = "moduleVersion"
public const val EXTENSION_CLASSES_KEY: String = "extensionClasses"
public const val STATIC_EXTENSION_CLASSES_KEY: String = "staticExtensionClasses"

public const val KEY_MODULE_NAME: String = "moduleName"
public const val KEY_MODULE_VERSION: String = "moduleVersion"
public const val KEY_EXTENSION_CLASSES: String = "extensionClasses"
public const val KEY_STATIC_EXTENSION_CLASSES: String = "staticExtensionClasses"

public const val MERGED_MODULE_NAME: String = "MergedByShadowJar"
public const val MERGED_MODULE_VERSION: String = "1.0.0"
}
Expand Down
Loading