Merge pull request #391 from uhafner/move-icon

Add icon parameter for tools.
uhafner · Nov 3, 2024 · 91105da · 91105da
2 parents 1e83231 + 0d04536
commit 91105da
Show file tree

Hide file tree

Showing 25 changed files with 301 additions and 199 deletions.
diff --git a/src/main/java/edu/hm/hafner/grading/AggregatedScore.java b/src/main/java/edu/hm/hafner/grading/AggregatedScore.java
@@ -426,6 +426,7 @@ public void gradeAnalysis(final AnalysisReportFactory factory) {
                         .withConfiguration(analysisConfiguration)
                         .withName(StringUtils.defaultIfBlank(tool.getName(), report.getName()))
                         .withId(tool.getId())
+                        .withIcon(tool.getIcon())
                         .withReport(report)
                         .build();
                 scores.add(score);
@@ -461,6 +462,7 @@ public void gradeCoverage(final CoverageReportFactory factory) {
                         .withConfiguration(coverageConfiguration)
                         .withName(StringUtils.defaultIfBlank(tool.getName(), report.getName()))
                         .withId(tool.getId())
+                        .withIcon(tool.getIcon())
                         .withReport(report, Metric.fromTag(tool.getMetric()))
                         .build();
                 scores.add(score);
@@ -495,6 +497,7 @@ public void gradeTests(final CoverageReportFactory factory) {
                 var score = new TestScoreBuilder()
                         .withConfiguration(testConfiguration)
                         .withId(tool.getId())
+                        .withIcon(tool.getIcon())
                         .withName(StringUtils.defaultIfBlank(tool.getName(), report.getName()))
                         .withReport(report)
                         .build();
@@ -530,6 +533,7 @@ public void gradeMetrics(final CoverageReportFactory factory) {
                 var score = new MetricScoreBuilder()
                         .withConfiguration(metricConfiguration)
                         .withId(tool.getId())
+                        .withIcon(tool.getIcon())
                         .withName(StringUtils.defaultIfBlank(tool.getName(), report.getName()))
                         .withReport(report, Metric.fromName(tool.getMetric()))
                         .build();

diff --git a/src/main/java/edu/hm/hafner/grading/AnalysisMarkdown.java b/src/main/java/edu/hm/hafner/grading/AnalysisMarkdown.java
@@ -88,24 +88,14 @@ private int sum(final AnalysisScore score, final Function<AnalysisScore, Integer
     }
 
     @Override
-    protected List<String> createSummary(final AnalysisScore score) {
-        return score.getSubScores().stream()
-                .map(s -> SPACE + SPACE + getIconAndName(s) + ": " + s.createSummary()).toList();
-    }
-
-    private String getIconAndName(final AnalysisScore analysisScore) {
-        return format(" %s &nbsp; %s", extractParserIcon(analysisScore), analysisScore.getName())
-                + createScoreTitle(analysisScore);
-    }
-
-    private String extractParserIcon(final AnalysisScore analysisScore) {
-        var descriptor = REGISTRY.get(analysisScore.getId());
-        if (descriptor.getIconUrl().isEmpty()) {
-            return getIcon(analysisScore);
-        }
-        else {
-            return format("<img src=\"%s\" alt=\"%s\" height=\"%d\" width=\"%d\">",
-                    descriptor.getIconUrl(), analysisScore.getName(), ICON_SIZE, ICON_SIZE);
+    protected String getToolIcon(final AnalysisScore score) {
+        if (REGISTRY.contains(score.getId())) {
+            var descriptor = REGISTRY.get(score.getId());
+            if (!descriptor.getIconUrl().isBlank()) {
+                return format("<img src=\"%s\" alt=\"%s\" height=\"%d\" width=\"%d\">",
+                        descriptor.getIconUrl(), score.getName(), ICON_SIZE, ICON_SIZE);
+            }
         }
+        return getDefaultIcon(score);
     }
 }
diff --git a/src/main/java/edu/hm/hafner/grading/AnalysisScore.java b/src/main/java/edu/hm/hafner/grading/AnalysisScore.java
@@ -43,9 +43,9 @@ public final class AnalysisScore extends Score<AnalysisScore, AnalysisConfigurat
 
     private transient Report report; // do not persist the issues
 
-    private AnalysisScore(final String id, final String name, final AnalysisConfiguration configuration,
+    private AnalysisScore(final String id, final String name, final String icon, final AnalysisConfiguration configuration,
             final List<AnalysisScore> scores) {
-        super(id, name, configuration, scores.toArray(new AnalysisScore[0]));
+        super(id, name, icon, configuration, scores.toArray(new AnalysisScore[0]));
 
         this.errorSize = scores.stream().reduce(0, (sum, score) -> sum + score.getErrorSize(), Integer::sum);
         this.highSeveritySize = scores.stream().reduce(0, (sum, score) -> sum + score.getHighSeveritySize(), Integer::sum);
@@ -57,9 +57,9 @@ private AnalysisScore(final String id, final String name, final AnalysisConfigur
         scores.stream().map(AnalysisScore::getReport).forEach(report::addAll);
     }
 
-    private AnalysisScore(final String id, final String name, final AnalysisConfiguration configuration,
+    private AnalysisScore(final String id, final String name, final String icon, final AnalysisConfiguration configuration,
             final Report report) {
-        super(id, name, configuration);
+        super(id, name, icon, configuration);
 
         this.errorSize = report.getSizeOf(ERROR);
         this.highSeveritySize = report.getSizeOf(WARNING_HIGH);
@@ -226,6 +226,7 @@ public static class AnalysisScoreBuilder {
         private String id;
         @CheckForNull
         private String name;
+        private String icon = StringUtils.EMPTY;
         @CheckForNull
         private AnalysisConfiguration configuration;
 
@@ -269,6 +270,24 @@ private String getName() {
             return StringUtils.defaultIfBlank(name, getConfiguration().getName());
         }
 
+        /**
+         * Sets the icon of the analysis score.
+         *
+         * @param icon
+         *         the icon to show
+         *
+         * @return this
+         */
+        @CanIgnoreReturnValue
+        public AnalysisScoreBuilder withIcon(final String icon) {
+            this.icon = icon;
+            return this;
+        }
+
+        private String getIcon() {
+            return StringUtils.defaultString(icon);
+        }
+
         /**
          * Sets the grading configuration.
          *
@@ -328,9 +347,9 @@ public AnalysisScore build() {
                     "You must either specify an analysis report or provide a list of sub-scores.");
 
             if (report == null) {
-                return new AnalysisScore(getId(), getName(), getConfiguration(), scores);
+                return new AnalysisScore(getId(), getName(), getIcon(), getConfiguration(), scores);
             }
-            return new AnalysisScore(getId(), getName(), getConfiguration(), Objects.requireNonNull(report));
+            return new AnalysisScore(getId(), getName(), getIcon(), getConfiguration(), Objects.requireNonNull(report));
         }
     }
 }
diff --git a/src/main/java/edu/hm/hafner/grading/CodeCoverageMarkdown.java b/src/main/java/edu/hm/hafner/grading/CodeCoverageMarkdown.java
@@ -22,9 +22,4 @@ public CodeCoverageMarkdown() {
     protected List<CoverageScore> createScores(final AggregatedScore aggregation) {
         return aggregation.getCodeCoverageScores();
     }
-
-    @Override
-    protected String getIcon(final CoverageScore score) {
-        return ":%s:".formatted(score.getIcon());
-    }
 }
diff --git a/src/main/java/edu/hm/hafner/grading/CoverageMarkdown.java b/src/main/java/edu/hm/hafner/grading/CoverageMarkdown.java
@@ -74,8 +74,14 @@ private String getImageForScoreOrCoverage(final CoverageScore score) {
     }
 
     @Override
-    protected List<String> createSummary(final CoverageScore score) {
-        return score.getSubScores().stream()
-                .map(s -> SPACE + SPACE + getTitle(s, 0) + ": " + s.createSummary()).toList();
+    protected String getToolIcon(final CoverageScore score) {
+        return switch (score.getMetric()) {
+            case BRANCH -> emoji("curly_loop");
+            case LINE -> emoji("wavy_dash");
+            case CYCLOMATIC_COMPLEXITY -> emoji("part_alternation_mark");
+            case LOC -> emoji("pencil2");
+            case TEST_STRENGTH ->  emoji("muscle");
+            default -> getDefaultIcon(score);
+        };
     }
 }
diff --git a/src/main/java/edu/hm/hafner/grading/CoverageScore.java b/src/main/java/edu/hm/hafner/grading/CoverageScore.java
@@ -35,13 +35,12 @@ public final class CoverageScore extends Score<CoverageScore, CoverageConfigurat
 
     private final int coveredPercentage;
     private final Metric metric;
-    private final String icon;
     private final int missedItems;
     private transient Node report; // do not persist the coverage tree
 
-    private CoverageScore(final String id, final String name, final CoverageConfiguration configuration,
+    private CoverageScore(final String id, final String name, final String icon, final CoverageConfiguration configuration,
             final List<CoverageScore> scores) {
-        super(id, name, configuration, scores.toArray(new CoverageScore[0]));
+        super(id, name, icon, configuration, scores.toArray(new CoverageScore[0]));
 
         this.coveredPercentage = scores.stream()
                 .reduce(0, (sum, score) -> sum + score.getCoveredPercentage(), Integer::sum)
@@ -58,19 +57,17 @@ private CoverageScore(final String id, final String name, final CoverageConfigur
         else {
             this.metric = metrics.iterator().next();
         }
-        this.icon = selectIcon();
 
         this.report = new ContainerNode(name);
         scores.stream().map(CoverageScore::getReport).forEach(report::addChild);
     }
 
-    private CoverageScore(final String id, final String name, final CoverageConfiguration configuration,
+    private CoverageScore(final String id, final String name, final String icon, final CoverageConfiguration configuration,
             final Node report, final Metric metric) {
-        super(id, name, configuration);
+        super(id, name, icon, configuration);
 
         this.report = report;
         this.metric = metric;
-        this.icon = selectIcon();
 
         var value = report.getValue(metric);
         if (value.isPresent() && value.get() instanceof Coverage) {
@@ -87,33 +84,6 @@ public int getMissedItems() {
         return missedItems;
     }
 
-    public String getIcon() {
-        return icon;
-    }
-
-    private String selectIcon() {
-        switch (metric) {
-            case BRANCH -> {
-                return "curly_loop";
-            }
-            case LINE -> {
-                return "wavy_dash";
-            }
-            case CYCLOMATIC_COMPLEXITY -> {
-                return "part_alternation_mark";
-            }
-            case LOC -> {
-                return "pencil2";
-            }
-            case TEST_STRENGTH ->  {
-                return "muscle";
-            }
-            default -> {
-                return "footprints";
-            }
-        }
-    }
-
     /**
      * Restore an empty report after de-serialization.
      *
@@ -166,32 +136,16 @@ protected String createSummary() {
     }
 
     private String getItemName() {
-        switch (metric) {
-            case MUTATION -> {
-                return "survived mutations";
-            }
-            case TEST_STRENGTH -> {
-                return "survived mutations in tested code";
-            }
-            case BRANCH -> {
-                return "missed branches";
-            }
-            case LINE -> {
-                return "missed lines";
-            }
-            case CYCLOMATIC_COMPLEXITY -> {
-                return "complexity";
-            }
-            case LOC -> {
-                return "lines of code";
-            }
-            case CONTAINER -> {
-                return "missed items";
-            }
-            default -> {
-                return "items";
-            }
-        }
+        return switch (metric) {
+            case MUTATION -> "survived mutations";
+            case TEST_STRENGTH -> "survived mutations in tested code";
+            case BRANCH -> "missed branches";
+            case LINE -> "missed lines";
+            case CYCLOMATIC_COMPLEXITY -> "complexity";
+            case LOC -> "lines of code";
+            case CONTAINER -> "missed items";
+            default -> "items";
+        };
     }
 
     @Override
@@ -225,6 +179,7 @@ public static class CoverageScoreBuilder {
         private String id;
         @CheckForNull
         private String name;
+        private String icon = StringUtils.EMPTY;
         @CheckForNull
         private CoverageConfiguration configuration;
 
@@ -270,6 +225,24 @@ private String getName() {
             return StringUtils.defaultIfBlank(name, getConfiguration().getName());
         }
 
+        /**
+         * Sets the icon of the coverage score.
+         *
+         * @param icon
+         *         the icon to show
+         *
+         * @return this
+         */
+        @CanIgnoreReturnValue
+        public CoverageScoreBuilder withIcon(final String icon) {
+            this.icon = icon;
+            return this;
+        }
+
+        private String getIcon() {
+            return StringUtils.defaultString(icon);
+        }
+
         /**
          * Sets the grading configuration.
          *
@@ -334,12 +307,12 @@ public CoverageScore build() {
                     "You must either specify a coverage report or provide a list of sub-scores.");
 
             if (scores.isEmpty() && report != null && metric != null) {
-                return new CoverageScore(getId(), getName(), getConfiguration(),
+                return new CoverageScore(getId(), getName(), getIcon(), getConfiguration(),
                         Objects.requireNonNull(report),
                         Objects.requireNonNull(metric));
             }
             else {
-                return new CoverageScore(getId(), getName(), getConfiguration(), scores);
+                return new CoverageScore(getId(), getName(), getIcon(), getConfiguration(), scores);
             }
         }
     }

diff --git a/src/main/java/edu/hm/hafner/grading/FileSystemMetricReportFactory.java b/src/main/java/edu/hm/hafner/grading/FileSystemMetricReportFactory.java
@@ -1,7 +1,5 @@
 package edu.hm.hafner.grading;
 
-import org.apache.commons.lang3.StringUtils;
-
 import edu.hm.hafner.coverage.Metric;
 import edu.hm.hafner.coverage.Node;
 import edu.hm.hafner.coverage.Value;
@@ -16,10 +14,8 @@
 public final class FileSystemMetricReportFactory implements CoverageReportFactory {
     @Override
     public Node create(final ToolConfiguration tool, final FilteredLog log) {
-        var name = StringUtils.defaultIfBlank(tool.getName(), "Software Metrics");
-
         var delegate = new FileSystemCoverageReportFactory();
-        var report = delegate.create(new ToolConfiguration("metrics", name, tool.getPattern(), "", "Metric"), log);
+        var report = delegate.create(tool, log);
 
         var metricName = delegate.extractMetric(tool, report);
         var metric = Metric.fromTag(metricName);

diff --git a/src/main/java/edu/hm/hafner/grading/FileSystemTestReportFactory.java b/src/main/java/edu/hm/hafner/grading/FileSystemTestReportFactory.java
@@ -19,7 +19,8 @@ public Node create(final ToolConfiguration tool, final FilteredLog log) {
         var name = StringUtils.defaultIfBlank(tool.getName(), "Tests");
 
         var delegate = new FileSystemCoverageReportFactory();
-        var report = delegate.create(new ToolConfiguration("junit", name, tool.getPattern(), "", Metric.TESTS.name()), log);
+        var report = delegate.create(new ToolConfiguration("junit", name, tool.getPattern(),
+                tool.getSourcePath(), Metric.TESTS.name(), tool.getIcon()), log);
 
         log.logInfo("-> %s Total: %s tests",
                 name, report.getValue(Metric.TESTS).orElse(Value.nullObject(Metric.TESTS)));

diff --git a/src/main/java/edu/hm/hafner/grading/MetricMarkdown.java b/src/main/java/edu/hm/hafner/grading/MetricMarkdown.java
@@ -51,19 +51,13 @@ protected void createSpecificDetails(final AggregatedScore aggregation, final Li
     }
 
     @Override
-    protected List<String> createSummary(final MetricScore score) {
-        return score.getSubScores().stream()
-                .map(s -> SPACE + SPACE + getTitle(s, 0) + ": " + s.createSummary()).toList();
-    }
-
-    @Override
-    protected String getIcon(final MetricScore score) {
+    protected String getToolIcon(final MetricScore score) {
         return switch (score.getMetric()) {
             case CYCLOMATIC_COMPLEXITY -> ":cyclone:";
             case NCSS -> ":memo:";
-            case COGNITIVE_COMPLEXITY -> ":bulb:";
+            case COGNITIVE_COMPLEXITY -> ":brain:";
             case NPATH_COMPLEXITY -> ":loop:";
-            default -> super.getIcon(score);
+            default -> getDefaultIcon(score);
         };
     }
 }