Add Json Report

This adds the ability to generate a json version of the report using
:jsonreport

Author: chriswininger

refactor-first-maven-plugin/pom.xml

@@ -31,6 +31,12 @@
             <version>3.6.1</version>
             <scope>provided</scope>
         </dependency>
+
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>2.13.2.2</version>
+        </dependency>
     </dependencies>
 
     <build>

refactor-first-maven-plugin/src/main/java/org/hjug/mavenreport/RefactorFirstJsonReport/JsonReport.java

@@ -0,0 +1,14 @@
+package org.hjug.mavenreport.RefactorFirstJsonReport;
+
+import java.util.List;
+
+import lombok.Builder;
+import lombok.Data;
+
+@Data
+@Builder
+class JsonReport
+{
+  private List<JsonReportDisharmonyEntry> rankedDisharmonies;
+  private List<String> errors;
+}

refactor-first-maven-plugin/src/main/java/org/hjug/mavenreport/RefactorFirstJsonReport/JsonReportDisharmonyEntry.java

@@ -0,0 +1,40 @@
+package org.hjug.mavenreport.RefactorFirstJsonReport;
+
+import java.time.ZoneId;
+import java.time.format.DateTimeFormatter;
+import java.time.format.FormatStyle;
+import java.util.Locale;
+
+import lombok.Builder;
+import lombok.Data;
+import org.hjug.cbc.RankedDisharmony;
+
+@Data
+@Builder
+class JsonReportDisharmonyEntry
+{
+  private static final DateTimeFormatter formatter =
+      DateTimeFormatter.ofLocalizedDateTime( FormatStyle.SHORT )
+          .withLocale( Locale.getDefault() )
+          .withZone( ZoneId.systemDefault() );
+
+  private final String className;
+  private final Integer effortRank;
+  private final Integer changePronenessRank;
+  private final Integer priority;
+  private final Integer weightedMethodCount;
+  private final Integer commitCount;
+  private final String mostRecentCommitTime;
+
+  public static JsonReportDisharmonyEntry fromRankedDisharmony(RankedDisharmony entry) {
+    return JsonReportDisharmonyEntry.builder()
+      .className(entry.getClassName())
+      .effortRank(entry.getEffortRank())
+      .changePronenessRank(entry.getChangePronenessRank())
+      .priority(entry.getPriority())
+      .weightedMethodCount(entry.getWmc())
+      .commitCount(entry.getCommitCount())
+      .mostRecentCommitTime(formatter.format(entry.getMostRecentCommitTime()))
+      .build();
+  }
+}

refactor-first-maven-plugin/src/main/java/org/hjug/mavenreport/RefactorFirstJsonReport/RefactorFirstMavenJsonReport.java

