Skip to content

Commit 59d49d3

Browse files
GooolerGoooler
authored
Rename const values (#1130)
1 parent 18d659e commit 59d49d3

File tree

3 files changed

+46
-44
lines changed

3 files changed

+46
-44
lines changed

‎api/shadow.api‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -435,14 +435,14 @@ public class com/github/jengelman/gradle/plugins/shadow/transformers/DontInclude
435435

436436
public class com/github/jengelman/gradle/plugins/shadow/transformers/GroovyExtensionModuleTransformer : com/github/jengelman/gradle/plugins/shadow/transformers/Transformer {
437437
public static final field Companion Lcom/github/jengelman/gradle/plugins/shadow/transformers/GroovyExtensionModuleTransformer$Companion;
438-
public static final field EXTENSION_CLASSES_KEY Ljava/lang/String;
439-
public static final field GROOVY_EXTENSION_MODULE_DESCRIPTOR_PATH Ljava/lang/String;
440-
public static final field GROOVY_LEGACY_EXTENSION_MODULE_DESCRIPTOR_PATH Ljava/lang/String;
438+
public static final field KEY_EXTENSION_CLASSES Ljava/lang/String;
439+
public static final field KEY_MODULE_NAME Ljava/lang/String;
440+
public static final field KEY_MODULE_VERSION Ljava/lang/String;
441+
public static final field KEY_STATIC_EXTENSION_CLASSES Ljava/lang/String;
441442
public static final field MERGED_MODULE_NAME Ljava/lang/String;
442443
public static final field MERGED_MODULE_VERSION Ljava/lang/String;
443-
public static final field MODULE_NAME_KEY Ljava/lang/String;
444-
public static final field MODULE_VERSION_KEY Ljava/lang/String;
445-
public static final field STATIC_EXTENSION_CLASSES_KEY Ljava/lang/String;
444+
public static final field PATH_GROOVY_EXTENSION_MODULE_DESCRIPTOR Ljava/lang/String;
445+
public static final field PATH_LEGACY_GROOVY_EXTENSION_MODULE_DESCRIPTOR Ljava/lang/String;
446446
public fun <init> ()V
447447
public fun canTransformResource (Lorg/gradle/api/file/FileTreeElement;)Z
448448
public fun hasTransformedResource ()Z

‎src/intiTest/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/GroovyExtensionModuleTransformerTest.kt‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@ package com.github.jengelman.gradle.plugins.shadow.transformers
22

33
import assertk.assertThat
44
import assertk.assertions.isEqualTo
5-
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.EXTENSION_CLASSES_KEY
6-
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.GROOVY_EXTENSION_MODULE_DESCRIPTOR_PATH
7-
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.GROOVY_LEGACY_EXTENSION_MODULE_DESCRIPTOR_PATH
5+
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.KEY_EXTENSION_CLASSES
6+
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.KEY_MODULE_NAME
7+
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.KEY_MODULE_VERSION
8+
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.KEY_STATIC_EXTENSION_CLASSES
89
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.MERGED_MODULE_NAME
910
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.MERGED_MODULE_VERSION
10-
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.MODULE_NAME_KEY
11-
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.MODULE_VERSION_KEY
12-
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.STATIC_EXTENSION_CLASSES_KEY
11+
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.PATH_GROOVY_EXTENSION_MODULE_DESCRIPTOR
12+
import com.github.jengelman.gradle.plugins.shadow.transformers.GroovyExtensionModuleTransformer.Companion.PATH_LEGACY_GROOVY_EXTENSION_MODULE_DESCRIPTOR
1313
import java.nio.file.Path
1414
import java.util.Properties
1515
import kotlin.io.path.appendText
@@ -26,7 +26,7 @@ class GroovyExtensionModuleTransformerTest : BaseTransformerTest() {
2626

2727
run(shadowJarTask)
2828

29-
val props = outputShadowJar.getContent(GROOVY_EXTENSION_MODULE_DESCRIPTOR_PATH).toProperties()
29+
val props = outputShadowJar.getContent(PATH_GROOVY_EXTENSION_MODULE_DESCRIPTOR).toProperties()
3030
commonAssertions(props)
3131
}
3232

@@ -35,15 +35,15 @@ class GroovyExtensionModuleTransformerTest : BaseTransformerTest() {
3535
projectScriptPath.appendText(
3636
transform<GroovyExtensionModuleTransformer>(
3737
shadowJarBlock = fromJar(
38-
buildJarFoo(GROOVY_LEGACY_EXTENSION_MODULE_DESCRIPTOR_PATH),
39-
buildJarBar(GROOVY_LEGACY_EXTENSION_MODULE_DESCRIPTOR_PATH),
38+
buildJarFoo(PATH_LEGACY_GROOVY_EXTENSION_MODULE_DESCRIPTOR),
39+
buildJarBar(PATH_LEGACY_GROOVY_EXTENSION_MODULE_DESCRIPTOR),
4040
),
4141
),
4242
)
4343

4444
run(shadowJarTask)
4545

46-
val props = outputShadowJar.getContent(GROOVY_LEGACY_EXTENSION_MODULE_DESCRIPTOR_PATH).toProperties()
46+
val props = outputShadowJar.getContent(PATH_LEGACY_GROOVY_EXTENSION_MODULE_DESCRIPTOR).toProperties()
4747
commonAssertions(props)
4848
}
4949

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

6161
run(shadowJarTask)
6262

63-
val props = outputShadowJar.getContent(GROOVY_EXTENSION_MODULE_DESCRIPTOR_PATH).toProperties()
63+
val props = outputShadowJar.getContent(PATH_GROOVY_EXTENSION_MODULE_DESCRIPTOR).toProperties()
6464
commonAssertions(props)
6565
}
6666

6767
private fun buildJarFoo(
68-
path: String = GROOVY_EXTENSION_MODULE_DESCRIPTOR_PATH,
68+
path: String = PATH_GROOVY_EXTENSION_MODULE_DESCRIPTOR,
6969
): Path = buildJar("foo.jar") {
7070
insert(
7171
path,
7272
"""
73-
$MODULE_NAME_KEY=foo
74-
$MODULE_VERSION_KEY=1.0.5
75-
$EXTENSION_CLASSES_KEY=$EXTENSION_CLASSES_FOO
76-
$STATIC_EXTENSION_CLASSES_KEY=$STATIC_EXTENSION_CLASSES_FOO
73+
$KEY_MODULE_NAME=foo
74+
$KEY_MODULE_VERSION=1.0.5
75+
$KEY_EXTENSION_CLASSES=$EXTENSION_CLASSES_FOO
76+
$KEY_STATIC_EXTENSION_CLASSES=$STATIC_EXTENSION_CLASSES_FOO
7777
""".trimIndent(),
7878
)
7979
}
8080

8181
private fun buildJarBar(
82-
path: String = GROOVY_EXTENSION_MODULE_DESCRIPTOR_PATH,
82+
path: String = PATH_GROOVY_EXTENSION_MODULE_DESCRIPTOR,
8383
): Path = buildJar("bar.jar") {
8484
insert(
8585
path,
8686
"""
87-
$MODULE_NAME_KEY=bar
88-
$MODULE_VERSION_KEY=2.3.5
89-
$EXTENSION_CLASSES_KEY=$EXTENSION_CLASSES_BAR
90-
$STATIC_EXTENSION_CLASSES_KEY=$STATIC_EXTENSION_CLASSES_BAR
87+
$KEY_MODULE_NAME=bar
88+
$KEY_MODULE_VERSION=2.3.5
89+
$KEY_EXTENSION_CLASSES=$EXTENSION_CLASSES_BAR
90+
$KEY_STATIC_EXTENSION_CLASSES=$STATIC_EXTENSION_CLASSES_BAR
9191
""".trimIndent(),
9292
)
9393
}
@@ -99,11 +99,11 @@ class GroovyExtensionModuleTransformerTest : BaseTransformerTest() {
9999
const val STATIC_EXTENSION_CLASSES_BAR = "com.acme.bar.SomeStaticExtension"
100100

101101
fun commonAssertions(properties: Properties) {
102-
assertThat(properties.getProperty(MODULE_NAME_KEY)).isEqualTo(MERGED_MODULE_NAME)
103-
assertThat(properties.getProperty(MODULE_VERSION_KEY)).isEqualTo(MERGED_MODULE_VERSION)
104-
assertThat(properties.getProperty(EXTENSION_CLASSES_KEY))
102+
assertThat(properties.getProperty(KEY_MODULE_NAME)).isEqualTo(MERGED_MODULE_NAME)
103+
assertThat(properties.getProperty(KEY_MODULE_VERSION)).isEqualTo(MERGED_MODULE_VERSION)
104+
assertThat(properties.getProperty(KEY_EXTENSION_CLASSES))
105105
.isEqualTo("$EXTENSION_CLASSES_FOO,$EXTENSION_CLASSES_BAR")
106-
assertThat(properties.getProperty(STATIC_EXTENSION_CLASSES_KEY))
106+
assertThat(properties.getProperty(KEY_STATIC_EXTENSION_CLASSES))
107107
.isEqualTo("$STATIC_EXTENSION_CLASSES_FOO,$STATIC_EXTENSION_CLASSES_BAR")
108108
}
109109
}

‎src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/GroovyExtensionModuleTransformer.kt‎

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,27 +36,27 @@ public open class GroovyExtensionModuleTransformer : Transformer {
3636

3737
override fun canTransformResource(element: FileTreeElement): Boolean {
3838
val path = element.relativePath.pathString
39-
if (path == GROOVY_EXTENSION_MODULE_DESCRIPTOR_PATH) {
39+
if (path == PATH_GROOVY_EXTENSION_MODULE_DESCRIPTOR) {
4040
// Groovy 2.5+
4141
legacy = false
4242
return true
4343
}
44-
return path == GROOVY_LEGACY_EXTENSION_MODULE_DESCRIPTOR_PATH
44+
return path == PATH_LEGACY_GROOVY_EXTENSION_MODULE_DESCRIPTOR
4545
}
4646

4747
override fun transform(context: TransformerContext) {
4848
val props = Properties()
4949
props.load(context.inputStream)
5050
props.forEach { key, value ->
5151
when (key as String) {
52-
MODULE_NAME_KEY -> handle(key, value as String) {
52+
KEY_MODULE_NAME -> handle(key, value as String) {
5353
module.setProperty(key, MERGED_MODULE_NAME)
5454
}
55-
MODULE_VERSION_KEY -> handle(key, value as String) {
55+
KEY_MODULE_VERSION -> handle(key, value as String) {
5656
module.setProperty(key, MERGED_MODULE_VERSION)
5757
}
58-
EXTENSION_CLASSES_KEY,
59-
STATIC_EXTENSION_CLASSES_KEY,
58+
KEY_EXTENSION_CLASSES,
59+
KEY_STATIC_EXTENSION_CLASSES,
6060
-> handle(key, value as String) { existingValue ->
6161
module.setProperty(key, "$existingValue,$value")
6262
}
@@ -76,7 +76,7 @@ public open class GroovyExtensionModuleTransformer : Transformer {
7676
override fun hasTransformedResource(): Boolean = module.isNotEmpty()
7777

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

8989
public companion object {
90-
public const val GROOVY_LEGACY_EXTENSION_MODULE_DESCRIPTOR_PATH: String =
90+
public const val PATH_LEGACY_GROOVY_EXTENSION_MODULE_DESCRIPTOR: String =
9191
"META-INF/services/org.codehaus.groovy.runtime.ExtensionModule"
92-
public const val GROOVY_EXTENSION_MODULE_DESCRIPTOR_PATH: String =
92+
public const val PATH_GROOVY_EXTENSION_MODULE_DESCRIPTOR: String =
9393
"META-INF/groovy/org.codehaus.groovy.runtime.ExtensionModule"
94-
public const val MODULE_NAME_KEY: String = "moduleName"
95-
public const val MODULE_VERSION_KEY: String = "moduleVersion"
96-
public const val EXTENSION_CLASSES_KEY: String = "extensionClasses"
97-
public const val STATIC_EXTENSION_CLASSES_KEY: String = "staticExtensionClasses"
94+
95+
public const val KEY_MODULE_NAME: String = "moduleName"
96+
public const val KEY_MODULE_VERSION: String = "moduleVersion"
97+
public const val KEY_EXTENSION_CLASSES: String = "extensionClasses"
98+
public const val KEY_STATIC_EXTENSION_CLASSES: String = "staticExtensionClasses"
99+
98100
public const val MERGED_MODULE_NAME: String = "MergedByShadowJar"
99101
public const val MERGED_MODULE_VERSION: String = "1.0.0"
100102
}

0 commit comments

Comments
 (0)