Merge pull request #6 from NeedleInAJayStack/feat/gridImprovements

Grid Improvements

Author: NeedleInAJayStack

Package.resolved

@@ -20,6 +20,34 @@ public struct Dict: Val {
         self.elements = elements
     }
 
+    public func trap(_ name: String) throws -> any Val {
+        guard let fieldVal = self.elements[name], !(fieldVal is Null) else {
+            throw DictError.tagNotFound(name)
+        }
+        return fieldVal
+    }
+    
+    public func trap<T: Val>(_ name: String, as: T.Type) throws -> T {
+        guard let fieldVal = self.elements[name], !(fieldVal is Null) else {
+            throw DictError.tagNotFound(name)
+        }
+        return try fieldVal.coerce(to: T.self)
+    }
+    
+    public func get(_ name: String) throws -> (any Val)? {
+        guard let fieldVal = self.elements[name], !(fieldVal is Null) else {
+            return nil
+        }
+        return fieldVal
+    }
+    
+    public func get<T: Val>(_ name: String, as: T.Type) throws -> T? {
+        guard let fieldVal = self.elements[name], !(fieldVal is Null) else {
+            return nil
+        }
+        return try fieldVal.coerce(to: T.self)
+    }
+    
     /// Converts to Zinc formatted string.
     /// See [Zinc Literals](https://project-haystack.org/doc/docHaystack/Zinc#literals)
     public func toZinc() -> String {
@@ -167,3 +195,7 @@ extension Dict: ExpressibleByDictionaryLiteral {
         self.elements = elements
     }
 }
+
+public enum DictError: Error {
+    case tagNotFound(String)
+}

Sources/Haystack/Dict.swift

@@ -59,7 +59,7 @@ public class GridBuilder {
     }
 
     @discardableResult
-    /// Append a new column to the grid. New columns may not be added if the builder contains rows.
+    /// Append a new column to the grid.
     /// - Parameters:
     ///   - name: The name of the new column
     ///   - meta: Column-level metadata for the new column
@@ -77,6 +77,24 @@ public class GridBuilder {
             colMeta[name] = meta
         }
 
+        rows = rows.map { row in
+            var newRow = row
+            newRow[name] = Null.val
+            return newRow
+        }
+        
+        return self
+    }
+    
+    @discardableResult
+    /// Append a list of new columns to the grid.
+    /// - Parameters:
+    ///   - names: The names of the new columns
+    /// - Returns: This instance for chaining
+    public func addCols(names: [String]) throws -> Self {
+        for name in names {
+            try self.addCol(name: name)
+        }
         return self
     }
 
@@ -102,7 +120,22 @@ public class GridBuilder {
     }
 
     @discardableResult
-    /// Append a new row to the grid. No new columns may be defined on the builder after calling this function.
+    /// Append a new row to the grid. Newly seen columns are added automatically with no metadata, although column ordering is not guaranteed.
+    /// - Parameter vals: The values of the row, in the same order as the columns.
+    /// - Returns: This instance for chaining
+    public func addRow(_ row: [String: any Val]) throws -> Self {
+        for (colName, _) in row {
+            if !colNames.contains(colName) {
+                try self.addCol(name: colName)
+            }
+        }
+        rows.append(row)
+        
+        return self
+    }
+    
+    @discardableResult
+    /// Append a new row to the grid.
     /// - Parameter vals: The values of the row, in the same order as the columns.
     /// - Returns: This instance for chaining
     public func addRow(_ vals: [any Val]) throws -> Self {
@@ -117,6 +150,17 @@ public class GridBuilder {
         rows.append(row)
         return self
     }
+    
+    @discardableResult
+    /// Append new rows to the grid.
+    /// - Parameter vals: The values of the rows, in the same order as the columns.
+    /// - Returns: This instance for chaining
+    public func addRows(_ rows: [[any Val]]) throws -> Self {
+        for row in rows {
+            try self.addRow(row)
+        }
+        return self
+    }
 }
 
 enum GridBuilderError: Error {

Sources/Haystack/Utils/GridBuilder.swift

@@ -15,6 +15,13 @@ extension Val {
 
         return self == otherAsMyType
     }
+    
+    func coerce<T: Val>(to: T.Type) throws -> T {
+        guard let coercedSelf = self as? T else {
+            throw ValError.cannotBeCoerced(self.toZinc(), T.valType)
+        }
+        return coercedSelf
+    }
 }
 
 

Sources/Haystack/Val.swift

@@ -1,5 +1,6 @@
 
 public enum ValError: Error {
+    case cannotBeCoerced(String, ValType)
     case invalidDateDefinition
     case invalidDateFormat(String)
     case invalidDateTimeDefinition

Sources/Haystack/ValError.swift

@@ -130,4 +130,24 @@ final class DictTests: XCTestCase {
             ])
         )
     }