@@ -0,0 +1,78 @@
+package org.hjug.mavenreport.RefactorFirstJsonReport;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.maven.plugin.AbstractMojo;
+import org.apache.maven.plugins.annotations.LifecyclePhase;
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.plugins.annotations.Parameter;
+import org.apache.maven.plugins.annotations.ResolutionScope;
+import org.apache.maven.project.MavenProject;
+import org.hjug.cbc.CostBenefitCalculator;
+import org.hjug.cbc.RankedDisharmony;
+
+import static org.hjug.mavenreport.ReportWriter.writeReportToDisk;
+
+@Slf4j
+@Mojo(
+    name = "jsonreport",
+    defaultPhase = LifecyclePhase.SITE,
+    requiresDependencyResolution = ResolutionScope.RUNTIME,
+    requiresProject = true,
+    threadSafe = true,
+    inheritByDefault = false
+)
+public class RefactorFirstMavenJsonReport extends AbstractMojo {
+  private static final String FILE_NAME = "refactor-first-data.json";
+
+  private static final ObjectMapper MAPPER = new ObjectMapper();
+
+  @Parameter(readonly = true, defaultValue = "${project}")
+  private MavenProject project;
+
+  @Override
+  public void execute() {
+    final String projectBaseDir = project.getBasedir().getPath();
+
+    final CostBenefitCalculator costBenefitCalculator = new CostBenefitCalculator();
+    final List<RankedDisharmony> rankedDisharmonies = costBenefitCalculator.calculateCostBenefitValues(projectBaseDir);
+    final List<JsonReportDisharmonyEntry> disharmonyEntries = rankedDisharmonies.stream()
+        .map(JsonReportDisharmonyEntry::fromRankedDisharmony)
+        .collect(Collectors.toList());
+
+    final JsonReport report = JsonReport
+        .builder()
+        .rankedDisharmonies(disharmonyEntries)
+        .build();
+
+    try {
+      final String reportJson = MAPPER.writeValueAsString(report);
+
+      writeReportToDisk(project, FILE_NAME, new StringBuilder(reportJson));
+    } catch (final JsonProcessingException jsonProcessingException) {
+      final String errorMessage = "Could not generate a json report: " + jsonProcessingException;
+
+      log.error(errorMessage);
+      final JsonReport errorReport = JsonReport.builder()
+          .errors(new ArrayList<>(Collections.singletonList(errorMessage)))
+          .build();
+
+      writeErrorReport(errorReport);
+    }
+  }
+
+  private void writeErrorReport(final JsonReport errorReport) {
+    try {
+      writeReportToDisk(project, FILE_NAME, new StringBuilder(MAPPER.writeValueAsString(errorReport)));
+    } catch (final JsonProcessingException jsonProcessingException) {
+      log.error("failed to write error report: ", jsonProcessingException);
+    }
+
+  }
+}

refactor-first-maven-plugin/src/main/java/org/hjug/mavenreport/RefactorFirstMavenCsvReport.java

@@ -24,6 +24,8 @@
 import java.util.Locale;
 import java.util.Optional;
 
+import static org.hjug.mavenreport.ReportWriter.writeReportToDisk;
+
 @Slf4j
 @Mojo(
         name = "csvreport",
@@ -100,7 +102,7 @@ public void execute() {
                     .append(projectName).append(" ")
                     .append(projectVersion).append(". ");
             contentBuilder.append("Please initialize a Git repository and perform an initial commit.");
-            writeReportToDisk(filename, contentBuilder);
+            writeReportToDisk(project, filename, contentBuilder);
             return;
         }
 
@@ -129,7 +131,7 @@ public void execute() {
                     .append(projectVersion).append(" has no God classes!");
             log.info("Done! No God classes found!");
 
-            writeReportToDisk(filename, contentBuilder);
+            writeReportToDisk(project, filename, contentBuilder);
             return;
         }
 
@@ -149,7 +151,7 @@ public void execute() {
 
         log.info(contentBuilder.toString());
 
-        writeReportToDisk(filename, contentBuilder);
+        writeReportToDisk(project, filename, contentBuilder);
     }
 
     private DateTimeFormatter createFileDateTimeFormatter() {
@@ -230,28 +232,4 @@ private void addsRow(StringBuilder contentBuilder, String[] rankedDisharmonyData
             contentBuilder.append(rowData).append(",");
         }
     }
-
-    private void writeReportToDisk(String filename, StringBuilder stringBuilder) {
-        String reportOutputDirectory = project.getModel().getReporting().getOutputDirectory();
-        File reportOutputDir = new File(reportOutputDirectory);
-        if(!reportOutputDir.exists()) {
-            reportOutputDir.mkdirs();
-        }
-        String pathname = reportOutputDirectory + File.separator + filename;
-
-        File reportFile = new File(pathname);
-        try {
-            reportFile.createNewFile();
-        } catch (IOException e) {
-            log.error("Failure creating chart script file", e);
-        }
-
-        try(BufferedWriter writer = new BufferedWriter(new FileWriter(reportFile))) {
-            writer.write(stringBuilder.toString());
-        } catch (IOException e) {
-            log.error("Error writing chart script file", e);
-        }
-
-        log.info("Done! View the report at target/site/{}", filename);
-    }
 }

