Improve menu

Author: jimbethancourt

report/src/main/java/org/hjug/refactorfirst/report/HtmlReport.java

@@ -1,9 +1,6 @@
 package org.hjug.refactorfirst.report;
 
-import java.util.HashSet;
-import java.util.List;
-import java.util.Locale;
-import java.util.Set;
+import java.util.*;
 import lombok.extern.slf4j.Slf4j;
 import org.hjug.cbc.RankedCycle;
 import org.hjug.cbc.RankedDisharmony;
@@ -418,6 +415,17 @@ public String printTitle(String projectName, String projectVersion) {
         return "<title>Refactor First Report for " + projectName + " " + projectVersion + " </title>\n";
     }
 
+    @Override
+    StringBuilder createMenu(
+            List<DisharmonySpec> disharmonySpecs,
+            Map<String, List<RankedDisharmony>> rankedDisharmoniesByAnchor,
+            List<RankedCycle> rankedCycles) {
+        StringBuilder stringBuilder = new StringBuilder();
+        stringBuilder.append("<li><a href=\"#CLASSMAP\">Class Map</a></li>\n");
+        stringBuilder.append(super.createMenu(disharmonySpecs, rankedDisharmoniesByAnchor, rankedCycles));
+        return stringBuilder;
+    }
+
     @Override
     String renderGithubButtons() {
         return "<div align=\"center\">\n" + "Show RefactorFirst some &#10084;&#65039;\n"
@@ -492,7 +500,7 @@ public String renderClassGraphVisuals(String repoUrl, CodebaseGraphDTO codebaseG
 
     private StringBuilder generateGraphButtons(String graphName, String dot) {
         StringBuilder stringBuilder = new StringBuilder();
-        stringBuilder.append("<h1 align=\"center\">Class Map</h1>");
+        stringBuilder.append("<h1 align=\"center\"><a id=\"CLASSMAP\">Class Map</a></h1>");
         stringBuilder.append("<script>\n");
         stringBuilder.append("const " + graphName + "_dot = " + dot + "\n");
         stringBuilder.append("</script>\n");

report/src/main/java/org/hjug/refactorfirst/report/SimpleHtmlReport.java

@@ -308,35 +308,9 @@ public StringBuilder generateReport(
         }
 
         stringBuilder.append("<header>\n" + "<nav>\n" + " <ul>\n");
-
-        if (!edgesToRemove.isEmpty()) {
-            stringBuilder.append("<li><a href=\"#EDGES\">Edges To Remove</a></li>\n");
-        }
-
-        if (!disharmonySpecs.isEmpty()) {
-            stringBuilder.append("<li><a href=\"#\">Disharmonies</a>\n" + "                <ul>");
-        }
-
-        for (DisharmonySpec spec : disharmonySpecs) {
-            if (rankedDisharmoniesByAnchor.containsKey(spec.anchorId())) {
-                stringBuilder
-                        .append("<li><a href=\"#")
-                        .append(spec.anchorId())
-                        .append("\">")
-                        .append(spec.title())
-                        .append("</a></li>\n");
-            }
-        }
-
-        if (!disharmonySpecs.isEmpty()) {
-            stringBuilder.append("</ul>\n" + "            </li>");
-        }
-
-        if (!rankedCycles.isEmpty()) {
-            stringBuilder.append("<li><a href=\"#CYCLES\">Class Cycles</a></li>\n");
-        }
-
+        stringBuilder.append(createMenu(disharmonySpecs, rankedDisharmoniesByAnchor, rankedCycles));
         stringBuilder.append("</ul>\n" + "</nav>\n" + "</header>\n");
+
         log.info("Generating HTML Report");
 
         stringBuilder.append(renderClassGraphVisuals(repoUrl, codebaseGraphDTO));
@@ -366,6 +340,40 @@ public StringBuilder generateReport(
         return stringBuilder;
     }
 
+    StringBuilder createMenu(
+            List<DisharmonySpec> disharmonySpecs,
+            Map<String, List<RankedDisharmony>> rankedDisharmoniesByAnchor,
+            List<RankedCycle> rankedCycles) {
+        StringBuilder menu = new StringBuilder();
+        if (!edgesToRemove.isEmpty()) {
+            menu.append("<li><a href=\"#EDGES\">Edges To Remove</a></li>\n");
+        }
+
+        if (!disharmonySpecs.isEmpty()) {
+            menu.append("<li><a href=\"#\">Disharmonies</a>\n" + "                <ul>");
+        }
+
+        for (DisharmonySpec spec : disharmonySpecs) {
+            if (rankedDisharmoniesByAnchor.containsKey(spec.anchorId())) {
+                menu.append("<li><a href=\"#")
+                        .append(spec.anchorId())
+                        .append("\">")
+                        .append(spec.title())
+                        .append("</a></li>\n");
+            }
+        }
+
+        if (!disharmonySpecs.isEmpty()) {
+            menu.append("</ul>\n" + "            </li>");
+        }
+
+        if (!rankedCycles.isEmpty()) {
+            menu.append("<li><a href=\"#CYCLES\">Class Cycles</a></li>\n");
+            menu.append("<li><a href=\"#CYCLEMAP\">Cycle Map</a></li>\n");
+        }
+        return menu;
+    }
+
     private String renderCycles(List<RankedCycle> rankedCycles, String repoUrl, CodebaseGraphDTO codebaseGraphDTO) {
         StringBuilder stringBuilder = new StringBuilder();
         stringBuilder.append(renderClassCycleSummary(rankedCycles));
@@ -579,8 +587,8 @@ private String renderSingleCycle(RankedCycle cycle, String repoUrl, CodebaseGrap
         stringBuilder.append("<br/>\n");
         stringBuilder.append("<br/>\n");
 
-        stringBuilder.append(
-                "<h2 align=\"center\">Largest Class Cycle : " + getClassName(cycle.getCycleName()) + "</h2>\n");
+        stringBuilder.append("<a id=\"CYCLEMAP\"><h2 align=\"center\">Largest Class Cycle : "
+                + getClassName(cycle.getCycleName()) + "</h2></a>\n");
         stringBuilder.append(
                 "<h3 align=\"center\">Limiting number of cycles displayed to 1 to keep page load time fast</h3>\n");
         stringBuilder.append(renderCycleVisuals(cycle, repoUrl, codebaseGraphDTO));