Initial HTML report generation

Author: manoelcampos

src/main/java/com/manoelcampos/javadoc/coverage/CoverageDoclet.java

@@ -122,14 +122,13 @@ public String getOutputDir() {
     /**
      * Gets a {@link PrintWriter} to export the documentation of a class or package.
      *
-     * @param fileName the name of the file to export the documentation to
+     * @param file the file to export the documentation to
      */
-    public PrintWriter getWriter(final String fileName) throws FileNotFoundException {
-        final File file = getOutputFile(fileName);
+    public PrintWriter getWriter(final File file) throws FileNotFoundException {
         return new PrintWriter(new OutputStreamWriter(new FileOutputStream(file)));
     }
 
-    private File getOutputFile(final String fileName) {
+    public File getOutputFile(final String fileName) {
         final File dir = new File(getOutputDir());
         if (!dir.exists() && !dir.mkdirs()) {
             throw new RuntimeException("The directory '" + getOutputDir() + "' was not created due to unknown reason.");

src/main/java/com/manoelcampos/javadoc/coverage/ReportGenerator.java

@@ -15,6 +15,7 @@
  */
 package com.manoelcampos.javadoc.coverage;
 
+import com.manoelcampos.javadoc.coverage.exporter.HtmlDataExporter;
 import com.manoelcampos.javadoc.coverage.stats.*;
 import com.sun.javadoc.PackageDoc;
 import com.sun.javadoc.RootDoc;
@@ -30,12 +31,13 @@
  * @since 1.0.0
  */
 public class ReportGenerator {
+    public static final String JAVADOC_COVERAGE_HTML = "javadoc-coverage.html";
     private final JavaDocsStats stats;
     private final CoverageDoclet doclet;
 
     public ReportGenerator(final CoverageDoclet doclet) {
-        this.doclet = doclet;
         this.stats = new JavaDocsStats(doclet.getRootDoc());
+        this.doclet = doclet;
     }
 
     /**
@@ -51,6 +53,14 @@ public boolean start() {
             writer.flush();
         }
 
+        try {
+            final File file = doclet.getOutputFile(JAVADOC_COVERAGE_HTML);
+            new HtmlDataExporter(stats, doclet.getWriter(file)).build();
+            System.out.printf("JavaDoc Coverage report saved to %s\n", file.getPath());
+        } catch (FileNotFoundException e) {
+            throw new RuntimeException(e);
+        }
+
         return true;
     }
 
@@ -123,14 +133,13 @@ private void exportMembersDocStats(final PrintWriter writer, final MembersDocSta
         exportMembersDocStats(writer, membersDocStats, "");
     }
 
-    private void exportMembersDocStats(final PrintWriter writer, final MembersDocStats membersDocStats, String memberTypeFormat) {
+    private void exportMembersDocStats(final PrintWriter writer, final MembersDocStats membersDocStats, final String memberTypeFormat) {
         if (membersDocStats.getMembersNumber() == 0 && !membersDocStats.isPrintIfNoMembers()) {
             return;
         }
 
-        memberTypeFormat = Utils.isStringEmpty(memberTypeFormat) ? "\t\t%-20s" : memberTypeFormat;
-
-        final String format = memberTypeFormat+" %6d Undocumented: %6d Documented: %6d (%.2f%%) \n";
+        final String format = (Utils.isStringEmpty(memberTypeFormat) ? "\t\t%-20s" : memberTypeFormat) +
+                              " %6d Undocumented: %6d Documented: %6d (%.2f%%) \n";
         writer.printf(format,
                 membersDocStats.getType()+":", membersDocStats.getMembersNumber(),
                 membersDocStats.getUndocumentedMembers(),

src/main/java/com/manoelcampos/javadoc/coverage/Utils.java

@@ -15,12 +15,9 @@
  */
 package com.manoelcampos.javadoc.coverage;
 
-import com.manoelcampos.javadoc.coverage.stats.MethodDocStats;
-
 import java.io.File;
 import java.util.Arrays;
 import java.util.stream.DoubleStream;
-import java.util.stream.Stream;
 
 /**
  * An utility class.

src/main/java/com/manoelcampos/javadoc/coverage/exporter/HtmlDataExporter.java

@@ -0,0 +1,67 @@
+package com.manoelcampos.javadoc.coverage.exporter;
+
+import com.manoelcampos.javadoc.coverage.stats.*;
+
+import java.io.PrintWriter;
+
+/**
+ * Exports data to HTML format.
+ *
+ * @author Manoel Campos da Silva Filho
+ * @since 1.0.0
+ */
+public class HtmlDataExporter {
+    public static final String COLUMNS = "<td>%s</td><td>%s</td><td>%s</td><td>%d</td><td>%d</td><td>%d</td><td>%.2f%%</td>\n";
+    private final JavaDocsStats stats;
+    private final PrintWriter writer;
+
+    public HtmlDataExporter(final JavaDocsStats stats, final PrintWriter writer){
+        this.writer = writer;
+        this.stats = stats;
+    }
+
+    public void build(){
+        try{
+            writer.println("<!DOCTYPE html>\n<html lang=en>");
+            writer.println("<head>");
+            writer.println("    <title>JavaDoc Coverage Report</title>");
+            writer.println("    <link rel='stylesheet' href='https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css' integrity='sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u' crossorigin='anonymous'>\n");
+            writer.println("    <link rel='stylesheet' href='https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap-theme.min.css' integrity='sha384-rHyoN1iRsVXV4nD0JutlnGaslCJuC7uwjduW9SVrLvRYooPp2bWYgmgJQIXwl/Sp' crossorigin='anonymous'>");
+            writer.println("    <script src='https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js' integrity='sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa' crossorigin='anonymous'></script>");
+            writer.println("    <meta content='width=device-width,initial-scale=1' name=viewport>");
+            writer.println("</head>");
+            writer.println("<body>");
+            writer.println("<table>");
+            writer.println("<tr>");
+            writer.println("<th>Element Type</th><th>Name</th><th>Package</th><th>Count</th><th>Undocumented</th><th>Documented</th><th>Documented Percent</th>");
+            writer.println("</tr>");
+
+            exportMembersDocStatsSummary(stats.getClassesDocStats());
+            for (final ClassDocStats classDocStats : stats.getClassesDocStats().getClassesList()) {
+                exportMembersDocStatsSummary(classDocStats)
+            }
+
+            writer.println("</table>");
+            writer.println("</body>");
+            writer.flush();
+        } finally {
+            writer.close();
+        }
+    }
+
+    private <T extends DocStats & DocumentableMembers> void exportMembersDocStatsSummary(final T membersDocStats) {
+        exportMembersDocStatsSummary(membersDocStats, "","");
+    }
+
+    private <T extends DocStats & DocumentableMembers> void exportMembersDocStatsSummary(final T membersDocStats, final String name, final String pkg) {
+        writer.println("<tr>");
+        writer.printf(COLUMNS,
+                membersDocStats.getType(),
+                name, pkg,
+                membersDocStats.getMembersNumber(),
+                membersDocStats.getUndocumentedMembers(),
+                membersDocStats.getDocumentedMembers(),
+                membersDocStats.getDocumentedMembersPercent());
+        writer.println("</tr>");
+    }
+}

src/main/java/com/manoelcampos/javadoc/coverage/stats/ClassMembersDocStats.java

@@ -15,9 +15,7 @@
  */
 package com.manoelcampos.javadoc.coverage.stats;
 
-import com.manoelcampos.javadoc.coverage.Utils;
 import com.sun.javadoc.Doc;
-import com.sun.javadoc.MemberDoc;
 
 import java.util.Arrays;
 import java.util.Objects;

src/main/java/com/manoelcampos/javadoc/coverage/stats/MembersDocStats.java

@@ -52,11 +52,11 @@ public final boolean isPrintIfNoMembers() {
         return this.printIfNoMembers;
     }
 
-    final void enablePrintIfNoMembers() {
+    public final void enablePrintIfNoMembers() {
         this.printIfNoMembers = true;
     }
 
-    final void disablePrintIfNoMembers() {
+    public final void disablePrintIfNoMembers() {
         this.printIfNoMembers = false;
     }
 }

src/main/java/com/manoelcampos/javadoc/coverage/stats/MethodTagsDocStats.java

@@ -15,7 +15,6 @@
  */
 package com.manoelcampos.javadoc.coverage.stats;
 
-import com.manoelcampos.javadoc.coverage.Utils;
 import com.sun.javadoc.ExecutableMemberDoc;
 import com.sun.javadoc.Tag;