Support CSV format in @table output

#108
tomitribe · Feb 3, 2024 · e18e4e0 · e18e4e0
1 parent e783cfc
commit e18e4e0
Show file tree

Hide file tree

Showing 3 changed files with 64 additions and 0 deletions.
diff --git a/tomitribe-crest-api/src/main/java/org/tomitribe/crest/api/table/Border.java b/tomitribe-crest-api/src/main/java/org/tomitribe/crest/api/table/Border.java
@@ -205,4 +205,12 @@ public enum Border {
      * </pre>
      */
     tsv,
+
+    /**
+     * id,project,releaseDate,version
+     * 9,Apache TomEE,A2016-05-17,A7.0.x
+     * 523456789,ATomcat,A2018-01-17,A9.0.x
+     * 14,AApache ActiveMQ Classic,A2022-03-09,A5.17.x
+     */
+    csv,
 }
diff --git a/tomitribe-crest/src/main/java/org/tomitribe/crest/table/Border.java b/tomitribe-crest/src/main/java/org/tomitribe/crest/table/Border.java
@@ -383,6 +383,35 @@ public static Border.Builder tsv() {
                 .escape(s -> s.replace("\t", "    "));
     }
 
+    public static Border.Builder csv() {
+        return builder()
+                .first(null)
+                .header(null)
+                .inner(null)
+                .row(Line.builder().left("").inner(",").right("").padded(false))
+                .last(null)
+                .escape(string -> {
+                    /*
+                     * Check if input contains commas, double quotes, or newlines
+                     */
+                    if (string.contains(",") || string.contains("\"") || string.contains("\n")) {
+
+                        /* Double any internal double quotes */
+                        final String escapedInput = string.replace("\"", "\"\"");
+
+                        /* Enclose in double quotes */
+                        return "\"" + escapedInput + "\"";
+
+                    } else {
+
+                        return string;
+                    }
+                });
+    }
+
+
+
+
     public static Builder builder() {
         return new Builder();
     }

diff --git a/tomitribe-crest/src/test/java/org/tomitribe/crest/table/TableTest.java b/tomitribe-crest/src/test/java/org/tomitribe/crest/table/TableTest.java
@@ -212,6 +212,33 @@ public void tsvEscaping() {
                 "This is a row with only one cell\t\t\t\n", actual);
     }
 
+    @Test
+    public void csv() {
+        assertTable(Border::csv, "" +
+                "Col1,Col2,Col3,Numeric Column\n" +
+                "Value 1,Value 2,123,10.0\n" +
+                "Separate,cols,with a tab or 4 spaces,\"-2,027.1\"\n" +
+                "This is a row with only one cell,,,\n");
+    }
+
+    @Test
+    public void csvEscaping() {
+        final Data data = Data.builder().headings(true)
+                .row("Col1", "Col2", "Col3", "Numeric Column")
+                .row("Value,1", "Value \"2", "123", "10.0")
+                .row("Separate", "cols", "with a \"tab\" or, 4 spaces", "-2,027.1")
+                .row("This is a row with only one cell")
+                .build();
+
+        final Table table = new Table(data, ((Supplier<Border.Builder>) Border::csv).get().build(), 300);
+        final String actual = table.format();
+        Assert.assertEquals("" +
+                "Col1,Col2,Col3,Numeric Column\n" +
+                "\"Value,1\",\"Value \"\"2\",123,10.0\n" +
+                "Separate,cols,\"with a \"\"tab\"\" or, 4 spaces\",\"-2,027.1\"\n" +
+                "This is a row with only one cell,,,\n", actual);
+    }
+
 
     public void assertTable(final Supplier<Border.Builder> border, final String expected) {
         final Table table = new Table(data, border.get().build(), 300);