Format the description of a studio to remove line breaks to increase readability (#488)

* Format the description of a studio to remove line breaks to increase readability

* Update src/main/java/io/seqera/tower/cli/utils/FormatHelper.java

Co-authored-by: Endre Sükösd <148096496+endre-seqera@users.noreply.github.com>

---------

Co-authored-by: Endre Sükösd <148096496+endre-seqera@users.noreply.github.com>

Author: georgi-seqera

src/main/java/io/seqera/tower/cli/responses/studios/StudiosList.java

@@ -30,6 +30,7 @@
 import io.seqera.tower.model.DataStudioStatusInfo;
 import io.seqera.tower.model.StudioUser;
 
+import static io.seqera.tower.cli.utils.FormatHelper.formatDescription;
 import static io.seqera.tower.cli.utils.FormatHelper.formatStudioStatus;
 
 public class StudiosList extends Response {
@@ -67,10 +68,10 @@ public void toString(PrintWriter out) {
             DataStudioStatusInfo statusInfo = studio.getStatusInfo();
             StudioUser user = studio.getUser();
             List<String> rows = new ArrayList<>(List.of(
-                    studio.getSessionId() == null ? "" : studio.getSessionId(),
-                    studio.getName() == null ? "" : studio.getName(),
-                    studio.getDescription() == null ? "" : studio.getDescription(),
-                    user == null ? "" : user.getUserName(),
+                    studio.getSessionId() == null ? "NA" : studio.getSessionId(),
+                    studio.getName() == null ? "NA" : studio.getName(),
+                    formatDescription(studio.getDescription(), 100),
+                    user == null ? "NA" : user.getUserName(),
                     formatStudioStatus(statusInfo == null ? null : statusInfo.getStatus())
             ));
 

src/main/java/io/seqera/tower/cli/responses/studios/StudiosView.java

@@ -27,6 +27,7 @@
 
 import java.io.PrintWriter;
 
+import static io.seqera.tower.cli.utils.FormatHelper.formatDescription;
 import static io.seqera.tower.cli.utils.FormatHelper.formatStudioStatus;
 import static io.seqera.tower.cli.utils.FormatHelper.formatTime;
 
@@ -54,7 +55,7 @@ public void toString(PrintWriter out){
         table.addRow("Status", formatStudioStatus(statusInfo == null ? null : statusInfo.getStatus()));
         table.addRow("Status last update", statusInfo == null ? "NA" : formatTime(statusInfo.getLastUpdate()));
         table.addRow("Studio URL", studio.getStudioUrl());
-        table.addRow("Description", studio.getDescription());
+        table.addRow("Description", formatDescription(studio.getDescription(), 100));
         table.addRow("Created on", formatTime(studio.getDateCreated()));
         table.addRow("Created by", studioUser == null ? "NA" : String.format("%s | %s",studioUser.getUserName(), studioUser.getEmail()));
         table.addRow("Template", studio.getTemplate() == null ? "NA" : studio.getTemplate().getRepository());

src/main/java/io/seqera/tower/cli/utils/FormatHelper.java

@@ -334,4 +334,19 @@ public static String formatLabels(java.util.List<io.seqera.tower.model.LabelDbDt
         .collect(Collectors.joining(","));
     }
 
+    public static String formatDescription(String description) {
+        return formatDescription(description, 2048);
+    }
+
+    public static String formatDescription(String description, int maxLength) {
+        if (description == null) {
+            return "NA";
+        }
+
+        // remove line breaks
+        var text = description.trim().replace("\n", " ").replace("\r", " ");
+        // cap the description length if too long
+        return text.length() > maxLength ? text.substring(0, maxLength) + "..." : text;
+    }
+
 }