Add toString() support for all datum types #1553 (#1802)

Author: xd1313113

CHANGELOG.md

@@ -39,6 +39,7 @@ rewritten to their query representation
 - `ABS` function support on `INTERVAL` values
 - Support for `OVERLAPS` predicate
 - Add cli option -e to load PartiQL literal data as default catalog data
+- Add toString() support for all datum types
 
 ### Changed
 

buildSrc/src/main/kotlin/partiql.versions.kt

@@ -53,6 +53,8 @@ object Versions {
     const val junit4 = "4.12"
     const val junit4Params = "1.1.1"
     const val mockito = "4.5.0"
+    const val snapshotTest = "4.0.8"
+    const val slf4j = "2.0.17"
 }
 
 object Deps {
@@ -96,6 +98,8 @@ object Deps {
     const val kotlinTestJunit = "org.jetbrains.kotlin:kotlin-test-junit5:${Versions.kotlin}"
     const val mockito = "org.mockito:mockito-junit-jupiter:${Versions.mockito}"
     const val ktlintTest = "com.pinterest.ktlint:ktlint-test:${Versions.ktlint}"
+    const val snapshotTest = "io.github.origin-energy:java-snapshot-testing-junit5:${Versions.snapshotTest}"
+    const val slf4j = "org.slf4j:slf4j-simple:${Versions.slf4j}"
 }
 
 object Plugins {

partiql-spi/build.gradle.kts

@@ -23,6 +23,8 @@ dependencies {
     api(Deps.ionElement)
     implementation(Deps.kotlinxCollections)
     testImplementation(Deps.kasechange)
+    testImplementation(Deps.snapshotTest)
+    testImplementation(Deps.slf4j)
 }
 
 tasks.shadowJar {

partiql-spi/src/main/java/org/partiql/spi/value/DatumBoolean.java

@@ -26,4 +26,12 @@ public boolean getBoolean() {
     public PType getType() {
         return _type;
     }
+
+    @Override
+    public String toString() {
+        return "DatumBoolean{" +
+                "_type=" + _type +
+                ", _value=" + _value +
+                '}';
+    }
 }

partiql-spi/src/main/java/org/partiql/spi/value/DatumByte.java

@@ -1,5 +1,6 @@
 package org.partiql.spi.value;
 
+import kotlin.text.HexFormat;
 import org.jetbrains.annotations.NotNull;
 import org.partiql.spi.types.PType;
 
@@ -31,4 +32,13 @@ public byte getByte() {
     public PType getType() {
         return _type;
     }
+
+    @Override
+    public String toString() {
+
+        return "DatumByte{" +
+                "_type=" + _type +
+                ", _value=" + _value +
+                '}';
+    }
 }

partiql-spi/src/main/java/org/partiql/spi/value/DatumBytes.java

@@ -3,6 +3,8 @@
 import org.jetbrains.annotations.NotNull;
 import org.partiql.spi.types.PType;
 
+import java.util.StringJoiner;
+
 /**
  * This shall always be package-private (internal).
  * <p></p>
@@ -34,4 +36,18 @@ public byte[] getBytes() {
     public PType getType() {
         return _type;
     }
+
+    @Override
+    public String toString() {
+        StringJoiner joiner = new StringJoiner(", ", "[", "]");
+        for (byte b : _value) {
+            joiner.add(Byte.toString(b));
+        }
+
+        return "DatumBytes{" +
+                "_type=" + _type +
+                ", _value=" + joiner +
+                '}';
+
+    }
 }

partiql-spi/src/main/java/org/partiql/spi/value/DatumChars.java

@@ -30,4 +30,12 @@ public String getString() {
     public PType getType() {
         return _type;
     }
+
+    @Override
+    public String toString() {
+        return "DatumChars{" +
+                "_type=" + _type +
+                ", _value=" + _value +
+                '}';
+    }
 }

partiql-spi/src/main/java/org/partiql/spi/value/DatumCollection.java

@@ -4,6 +4,9 @@
 import org.partiql.spi.types.PType;
 
 import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.StringJoiner;
 
 /**
  * This shall always be package-private (internal).
@@ -41,7 +44,7 @@ public PType getType() {
     public String toString() {
         return "DatumCollection{" +
                 "_type=" + _type +
-                ", _value=" + _value +
+                ", _value=" + DatumUtils.formatListToString(_value) +
                 '}';
     }
 }

partiql-spi/src/main/java/org/partiql/spi/value/DatumDate.java

@@ -35,6 +35,9 @@ public LocalDate getLocalDate() {
 
     @Override
     public String toString() {
-        return this.value.toString();
+        return "DatumDate{" +
+                "_type=" + type +
+                ", _value=" + value +
+                '}';
     }
 }

partiql-spi/src/main/java/org/partiql/spi/value/DatumDecimal.java

@@ -54,8 +54,8 @@ public int hashCode() {
     @Override
     public String toString() {
         return "DatumDecimal{" +
-                "_value=" + _value +
-                ", _type=" + _type +
+                "_type=" + _type +
+                ", _value=" + _value +
                 '}';
     }
 }