tabledata: add withNewKeyColumns (#732)

Author: MykolaGolubyev

webtau-core-groovy/src/test/groovy/org/testingisdocumenting/webtau/data/table/TableDataGroovyTest.groovy

@@ -93,10 +93,35 @@ class TableDataGroovyTest {
         validateSimpleTableDataAfterReplace(newTableData)
     }
 
+    @Test
+    void "access by key column"() {
+        TableData tableData = createTableWithKeyColumns()
+        findByKeyAndValidate(tableData)
+    }
+
+    @Test
+    void "should change key columns and validate uniqueness"() {
+        def tableData = createTableWithKeyColumns()
+        code {
+            changeKeyColumns(tableData)
+        } should throwException("duplicate entry found with key: [N, T]\n" +
+                "{id=id1, Name=N, Type=T}\n" +
+                "{id=id3, Name=N, Type=T}")
+    }
+
     private static TableData replaceValue(TableData tableData) {
         tableData.replace("v1b", "v1b_")
     }
 
+    private static TableData changeKeyColumns(TableData tableData) {
+        tableData.withNewKeyColumns("Name", "Type")
+    }
+
+    private static void findByKeyAndValidate(TableData tableData) {
+        def found = tableData.find(key("id2"))
+        found.Name.should == "N2"
+    }
+
     @Test
     void "should ignore underscore under header"() {
         def table = ["hello" | "world"] {
@@ -162,4 +187,12 @@ class TableDataGroovyTest {
          "Bob"  | cell.above                | increment
          "Mike" | cell.above                | increment }
     }
+
+    static TableData createTableWithKeyColumns() {
+        ["*id" | "Name" | "Type"] {
+        ___________________________
+         "id1" | "N"    | "T"
+         "id2" | "N2"   | "T2"
+         "id3" | "N"    | "T" }
+    }
 }

webtau-core/src/main/java/org/testingisdocumenting/webtau/WebTauCore.java

@@ -21,6 +21,7 @@
 import org.testingisdocumenting.webtau.data.table.TableData;
 import org.testingisdocumenting.webtau.data.table.TableDataUnderscore;
 import org.testingisdocumenting.webtau.data.table.autogen.TableDataCellValueGenFunctions;
+import org.testingisdocumenting.webtau.data.table.header.CompositeKey;
 import org.testingisdocumenting.webtau.documentation.CoreDocumentation;
 import org.testingisdocumenting.webtau.expectation.ActualPath;
 import org.testingisdocumenting.webtau.persona.Persona;
@@ -50,6 +51,10 @@ public static TableData table(Object... columnNames) {
         return new TableData(Arrays.stream(columnNames));
     }
 
+    public static CompositeKey key(Object... values) {
+        return new CompositeKey(Arrays.stream(values));
+    }
+
     public static MultiValue permute(Object atLeastOneValue, Object... values) {
         return new MultiValue(atLeastOneValue, values);
     }

webtau-core/src/main/java/org/testingisdocumenting/webtau/data/table/TableData.java

@@ -70,6 +70,23 @@ public Integer findRowIdxByKey(CompositeKey key) {
         return rowIdxByKey.get(key);
     }
 
+    /**
+     * create new table data with the data of a current one but with new key columns.
+     * can be used to validate new key columns uniqueness
+     * @param keyColumns new key columns
+     * @return new table data with updated key columns
+     */
+    public TableData withNewKeyColumns(String... keyColumns) {
+        TableDataHeader newHeader = new TableDataHeader(header.getNamesStream(), Arrays.stream(keyColumns));
+        TableData withNewHeader = new TableData(newHeader);
+
+        for (Record originalRow : rows) {
+            withNewHeader.addRow(newHeader.createRecord(originalRow.valuesStream()));
+        }
+
+        return withNewHeader;
+    }
+
     /**
      * @param values row values combined in one vararg
      * @return populate table data instance

webtau-core/src/main/java/org/testingisdocumenting/webtau/data/table/header/CompositeKey.java

@@ -1,4 +1,5 @@
 /*
+ * Copyright 2020 webtau maintainers
  * Copyright 2019 TWO SIGMA OPEN SOURCE, LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -27,7 +28,7 @@
  * Composite key to be used in structures like {@link TableData}.
  */
 public class CompositeKey {
-    private List<Object> values;
+    private final List<Object> values;
 
     public CompositeKey(Stream<Object> values) {
         this.values = values

webtau-core/src/main/java/org/testingisdocumenting/webtau/data/table/header/TableDataHeader.java

@@ -19,29 +19,29 @@
 
 import org.testingisdocumenting.webtau.data.table.Record;
 
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
+import java.util.stream.Collectors;
 import java.util.stream.IntStream;
 import java.util.stream.Stream;
 
 public class TableDataHeader {
-    private final Map<String, Integer> indexByName;
-    private final List<String> namesByIndex;
+    private final Map<String, Integer> indexByName = new HashMap<>();
+    private final List<String> namesByIndex = new ArrayList<>();
 
+    private final List<Integer> keyIdx = new ArrayList<>();
     private final List<String> keyNames;
-    private final List<Integer> keyIdx;
 
     public TableDataHeader(Stream<String> names) {
-        this.indexByName = new HashMap<>();
-        this.namesByIndex = new ArrayList<>();
         this.keyNames = new ArrayList<>();
-        this.keyIdx = new ArrayList<>();
-
         names.forEach(this::add);
     }
 
+    public TableDataHeader(Stream<String> names, Stream<String> keyNames) {
+        this.keyNames = new ArrayList<>();
+        Set<String> keyNamesAsSet = keyNames.collect(Collectors.toSet());
+        names.forEach(name -> add(name, keyNamesAsSet.contains(name)));
+    }
+
     public Record createRecord(Stream<Object> values) {
         return new Record(this, values);
     }
@@ -82,9 +82,13 @@ private void add(String nameWithMeta) {
         boolean startsWithAsterisk = nameWithMeta.startsWith("*");
 
         String name = startsWithAsterisk ? nameWithMeta.substring(1) : nameWithMeta;
+        add(name, startsWithAsterisk);
+    }
+
+    private void add(String name, boolean isKeyColumn) {
         int newIdx = namesByIndex.size();
 
-        if (startsWithAsterisk) {
+        if (isKeyColumn) {
             keyNames.add(name);
             keyIdx.add(newIdx);
         }
@@ -95,6 +99,7 @@ private void add(String nameWithMeta) {
         }
 
         namesByIndex.add(name);
+
     }
 
     public String columnNameByIdx(int idx) {

webtau-core/src/test/groovy/org/testingisdocumenting/webtau/data/table/TableDataHeaderTest.groovy

@@ -40,8 +40,8 @@ class TableDataHeaderTest {
 
     @Test
     void "defines key columns using asterisk in front of column name"() {
-        assert header.getKeyNamesStream().collect(toList()) == ["ColumnB", "ColumnC"]
-        assert header.getKeyIdxStream().collect(toList()) == [1, 2]
+        assert header.keyNamesStream.collect(toList()) == ["ColumnB", "ColumnC"]
+        assert header.keyIdxStream.collect(toList()) == [1, 2]
     }
 
     @Test
@@ -51,4 +51,15 @@ class TableDataHeaderTest {
         def keyLessHeader = new TableDataHeader(Stream.of("ColumnA", "ColumnB"))
         assert ! keyLessHeader.hasKeyColumns()
     }
+
+    @Test
+    void "define key columns as a second parameter to constructor"() {
+        def header = new TableDataHeader(Stream.of("ColumnA", "ColumnB", "ColumnC", "ColumnD"),
+                Stream.of("ColumnB", "ColumnC"))
+
+        assert header.columnIdxByName("ColumnB") == 1
+        assert header.has("ColumnC")
+        assert header.keyNamesStream.collect(toList()) == ["ColumnB", "ColumnC"]
+        assert header.keyIdxStream.collect(toList()) == [1, 2]
+    }
 }

webtau-core/src/test/java/org/testingisdocumenting/webtau/data/table/TableDataJavaTest.java

@@ -24,6 +24,7 @@
 import java.time.LocalDate;
 import java.time.format.DateTimeFormatter;
 
+import static org.testingisdocumenting.webtau.Matchers.code;
 import static org.testingisdocumenting.webtau.WebTauCore.*;
 import static org.testingisdocumenting.webtau.data.table.TableDataJavaTestValidations.*;
 
@@ -98,10 +99,36 @@ public void shouldReplaceSingleSpecifiedValue() {
         saveTableWithDate(newTableData, "table-after-replace");
     }
 
+    @Test
+    public void accessByKeyColumn() {
+        TableData tableData = createTableWithKeyColumns();
+        findByKeyAndValidate(tableData);
+    }
+
+    @Test
+    public void shouldChangeKeyColumnsAndValidateUniqueness() {
+        TableData tableData = createTableWithKeyColumns();
+
+        code(() ->
+            changeKeyColumns(tableData)
+        ).should(throwException("duplicate entry found with key: [N, T]\n" +
+                "{id=id1, Name=N, Type=T}\n" +
+                "{id=id3, Name=N, Type=T}"));
+    }
+
     private static TableData replaceValue(TableData tableData) {
         return tableData.replace("v1b", "v1b_");
     }
 
+    private static TableData changeKeyColumns(TableData tableData) {
+        return tableData.withNewKeyColumns("Name", "Type");
+    }
+
+    private static void findByKeyAndValidate(TableData tableData) {
+        Record found = tableData.find(key("id2"));
+        actual(found.get("Name")).should(equal("N2"));
+    }
+
     private static TableData createTableDataSeparateValues() {
         return table("Col A", "Col B", "Col C").values(
                        "v1a",   "v1b", "v1c",
@@ -161,6 +188,14 @@ private static TableData createTableDataWithAboveRefAndMathExtracted() {
                      "Mike", cell.above               , increment);
     }
 
+    static TableData createTableWithKeyColumns() {
+        return table("*id" , "Name" , "Type",
+                     _______________________,
+                     "id1" , "N"    , "T",
+                     "id2" , "N2"   , "T2",
+                     "id3" , "N"    , "T");
+    }
+    
     private void saveTableWithDate(TableData tableData, String artifactName) {
         DocumentationArtifacts.createAsJson(TableDataJavaTest.class, artifactName,
                 tableData

webtau-docs/znai/reference/table-data.md

@@ -24,6 +24,40 @@ Java:
 :include-java: org/testingisdocumenting/webtau/data/table/TableDataJavaTest.java {entry: "createTableDataSeparateValues", bodyOnly: true, removeReturn: true, removeSemicolon: true}
 ```
 
+# Key Columns
+
+Use `*` in front of a column to specify it as a key column
+
+```tabs
+Groovy:
+:include-groovy: org/testingisdocumenting/webtau/data/table/TableDataGroovyTest.groovy {entry: "createTableWithKeyColumns", bodyOnly: true}
+
+Java:
+:include-java: org/testingisdocumenting/webtau/data/table/TableDataJavaTest.java {entry: "createTableWithKeyColumns", bodyOnly: true, removeReturn: true, removeSemicolon: true}
+```
+
+To access a value by key column
+
+```tabs
+Groovy:
+:include-groovy: org/testingisdocumenting/webtau/data/table/TableDataGroovyTest.groovy {entry: "findByKeyAndValidate", bodyOnly: true}
+
+Java:
+:include-java: org/testingisdocumenting/webtau/data/table/TableDataJavaTest.java {entry: "findByKeyAndValidate", bodyOnly: true}
+```
+
+To change key columns of an existing table
+
+```tabs
+Groovy:
+:include-groovy: org/testingisdocumenting/webtau/data/table/TableDataGroovyTest.groovy {entry: "changeKeyColumns", bodyOnly: true}
+
+Java:
+:include-java: org/testingisdocumenting/webtau/data/table/TableDataJavaTest.java {entry: "changeKeyColumns", bodyOnly: true, removeReturn: true, removeSemicolon: true}
+```
+
+Note: `withNewKeyColumns` creates new table and validates new key column uniqueness
+
 # Permutations
 
 Use `permute(v1, v2)` to automatically generate multiple rows.