-
Notifications
You must be signed in to change notification settings - Fork 396
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.
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
Change names of files with the same path - this time by Transformer #102
Open
amorfis
wants to merge
5
commits into
GradleUp:main
Choose a base branch
from
amorfis:master
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
8884d07
Pass file to visitArchiveFile, to have access to the .jar path
amorfis 8b774e9
Transformer interface change. Pass merged jar name to transformer so …
amorfis 88438de
Transformer for files which have the same path in merged jars. When i…
amorfis 842cb10
SamePathFilesTransformer can now be restricted by include/exclude pat…
amorfis d8a2f91
Test for excluding file from SamePathFilesTransformer
amorfis File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
204 changes: 204 additions & 0 deletions
204
...y/com/github/jengelman/gradle/plugins/shadow/transformers/SamePathFilesTransformer.groovy
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,204 @@ | ||
/* | ||
* Licensed to the Apache Software Foundation (ASF) under one | ||
* or more contributor license agreements. See the NOTICE file | ||
* distributed with this work for additional information | ||
* regarding copyright ownership. The ASF licenses this file | ||
* to you under the Apache License, Version 2.0 (the | ||
* "License"); you may not use this file except in compliance | ||
* with the License. You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, | ||
* software distributed under the License is distributed on an | ||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
* KIND, either express or implied. See the License for the | ||
* specific language governing permissions and limitations | ||
* under the License. | ||
*/ | ||
|
||
package com.github.jengelman.gradle.plugins.shadow.transformers | ||
import com.github.jengelman.gradle.plugins.shadow.relocation.Relocator | ||
import org.apache.commons.collections.map.MultiValueMap | ||
import org.apache.commons.io.FilenameUtils | ||
import org.apache.commons.lang.StringUtils | ||
import org.apache.tools.zip.ZipEntry | ||
import org.apache.tools.zip.ZipOutputStream | ||
import org.gradle.api.file.FileTreeElement | ||
import org.gradle.api.specs.Spec | ||
import org.gradle.api.tasks.util.PatternFilterable | ||
import org.gradle.api.tasks.util.PatternSet | ||
import org.gradle.mvn3.org.codehaus.plexus.util.IOUtil | ||
|
||
class SamePathFilesTransformer implements Transformer, PatternFilterable { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Need a better name for this class. Also javadoc describing what it does. |
||
|
||
private final PatternSet patternSet = new PatternSet() | ||
|
||
private final def serviceEntires = new MultiValueMap() | ||
|
||
@Override | ||
boolean canTransformResource(FileTreeElement element) { | ||
return patternSet.asSpec.isSatisfiedBy(element) | ||
} | ||
|
||
@Override | ||
void transform(String jarName, String path, InputStream is, List<Relocator> relocators) { | ||
serviceEntires.put(path, new InputStreamWithJarName(is, jarName)) | ||
} | ||
|
||
@Override | ||
boolean hasTransformedResource() { | ||
return true; | ||
} | ||
|
||
@Override | ||
void modifyOutputStream(ZipOutputStream os) { | ||
serviceEntires.each { String path, List<InputStreamWithJarName> streams -> | ||
if (streams.size() == 1) { | ||
os.putNextEntry(new ZipEntry(path)) | ||
IOUtil.copy(streams[0].is, os) | ||
os.closeEntry() | ||
} else { | ||
streams.each { | ||
def newPath = createFilePathWithMergedJarName(path, it.jarName) | ||
os.putNextEntry(new ZipEntry(newPath)) | ||
IOUtil.copy(it.is, os) | ||
os.closeEntry() | ||
} | ||
} | ||
} | ||
} | ||
|
||
private String createFilePathWithMergedJarName(String path, String mergedJarName) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this needs to be configurable. |
||
def extension = FilenameUtils.getExtension(path) | ||
def pathWithoutExtension = path | ||
if (StringUtils.isNotEmpty(extension)) { | ||
pathWithoutExtension = path.substring(0, path.length() - extension.length() - 1) | ||
extension = ".$extension" | ||
} | ||
|
||
def mergedJarExtension = FilenameUtils.getExtension(mergedJarName) | ||
if (StringUtils.isNotEmpty(mergedJarExtension)) { | ||
mergedJarName = mergedJarName.substring(0, mergedJarName.length() - mergedJarExtension.length() - 1) | ||
} | ||
|
||
return "${pathWithoutExtension}_$mergedJarName$extension" | ||
} | ||
|
||
/** | ||
* {@inheritDoc} | ||
*/ | ||
@Override | ||
SamePathFilesTransformer include(String... includes) { | ||
patternSet.include(includes) | ||
return this | ||
} | ||
|
||
/** | ||
* {@inheritDoc} | ||
*/ | ||
@Override | ||
SamePathFilesTransformer include(Iterable<String> includes) { | ||
patternSet.include(includes) | ||
return this | ||
} | ||
|
||
/** | ||
* {@inheritDoc} | ||
*/ | ||
@Override | ||
SamePathFilesTransformer include(Spec<FileTreeElement> includeSpec) { | ||
patternSet.include(includeSpec) | ||
return this | ||
} | ||
|
||
/** | ||
* {@inheritDoc} | ||
*/ | ||
@Override | ||
SamePathFilesTransformer include(Closure includeSpec) { | ||
patternSet.include(includeSpec) | ||
return this | ||
} | ||
|
||
/** | ||
* {@inheritDoc} | ||
*/ | ||
@Override | ||
SamePathFilesTransformer exclude(String... excludes) { | ||
patternSet.exclude(excludes) | ||
return this | ||
} | ||
|
||
/** | ||
* {@inheritDoc} | ||
*/ | ||
@Override | ||
SamePathFilesTransformer exclude(Iterable<String> excludes) { | ||
patternSet.exclude(excludes) | ||
return this | ||
} | ||
|
||
/** | ||
* {@inheritDoc} | ||
*/ | ||
@Override | ||
SamePathFilesTransformer exclude(Spec<FileTreeElement> excludeSpec) { | ||
patternSet.exclude(excludeSpec) | ||
return this | ||
} | ||
|
||
/** | ||
* {@inheritDoc} | ||
*/ | ||
@Override | ||
SamePathFilesTransformer exclude(Closure excludeSpec) { | ||
patternSet.exclude(excludeSpec) | ||
return this | ||
} | ||
|
||
/** | ||
* {@inheritDoc} | ||
*/ | ||
@Override | ||
Set<String> getIncludes() { | ||
return patternSet.includes | ||
} | ||
|
||
/** | ||
* {@inheritDoc} | ||
*/ | ||
@Override | ||
SamePathFilesTransformer setIncludes(Iterable<String> includes) { | ||
patternSet.includes = includes | ||
return this | ||
} | ||
|
||
/** | ||
* {@inheritDoc} | ||
*/ | ||
@Override | ||
Set<String> getExcludes() { | ||
return patternSet.excludes | ||
} | ||
|
||
/** | ||
* {@inheritDoc} | ||
*/ | ||
@Override | ||
SamePathFilesTransformer setExcludes(Iterable<String> excludes) { | ||
patternSet.excludes = excludes | ||
return this | ||
} | ||
|
||
private class InputStreamWithJarName { | ||
|
||
private InputStream is; | ||
private String jarName; | ||
|
||
InputStreamWithJarName(InputStream is, String jarName) { | ||
this.is = is | ||
this.jarName = jarName | ||
} | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Won't
mergedJar.name
work fine for this? Seems like we've made a bunch of changes that aren't really need as the information is available from the existing API.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On that note, I'd prefer if you kept the changes to a minimum. The variable renames makes this a lot harder to review because it's harder to see what the actually change was.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, thanks for looking at this! WRT variables naming, I was really lost with "archive", it was never clear to me if it is the .jar we are merging into fat jar, or far jar itself.
WRT redundancy, I'll look at this, but AFAIR there was no jar file path in
mergedJar
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
http://docs.oracle.com/javase/7/docs/api/java/util/zip/ZipFile.html#getName()
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd prefer to name the variable
sourceJar
then.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or
sourceArchive