Implement configuration for handling artifact ratings from a file

checkstyle-suppressions.xml

@@ -54,6 +54,12 @@
   <suppress checks="AbbreviationAsWordInName"
     files="GAV.java"
     lines="12"/>
+  <suppress checks="AbbreviationAsWordInName"
+    files="AbstractReporter.java"
+    lines="35"/>
+  <suppress checks="MemberName"
+    files="AbstractReporter.java"
+    lines="35"/>
   <suppress checks="LineLength"
     files="package-info.java"
     lines="142"/>

src/main/java/com/sap/oss/phosphor/fosstars/model/rating/oss/OssArtifactSecurityRating.java

@@ -6,13 +6,13 @@
 import com.sap.oss.phosphor.fosstars.model.Label;
 import com.sap.oss.phosphor.fosstars.model.Score;
 import com.sap.oss.phosphor.fosstars.model.rating.AbstractRating;
+import com.sap.oss.phosphor.fosstars.model.rating.oss.OssSecurityRating.SecurityLabel;
 import com.sap.oss.phosphor.fosstars.model.score.oss.OssArtifactSecurityScore;
 import com.sap.oss.phosphor.fosstars.model.value.ScoreValue;
 import java.util.Objects;
 
 /**
- * This is a security rating for artifacts of an open-source project.
- * The rating is based on {@link
+ * This is a security rating for artifacts of an open-source project. The rating is based on {@link
  * com.sap.oss.phosphor.fosstars.model.score.oss.OssArtifactSecurityScore}.
  */
 public class OssArtifactSecurityRating extends AbstractRating {
@@ -21,7 +21,6 @@ public class OssArtifactSecurityRating extends AbstractRating {
    * A set of labels for the rating.
    */
   public enum ArtifactSecurityLabel implements Label {
-
     BAD, MODERATE, GOOD, UNCLEAR, UNKNOWN;
   }
 
@@ -41,7 +40,7 @@ public OssArtifactSecurityRating() {
    * Initializes a new rating.
    *
    * @param score An instance of
-   *              {@link com.sap.oss.phosphor.fosstars.model.score.oss.OssArtifactSecurityScore}.
+   * {@link com.sap.oss.phosphor.fosstars.model.score.oss.OssArtifactSecurityScore}.
    * @param thresholds Thresholds for labels.
    */
   @JsonCreator
@@ -50,8 +49,7 @@ public OssArtifactSecurityRating(
       @JsonProperty("thresholds") Thresholds thresholds) {
 
     super("Security rating for artifact versions of an open-source project", score);
-    Objects.requireNonNull(thresholds, "Oh no! Thresholds is null!");
-    this.thresholds = thresholds;
+    this.thresholds = Objects.requireNonNull(thresholds, "Oh no! Thresholds is null!");
   }
 
   @Override
@@ -84,6 +82,15 @@ protected ArtifactSecurityLabel label(ScoreValue scoreValue) {
     return ArtifactSecurityLabel.GOOD;
   }
 
+  /**
+   * Return thresholds for the labels.
+   *
+   * @return The thresholds for the labels.
+   */
+  public Thresholds thresholds() {
+    return thresholds;
+  }
+
   /**
    * Holds thresholds for labels.
    */
@@ -113,8 +120,8 @@ public static class Thresholds {
      * Initialize thresholds.
      *
      * @param moderate A threshold for the moderate label.
-     * @param good A threshold for the good label.
-     * @param unclear A threshold for the unclear label.
+     * @param good     A threshold for the good label.
+     * @param unclear  A threshold for the unclear label.
      */
     @JsonCreator
     public Thresholds(
@@ -135,6 +142,32 @@ public Thresholds(
       this.good = good;
       this.unclear = unclear;
     }
-  }
 
+    /**
+     * Returns the threshold for {@link SecurityLabel#MODERATE} label.
+     *
+     * @return The threshold.
+     */
+    public double forModerate() {
+      return moderate;
+    }
+
+    /**
+     * Returns the threshold for {@link SecurityLabel#GOOD} label.
+     *
+     * @return The threshold.
+     */
+    public double forGood() {
+      return good;
+    }
+
+    /**
+     * Returns the threshold for {@link SecurityLabel#UNCLEAR} label.
+     *
+     * @return The threshold.
+     */
+    public double forUnclear() {
+      return unclear;
+    }
+  }
 }

src/main/java/com/sap/oss/phosphor/fosstars/model/rating/oss/OssSecurityRating.java

@@ -11,16 +11,15 @@
 import java.util.Objects;
 
 /**
- * This is a security rating for open-source projects
- * that is based on a security score for open-source project.
+ * This is a security rating for open-source projects that is based on a security score for
+ * open-source project.
  */
 public class OssSecurityRating extends AbstractRating {
 
   /**
    * A set of labels for the rating.
    */
   public enum SecurityLabel implements Label {
-
     BAD, MODERATE, GOOD, UNCLEAR
   }
 
@@ -39,7 +38,7 @@ public OssSecurityRating() {
   /**
    * Initializes a security rating based on a security score for open-source projects.
    *
-   * @param score The security score.
+   * @param score      The security score.
    * @param thresholds Thresholds for labels.
    */
   @JsonCreator
@@ -116,8 +115,8 @@ public static class Thresholds {
      * Initialize thresholds.
      *
      * @param moderate A threshold for the moderate label.
-     * @param good A threshold for the good label.
-     * @param unclear A threshold for the unclear label.
+     * @param good     A threshold for the good label.
+     * @param unclear  A threshold for the unclear label.
      */
     @JsonCreator
     public Thresholds(
@@ -166,5 +165,4 @@ public double forUnclear() {
       return unclear;
     }
   }
-
-}
+}

src/main/java/com/sap/oss/phosphor/fosstars/model/subject/oss/MavenArtifact.java

@@ -10,6 +10,7 @@
 import java.util.Objects;
 import java.util.Optional;
 import javax.annotation.Nullable;
+import org.apache.commons.lang3.StringUtils;
 
 /**
  * Maven artifact.
@@ -40,10 +41,10 @@ public class MavenArtifact extends AbstractSubject implements Artifact {
   /**
    * Initializes a Maven artifact.
    *
-   * @param group A group id of the artifact.
+   * @param group    A group id of the artifact.
    * @param artifact An artifact id of the artifact.
-   * @param version The version of the artifact. It may be null.
-   * @param project A {@link GitHubProject}. It may be null.
+   * @param version  The version of the artifact. It may be null.
+   * @param project  A {@link GitHubProject}. It may be null.
    */
   @JsonCreator
   public MavenArtifact(
@@ -88,6 +89,16 @@ public Optional<String> version() {
     return Optional.ofNullable(version);
   }
 
+  /**
+   * Return the artifact in GAV format.
+   *
+   * @return GAV format of the artifact.
+   */
+  public String gav() {
+    String versionPrint = StringUtils.isEmpty(version) ? "" : String.format(":%s", version);
+    return String.format("%s:%s%s", group, artifact, versionPrint);
+  }
+
   @Override
   public boolean equals(Object o) {
     if (this == o) {
@@ -121,4 +132,10 @@ public String purl() {
 
     return format("pkg:maven/%s/%s@%s", group, artifact, version);
   }
+
+  @Override
+  public String toString() {
+    String scmPrint = project == null ? "" : String.format(" -> %s", project);
+    return String.format("%s%s", gav(), scmPrint);
+  }
 }