Skip to content

Commit 91369fa

Browse files
kriegaexmichael-o
kriegaex
authored and
michael-o
committed
[MJAVADOC-775] Option 'taglets/taglet/tagletpath' ignored when pointing to a JAR
New method JavadocUtil::prunePaths takes care of pruning classpath elements correctly, the existing JavadocUtil::pruneDirs is now just a special case delegating to prunePaths. This closes #255
1 parent be2fa20 commit 91369fa

File tree

3 files changed

+62
-17
lines changed

3 files changed

+62
-17
lines changed

‎src/main/java/org/apache/maven/plugins/javadoc/AbstractJavadocMojo.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -2962,8 +2962,9 @@ private String getTagletPath() throws MavenReportException {
29622962
&& (StringUtils.isNotEmpty(taglet.getTagletArtifact().getVersion()))) {
29632963
pathParts.addAll(JavadocUtil.pruneFiles(getArtifactsAbsolutePath(taglet.getTagletArtifact())));
29642964
} else if (StringUtils.isNotEmpty(taglet.getTagletpath())) {
2965-
for (Path dir : JavadocUtil.pruneDirs(project, Collections.singletonList(taglet.getTagletpath()))) {
2966-
pathParts.add(dir.toString());
2965+
for (Path path :
2966+
JavadocUtil.prunePaths(project, Collections.singletonList(taglet.getTagletpath()), true)) {
2967+
pathParts.add(path.toString());
29672968
}
29682969
}
29692970
}

‎src/main/java/org/apache/maven/plugins/javadoc/JavadocUtil.java

+26-11
Original file line numberDiff line numberDiff line change
@@ -118,32 +118,47 @@ public class JavadocUtil {
118118
+ "environment variable using -Xms:<size> and -Xmx:<size>.";
119119

120120
/**
121-
* Method that removes the invalid directories in the specified directories. <b>Note</b>: All elements in
122-
* <code>dirs</code> could be an absolute or relative against the project's base directory <code>String</code> path.
121+
* Method that removes invalid classpath elements in the specified paths.
122+
* <b>Note</b>: All elements in {@code paths} could be absolute or relative against the project's base directory.
123+
* When pruning classpath elements, you can optionally include files in the result, otherwise only directories are
124+
* permitted.
123125
*
124126
* @param project the current Maven project not null
125-
* @param dirs the collection of <code>String</code> directories path that will be validated.
126-
* @return a List of valid <code>String</code> directories absolute paths.
127+
* @param paths the collection of paths that will be validated
128+
* @param includeFiles whether to include files in the result as well
129+
* @return a list of valid classpath elements as absolute paths
127130
*/
128-
public static Collection<Path> pruneDirs(MavenProject project, Collection<String> dirs) {
131+
public static Collection<Path> prunePaths(MavenProject project, Collection<String> paths, boolean includeFiles) {
129132
final Path projectBasedir = project.getBasedir().toPath();
130133

131-
Set<Path> pruned = new LinkedHashSet<>(dirs.size());
132-
for (String dir : dirs) {
133-
if (dir == null) {
134+
Set<Path> pruned = new LinkedHashSet<>(paths.size());
135+
for (String path : paths) {
136+
if (path == null) {
134137
continue;
135138
}
136139

137-
Path directory = projectBasedir.resolve(dir);
140+
Path resolvedPath = projectBasedir.resolve(path);
138141

139-
if (Files.isDirectory(directory)) {
140-
pruned.add(directory.toAbsolutePath());
142+
if (Files.isDirectory(resolvedPath) || includeFiles && Files.isRegularFile(resolvedPath)) {
143+
pruned.add(resolvedPath.toAbsolutePath());
141144
}
142145
}
143146

144147
return pruned;
145148
}
146149

150+
/**
151+
* Method that removes the invalid classpath directories in the specified directories.
152+
* <b>Note</b>: All elements in {@code dirs} could be absolute or relative against the project's base directory.
153+
*
154+
* @param project the current Maven project not null
155+
* @param dirs the collection of directories that will be validated
156+
* @return a list of valid claspath elements as absolute paths
157+
*/
158+
public static Collection<Path> pruneDirs(MavenProject project, Collection<String> dirs) {
159+
return prunePaths(project, dirs, false);
160+
}
161+
147162
/**
148163
* Method that removes the invalid files in the specified files. <b>Note</b>: All elements in <code>files</code>
149164
* should be an absolute <code>String</code> path.

‎src/test/java/org/apache/maven/plugins/javadoc/JavadocUtilTest.java

+33-4
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,11 @@
3232
import java.nio.file.Path;
3333
import java.nio.file.Paths;
3434
import java.util.ArrayList;
35+
import java.util.Arrays;
3536
import java.util.Collection;
3637
import java.util.Collections;
3738
import java.util.HashMap;
39+
import java.util.HashSet;
3840
import java.util.List;
3941
import java.util.Map;
4042
import java.util.Set;
@@ -582,18 +584,45 @@ public void testCopyJavadocResources() throws Exception {
582584
*/
583585
public void testPruneDirs() {
584586
List<String> list = new ArrayList<>();
585-
list.add(getBasedir() + "/target/classes");
586-
list.add(getBasedir() + "/target/classes");
587-
list.add(getBasedir() + "/target/classes");
587+
String classesDir = getBasedir() + "/target/classes";
588+
list.add(classesDir);
589+
list.add(classesDir);
590+
list.add(classesDir);
588591

589-
Set<Path> expected = Collections.singleton(Paths.get(getBasedir(), "target/classes"));
592+
Set<Path> expected = Collections.singleton(Paths.get(classesDir));
590593

591594
MavenProjectStub project = new MavenProjectStub();
592595
project.setFile(new File(getBasedir(), "pom.xml"));
593596

594597
assertEquals(expected, JavadocUtil.pruneDirs(project, list));
595598
}
596599

600+
/**
601+
* Method to test prunePaths()
602+
*
603+
*/
604+
public void testPrunePaths() {
605+
List<String> list = new ArrayList<>();
606+
String classesDir = getBasedir() + "/target/classes";
607+
String tagletJar = getBasedir()
608+
+ "/target/test-classes/unit/taglet-test/artifact-taglet/org/tullmann/taglets/1.0/taglets-1.0.jar";
609+
list.add(classesDir);
610+
list.add(classesDir);
611+
list.add(classesDir);
612+
list.add(tagletJar);
613+
list.add(tagletJar);
614+
list.add(tagletJar);
615+
616+
Set<Path> expectedNoJar = Collections.singleton(Paths.get(classesDir));
617+
Set<Path> expectedWithJar = new HashSet<>(Arrays.asList(Paths.get(classesDir), Paths.get(tagletJar)));
618+
619+
MavenProjectStub project = new MavenProjectStub();
620+
project.setFile(new File(getBasedir(), "pom.xml"));
621+
622+
assertEquals(expectedNoJar, JavadocUtil.prunePaths(project, list, false));
623+
assertEquals(expectedWithJar, JavadocUtil.prunePaths(project, list, true));
624+
}
625+
597626
/**
598627
* Method to test unifyPathSeparator()
599628
*

0 commit comments

Comments
 (0)