Feature: adding "sort-by-value" field to cell-value - to allow correct sorting by complex visual-values

exadmin · exadmin · commit 94ef21cd6570 · 2025-05-22T11:10:39.000+03:00
diff --git a/docs/data/data.json b/docs/data/data.json
diff --git a/docs/misc/report.js b/docs/misc/report.js
@@ -12,14 +12,19 @@ function defaultRender (data, type, row, meta) {
 //      "href": "<url>",        # Link in cell
 //      "value": "string"       # Value of cell
 //   }
+    // console.log("defaultRenderer is called with type = " + type);
+    if (type == 'sort') {
+        return data.sortByValue;
+    }
+
     if (data.title && data.href) {
         return '<div title="<p class=\'my-tooltip\'>' + data.title + '</p>"><a href="' + data.href + '" target="_blank">' + (data.value || '&nbsp;') + '</a></div>';
     } else if (data.title) {
         return '<div title="' + data.title + '">' + (data.value || '&nbsp;') + '</div>';
     } else if (data.href) {
         return '<a href="' + data.href + '" target="_blank">' + (data.value || '&nbsp;') + '</a>';
     } else if (data.value) {
-               return String(data.value);
+        return String(data.value);
     } else {
         return String(data);
     }
diff --git a/src/main/java/com/github/exadmin/ostm/collectors/impl/repos/ListAllRepositories.java b/src/main/java/com/github/exadmin/ostm/collectors/impl/repos/ListAllRepositories.java
@@ -27,8 +27,8 @@ public void collectDataInto(TheReportModel theReportModel, GitHubFacade gitHubFa
 
         int number = 1;
         for (Map.Entry<String, String> me : repoNames.entrySet()) {
-            colRepoNumber.addValue(me.getKey(), new TheCellValue("" + number));
-            colRepoName.addValue(me.getKey(), new TheCellValue(me.getValue()));
+            colRepoNumber.addValue(me.getKey(), new TheCellValue("" + number, "" + number));
+            colRepoName.addValue(me.getKey(), new TheCellValue(me.getValue(), me.getValue()));
 
             number++;
         }
diff --git a/src/main/java/com/github/exadmin/ostm/collectors/impl/repos/SonarCodeCoverage.java b/src/main/java/com/github/exadmin/ostm/collectors/impl/repos/SonarCodeCoverage.java
@@ -76,7 +76,7 @@ public void collectDataInto(TheReportModel theReportModel, GitHubFacade gitHubFa
                         String component = (String) mData.get("component");
 
                         String rowId = componentToRowIdMap.remove(component);
-                        column.addValue(rowId, new TheCellValue(value + "%"));
+                        column.addValue(rowId, new TheCellValue(value + "%", value));
                     }
                 }
             }
@@ -89,7 +89,7 @@ public void collectDataInto(TheReportModel theReportModel, GitHubFacade gitHubFa
 
         // at this step - componenToRowIdMap contains list of components with absent data
         for (Map.Entry<String, String> me : componentToRowIdMap.entrySet()) {
-            column.addValue(me.getValue(), new TheCellValue("Not Registered"));
+            column.addValue(me.getValue(), new TheCellValue("Not Registered", "0"));
         }
     }
 }
diff --git a/src/main/java/com/github/exadmin/ostm/collectors/impl/repos/TopicAndTeamPerRepository.java b/src/main/java/com/github/exadmin/ostm/collectors/impl/repos/TopicAndTeamPerRepository.java
@@ -19,7 +19,7 @@ public void collectDataInto(TheReportModel theReportModel, GitHubFacade gitHubFa
         List<GitHubRepository> repoList = gitHubFacade.getAllRepositories("Netcracker");
         for (GitHubRepository repository : repoList) {
             String rowId = repository.getId();
-            TheCellValue cellValue = new TheCellValue(topicsListToStr(repository.getTopics()));
+            TheCellValue cellValue = new TheCellValue(topicsListToStr(repository.getTopics()), "");
             colTopics.addValue(rowId, cellValue);
         }
     }
