@suffolklitlab/alkiln 5.8.1-feat2columns2 → 5.8.1-feat2columns3

package/.github/workflows/github_server.yml

@@ -88,5 +88,5 @@ jobs:
           #### Developer note: Useful for temporarily shortening ALKiln tests
           #### to debug the docker install step
           # ALKILN_TAG_EXPRESSION: @a_tag_expression
-          ALKILN_VERSION: 5.8.1-feat2columns2
+          ALKILN_VERSION: 5.8.1-feat2columns3
 

package/.github/workflows/playground.yml

@@ -55,4 +55,4 @@ jobs:
           #### to debug the docker install step
           # ALKILN_TAG_EXPRESSION: @a_tag_expression
           #### Developer note: you probalby don't need this
-          ALKILN_VERSION: 5.8.1-feat2columns2
+          ALKILN_VERSION: 5.8.1-feat2columns3

package/CHANGELOG.md

@@ -45,6 +45,10 @@ Format:
 
 <!-- ## [Unreleased] -->
 
+### Added
+
+- 2-column Story Tables that work without the trigger variable. Now column 1, "var", should only contain the actual variable name with no proxies (x, i, j, etc). For example, instead of `x[i].name.first` the var column should now contain `users[0].name.first`. Column 2 is the same as it was before - the answer for the field. See [#582](https://github.com/SuffolkLITLab/ALKiln/issues/582).
+
 ## [5.8.1] - 2023-12-28
 
 ### Fixed

package/lib/scope.js

@@ -721,51 +721,6 @@ module.exports = {
     return result;
   },  // Ends scope.getLoadData()
 
-  // three_column_table_warning: async function ( scope, { var_data=null, raw_var_data=null }) {
-
-  // },
-
-  // normalize_table_base: async function ( scope, { var_data=null, raw_var_data=null }) {
-  //   /* Return data derived from cucumber variable-setting data, from either an object format
-  //    * (var_data) or an array format (raw_var_data). `var_data` only is used when calling
-  //    * normalizeTable internally.
-  //    *
-  //    * Takes care of the shared funcitonality that needs to happen to all tables.
-  //    */
-
-  //   if (!var_data && ! raw_var_data) {
-  //     let no_data_msg = `ALKiln Internal error: normalizeTable called w/o var_data or raw_var_data:` +
-  //         ` open an issue at https://github.com/SuffolkLITLab/ALKiln/issues/new if you see this!`;
-  //     reports.addToReport( scope, { type: `error`, value: no_data_msg });
-  //     throw Error(no_data_msg);
-  //   }
-
-  //   // Always use the raw var data if present; it has the full first row
-  //   if (raw_var_data) {
-  //     var_data = raw_var_data.hashes();
-  //     if (!('var' in var_data[0]) || !('value' in var_data[0])) {
-  //       let raw_array = raw_var_data.raw();
-  //       var_data = [];
-  //       for (let row_raw of raw_array) {
-  //         if (row_raw.length < 2) {
-  //           let bad_table_msg = `Your Story Table has less than 2 columns.`
-  //               + ` Take another look at Story Table documentation at`
-  //               + ` https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#story-tables.`
-  //           reports.addToReport( scope, { type: `error`, value: bad_table_msg})
-  //           throw Error(bad_table_msg);
-  //         } else if (row_raw.length == 2) {
-  //           var_data.push({var: row_raw[0], value: row_raw[1]});
-  //         } else {
-  //           var_data.push({var: row_raw[0], value: row_raw[1], trigger: row_raw[2]});
-  //         }
-  //       }
-  //     }
-  //   }
-
-
-
-  // },
-
   normalizeTable: async function ( scope, { var_data=null, raw_var_data=null }) {
     /* Return data derived from cucumber variable-setting data, from either an object format
      * (var_data) or an array format (raw_var_data). `var_data` only is used when calling
@@ -1482,9 +1437,12 @@ module.exports = {
 
       let multiple_matches_msg = `Do you have a duplicate story table row? `
         + `Multiple story table rows match this field's variable name. `
-        + `The test will use the last row that matched. See `
-        + `https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#trigger.`
-        + `\nThe matching rows:\n${ rows_as_story_table.join(`\n`) }`
+        + `The test will use the last row that matched.`
+
+      if ( trigger_might_be_needed ) {
+        multiple_matches_msg += ` See https://suffolklitlab.org/docassemble-AssemblyLine-documentation/docs/alkiln/#trigger.`
+      }
+      multiple_matches_msg += `\nThe matching rows:\n${ rows_as_story_table.join(`\n`) }`
         + `\nThis field's data:\n${ JSON.stringify( field )}`;
       reports.addToReport(scope, { type: `warning`, value: multiple_matches_msg });
     }
@@ -2148,24 +2106,21 @@ module.exports = {
 
     // If all table rows must be used and any table row was not, error
     if ( ensure_all_vars_used ) {
-      let num_unused_rows = 0;
       for ( let row of var_data ) {
         if ( row.times_used === 0 ) {
-          num_unused_rows += 1;
+          let values_used_status = 'The page is missing a value';
           let source_row = row;
           // TODO: Make the row object flatter so we don't need to dig in this way
           if ( row.source ) { source_row = row.source; }
           let original_row = source_row.original;
-          let msg = `Did not find a field on this page for the variable "${ original_row.var }" that could be set to "${ original_row.value }"`;
-          reports.addToReport(scope, { type: `warning`, value: msg });
+          let { id } = await scope.examinePageID( scope, 'none to match' );
+          let msg = `In a linear Step all the values you give MUST be filled in, but ALKiln was unable `
+            + `to find a field on the page "${id}" for the variable "${ original_row.var }" that `
+            + `could be set to "${ original_row.value }". See this Scenario's HTML file for details.`;
+          reports.addToReport(scope, { type: `error`, value: msg });
+          expect( values_used_status, msg ).to.equal( '' );
         }
       }
-      if ( num_unused_rows > 0 ) {
-        let { id } = await scope.examinePageID( scope, 'none to match' );
-        let msg = `Error on page "${id}". See screenshot and see text above for more details.`;
-        reports.addToReport(scope, { type: `error`, value: msg });
-        expect( num_unused_rows, msg ).to.equal( 0 );
-      }
     }
 
     // If didn't already press a continue button, press one now.

package/lib/steps.js

@@ -297,7 +297,9 @@ Given(/the max(?:imum)? sec(?:ond)?s for each step (?:in this scenario )?is (\d+
 // Story
 //#####################################
 //#####################################
-
+// TODO: Consider more permissive sentences:
+// with(?: this data| these answers)?:?
+// with(?:.*):?
 When(/^(?:the user gets)?(?:I get)? to ?(?:the)?(?: ?question)?(?: id)? "([^"]+)" with this data:?/, {timeout: -1}, async (target_id, raw_var_data) => {
   /* NO CUCUMBER TIMEOUT. Must handle timeout ourselves:
   * https://github.com/cucumber/cucumber-js/blob/master/docs/support_files/timeouts.md#disable-timeouts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.8.1-feat2columns2",
+  "version": "5.8.1-feat2columns3",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {