F!! MarkdownTable is consistent width by default per column

ScottBob · ScottBob · commit 2b2102b3779b · 2022-06-30T15:42:35.000-05:00
diff --git a/approvaltests-tests/src/test/java/org/approvaltests/StoryBoardTest.gameOfLifeInMarkdown.approved.md b/approvaltests-tests/src/test/java/org/approvaltests/StoryBoardTest.gameOfLifeInMarkdown.approved.md
@@ -2,67 +2,67 @@
 
 
 ### Initial:
-|     | 0 | 1 | 2 | 3 | 4 |
-|-----|---|---|---|---|---|
-|**0**| . | . | . | . | . |
-|**1**| . | . | . | . | . |
-|**2**| . | x | x | x | . |
-|**3**| . | . | . | . | . |
-|**4**| . | . | . | . | . |
+|       | 0 | 1 | 2 | 3 | 4 |
+|-------|---|---|---|---|---|
+| **0** | . | . | . | . | . |
+| **1** | . | . | . | . | . |
+| **2** | . | x | x | x | . |
+| **3** | . | . | . | . | . |
+| **4** | . | . | . | . | . |
 
 
 ### Start Game:
-|     | 0 | 1 | 2 | 3 | 4 |
-|-----|---|---|---|---|---|
-|**0**| . | . | . | . | . |
-|**1**| . | . | x | . | . |
-|**2**| . | . | x | . | . |
-|**3**| . | . | x | . | . |
-|**4**| . | . | . | . | . |
+|       | 0 | 1 | 2 | 3 | 4 |
+|-------|---|---|---|---|---|
+| **0** | . | . | . | . | . |
+| **1** | . | . | x | . | . |
+| **2** | . | . | x | . | . |
+| **3** | . | . | x | . | . |
+| **4** | . | . | . | . | . |
 
 
 ### Frame #2:
-|     | 0 | 1 | 2 | 3 | 4 |
-|-----|---|---|---|---|---|
-|**0**| . | . | . | . | . |
-|**1**| . | . | . | . | . |
-|**2**| . | x | x | x | . |
-|**3**| . | . | . | . | . |
-|**4**| . | . | . | . | . |
+|       | 0 | 1 | 2 | 3 | 4 |
+|-------|---|---|---|---|---|
+| **0** | . | . | . | . | . |
+| **1** | . | . | . | . | . |
+| **2** | . | x | x | x | . |
+| **3** | . | . | . | . | . |
+| **4** | . | . | . | . | . |
 
 
 `setting alive: *`  
 `setting dead: _`  
 
 
 ### Frame #3:
-|     | 0 | 1 | 2 | 3 | 4 |
-|-----|---|---|---|---|---|
-|**0**| _ | _ | _ | _ | _ |
-|**1**| _ | _ | * | _ | _ |
-|**2**| _ | _ | * | _ | _ |
-|**3**| _ | _ | * | _ | _ |
-|**4**| _ | _ | _ | _ | _ |
+|       | 0 | 1 | 2 | 3 | 4 |
+|-------|---|---|---|---|---|
+| **0** | _ | _ | _ | _ | _ |
+| **1** | _ | _ | * | _ | _ |
+| **2** | _ | _ | * | _ | _ |
+| **3** | _ | _ | * | _ | _ |
+| **4** | _ | _ | _ | _ | _ |
 
 
 ### Frame #4:
-|     | 0 | 1 | 2 | 3 | 4 |
-|-----|---|---|---|---|---|
-|**0**| _ | _ | _ | _ | _ |
-|**1**| _ | _ | _ | _ | _ |
-|**2**| _ | * | * | * | _ |
-|**3**| _ | _ | _ | _ | _ |
-|**4**| _ | _ | _ | _ | _ |
+|       | 0 | 1 | 2 | 3 | 4 |
+|-------|---|---|---|---|---|
+| **0** | _ | _ | _ | _ | _ |
+| **1** | _ | _ | _ | _ | _ |
+| **2** | _ | * | * | * | _ |
+| **3** | _ | _ | _ | _ | _ |
+| **4** | _ | _ | _ | _ | _ |
 
 
 `setting dead:  `  
 
 
 ### Frame #5:
-|     | 0 | 1 | 2 | 3 | 4 |
-|-----|---|---|---|---|---|
-|**0**|   |   |   |   |   |
-|**1**|   |   | * |   |   |
-|**2**|   |   | * |   |   |
-|**3**|   |   | * |   |   |
-|**4**|   |   |   |   |   |
+|       | 0 | 1 | 2 | 3 | 4 |
+|-------|---|---|---|---|---|
+| **0** |   |   |   |   |   |
+| **1** |   |   | * |   |   |
+| **2** |   |   | * |   |   |
+| **3** |   |   | * |   |   |
+| **4** |   |   |   |   |   |
diff --git a/approvaltests-tests/src/test/java/org/approvaltests/TableTest.abilityModifier.approved.md b/approvaltests-tests/src/test/java/org/approvaltests/TableTest.abilityModifier.approved.md
@@ -1,22 +1,22 @@
 | Score | Modifier |
-| --- | --- |
-| 1 | -5 |
-| 2 | -4 |
-| 3 | -4 |
-| 4 | -3 |
-| 5 | -3 |
-| 6 | -2 |
-| 7 | -2 |
-| 8 | -1 |
-| 9 | -1 |
-| 10 | 0 |
-| 11 | 0 |
-| 12 | 1 |
-| 13 | 1 |
-| 14 | 2 |
-| 15 | 2 |
-| 16 | 3 |
-| 17 | 3 |
-| 18 | 4 |
-| 19 | 4 |
-| 20 | 5 |
+|-------|----------|
+|   1   |    -5    |
+|   2   |    -4    |
+|   3   |    -4    |
+|   4   |    -3    |
+|   5   |    -3    |
+|   6   |    -2    |
+|   7   |    -2    |
+|   8   |    -1    |
+|   9   |    -1    |
+|  10   |    0     |
+|  11   |    0     |
+|  12   |    1     |
+|  13   |    1     |
+|  14   |    2     |
+|  15   |    2     |
+|  16   |    3     |
+|  17   |    3     |
+|  18   |    4     |
+|  19   |    4     |
+|  20   |    5     |
diff --git a/approvaltests-tests/src/test/java/org/approvaltests/TableTest.differentCases.approved.md b/approvaltests-tests/src/test/java/org/approvaltests/TableTest.differentCases.approved.md
@@ -1,6 +1,6 @@
-| Input | Camel Case | Snake Case | Kebab Case |
-| --- | --- | --- | --- |
-| verify json | verifyJson | verify_json | verify-json |
-| verify all | verifyAll | verify_all | verify-all |
+|       Input       |    Camel Case    |    Snake Case     |    Kebab Case     |
+|-------------------|------------------|-------------------|-------------------|
+|    verify json    |    verifyJson    |    verify_json    |    verify-json    |
+|    verify all     |    verifyAll     |    verify_all     |    verify-all     |
 | verify parameters | verifyParameters | verify_parameters | verify-parameters |
-| verify as json | verifyAsJson | verify_as_json | verify-as-json |
+|  verify as json   |   verifyAsJson   |  verify_as_json   |  verify-as-json   |
diff --git a/approvaltests-util-tests/src/test/java/com/spun/util/DateUtilsTest.java b/approvaltests-util-tests/src/test/java/com/spun/util/DateUtilsTest.java
@@ -1,6 +1,5 @@
 package com.spun.util;
 
-import org.apache.commons.lang3.time.DatePrinter;
 import org.approvaltests.utils.WithTimeZone;
 import org.junit.jupiter.api.Test;
 
@@ -17,8 +16,10 @@
 
 public class DateUtilsTest
 {
-  private StartAndEndUseCases[] startAndEndUseCases = {new StartAndEndUseCases(Calendar.YEAR,
-      "2003.05.03 15:20:20:123", "2003.01.01 00:00:00:000", "2003.12.31 23:59:59:999")};
+  private StartAndEndUseCases[] getStartAndEndUseCases() {
+    return new StartAndEndUseCases[] {new StartAndEndUseCases(Calendar.YEAR,
+            "2003.05.03 15:20:20:123", "2003.01.01 00:00:00:000", "2003.12.31 23:59:59:999")};
+  }
   @Test
   public void testToDate()
   {
@@ -39,15 +40,19 @@ private String toUtc(Date toDate)
   @Test
   public void testStartAndEndUseCases()
   {
-    for (int i = 0; i < startAndEndUseCases.length; i++)
+    try (WithTimeZone t = new WithTimeZone())
     {
-      assertStartAndEnd(startAndEndUseCases[i]);
+      StartAndEndUseCases[] startAndEndUseCases = getStartAndEndUseCases();
+      for (int i = 0; i < startAndEndUseCases.length; i++)
+      {
+        assertStartAndEnd(startAndEndUseCases[i]);
+      }
     }
   }
   private void assertStartAndEnd(StartAndEndUseCases useCase)
   {
-    assertEquals(useCase.start, DateUtils.getStartOf(useCase.unit, useCase.date), "Start date ");
-    assertEquals(useCase.end, DateUtils.getEndOf(useCase.unit, useCase.date), "End date ");
+      assertEquals(useCase.start, DateUtils.getStartOf(useCase.unit, useCase.date), "Start date ");
+      assertEquals(useCase.end, DateUtils.getEndOf(useCase.unit, useCase.date), "End date ");
   }
   @Test
   public void testNextAndLast()
diff --git a/approvaltests-util/src/main/java/com/spun/util/MarkdownTable.java b/approvaltests-util/src/main/java/com/spun/util/MarkdownTable.java
@@ -6,7 +6,7 @@
 public class MarkdownTable implements MarkdownCompatible
 {
   public Queryable<MarkdownTableElement> markdown = new Queryable<MarkdownTableElement>(MarkdownTableElement.class);
-  private boolean fixedWidth = false;
+  private boolean fixedWidth = true;
   
   public void setColumnsConsistentWidth(boolean setting) {
     fixedWidth = setting;
@@ -63,7 +63,10 @@ private void handleFixedWidth() {
     for (int column = 0; column < rows.get(0).size(); column++) {
       int col = column;
       if (rows.get(0).get(column) instanceof MarkdownTableContents) {
-          Queryable<MarkdownTableContents> select = rows.select(e -> e.get(col)).where(e -> e instanceof MarkdownTableContents).select(e -> (MarkdownTableContents) e);
+          Queryable<Resizable> select = rows
+                  .select(e -> e.get(col))
+                  .where(e -> e instanceof Resizable)
+                  .select(e -> (Resizable) e);
           int length = select.max(e -> e.getLength()).getLength();
           select.forEach(e -> e.setPadding(length));
       }
@@ -77,7 +80,12 @@ public static String printColumnHeaders(String... headers)
   public static Queryable<MarkdownTableElement> constructColumnHeaders(String... headers)
   {
     Queryable<MarkdownTableElement> row = constructRow(headers);
-    row.addAll(constructRow(ArrayUtils.of("---", headers.length)));
+    for (int i = 0; i < headers.length; i++) {
+      row.add(MarkdownTableElement.DELIMITER);
+      row.add(new MarkdownTableHeader());
+    }
+    row.add(MarkdownTableElement.DELIMITER);
+    row.add(MarkdownTableElement.NEWLINE);
     return row;
   }
   public static String printRow(Object... columns)
diff --git a/approvaltests-util/src/main/java/com/spun/util/MarkdownTableContents.java b/approvaltests-util/src/main/java/com/spun/util/MarkdownTableContents.java
@@ -1,6 +1,6 @@
 package com.spun.util;
 
-public class MarkdownTableContents implements MarkdownTableElement {
+public class MarkdownTableContents implements MarkdownTableElement, Resizable {
     private String contents;
     private int padUntil;
 
diff --git a/approvaltests-util/src/main/java/com/spun/util/MarkdownTableHeader.java b/approvaltests-util/src/main/java/com/spun/util/MarkdownTableHeader.java
@@ -0,0 +1,22 @@
+package com.spun.util;
+
+public class MarkdownTableHeader implements MarkdownTableElement, Resizable {
+    private int padUntil = 1;
+
+    public MarkdownTableHeader() {
+    }
+
+    @Override
+    public String toString() {
+        int dashes = padUntil + 2; // Math.max(3, padUntil + 2);
+        return "----------------------------------".substring(0, dashes);
+    }
+
+    public int getLength() {
+        return 1;
+    }
+
+    public void setPadding(int length) {
+        padUntil = length;
+    }
+}
diff --git a/approvaltests-util/src/main/java/com/spun/util/Resizable.java b/approvaltests-util/src/main/java/com/spun/util/Resizable.java
@@ -0,0 +1,6 @@
+package com.spun.util;
+
+public interface Resizable {
+    public int getLength();
+    public void setPadding(int length);
+}

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`package com.spun.util;`
`2`	`2`
`3`		`-import org.apache.commons.lang3.time.DatePrinter;`
`4`	`3`	`import org.approvaltests.utils.WithTimeZone;`
`5`	`4`	`import org.junit.jupiter.api.Test;`
`6`	`5`
`@@ -17,8 +16,10 @@`
`17`	`16`
`18`	`17`	`public class DateUtilsTest`
`19`	`18`	`{`
`20`		`- private StartAndEndUseCases[] startAndEndUseCases = {new StartAndEndUseCases(Calendar.YEAR,`
`21`		`- "2003.05.03 15:20:20:123", "2003.01.01 00:00:00:000", "2003.12.31 23:59:59:999")};`
	`19`	`+ private StartAndEndUseCases[] getStartAndEndUseCases() {`
	`20`	`+ return new StartAndEndUseCases[] {new StartAndEndUseCases(Calendar.YEAR,`
	`21`	`+ "2003.05.03 15:20:20:123", "2003.01.01 00:00:00:000", "2003.12.31 23:59:59:999")};`
	`22`	`+ }`
`22`	`23`	`@Test`
`23`	`24`	`public void testToDate()`
`24`	`25`	`{`
`@@ -39,15 +40,19 @@ private String toUtc(Date toDate)`
`39`	`40`	`@Test`
`40`	`41`	`public void testStartAndEndUseCases()`
`41`	`42`	`{`
`42`		`- for (int i = 0; i < startAndEndUseCases.length; i++)`
	`43`	`+ try (WithTimeZone t = new WithTimeZone())`
`43`	`44`	`{`
`44`		`- assertStartAndEnd(startAndEndUseCases[i]);`
	`45`	`+ StartAndEndUseCases[] startAndEndUseCases = getStartAndEndUseCases();`
	`46`	`+ for (int i = 0; i < startAndEndUseCases.length; i++)`
	`47`	`+ {`
	`48`	`+ assertStartAndEnd(startAndEndUseCases[i]);`
	`49`	`+ }`
`45`	`50`	`}`
`46`	`51`	`}`
`47`	`52`	`private void assertStartAndEnd(StartAndEndUseCases useCase)`
`48`	`53`	`{`
`49`		`- assertEquals(useCase.start, DateUtils.getStartOf(useCase.unit, useCase.date), "Start date ");`
`50`		`- assertEquals(useCase.end, DateUtils.getEndOf(useCase.unit, useCase.date), "End date ");`
	`54`	`+ assertEquals(useCase.start, DateUtils.getStartOf(useCase.unit, useCase.date), "Start date ");`
	`55`	`+ assertEquals(useCase.end, DateUtils.getEndOf(useCase.unit, useCase.date), "End date ");`
`51`	`56`	`}`
`52`	`57`	`@Test`
`53`	`58`	`public void testNextAndLast()`