Added unit tests and refactored a little

Author: jimbethancourt

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

@@ -60,10 +60,6 @@ public String getDescription(Locale locale) {
     @Override
     protected void executeReport(Locale locale) throws MavenReportException {
 
-        GitLogReader gitLogReader = new GitLogReader();
-        String projectBaseDir = project.getBasedir().getPath();
-        String parentOfGitDir = gitLogReader.getGitDir(project.getBasedir()).getParentFile().getPath();
-
         final String[] simpleTableHeadings = {  "Class",
                                                 "Priority",
                                                 "Change Proneness Rank",
@@ -89,6 +85,9 @@ protected void executeReport(Locale locale) throws MavenReportException {
 
         final String[] tableHeadings = showDetails ? detailedTableHeadings: simpleTableHeadings;
 
+        GitLogReader gitLogReader = new GitLogReader();
+        String projectBaseDir = project.getBasedir().getPath();
+        String parentOfGitDir = gitLogReader.getGitDir(project.getBasedir()).getParentFile().getPath();
         log.info("Project Base Dir: {} ", projectBaseDir);
         log.info("Parent of Git Dir: {}", parentOfGitDir);
 
@@ -218,13 +217,13 @@ protected void executeReport(Locale locale) throws MavenReportException {
         log.info("Done! View the report at target/site/{}", filename);
     }
 
-    private void drawTableHeaderCell(String cellText, Sink mainSink) {
+    void drawTableHeaderCell(String cellText, Sink mainSink) {
         mainSink.tableHeaderCell();
         mainSink.text(cellText);
         mainSink.tableHeaderCell_();
     }
 
-    private void drawTableCell(String cellText, Sink mainSink) {
+    void drawTableCell(String cellText, Sink mainSink) {
         mainSink.tableCell();
         mainSink.text(cellText);
         mainSink.tableCell_();
@@ -233,7 +232,7 @@ private void drawTableCell(String cellText, Sink mainSink) {
     /**
      * @See https://maven.apache.org/doxia/developers/sink.html#How_to_inject_javascript_code_into_HTML
      */
-    private void generateChart(List<RankedDisharmony> rankedDisharmonies, Sink mainSink) {
+    void generateChart(List<RankedDisharmony> rankedDisharmonies, Sink mainSink) {
         SinkEventAttributeSet googleChartImport = new SinkEventAttributeSet();
         googleChartImport.addAttribute( SinkEventAttributes.TYPE, "text/javascript" );
         googleChartImport.addAttribute( SinkEventAttributes.SRC, "https://www.gstatic.com/charts/loader.js" );
@@ -242,6 +241,18 @@ private void generateChart(List<RankedDisharmony> rankedDisharmonies, Sink mainS
         mainSink.unknown(script, new Object[]{HtmlMarkup.TAG_TYPE_START}, googleChartImport);
         mainSink.unknown(script, new Object[]{HtmlMarkup.TAG_TYPE_END}, null);
 
+        writeGchartJs(rankedDisharmonies);
+
+        SinkEventAttributeSet javascript = new SinkEventAttributeSet();
+        javascript.addAttribute( SinkEventAttributes.TYPE, "text/javascript");
+        javascript.addAttribute( SinkEventAttributes.SRC, "./gchart.js");
+
+        mainSink.unknown(script, new Object[]{HtmlMarkup.TAG_TYPE_START }, javascript );
+        mainSink.unknown(script, new Object[]{HtmlMarkup.TAG_TYPE_END}, null );
+    }
+
+    //TODO: Move to another class to allow use by Gradle plugin
+    void writeGchartJs(List<RankedDisharmony> rankedDisharmonies) {
         GraphDataGenerator graphDataGenerator = new GraphDataGenerator();
         String scriptStart = graphDataGenerator.getScriptStart();
         String bubbleChartData = graphDataGenerator.generateBubbleChartData(rankedDisharmonies);
@@ -268,12 +279,5 @@ private void generateChart(List<RankedDisharmony> rankedDisharmonies, Sink mainS
         } catch (IOException e) {
             log.error("Error writing chart script file", e);
         }
-
-        SinkEventAttributeSet javascript = new SinkEventAttributeSet();
-        javascript.addAttribute( SinkEventAttributes.TYPE, "text/javascript");
-        javascript.addAttribute( SinkEventAttributes.SRC, "./gchart.js");
-
-        mainSink.unknown(script, new Object[]{HtmlMarkup.TAG_TYPE_START }, javascript );
-        mainSink.unknown(script, new Object[]{HtmlMarkup.TAG_TYPE_END}, null );
     }
 }

refactor-first-maven-plugin/src/test/java/org/hjug/mavenreport/RefactorFirstMavenReportTest.java

@@ -0,0 +1,61 @@
+package org.hjug.mavenreport;
+
+import org.apache.maven.doxia.sink.Sink;
+import org.junit.Before;
+import org.junit.Test;
+
+import java.util.Locale;
+
+import static org.junit.Assert.*;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+
+public class RefactorFirstMavenReportTest {
+
+    private RefactorFirstMavenReport mavenReport = new RefactorFirstMavenReport();
+    private Sink sink;
+
+    @Before
+    public void setUp() {
+        sink = mock(Sink.class);
+    }
+
+    @Test
+    public void testGetOutputName() {
+        // This report will generate simple-report.html when invoked in a project with `mvn site`
+        assertEquals("refactor-first-report", mavenReport.getOutputName());
+    }
+
+    @Test
+    public void getName() {
+        // Name of the report when listed in the project-reports.html page of a project
+        assertEquals("Refactor First Report", mavenReport.getName(Locale.getDefault()));
+    }
+
+    @Test
+    public void getDescription() {
+        // Description of the report when listed in the project-reports.html page of a project
+        assertEquals("Ranks the disharmonies in a codebase.  The classes that should be refactored first "
+                + " have the highest priority values.", mavenReport.getDescription(Locale.getDefault()));
+    }
+
+    @Test
+    public void drawTableHeaderCell() {
+        mavenReport.drawTableHeaderCell("test", sink);
+        verify(sink).tableHeaderCell();
+        verify(sink).text("test");
+        verify(sink).tableHeaderCell_();
+    }
+
+    @Test
+    public void drawTableCell() {
+        mavenReport.drawTableCell("test", sink);
+        verify(sink).tableCell();
+        verify(sink).text("test");
+        verify(sink).tableCell_();
+    }
+
+    @Test
+    public void generateChart() {
+    }
+}