Add True Class Name

Class name and file name were being conflated. In most cases the two are
the same but not always.

I renamed the existing className property in RankedDisharmony to
fileName to reflect what it actually is.

I added a new className property which is set to the actual
className.

To get class name passed into the logic where RankedDisharmony is
constructed I also had to update the GodClass definition to include
className as well as file name.

The html and cvs report output should not change, as I updated them to
call getFileName from ranked disharmony rather than getClassName. This
preserves existing behavior.

The only output which should change is the  json report which will now expose both fileName and className, letting the
consumer choose which they care about.

Author: chriswininger

cost-benefit-calculator/src/main/java/org/hjug/cbc/RankedDisharmony.java

@@ -10,6 +10,7 @@
 public class RankedDisharmony {
 
     private final String path;
+    private final String fileName;
     private final String className;
     private final Integer effortRank;
     private final Integer changePronenessRank;
@@ -29,7 +30,8 @@ public class RankedDisharmony {
     public RankedDisharmony(GodClass godClass, ScmLogInfo scmLogInfo) {
         path = scmLogInfo.getPath();
         // from https://stackoverflow.com/questions/1011287/get-file-name-from-a-file-location-in-java
-        className = Paths.get(path).getFileName().toString();
+        fileName = Paths.get(path).getFileName().toString();
+        className = godClass.getClassName();
         changePronenessRank = scmLogInfo.getChangePronenessRank();
         effortRank = godClass.getOverallRank();
         priority = changePronenessRank - effortRank;

effort-ranker/src/main/java/org/hjug/metrics/GodClass.java

@@ -10,6 +10,7 @@
 @Data
 public class GodClass {
 
+    private String className;
     private String fileName;
     private String packageName;
     private Integer wmc;
@@ -22,7 +23,8 @@ public class GodClass {
     private Integer sumOfRanks;
     private Integer overallRank;
 
-    public GodClass(String fileName, String packageName, String result) {
+    public GodClass(String className, String fileName, String packageName, String result) {
+        this.className = className;
         this.fileName = fileName;
         this.packageName = packageName;
 

effort-ranker/src/main/java/org/hjug/metrics/PMDGodClassRuleRunner.java

@@ -73,7 +73,11 @@ public Optional<GodClass> runPMD(String sourceCodeFileName, InputStream inputStr
             // write results
             if (!ctx.getReport().isEmpty()) {
                 for (final RuleViolation violation : ctx.getReport()) {
-                    godClass = new GodClass(sourceCodeFileName, violation.getPackageName(), violation.getDescription());
+                    godClass = new GodClass(
+                            violation.getClassName(),
+                            sourceCodeFileName,
+                            violation.getPackageName(),
+                            violation.getDescription());
                 }
             }
         } catch (PMDException ignore) {

effort-ranker/src/test/java/org/hjug/metrics/GodClassParsingTest.java

@@ -25,7 +25,7 @@ public void after() {
     @Test
     public void test() {
         String result = "Possible God Class (WMC=9200, ATFD=1,700, TCC=4.597%)";
-        GodClass god = new GodClass("a.txt", "org.hjug", result);
+        GodClass god = new GodClass("a", "a.txt", "org.hjug", result);
         assertEquals(Integer.valueOf(9200), god.getWmc());
         assertEquals(Integer.valueOf(1700), god.getAtfd());
         assertEquals(Float.valueOf(4.597f), god.getTcc());

effort-ranker/src/test/java/org/hjug/metrics/GodClassRankerTest.java

@@ -14,22 +14,26 @@ public class GodClassRankerTest {
     private final GodClassRanker godClassRanker = new GodClassRanker();
 
     private final GodClass attributeHandler = new GodClass(
+            "AttributeHandler",
             "org/hjug/git/AttributeHandler.java",
             "org.apache.myfaces.tobago.facelets",
             "null (WMC=79, ATFD=79, TCC=0.027777777777777776)");
     private final GodClass attributeHandler2 = new GodClass(
+            "AttributeHandler",
             "org/hjug/git/AttributeHandler.java",
             "org.apache.myfaces.tobago.facelets",
             "null (WMC=79, ATFD=79, TCC=0.027777777777777776)");
-    private final GodClass sorter =
-            new GodClass("Sorter.java", "org.apache.myfaces.tobago.facelets", " God class (WMC=51, ATFD=25, TCC=0.2)");
-    private final GodClass sorter2 =
-            new GodClass("Sorter2.java", "org.apache.myfaces.tobago.facelets", " God class (WMC=51, ATFD=25, TCC=0.2)");
+    private final GodClass sorter = new GodClass(
+            "Sorter", "Sorter.java", "org.apache.myfaces.tobago.facelets", " God class (WMC=51, ATFD=25, TCC=0.2)");
+    private final GodClass sorter2 = new GodClass(
+            "Sorter", "Sorter2.java", "org.apache.myfaces.tobago.facelets", " God class (WMC=51, ATFD=25, TCC=0.2)");
     private final GodClass themeImpl = new GodClass(
+            "ThemeImpl",
             "ThemeImpl.java",
             "org.apache.myfaces.tobago.facelets",
             "God class (WMC=60, ATFD=16, TCC=0.07816091954022988)");
     private final GodClass themeImpl2 = new GodClass(
+            "ThemeImpl",
             "ThemeImpl2.java",
             "org.apache.myfaces.tobago.facelets",
             "God class (WMC=60, ATFD=16, TCC=0.07816091954022988)");

graph-data-generator/src/main/java/org/hjug/gdg/GraphDataGenerator.java

@@ -41,7 +41,7 @@ public String generateBubbleChartData(List<RankedDisharmony> rankedDisharmonies)
             RankedDisharmony rankedDisharmony = rankedDisharmonies.get(i);
             chartData.append("[");
             chartData.append("'");
-            chartData.append(rankedDisharmony.getClassName());
+            chartData.append(rankedDisharmony.getFileName());
             chartData.append("',");
             chartData.append(rankedDisharmony.getEffortRank());
             chartData.append(",");

graph-data-generator/src/test/java/org/hjug/gdg/GraphDataGeneratorTest.java

@@ -55,6 +55,7 @@ public void getScriptEnd() {
     @Test
     public void generateBubbleChartDataOneDataPoint() {
         GodClass godClass = new GodClass(
+                "AttributeHandler",
                 "AttributeHandler.java",
                 "org.apache.myfaces.tobago.facelets",
                 "(WMC=77, ATFD=105, TCC=15.555999755859375)");
@@ -76,6 +77,7 @@ public void generateBubbleChartDataOneDataPoint() {
     @Test
     public void generateBubbleChartDataTwoDataPoints() {
         GodClass godClass = new GodClass(
+                "AttributeHandler",
                 "AttributeHandler.java",
                 "org.apache.myfaces.tobago.facelets",
                 "(WMC=77, ATFD=105, TCC=15.555999755859375)");

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

@@ -15,8 +15,12 @@ class JsonReportDisharmonyEntry {
             .withLocale(Locale.getDefault())
             .withZone(ZoneId.systemDefault());
 
+    private final String fileName;
+
     private final String className;
 
+    private final String fullFilePath;
+
     private final Integer effortRank;
 
     private final Integer changePronenessRank;
@@ -29,18 +33,17 @@ class JsonReportDisharmonyEntry {
 
     private final String mostRecentCommitTime;
 
-    private final String fullPath;
-
     public static JsonReportDisharmonyEntry fromRankedDisharmony(RankedDisharmony entry) {
         return JsonReportDisharmonyEntry.builder()
+                .fileName(entry.getFileName())
                 .className(entry.getClassName())
                 .effortRank(entry.getEffortRank())
                 .changePronenessRank(entry.getChangePronenessRank())
                 .priority(entry.getPriority())
                 .weightedMethodCount(entry.getWmc())
                 .commitCount(entry.getCommitCount())
                 .mostRecentCommitTime(formatter.format(entry.getMostRecentCommitTime()))
-                .fullPath(entry.getPath())
+                .fullFilePath(entry.getPath())
                 .build();
     }
 }

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

@@ -180,7 +180,7 @@ private DateTimeFormatter createCsvDateTimeFormatter() {
 
     private String[] getDataList(RankedDisharmony rankedDisharmony) {
         String[] simpleRankedDisharmonyData = {
-            rankedDisharmony.getClassName(),
+            rankedDisharmony.getFileName(),
             rankedDisharmony.getPriority().toString(),
             rankedDisharmony.getChangePronenessRank().toString(),
             rankedDisharmony.getEffortRank().toString(),
@@ -190,7 +190,7 @@ private String[] getDataList(RankedDisharmony rankedDisharmony) {
         };
 
         String[] detailedRankedDisharmonyData = {
-            rankedDisharmony.getClassName(),
+            rankedDisharmony.getFileName(),
             rankedDisharmony.getPriority().toString(),
             rankedDisharmony.getChangePronenessRank().toString(),
             rankedDisharmony.getEffortRank().toString(),

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

@@ -278,7 +278,7 @@ public void execute() {
             stringBuilder.append("<tr>");
 
             String[] simpleRankedDisharmonyData = {
-                rankedDisharmony.getClassName(),
+                rankedDisharmony.getFileName(),
                 rankedDisharmony.getPriority().toString(),
                 rankedDisharmony.getChangePronenessRank().toString(),
                 rankedDisharmony.getEffortRank().toString(),
@@ -288,7 +288,7 @@ public void execute() {
             };
 
             String[] detailedRankedDisharmonyData = {
-                rankedDisharmony.getClassName(),
+                rankedDisharmony.getFileName(),
                 rankedDisharmony.getPriority().toString(),
                 rankedDisharmony.getChangePronenessRank().toString(),
                 rankedDisharmony.getEffortRank().toString(),