diff --git a/src/main/java/com/github/exadmin/ostm/collectors/impl/teams/CountNumberOfCommitsPerUser.java b/src/main/java/com/github/exadmin/ostm/collectors/impl/teams/CountNumberOfCommitsPerUser.java
@@ -42,7 +42,7 @@ public void collectDataInto(TheReportModel theReportModel, GitHubFacade gitHubFa
             Integer count = ghResponse.getObject("/data/user/contributionsCollection/contributionCalendar/totalContributions");
             if (count == null) count = 0;
 
-            TheCellValue cellValue = new TheCellValue("" + count);
+            TheCellValue cellValue = new TheCellValue("" + count, "" + count);
             String rowId = "row:" + login;
 
             theColumn.addValue(rowId, cellValue);
diff --git a/src/main/java/com/github/exadmin/ostm/collectors/impl/teams/NumberOfCommitsPerWeekPerUser.java b/src/main/java/com/github/exadmin/ostm/collectors/impl/teams/NumberOfCommitsPerWeekPerUser.java
@@ -116,7 +116,7 @@ public void collectDataInto(TheReportModel theReportModel, GitHubFacade gitHubFa
                     sbTooltip.append("&nbsp;&nbsp;").append(noDomain(me.getKey())).append(": ").append(me.getValue()).append("<br>");
                 }
 
-                TheCellValue cellValue = new TheCellValue("" + totalCount);
+                TheCellValue cellValue = new TheCellValue("" + totalCount, "" + totalCount);
                 cellValue.setToolTipText(sbTooltip.toString());
                 String rowId = "row:" + login;
 
@@ -127,7 +127,7 @@ public void collectDataInto(TheReportModel theReportModel, GitHubFacade gitHubFa
 
         for (String login : usersWithNoResponse) {
             for (TheColumn theColumn : columns) {
-                TheCellValue cellValue = new TheCellValue("0");
+                TheCellValue cellValue = new TheCellValue("No data", "0");
                 String rowId = "row:" + login;
 
                 theColumn.addValue(rowId, cellValue);
diff --git a/src/main/java/com/github/exadmin/ostm/collectors/impl/teams/TeamKnownNames.java b/src/main/java/com/github/exadmin/ostm/collectors/impl/teams/TeamKnownNames.java
@@ -69,12 +69,12 @@ public void collectDataInto(TheReportModel theReportModel, GitHubFacade gitHubFa
         for (String login : uniqueLogins) {
             String rowId = "row:" + login;
 
-            TheCellValue cvLogin = new TheCellValue(login);
+            TheCellValue cvLogin = new TheCellValue(login, login);
             colLogin.addValue(rowId, cvLogin);
 
             String realName = ALIAS_TO_NAME.get(login);
             if (realName == null) realName = "---";
-            TheCellValue cvRealName = new TheCellValue(realName);
+            TheCellValue cvRealName = new TheCellValue(realName, realName);
             colRealName.addValue(rowId, cvRealName);
         }
     }
diff --git a/src/main/java/com/github/exadmin/ostm/persistence/ReportModelPersister.java b/src/main/java/com/github/exadmin/ostm/persistence/ReportModelPersister.java
@@ -51,11 +51,16 @@ public void saveToFile(Path outputFilePath) {
                     if (theCellValue == null) {
                         log.warn("No cell value is registered for sheet '{}', column '{}', rowId '{}'", sheet, theColumn, rowId);
                     }
-                    String valueAsStr = theCellValue == null ? "null" : theCellValue.getValue();
-                    String toolTip = theCellValue == null ? null : theCellValue.getToolTipText();
 
                     Map<String, String> cellValueJson = new HashMap<>();
-                    cellValueJson.put("value", valueAsStr);
+
+                    String visualValue = theCellValue == null ? "null" : theCellValue.getVisualValue();
+                    cellValueJson.put("value", visualValue);
+
+                    String techValue   = theCellValue == null ? "null" : theCellValue.getSortByValue();
+                    cellValueJson.put("sortByValue", techValue);
+
+                    String toolTip = theCellValue == null ? null : theCellValue.getToolTipText();
                     if (StringUtils.isNotEmpty(toolTip)) cellValueJson.put("title", toolTip);
 
                     dataMap.put(theColumn.getId(), cellValueJson);
diff --git a/src/main/java/com/github/exadmin/ostm/uimodel/TheCellValue.java b/src/main/java/com/github/exadmin/ostm/uimodel/TheCellValue.java
@@ -1,24 +1,39 @@
 package com.github.exadmin.ostm.uimodel;
 
 public class TheCellValue {
-    private String value;
+    private String visualValue;
+    private String sortByValue;
     private String toolTipText;
 
-    public TheCellValue(String value) {
-        this.value = value;
+    /**
+     * Create cell-value to be rendered in the report
+     * @param visualValue visual value how it will look like
+     * @param sortByValue hidden value how it will be interpreted by html rendering framework (for instance: sorting will be done by this values, not visual)
+     */
+    public TheCellValue(String visualValue, String sortByValue) {
+        this.visualValue = visualValue;
+        this.sortByValue = sortByValue;
     }
 
-    public String getValue() {
-        return value;
+    public String getVisualValue() {
+        return visualValue;
     }
 
-    public void setValue(String value) {
-        this.value = value;
+    public void setVisualValue(String visualValue) {
+        this.visualValue = visualValue;
+    }
+
+    public String getSortByValue() {
+        return sortByValue;
+    }
+
+    public void setSortByValue(String sortByValue) {
+        this.sortByValue = sortByValue;
     }
 
     @Override
     public String toString() {
-        return value;
+        return visualValue;
     }
 
     public String getToolTipText() {

Original file line number	Diff line number	Diff line change
`@@ -27,8 +27,8 @@ public void collectDataInto(TheReportModel theReportModel, GitHubFacade gitHubFa`
`27`	`27`
`28`	`28`	`int number = 1;`
`29`	`29`	`for (Map.Entry<String, String> me : repoNames.entrySet()) {`
`30`		`- colRepoNumber.addValue(me.getKey(), new TheCellValue("" + number));`
`31`		`- colRepoName.addValue(me.getKey(), new TheCellValue(me.getValue()));`
	`30`	`+ colRepoNumber.addValue(me.getKey(), new TheCellValue("" + number, "" + number));`
	`31`	`+ colRepoName.addValue(me.getKey(), new TheCellValue(me.getValue(), me.getValue()));`
`32`	`32`
`33`	`33`	`number++;`
`34`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ public void collectDataInto(TheReportModel theReportModel, GitHubFacade gitHubFa`
`76`	`76`	`String component = (String) mData.get("component");`
`77`	`77`
`78`	`78`	`String rowId = componentToRowIdMap.remove(component);`
`79`		`- column.addValue(rowId, new TheCellValue(value + "%"));`
	`79`	`+ column.addValue(rowId, new TheCellValue(value + "%", value));`
`80`	`80`	`}`
`81`	`81`	`}`
`82`	`82`	`}`
`@@ -89,7 +89,7 @@ public void collectDataInto(TheReportModel theReportModel, GitHubFacade gitHubFa`
`89`	`89`
`90`	`90`	`// at this step - componenToRowIdMap contains list of components with absent data`
`91`	`91`	`for (Map.Entry<String, String> me : componentToRowIdMap.entrySet()) {`
`92`		`- column.addValue(me.getValue(), new TheCellValue("Not Registered"));`
	`92`	`+ column.addValue(me.getValue(), new TheCellValue("Not Registered", "0"));`
`93`	`93`	`}`
`94`	`94`	`}`
`95`	`95`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ public void collectDataInto(TheReportModel theReportModel, GitHubFacade gitHubFa`
`19`	`19`	`List<GitHubRepository> repoList = gitHubFacade.getAllRepositories("Netcracker");`
`20`	`20`	`for (GitHubRepository repository : repoList) {`
`21`	`21`	`String rowId = repository.getId();`
`22`		`- TheCellValue cellValue = new TheCellValue(topicsListToStr(repository.getTopics()));`
	`22`	`+ TheCellValue cellValue = new TheCellValue(topicsListToStr(repository.getTopics()), "");`
`23`	`23`	`colTopics.addValue(rowId, cellValue);`
`24`	`24`	`}`
`25`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -69,12 +69,12 @@ public void collectDataInto(TheReportModel theReportModel, GitHubFacade gitHubFa`
`69`	`69`	`for (String login : uniqueLogins) {`
`70`	`70`	`String rowId = "row:" + login;`
`71`	`71`
`72`		`- TheCellValue cvLogin = new TheCellValue(login);`
	`72`	`+ TheCellValue cvLogin = new TheCellValue(login, login);`
`73`	`73`	`colLogin.addValue(rowId, cvLogin);`
`74`	`74`
`75`	`75`	`String realName = ALIAS_TO_NAME.get(login);`
`76`	`76`	`if (realName == null) realName = "---";`
`77`		`- TheCellValue cvRealName = new TheCellValue(realName);`
	`77`	`+ TheCellValue cvRealName = new TheCellValue(realName, realName);`
`78`	`78`	`colRealName.addValue(rowId, cvRealName);`
`79`	`79`	`}`
`80`	`80`	`}`