Skip to content

Restore removed Named from ResourceTransformer #1449

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
merged 3 commits into from
May 28, 2025
Merged

Restore removed Named from ResourceTransformer #1449

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5dc214b
Revert "Remove Named from the parents of Transformer"
Goooler May 28, 2025
4736ee3
Fix conflicts
Goooler May 28, 2025
11e4f61
Update changelog
Goooler May 28, 2025
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
7 changes: 6 additions & 1 deletion api/shadow.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,7 @@ public final class com/github/jengelman/gradle/plugins/shadow/tasks/ShadowSpec$D
public class com/github/jengelman/gradle/plugins/shadow/transformers/ApacheLicenseResourceTransformer : com/github/jengelman/gradle/plugins/shadow/transformers/ResourceTransformer {
public fun <init> ()V
public fun canTransformResource (Lorg/gradle/api/file/FileTreeElement;)Z
public fun getName ()Ljava/lang/String;
public fun getObjectFactory ()Lorg/gradle/api/model/ObjectFactory;
public fun hasTransformedResource ()Z
public fun modifyOutputStream (Lorg/apache/tools/zip/ZipOutputStream;Z)V
Expand Down Expand Up @@ -298,6 +299,7 @@ public final class com/github/jengelman/gradle/plugins/shadow/transformers/Compo
public class com/github/jengelman/gradle/plugins/shadow/transformers/DontIncludeResourceTransformer : com/github/jengelman/gradle/plugins/shadow/transformers/ResourceTransformer {
public fun <init> (Lorg/gradle/api/model/ObjectFactory;)V
public fun canTransformResource (Lorg/gradle/api/file/FileTreeElement;)Z
public fun getName ()Ljava/lang/String;
public final fun getObjectFactory ()Lorg/gradle/api/model/ObjectFactory;
public fun getResource ()Lorg/gradle/api/provider/Property;
public fun hasTransformedResource ()Z
Expand Down Expand Up @@ -329,6 +331,7 @@ public class com/github/jengelman/gradle/plugins/shadow/transformers/IncludeReso
public fun <init> (Lorg/gradle/api/model/ObjectFactory;)V
public fun canTransformResource (Lorg/gradle/api/file/FileTreeElement;)Z
public fun getFile ()Lorg/gradle/api/file/RegularFileProperty;
public fun getName ()Ljava/lang/String;
public final fun getObjectFactory ()Lorg/gradle/api/model/ObjectFactory;
public fun getResource ()Lorg/gradle/api/provider/Property;
public fun hasTransformedResource ()Z
Expand Down Expand Up @@ -398,10 +401,11 @@ public final class com/github/jengelman/gradle/plugins/shadow/transformers/Prope
public final fun from (Ljava/lang/String;)Lcom/github/jengelman/gradle/plugins/shadow/transformers/PropertiesFileTransformer$MergeStrategy;
}

public abstract interface class com/github/jengelman/gradle/plugins/shadow/transformers/ResourceTransformer {
public abstract interface class com/github/jengelman/gradle/plugins/shadow/transformers/ResourceTransformer : org/gradle/api/Named {
public static final field Companion Lcom/github/jengelman/gradle/plugins/shadow/transformers/ResourceTransformer$Companion;
public abstract fun canTransformResource (Lorg/gradle/api/file/FileTreeElement;)Z
public static fun create (Ljava/lang/Class;Lorg/gradle/api/model/ObjectFactory;)Lcom/github/jengelman/gradle/plugins/shadow/transformers/ResourceTransformer;
public fun getName ()Ljava/lang/String;
public fun getObjectFactory ()Lorg/gradle/api/model/ObjectFactory;
public abstract fun hasTransformedResource ()Z
public abstract fun modifyOutputStream (Lorg/apache/tools/zip/ZipOutputStream;Z)V
Expand All @@ -417,6 +421,7 @@ public final class com/github/jengelman/gradle/plugins/shadow/transformers/Resou
}

public final class com/github/jengelman/gradle/plugins/shadow/transformers/ResourceTransformer$DefaultImpls {
public static fun getName (Lcom/github/jengelman/gradle/plugins/shadow/transformers/ResourceTransformer;)Ljava/lang/String;
public static fun getObjectFactory (Lcom/github/jengelman/gradle/plugins/shadow/transformers/ResourceTransformer;)Lorg/gradle/api/model/ObjectFactory;
}

Expand Down
3 changes: 3 additions & 0 deletions docs/changes/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

## [Unreleased](https://github.com/GradleUp/shadow/compare/9.0.0-beta15...HEAD) - 2025-xx-xx

**Fixed**

- Restore removed `Named` from `ResourceTransformer`. ([#1449](https://github.com/GradleUp/shadow/pull/1449))

## [9.0.0-beta15](https://github.com/GradleUp/shadow/releases/tag/9.0.0-beta15) - 2025-05-28

Expand Down
7 changes: 6 additions & 1 deletion ...ain/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/ResourceTransformer.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package com.github.jengelman.gradle.plugins.shadow.transformers
import com.github.jengelman.gradle.plugins.shadow.relocation.CacheableRelocator
import java.io.IOException
import org.apache.tools.zip.ZipOutputStream
import org.gradle.api.Named
import org.gradle.api.file.FileTreeElement
import org.gradle.api.model.ObjectFactory
import org.gradle.api.tasks.Internal
Expand All @@ -15,7 +16,7 @@ import org.gradle.api.tasks.Internal
* @author John Engelman
*/
@JvmDefaultWithCompatibility
public interface ResourceTransformer {
public interface ResourceTransformer : Named {
public fun canTransformResource(element: FileTreeElement): Boolean

@Throws(IOException::class)
Expand All @@ -26,6 +27,10 @@ public interface ResourceTransformer {
@Throws(IOException::class)
public fun modifyOutputStream(os: ZipOutputStream, preserveFileTimestamps: Boolean)

@Suppress("unused") // Used by Gradle side, see https://github.com/GradleUp/shadow/pull/1289#issuecomment-2915738983.
@Internal
override fun getName(): String = this::class.java.simpleName

/**
* This is used for creating Gradle's lazy properties in the subclass, Shadow's build-in transformers that depend on
* this have been injected via [ObjectFactory.newInstance]. Custom transformers should implement or inject
Expand Down