+    
+    func testTrap() {
+        let dict: Dict = ["a": "abc", "b": null]
+        
+        try XCTAssertNoThrow(dict.trap("a"))
+        try XCTAssertEqual(dict.trap("a", as: String.self), "abc")
+        try XCTAssertThrowsError(dict.trap("a", as: Number.self))
+        try XCTAssertThrowsError(dict.trap("b"))
+        try XCTAssertThrowsError(dict.trap("c"))
+    }
+    
+    func testGet() {
+        let dict: Dict = ["a": "abc", "b": null]
+        
+        try XCTAssertNotNil(dict.get("a"))
+        try XCTAssertEqual(dict.get("a", as: String.self), "abc")
+        try XCTAssertThrowsError(dict.get("a", as: Number.self))
+        try XCTAssertNil(dict.get("b"))
+        try XCTAssertNil(dict.get("c"))
+    }
 }

Tests/HaystackTests/DictTests.swift

@@ -9,8 +9,8 @@ final class GridTests: XCTestCase {
             .addCol(name: "equip")
             .addCol(name: "siteRef")
             .addCol(name: "installed")
-            .addRow(["RTU-1", marker, Ref("153c-699a", dis: "HQ"), Date(year: 2005, month: 6, day: 1)])
-            .addRow(["RTU-2", marker, Ref("153c-699b", dis: "Library"), Date(year: 1997, month: 7, day: 12)])
+            .addRow(["dis": "RTU-1", "equip": marker, "siteRef": Ref("153c-699a", dis: "HQ"), "installed": Date(year: 2005, month: 6, day: 1)])
+            .addRow(["dis": "RTU-2", "equip": marker, "siteRef": Ref("153c-699b", dis: "Library"), "installed": Date(year: 1997, month: 7, day: 12)])
             .toGrid()
         let jsonString = #"{"_kind":"grid","meta":{"ver":"3.0","foo":"bar"},"cols":[{"name":"dis","meta":{"dis":"Equip Name"}},{"name":"equip"},{"name":"siteRef"},{"name":"installed"}],"rows":[{"dis":"RTU-1","equip":{"_kind":"marker"},"siteRef":{"_kind":"ref","val":"153c-699a","dis":"HQ"},"installed":{"_kind":"date","val":"2005-06-01"}},{"dis": "RTU-2","equip":{"_kind":"marker"},"siteRef":{"_kind":"ref","val":"153c-699b","dis":"Library"},"installed":{"_kind":"date","val":"1997-07-12"}}]}"#
 
@@ -54,8 +54,8 @@ final class GridTests: XCTestCase {
                 .addCol(name: "equip")
                 .addCol(name: "siteRef")
                 .addCol(name: "installed")
-                .addRow(["RTU-1", marker, Ref("153c-699a", dis: "HQ"), Date(year: 2005, month: 6, day: 1)])
-                .addRow(["RTU-2", marker, Ref("153c-699b", dis: "Library"), Date(year: 1997, month: 7, day: 12)])
+                .addRow(["dis": "RTU-1", "equip": marker, "siteRef": Ref("153c-699a", dis: "HQ"), "installed": Date(year: 2005, month: 6, day: 1)])
+                .addRow(["dis": "RTU-2", "equip": marker, "siteRef": Ref("153c-699b", dis: "Library"), "installed": Date(year: 1997, month: 7, day: 12)])
                 .toGrid()
                 .toZinc(),
             """
@@ -86,17 +86,17 @@ final class GridTests: XCTestCase {
             .addCol(name: "equip")
             .addCol(name: "siteRef")
             .addCol(name: "managed")
-            .addRow(["RTU-1", marker, Ref("153c-699a", dis: "HQ"), true])
-            .addRow(["RTU-2", marker, Ref("153c-699b", dis: "Library"), false])
+            .addRow(["dis": "RTU-1", "equip": marker, "siteRef": Ref("153c-699a", dis: "HQ"), "managed": true])
+            .addRow(["dis": "RTU-2", "equip": marker, "siteRef": Ref("153c-699b", dis: "Library"), "managed": false])
 
         let builder2 = try GridBuilder()
             .setMeta(["ver": "3.0", "foo": "bar"])
             .addCol(name: "dis", meta: ["dis": "Equip Name"])
             .addCol(name: "equip")
             .addCol(name: "siteRef")
             .addCol(name: "managed")
-            .addRow(["RTU-1", marker, Ref("153c-699a", dis: "HQ"), false])
-            .addRow(["RTU-2", marker, Ref("153c-699b", dis: "Library"), false])
+            .addRow(["dis": "RTU-1", "equip": marker, "siteRef": Ref("153c-699a", dis: "HQ"), "managed": false])
+            .addRow(["dis": "RTU-2", "equip": marker, "siteRef": Ref("153c-699b", dis: "Library"), "managed": false])
 
 
         // Test basic