Skip to content
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

Add .md support to the Apache License and Notice transformers #1041

Merged
merged 2 commits into from
Nov 25, 2024
Merged

Add .md support to the Apache License and Notice transformers #1041

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
d9c8844
Add .md support to the Apache License and Notice transformers
Goooler Nov 25, 2024
1812587
Add tests
Goooler Nov 25, 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
4 changes: 4 additions & 0 deletions src/docs/changes/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@

## [Unreleased]

**Added**

- Add .md support to the Apache License and Notice transformers. ([#1041](https://github.com/GradleUp/shadow/pull/1041))

**Changed**

- **BREAKING CHANGE:** Rewrite this plugin in Kotlin. ([#1012](https://github.com/GradleUp/shadow/pull/1012))
Expand Down
4 changes: 3 additions & 1 deletion ...m/github/jengelman/gradle/plugins/shadow/transformers/ApacheLicenseResourceTransformer.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@ public open class ApacheLicenseResourceTransformer : Transformer by NoOpTransfor
override fun canTransformResource(element: FileTreeElement): Boolean {
val path = element.relativePath.pathString
return LICENSE_PATH.equals(path, ignoreCase = true) ||
LICENSE_TXT_PATH.regionMatches(0, path, 0, LICENSE_TXT_PATH.length, ignoreCase = true)
LICENSE_TXT_PATH.regionMatches(0, path, 0, LICENSE_TXT_PATH.length, ignoreCase = true) ||
LICENSE_MD_PATH.regionMatches(0, path, 0, LICENSE_MD_PATH.length, ignoreCase = true)
}

private companion object {
private const val LICENSE_PATH = "META-INF/LICENSE"
private const val LICENSE_TXT_PATH = "META-INF/LICENSE.txt"
private const val LICENSE_MD_PATH = "META-INF/LICENSE.md"
}
}
5 changes: 4 additions & 1 deletion ...om/github/jengelman/gradle/plugins/shadow/transformers/ApacheNoticeResourceTransformer.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,9 @@ public open class ApacheNoticeResourceTransformer : Transformer {

override fun canTransformResource(element: FileTreeElement): Boolean {
val path = element.relativePath.pathString
return NOTICE_PATH.equals(path, ignoreCase = true) || NOTICE_TXT_PATH.equals(path, ignoreCase = true)
return NOTICE_PATH.equals(path, ignoreCase = true) ||
NOTICE_TXT_PATH.equals(path, ignoreCase = true) ||
NOTICE_MD_PATH.equals(path, ignoreCase = true)
}

override fun transform(context: TransformerContext) {
Expand Down Expand Up @@ -174,5 +176,6 @@ public open class ApacheNoticeResourceTransformer : Transformer {
private companion object {
private const val NOTICE_PATH = "META-INF/NOTICE"
private const val NOTICE_TXT_PATH = "META-INF/NOTICE.txt"
private const val NOTICE_MD_PATH = "META-INF/NOTICE.md"
}
}
2 changes: 2 additions & 0 deletions .../jengelman/gradle/plugins/shadow/transformers/ApacheLicenseResourceTransformerTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ class ApacheLicenseResourceTransformerTest extends TransformerTestSupport<Apache
assertTrue(transformer.canTransformResource(getFileElement("META-INF/LICENSE")))
assertTrue(transformer.canTransformResource(getFileElement("META-INF/LICENSE.TXT")))
assertTrue(transformer.canTransformResource(getFileElement("META-INF/License.txt")))
assertTrue(transformer.canTransformResource(getFileElement("META-INF/LICENSE.md")))
assertTrue(transformer.canTransformResource(getFileElement("META-INF/License.md")))
assertFalse(transformer.canTransformResource(getFileElement("META-INF/MANIFEST.MF")))
}

Expand Down
9 changes: 9 additions & 0 deletions ...n/gradle/plugins/shadow/transformers/ApacheNoticeResourceTransformerParameterTests.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,15 @@ class ApacheNoticeResourceTransformerParameterTests extends TransformerTestSuppo
stats = new ShadowStats()
}

@Test
void testCanTransformResource() {
assertTrue(transformer.canTransformResource(getFileElement("META-INF/NOTICE")))
assertTrue(transformer.canTransformResource(getFileElement("META-INF/NOTICE.TXT")))
assertTrue(transformer.canTransformResource(getFileElement("META-INF/Notice.txt")))
assertTrue(transformer.canTransformResource(getFileElement("META-INF/NOTICE.md")))
assertTrue(transformer.canTransformResource(getFileElement("META-INF/Notice.md")))
}

@Test
void testNoParametersShouldNotThrowNullPointerWhenNoInput() {
processAndFailOnNullPointer("")
Expand Down