Upgrade Doxia to 2.x stack - fix 5

mojohaus · Oct 11, 2024 · 2e31b1e · 2e31b1e
1 parent 408c9a6
commit 2e31b1e
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 10 deletions.
diff --git a/src/main/java/org/codehaus/mojo/taglist/FileAnalyser.java b/src/main/java/org/codehaus/mojo/taglist/FileAnalyser.java
@@ -116,6 +116,8 @@ public class FileAnalyser {
      * @param tagClasses the array of tag classes to use for searching
      */
     public FileAnalyser(TagListReport report, List<TagClass> tagClasses) {
+        // TODO - direct class TagListReport should not be used,
+        //  we can add a separate args or new class/interface for group of args
         multipleLineCommentsOn = report.isMultipleLineComments();
         emptyCommentsOn = report.isEmptyComments();
         log = report.getLog();

diff --git a/src/main/java/org/codehaus/mojo/taglist/TagListReport.java b/src/main/java/org/codehaus/mojo/taglist/TagListReport.java
@@ -68,6 +68,7 @@ public class TagListReport extends AbstractMavenReport {
      *
      * @since 2.4
      */
+    // TODO rename to sourceFilesLocale
     @Parameter(property = "sourceFileLocale", defaultValue = "en")
     private String sourceFileLocale;
 
@@ -539,10 +540,10 @@ void setSourceFileLocale(String sourceFileLocale) {
      */
     public Locale getSourceFileLocale() {
         String[] items = sourceFileLocale.split("_");
-        if (items.length > 3) {
+        if (sourceFileLocale.isEmpty() || items.length > 3) {
             getLog().warn("Invalid java.util.Locale format '" + sourceFileLocale
-                    + "' for 'sourceFileLocale' use ROOT locale");
-            return Locale.ROOT;
+                    + "' for 'sourceFileLocale' using 'ENGLISH' locale");
+            return Locale.ENGLISH;
         }
 
         String language = "";

diff --git a/src/main/java/org/codehaus/mojo/taglist/TaglistReportRenderer.java b/src/main/java/org/codehaus/mojo/taglist/TaglistReportRenderer.java
@@ -51,9 +51,9 @@ public class TaglistReportRenderer extends AbstractMavenReportRenderer {
     private ResourceBundle bundle;
 
     /**
-     * The output path of the site.
+     * The output path of the report.
      */
-    private final File siteOutputDirectory;
+    private final File reportOutputDirectory;
 
     /**
      * A list of sorted tag reports.
@@ -74,7 +74,7 @@ public class TaglistReportRenderer extends AbstractMavenReportRenderer {
     public TaglistReportRenderer(TagListReport report, Collection<TagReport> tagReports) {
         super(report.getSink());
         this.sortedTagReports = new TreeSet<>(tagReports);
-        this.siteOutputDirectory = report.getReportOutputDirectory();
+        this.reportOutputDirectory = report.getReportOutputDirectory();
         this.showEmptyDetails = report.isShowEmptyDetails();
     }
 
@@ -208,7 +208,7 @@ private void doCommentLine(FileReport fileReport, Integer lineNumber) {
         String link = null;
         if (xrefLocation != null) {
             String fileLink = xrefLocation + "/" + fileReport.getClassNameWithSlash() + ".html";
-            File xrefFile = new File(siteOutputDirectory, fileLink.substring(2));
+            File xrefFile = new File(reportOutputDirectory, fileLink.substring(2));
 
             // Link only if file exists in xref
             if (xrefFile.exists()) {
@@ -218,7 +218,7 @@ private void doCommentLine(FileReport fileReport, Integer lineNumber) {
         // If the file was not linked to xref and there is a test xref location check it
         if (link == null && testXrefLocation != null) {
             String testFileLink = testXrefLocation + "/" + fileReport.getClassNameWithSlash() + ".html";
-            File testXrefFile = new File(siteOutputDirectory, testFileLink.substring(2));
+            File testXrefFile = new File(reportOutputDirectory, testFileLink.substring(2));
 
             // Link only if file exists in test xref
             if (testXrefFile.exists()) {

diff --git a/src/test/java/org/codehaus/mojo/taglist/TagListReportSourceFileLocaleTest.java b/src/test/java/org/codehaus/mojo/taglist/TagListReportSourceFileLocaleTest.java
@@ -17,8 +17,8 @@ static Stream<Arguments> sourceFileLocaleParserTest() {
                 of("en", new Locale("en")),
                 of("en_US", new Locale("en", "US")),
                 of("en_US_win", new Locale("en", "US", "win")),
-                of("en_US_win_XX", Locale.ROOT),
-                of("", Locale.ROOT));
+                of("en_US_win_XX", Locale.ENGLISH),
+                of("", Locale.ENGLISH));
     }
 
     @ParameterizedTest