Merge pull request #1052 from jpasquali

* pr/1052:
  Polish "Add support for Maven's finalName"
  Add support for Maven's finalName

Closes gh-1052
This commit is contained in:
Stephane Nicoll 2020-03-17 08:10:23 +01:00
commit 09f77cb1a0
3 changed files with 41 additions and 2 deletions

View File

@ -47,6 +47,8 @@ public class MavenBuildSettings extends BuildSettings {
private final MavenScm scm;
private final String finalName;
private final String sourceDirectory;
private final String testSourceDirectory;
@ -60,6 +62,7 @@ public class MavenBuildSettings extends BuildSettings {
this.licenses = Collections.unmodifiableList(new ArrayList<>(builder.licenses));
this.developers = Collections.unmodifiableList(new ArrayList<>(builder.developers));
this.scm = builder.scm.build();
this.finalName = builder.finalName;
this.sourceDirectory = builder.sourceDirectory;
this.testSourceDirectory = builder.testSourceDirectory;
}
@ -122,6 +125,14 @@ public class MavenBuildSettings extends BuildSettings {
return this.scm;
}
/**
* Return the final name of the artifact.
* @return the final name or {@code null} to use the default
*/
public String getFinalName() {
return this.finalName;
}
/**
* Return the location of main source code. Can use Maven properties such as
* {@code ${basedir}}.
@ -161,6 +172,8 @@ public class MavenBuildSettings extends BuildSettings {
private final MavenScm.Builder scm = new MavenScm.Builder();
private String finalName;
private String sourceDirectory;
private String testSourceDirectory;
@ -251,6 +264,16 @@ public class MavenBuildSettings extends BuildSettings {
return self();
}
/**
* Set the name of the bundled project when it is finally built.
* @param finalName the final name of the artifact
* @return this for method chaining
*/
public Builder finalName(String finalName) {
this.finalName = finalName;
return self();
}
/**
* Set the the location of main source code. Can use Maven properties such as
* {@code ${basedir}}.

View File

@ -304,12 +304,14 @@ public class MavenBuildWriter {
private void writeBuild(IndentingWriter writer, MavenBuild build) {
MavenBuildSettings settings = build.getSettings();
if (settings.getSourceDirectory() == null && settings.getTestSourceDirectory() == null
&& build.resources().isEmpty() && build.testResources().isEmpty() && build.plugins().isEmpty()) {
if (settings.getFinalName() == null && settings.getSourceDirectory() == null
&& settings.getTestSourceDirectory() == null && build.resources().isEmpty()
&& build.testResources().isEmpty() && build.plugins().isEmpty()) {
return;
}
writer.println();
writeElement(writer, "build", () -> {
writeSingleElement(writer, "finalName", settings.getFinalName());
writeSingleElement(writer, "sourceDirectory", settings.getSourceDirectory());
writeSingleElement(writer, "testSourceDirectory", settings.getTestSourceDirectory());
writeResources(writer, build);

View File

@ -672,6 +672,20 @@ class MavenBuildWriterTests {
});
}
@Test
void pomWithNoFinalName() {
MavenBuild build = new MavenBuild();
build.settings().coordinates("com.example.demo", "demo").build();
generatePom(build, (pom) -> assertThat(pom.nodeAtPath("/project/build/finalName")).isNull());
}
@Test
void pomWithFinalName() {
MavenBuild build = new MavenBuild();
build.settings().coordinates("com.example.demo", "demo").finalName("demo.jar");
generatePom(build, (pom) -> assertThat(pom).textAtPath("/project/build/finalName").isEqualTo("demo.jar"));
}
@Test
void pomWithCustomSourceDirectories() {
MavenBuild build = new MavenBuild();