refactor-first-maven-plugin/src/main/java/org/hjug/mavenreport/RefactorFirstMavenReport.java

@@ -25,6 +25,8 @@
 import java.util.Locale;
 import java.util.Optional;
 
+import static org.hjug.mavenreport.ReportWriter.writeReportToDisk;
+
 @Slf4j
 @Mojo(
         name = "report",
@@ -206,7 +208,7 @@ public void execute() {
             stringBuilder.append("No Git repository found in project ").append(projectName).append(" ").append(projectVersion).append(".  ");
             stringBuilder.append("Please initialize a Git repository and perform an initial commit.");
             stringBuilder.append(THE_END);
-            writeReportToDisk(filename, stringBuilder);
+            writeReportToDisk(project, filename, stringBuilder);
             return;
         }
 
@@ -234,7 +236,7 @@ public void execute() {
                     .append(projectVersion).append(" has no God classes!");
             log.info("Done! No God classes found!");
             stringBuilder.append(THE_END);
-            writeReportToDisk(filename, stringBuilder);
+            writeReportToDisk(project, filename, stringBuilder);
             return;
         }
 
@@ -299,31 +301,7 @@ public void execute() {
 
         log.info(stringBuilder.toString());
 
-        writeReportToDisk(filename, stringBuilder);
-    }
-
-    private void writeReportToDisk(String filename, StringBuilder stringBuilder) {
-        String reportOutputDirectory = project.getModel().getReporting().getOutputDirectory();
-        File reportOutputDir = new File(reportOutputDirectory);
-        if(!reportOutputDir.exists()) {
-            reportOutputDir.mkdirs();
-        }
-        String pathname = reportOutputDirectory + File.separator + "refactor-first-report.html";
-
-        File reportFile = new File(pathname);
-        try {
-            reportFile.createNewFile();
-        } catch (IOException e) {
-            log.error("Failure creating chart script file", e);
-        }
-
-        try(BufferedWriter writer = new BufferedWriter(new FileWriter(reportFile))) {
-            writer.write(stringBuilder.toString());
-        } catch (IOException e) {
-            log.error("Error writing chart script file", e);
-        }
-
-        log.info("Done! View the report at target/site/{}", filename);
+        writeReportToDisk(project, filename, stringBuilder);
     }
 
     //TODO: Move to another class to allow use by Gradle plugin

refactor-first-maven-plugin/src/main/java/org/hjug/mavenreport/ReportWriter.java

@@ -0,0 +1,44 @@
+package org.hjug.mavenreport;
+
+import java.io.BufferedWriter;
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+
+import lombok.extern.slf4j.Slf4j;
+import org.apache.maven.project.MavenProject;
+
+@Slf4j
+public class ReportWriter
+{
+  public static void writeReportToDisk(
+      final MavenProject project,
+      final String filename,
+      final StringBuilder stringBuilder
+  ) {
+    final String reportOutputDirectory = project.getModel().getReporting().getOutputDirectory();
+    final File reportOutputDir = new File(reportOutputDirectory);
+
+    if(!reportOutputDir.exists()) {
+      reportOutputDir.mkdirs();
+    }
+
+    final String pathname = reportOutputDirectory + File.separator + filename;
+
+    final File reportFile = new File(pathname);
+
+    try {
+      reportFile.createNewFile();
+    } catch (IOException e) {
+      log.error("Failure creating chart script file", e);
+    }
+
+    try(BufferedWriter writer = new BufferedWriter(new FileWriter(reportFile))) {
+      writer.write(stringBuilder.toString());
+    } catch (IOException e) {
+      log.error("Error writing chart script file", e);
+    }
+
+    log.info("Done! View the report at target/site/{}", filename);
+  }
+}