Coverage dashboard column

plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageBuildAction.java

@@ -27,6 +27,7 @@
 import hudson.model.Run;
 import hudson.util.XStream2;
 
+import io.jenkins.plugins.coverage.model.util.FractionFormatter;
 import io.jenkins.plugins.forensics.reference.ReferenceBuild;
 import io.jenkins.plugins.util.AbstractXmlStream;
 import io.jenkins.plugins.util.BuildAction;
@@ -121,6 +122,30 @@ public Coverage getBranchCoverage() {
         return branchCoverage;
     }
 
+    /**
+     * Returns whether the {@link Coverage} for the passed metric exists.
+     *
+     * @param coverageMetric
+     *         the metric to check
+     *
+     * @return {@code true} if a coverage is available for the specified metric
+     */
+    public boolean hasCoverage(final CoverageMetric coverageMetric) {
+        return getResult().getCoverage(coverageMetric).isSet();
+    }
+
+    /**
+     * Gets the {@link Coverage} for the passed metric.
+     *
+     * @param coverageMetric
+     *         The coverage metric
+     *
+     * @return the coverage
+     */
+    public Coverage getCoverage(final CoverageMetric coverageMetric) {
+        return getResult().getCoverage(coverageMetric);
+    }
+
     /**
      * Returns the possible reference build that has been used to compute the coverage delta.
      *
@@ -179,7 +204,7 @@ public boolean hasDelta(final CoverageMetric metric) {
     public String formatDelta(final CoverageMetric metric) {
         Locale clientLocale = Functions.getCurrentLocale();
         if (hasDelta(metric)) {
-            return String.format(clientLocale, "%+.3f", difference.get(metric).doubleValue());
+            return FractionFormatter.formatDeltaFraction(difference.get(metric), clientLocale);
         }
         return Messages.Coverage_Not_Available();
     }

plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageMetric.java

@@ -1,6 +1,8 @@
 package io.jenkins.plugins.coverage.model;
 
 import java.io.Serializable;
+import java.util.Arrays;
+import java.util.List;
 import java.util.Locale;
 
 import org.apache.commons.lang3.StringUtils;
@@ -79,6 +81,15 @@ public static CoverageMetric valueOf(final String name) {
         return new CoverageMetric(name, DEFAULT_ORDER);
     }
 
+    /**
+     * Provides all available values of {@link CoverageMetric}.
+     *
+     * @return the available metrics
+     */
+    public static List<CoverageMetric> getAvailableCoverageMetrics() {
+        return Arrays.asList(LINE, BRANCH, INSTRUCTION, METHOD, CLASS, FILE, PACKAGE, MODULE);
+    }
+
     /**
      * Checks if this instance has a name that is equal to the specified name (ignoring case).
      *

plugin/src/main/java/io/jenkins/plugins/coverage/model/CoverageViewModel.java

@@ -26,6 +26,8 @@
 import hudson.model.ModelObject;
 import hudson.model.Run;
 
+import io.jenkins.plugins.coverage.model.visualization.colorization.ColorProvider;
+import io.jenkins.plugins.coverage.model.visualization.colorization.ColorProviderFactory;
 import io.jenkins.plugins.datatables.DefaultAsyncTableContentProvider;
 import io.jenkins.plugins.datatables.TableColumn;
 import io.jenkins.plugins.datatables.TableColumn.ColumnCss;
@@ -45,7 +47,8 @@ public class CoverageViewModel extends DefaultAsyncTableContentProvider implemen
     private static final CoverageMetric LINE_COVERAGE = CoverageMetric.LINE;
     private static final CoverageMetric BRANCH_COVERAGE = CoverageMetric.BRANCH;
     private static final JacksonFacade JACKSON_FACADE = new JacksonFacade();
-    private static final TreeMapNodeConverter TREE_MAP_NODE_CONVERTER = new TreeMapNodeConverter();
+    private static final ColorProvider COLOR_PROVIDER = ColorProviderFactory.createColorProvider();
+    private static final TreeMapNodeConverter TREE_MAP_NODE_CONVERTER = new TreeMapNodeConverter(COLOR_PROVIDER);
     private static final BuildResultNavigator NAVIGATOR = new BuildResultNavigator();
 
     private final Run<?, ?> owner;

plugin/src/main/java/io/jenkins/plugins/coverage/model/TreeMapNodeConverter.java

@@ -2,13 +2,24 @@
 
 import edu.hm.hafner.echarts.TreeMapNode;
 
+import io.jenkins.plugins.coverage.model.util.FractionFormatter;
+import io.jenkins.plugins.coverage.model.visualization.colorization.ColorProvider;
+import io.jenkins.plugins.coverage.model.visualization.colorization.CoverageLevel;
+
 /**
- * Converts a tree of {@link CoverageNode coverage nodes} to a corresponding tree of {@link TreeMapNode ECharts tree
- * map nodes}.
+ * Converts a tree of {@link CoverageNode coverage nodes} to a corresponding tree of {@link TreeMapNode ECharts tree map
+ * nodes}.
  *
  * @author Ullrich Hafner
  */
 class TreeMapNodeConverter {
+
+    private final ColorProvider colorProvider;
+
+    TreeMapNodeConverter(final ColorProvider colorProvider) {
+        this.colorProvider = colorProvider;
+    }
+
     TreeMapNode toTeeChartModel(final CoverageNode node) {
         TreeMapNode root = toTreeMapNode(node);
         for (TreeMapNode child : root.getChildren()) {
@@ -21,9 +32,15 @@ TreeMapNode toTeeChartModel(final CoverageNode node) {
     private TreeMapNode toTreeMapNode(final CoverageNode node) {
         Coverage coverage = node.getCoverage(CoverageMetric.LINE);
 
-        TreeMapNode treeNode = new TreeMapNode(node.getName(),
-                assignColor(coverage.getRoundedPercentage()),
-                coverage.getTotal(), coverage.getCovered());
+        double coveragePercentage = FractionFormatter
+                .transformFractionToPercentage(coverage.getCoveredPercentage())
+                .doubleValue();
+
+        String color = CoverageLevel
+                .getDisplayColorsOfCoverageLevel(coveragePercentage, colorProvider)
+                .getFillColorAsHex();
+
+        TreeMapNode treeNode = new TreeMapNode(node.getName(), color, coverage.getTotal(), coverage.getCovered());
         if (node.getMetric().equals(CoverageMetric.FILE)) {
             return treeNode;
         }
@@ -33,17 +50,4 @@ private TreeMapNode toTreeMapNode(final CoverageNode node) {
                 .forEach(treeNode::insertNode);
         return treeNode;
     }
-
-    private String assignColor(final double percentage) {
-        String[] colors = {"#ef9a9a", "#f6bca0", "#fbdea6", "#e2f1aa", "#c4e4a9", "#a5d6a7"};
-        double[] levels = {75, 50, 85, 90, 95};
-
-        for (int index = 0; index < levels.length; index++) {
-            if (percentage < levels[index]) {
-                return colors[index];
-            }
-        }
-        return colors[levels.length - 1];
-    }
-
 }

plugin/src/main/java/io/jenkins/plugins/coverage/model/util/FractionFormatter.java

@@ -0,0 +1,76 @@
+package io.jenkins.plugins.coverage.model.util;
+
+import java.util.Locale;
+
+import org.apache.commons.lang3.math.Fraction;
+
+/**
+ * Formats fraction and percentage values represented by {@link Fraction} and provides these values as formatted
+ * percentages dependent on the use case.
+ *
+ * @author Florian Orendi
+ */
+public class FractionFormatter {
+
+    private static final Fraction HUNDRED = Fraction.getFraction(100, 1);
+
+    private FractionFormatter() {
+        // prevents instantiation
+    }
+
+    /**
+     * Transforms a fraction within the range [0;1] to a percentage value within the range [0;100].
+     *
+     * @param fraction
+     *         The fraction to be transformed
+     *
+     * @return the fraction as percentage
+     */
+    public static Fraction transformFractionToPercentage(final Fraction fraction) {
+        return fraction.multiplyBy(HUNDRED);
+    }
+
+    /**
+     * Formats a percentage to plain text and rounds the value to two decimals.
+     *
+     * @param percentage
+     *         The percentage to be formatted
+     * @param locale
+     *         The used locale
+     *
+     * @return the formatted percentage as plain text
+     */
+    public static String formatPercentage(final Fraction percentage, final Locale locale) {
+        return String.format(locale, "%.2f%%", percentage.doubleValue());
+    }
+
+    /**
+     * Formats a delta fraction to its plain text percentage representation with a leading sign and rounds the value to
+     * two decimals.
+     *
+     * @param fraction
+     *         The fraction to be formatted
+     * @param locale
+     *         The used locale
+     *
+     * @return the formatted delta fraction as plain text with a leading sign
+     */
+    public static String formatDeltaFraction(final Fraction fraction, final Locale locale) {
+        return String.format(locale, "%+.2f%%", transformFractionToPercentage(fraction).doubleValue());
+    }
+
+    /**
+     * Formats a delta percentage to its plain text representation with a leading sign and rounds the value to two
+     * decimals.
+     *
+     * @param percentage
+     *         The percentage to be formatted
+     * @param locale
+     *         The used locale
+     *
+     * @return the formatted delta percentage as plain text with a leading sign
+     */
+    public static String formatDeltaPercentage(final Fraction percentage, final Locale locale) {
+        return String.format(locale, "%+.2f%%", percentage.doubleValue());
+    }
+}

plugin/src/main/java/io/jenkins/plugins/coverage/model/visualization/colorization/ColorId.java

@@ -0,0 +1,23 @@
+package io.jenkins.plugins.coverage.model.visualization.colorization;
+
+/**
+ * Provides IDs for colors which are used within this plugin in order to separate the color palette from the logic.
+ *
+ * @author Florian Orendi
+ */
+public enum ColorId {
+    INSUFFICIENT,
+    VERY_BAD,
+    BAD,
+    INADEQUATE,
+    BELOW_AVERAGE,
+    AVERAGE,
+    ABOVE_AVERAGE,
+    GOOD,
+    VERY_GOOD,
+    EXCELLENT,
+    OUTSTANDING,
+
+    BLACK,
+    WHITE
+}