@suffolklitlab/alkiln 3.0.9

package/tests/unit_tests/getAllFields.test.js

@@ -0,0 +1,142 @@
+const chai = require('chai');
+const expect = chai.expect;
+// We need jest or something, right? To do fancy stuff.
+
+const html = require('./html.fixtures.js');
+const fields = require('./fields.fixtures.js');
+const scope = require('../../lib/scope.js');
+const getAllFields = scope.getAllFields;
+// TODO: Rearrange fixtures so related fixtures are next to each other? e.g.
+// buttons_yesno.html, buttons_yesno.fields, buttons_yesno.table, buttons_yesno.matches
+// May make more files both to make and to import, but may be more useful
+// for editing, maintaining, and clarity.
+
+
+/* Test `scope.getAllFields()`. Discuss: If we do a good job outlining
+* what behvior the main tests cover, then we might not need to test
+* each individual function separately.
+* 
+* NOTE: scope.getField should only be concerned with the stuff in `#daquestion`
+*/
+
+// ============================
+// Standard fields - no proxies
+// ============================
+// TODO: Add more complex fields. E.g `object_checkboxes` and dropdown with `object`.
+
+// TODO: Add notes detailing what behavior each test covers, including the
+// behavior in sub-functions if they are not tested independently
+it(`creates the right data for standard fields`, async function() {
+  // 18 fields (03/15/21)
+  let result = await getAllFields( scope, { html: html.standard });
+  expect( result ).to.deep.equal( fields.standard );
+});
+
+
+// ============================
+// Simple show if fields - no proxies
+// ============================
+it(`creates the right data for 'show if' fields`, async function() {
+  let result = await getAllFields( scope, { html: html.show_if });
+  expect( result ).to.deep.equal( fields.show_if );
+});
+
+
+// ============================
+// Buttons
+// ============================
+it(`creates the right data for one continue button`, async function() {
+  // `continue button field:`
+  let result = await getAllFields( scope, { html: html.button_continue });
+  expect( result ).to.deep.equal( fields.button_continue );
+});
+
+it(`creates the right data for yesnomaybe buttons`, async function() {
+  // `yesnomaybe:`
+  let result = await getAllFields( scope, { html: html.buttons_yesnomaybe });
+  expect( result ).to.deep.equal( fields.buttons_yesnomaybe );
+});
+
+it(`creates the right data for other mutiple choice continue buttons`, async function() {
+  // `field:` and `buttons:`
+  let result = await getAllFields( scope, { html: html.buttons_other });
+  expect( result ).to.deep.equal( fields.buttons_other );
+});
+
+it(`creates the right data for an event action button`, async function() {
+  // `field:` and `action buttons:`
+  let result = await getAllFields( scope, { html: html.buttons_event_action });
+  expect( result ).to.deep.equal( fields.buttons_event_action );
+});
+
+
+// ============================
+// Proxy vars (x, i, j, ...)
+// ============================
+// x[i].name.first
+it(`creates the right data for a multi-proxy name (x[i])`, async function() {
+  let result = await getAllFields( scope, { html: html.proxies_xi });
+  expect( result ).to.deep.equal( fields.proxies_xi );
+});
+
+// Multiple proxies by the same name are on the list (because of a loop)
+// x[i].name.first
+it(`creates the right data for a multi-proxy name (x[i]) again for consistency`, async function() {
+  // same data as `proxies_xi`, but have this here for consistency
+  let result = await getAllFields( scope, { html: html.proxies_multi });
+  expect( result ).to.deep.equal( fields.proxies_multi );
+});
+
+
+// ============================
+// Signature
+// ============================
+it(`creates the right data for a signature field`, async function() {
+  // `field:` and `action buttons:`
+  let result = await getAllFields( scope, { html: html.signature });
+  expect( result ).to.deep.equal( fields.signature );
+});
+
+
+// ============================
+// `choices:`
+// ============================
+// ```
+// field: favorite_fruit
+// choices:
+//   - Apple
+//   - Orange
+// ```
+it(`creates the right data for a 'choices:' field`, async function() {
+  let result = await getAllFields( scope, { html: html.choices });
+  expect( result ).to.deep.equal( fields.choices );
+});
+
+
+// ============================
+// dropdowns created with objects
+// ============================
+// ```
+// - Something: some_var
+//   datatype: object
+//   choices:
+//     - obj1
+//     - obj2
+// ```
+it(`creates the right data for a dropdown created with an object`, async function() {
+  let result = await getAllFields( scope, { html: html.object_dropdown });
+  expect( result ).to.deep.equal( fields.object_dropdown );
+});
+
+
+// ============================
+// DOM for mixed quotes test in getMatchingRows.test.js
+// ============================
+// Why is this test useful? Or so someone might ask when looking at this closely.
+// This file runs tests for `.getAllFields()`, but also helps us generate the
+// objects in fields.fixtures.js for the `.getMatchingRows()` unit tests. The
+// following test is mostly useful for that second purpose.
+it(`creates the right data for a question whose table will have mixed quotes`, async function() {
+  let result = await getAllFields( scope, { html: html.mixed_quotes });
+  expect( result ).to.deep.equal( fields.mixed_quotes );
+});

package/tests/unit_tests/getMatchingRows.test.js

@@ -0,0 +1,261 @@
+const chai = require('chai');
+const expect = chai.expect;
+
+
+const tables = require('./tables.fixtures.js');
+const fields = require('./fields.fixtures.js');
+const matches = require('./matches.fixtures.js');
+const scope = require('../../lib/scope.js');
+const getMatchingRows = scope.getMatchingRows;
+
+// TODO: Add tests for reports
+
+// ============================
+// Helpers
+
+let getSafeName = function ( field ) {
+  let name = 'a field with no name';
+  let guess_1 = field.guesses[0];
+  if ( guess_1 ) { name = field.guesses[0].var }
+  return name;
+};
+
+// TODO: Add `testForMatches()` to reduce duplication (will run for loops)
+
+// ============================
+
+
+// ============================
+// Standard fields - no proxies, no showifs.
+// ============================
+describe("Matches: For standard fields", async function() {
+  // TODO: One of these should have a report for having two fields that match. Test the report?
+  for ( let test_i = 0; test_i < fields.standard.length; test_i++ ) {
+    let field = fields.standard[ test_i ];
+    let curr_matches = matches.standard[ test_i ];
+    let name = getSafeName( field );
+    let result = await getMatchingRows( scope, { field, var_data: tables.standard });
+    it( `finds the right matches for ${ name }`, async function() {
+      expect( result ).to.deep.equal( curr_matches );
+    });
+  }
+});
+
+
+// ============================
+// Simple show if fields - no proxies
+// ============================
+describe("For simple show if fields", async function() {
+  for ( let test_i = 0; test_i < fields.show_if.length; test_i++ ) {
+    let field = fields.show_if[ test_i ];
+    let curr_matches = matches.show_if[ test_i ];
+    let name = getSafeName( field );
+    let result = await getMatchingRows( scope, { field, var_data: tables.show_if });
+    it( `finds the right matches for ${ name }`, async function() {
+      expect( result ).to.deep.equal( curr_matches );
+    });
+  }
+});
+
+
+// ============================
+// Buttons
+// ============================
+// `continue button field:`
+describe("For one continue button", async function() {
+  for ( let test_i = 0; test_i < fields.button_continue.length; test_i++ ) {
+    let field = fields.button_continue[ test_i ];
+    let curr_matches = matches.button_continue[ test_i ];
+    let name = getSafeName( field );
+    it( `finds the right matches for ${ name }`, async function() {
+      let result = await getMatchingRows( scope, { field, var_data: tables.button_continue });
+      expect( result ).to.deep.equal( curr_matches );
+    });
+  }
+});
+
+// `yesnomaybe:`
+describe("For the 'yes' choice of yesnomaybe buttons", async function() {
+  for ( let test_i = 0; test_i < fields.buttons_yesnomaybe.length; test_i++ ) {
+    let field = fields.buttons_yesnomaybe[ test_i ];
+    let curr_matches = matches.buttons_yesnomaybe_yes[ test_i ];
+    let name = getSafeName( field );
+    it( `finds the right matches for ${ name }`, async function() {
+      let result = await getMatchingRows( scope, { field, var_data: tables.buttons_yesnomaybe_yes });
+      expect( result ).to.deep.equal( curr_matches );
+    });
+  }
+});
+describe("For the 'no' choice of yesnomaybe buttons", async function() {
+  for ( let test_i = 0; test_i < fields.buttons_yesnomaybe.length; test_i++ ) {
+    let field = fields.buttons_yesnomaybe[ test_i ];
+    let curr_matches = matches.buttons_yesnomaybe_no[ test_i ];
+    let name = getSafeName( field );
+    it( `finds the right matches for ${ name }`, async function() {
+      let result = await getMatchingRows( scope, { field, var_data: tables.buttons_yesnomaybe_no });
+      expect( result ).to.deep.equal( curr_matches );
+    });
+  }
+});
+describe("For the 'maybe' choice of yesnomaybe buttons", async function() {
+  for ( let test_i = 0; test_i < fields.buttons_yesnomaybe.length; test_i++ ) {
+    let field = fields.buttons_yesnomaybe[ test_i ];
+    let curr_matches = matches.buttons_yesnomaybe_none[ test_i ];
+    let name = getSafeName( field );
+    it( `finds the right matches for ${ name }`, async function() {
+      let result = await getMatchingRows( scope, { field, var_data: tables.buttons_yesnomaybe_none });
+      expect( result ).to.deep.equal( curr_matches );
+    });
+  }
+});
+
+// `field:` and `buttons:`
+describe("For choice 1 of other mutiple choice continue buttons", async function() {
+  for ( let test_i = 0; test_i < fields.buttons_other.length; test_i++ ) {
+    let field = fields.buttons_other[ test_i ];
+    let curr_matches = matches.buttons_other_1[ test_i ];
+    let name = getSafeName( field );
+    it( `finds the right matches for ${ name }`, async function() {
+      let result = await getMatchingRows( scope, { field, var_data: tables.buttons_other_1 });
+      expect( result ).to.deep.equal( curr_matches );
+    });
+  }
+});
+describe("For choice 2 of other mutiple choice continue buttons", async function() {
+  for ( let test_i = 0; test_i < fields.buttons_other.length; test_i++ ) {
+    let field = fields.buttons_other[ test_i ];
+    let curr_matches = matches.buttons_other_2[ test_i ];
+    let name = getSafeName( field );
+    it( `finds the right matches for ${ name }`, async function() {
+      let result = await getMatchingRows( scope, { field, var_data: tables.buttons_other_2 });
+      expect( result ).to.deep.equal( curr_matches );
+    });
+  }
+});
+describe("For choice 3 of other mutiple choice continue buttons", async function() {
+  for ( let test_i = 0; test_i < fields.buttons_other.length; test_i++ ) {
+    let field = fields.buttons_other[ test_i ];
+    let curr_matches = matches.buttons_other_3[ test_i ];
+    let name = getSafeName( field );
+    it( `finds the right matches for ${ name }`, async function() {
+      let result = await getMatchingRows( scope, { field, var_data: tables.buttons_other_3 });
+      expect( result ).to.deep.equal( curr_matches );
+    });
+  }
+});
+
+// `field:` and `action buttons:`
+describe(`For an action button`, async function() {
+  for ( let test_i = 0; test_i < fields.buttons_event_action.length; test_i++ ) {
+    let field = fields.buttons_event_action[ test_i ];
+    let curr_matches = matches.buttons_event_action[ test_i ];
+    let name = getSafeName( field );
+    it( `finds the right matches for ${ name }`, async function() {
+      let result = await getMatchingRows( scope, { field, var_data: tables.buttons_event_action });
+      expect( result ).to.deep.equal( curr_matches );
+    });
+  }
+});
+
+
+// ============================
+// Proxy vars (x, i, j, ...)
+// ============================
+// x[i].name.first
+describe(`For a multi-proxy name (x[i])`, async function() {
+  for ( let test_i = 0; test_i < fields.proxies_xi.length; test_i++ ) {
+    let field = fields.proxies_xi[ test_i ];
+    let curr_matches = matches.proxies_xi[ test_i ];
+    let name = getSafeName( field );
+    it( `finds the right matches for ${ name }`, async function() {
+      let result = await getMatchingRows( scope, { field, var_data: tables.proxies_xi });
+      expect( result ).to.deep.equal( curr_matches );
+    });
+  }
+});
+
+// Multiple proxies by the same name are on the list (because of a loop)
+// x[i].name.first
+describe(`For mulitple rows with the same proxies`, async function() {
+  for ( let test_i = 0; test_i < fields.proxies_multi.length; test_i++ ) {
+    let field = fields.proxies_multi[ test_i ];
+    let curr_matches = matches.proxies_multi[ test_i ];
+    let name = getSafeName( field );
+    it( `finds the right matches for ${ name }`, async function() {
+      let result = await getMatchingRows( scope, { field, var_data: tables.proxies_multi });
+      expect( result ).to.deep.equal( curr_matches );
+    });
+  }
+});
+
+
+// ============================
+// Signature
+// ============================
+describe(`For a signature field`, async function() {
+  for ( let test_i = 0; test_i < fields.signature.length; test_i++ ) {
+    let field = fields.signature[ test_i ];
+    let curr_matches = matches.signature[ test_i ];
+    let name = getSafeName( field );
+    it( `finds the right matches for ${ name }`, async function() {
+      let result = await getMatchingRows( scope, { field, var_data: tables.signature });
+      expect( result ).to.deep.equal( curr_matches );
+    });
+  }
+});
+
+
+// ============================
+// `choices:`
+// ============================
+// `field:` and `choices:`
+describe(`For a 'choices:' specifier`, async function() {
+  for ( let test_i = 0; test_i < fields.choices.length; test_i++ ) {
+    let field = fields.choices[ test_i ];
+    let curr_matches = matches.choices[ test_i ];
+    let name = getSafeName( field );
+    it( `finds the right matches for ${ name }`, async function() {
+      let result = await getMatchingRows( scope, { field, var_data: tables.choices });
+      expect( result ).to.deep.equal( curr_matches );
+    });
+  }
+});
+
+
+// ============================
+// dropdowns created with objects
+// ============================
+// ```
+// - Something: some_var
+//   datatype: object
+//   object labeler: |
+//     lambda y: y.short_label()```
+//   choices: some_obj
+// ```
+describe(`For a dropdown created with objects`, async function() {
+  for ( let test_i = 0; test_i < fields.object_dropdown.length; test_i++ ) {
+    let field = fields.object_dropdown[ test_i ];
+    let curr_matches = matches.object_dropdown[ test_i ];
+    let name = getSafeName( field );
+    it( `finds the right matches for ${ name }`, async function() {
+      let result = await getMatchingRows( scope, { field, var_data: tables.object_dropdown });
+      expect( result ).to.deep.equal( curr_matches );
+    });
+  }
+});
+
+
+// ============================
+// mixed quotes
+// ============================
+describe(`For quotes that are mismatched`, async function() {
+  for ( let test_i = 0; test_i < fields.mixed_quotes.length; test_i++ ) {
+    let field = fields.mixed_quotes[ test_i ];
+    let curr_matches = matches.mixed_quotes[ test_i ];
+    let name = getSafeName( field );
+    it( `finds the right matches for ${ name }`, async function() {
+      let result = await getMatchingRows( scope, { field, var_data: tables.mixed_quotes });
+      expect( result ).to.deep.equal( curr_matches );
+    });
+  }
+});

package/tests/unit_tests/getSafeScenarioBaseFilename.fixtures.js

@@ -0,0 +1,12 @@
+let names = {};
+
+names.with_spaces = `a tests description`;
+names.tag1 = `tag1`;
+names.tag2 = `tag2`;
+
+names.non_english_chars = `是汉字`;
+
+names.colon_input = `invalid:colon`;
+names.colon_output = `invalid_colon`;
+
+module.exports = names;

package/tests/unit_tests/getSafeScenarioBaseFilename.test.js

@@ -0,0 +1,62 @@
+const chai = require(`chai`);
+const expect = chai.expect;
+
+const names = require(`./getSafeScenarioBaseFilename.fixtures.js`);
+const scope = require(`../../lib/scope.js`);
+const getSafeScenarioBaseFilename = scope.getSafeScenarioBaseFilename;
+
+
+let mock_scenario = function ( description, tag_names=[] ) {
+  /** Mock the complex structure of a Scenario object */
+  let scenario = {
+    pickle: { name: description, tags: [], }
+  };
+  for ( let tag of tag_names ) {
+    scenario.pickle.tags.push({ name: tag });
+  }
+  return scenario;
+};  // Ends mock_scenario();
+
+describe(`When I use scope.getSafeScenarioBaseFilename()`, function() {
+
+  beforeEach(function() {
+    scope.language = undefined;
+  });
+
+  // No language, no tags
+  it(`preserves spaces`, async function() {
+    let scenario = mock_scenario( names.with_spaces, [] );
+    let result = await getSafeScenarioBaseFilename( scope, { scenario });
+    expect( result ).to.equal( names.with_spaces );
+  });
+
+  it(`preserves non-english characters`, async function() {
+    let scenario = mock_scenario( names.non_english_chars, [] );
+    let result = await getSafeScenarioBaseFilename( scope, { scenario });
+    expect( result ).to.equal( names.non_english_chars );
+  });
+
+  it(`replaces invalid characters with "_"`, async function() {
+    let scenario = mock_scenario( names.colon_input, [] );
+    let result = await getSafeScenarioBaseFilename( scope, { scenario });
+    expect( result ).to.equal( names.colon_output );
+  });
+
+  // language, 1 tag
+  it(`adds a language and 1 tag correctly, preserving numbers`, async function() {
+    scope.language = names.non_english_chars;
+    let scenario = mock_scenario( names.with_spaces, [ names.tag1 ] );
+    let result = await getSafeScenarioBaseFilename( scope, { scenario });
+    let expected = `${ names.non_english_chars }-${ names.with_spaces }-${ names.tag1 }`;
+    expect( result ).to.equal( expected );
+  });
+
+  // 2 tags
+  it(`adds 2 tags correctly, preserving numbers`, async function() {
+    let scenario = mock_scenario( names.with_spaces, [ names.tag1, names.tag2 ] );
+    let result = await getSafeScenarioBaseFilename( scope, { scenario });
+    let expected = `${ names.with_spaces }-${ names.tag1 }-${ names.tag2 }`;
+    expect( result ).to.equal( expected );
+  });
+
+});

package/tests/unit_tests/getSafeScenarioFilename.test.js

@@ -0,0 +1,83 @@
+
+ const chai = require('chai');
+ const expect = chai.expect;
+ 
+ const names = require('./names.fixtures.js');
+ const scope = require('../../lib/scope.js');
+ const getSafeScenarioFilename = scope.getSafeScenarioFilename;
+ 
+ 
+let test_filename = function ( expected_prefix, result ) {
+   /* Test a name to see if it's valid output with a language defined. */
+  let expected_name_regex_str = `^${ expected_prefix }\\d{13}-${ names.base_filename }$`;
+   let regex = new RegExp( expected_name_regex_str );
+ 
+  // Log more info if it failed
+  let found_match = regex.test( result );
+  if ( !found_match ) {
+    console.log( 'regex:', regex.source );
+    console.log( 'result:', result );
+  }
+
+  expect( found_match ).to.be.true;
+ };
+ 
+
+ describe(`When I use scope.getSafeScenarioFilename()`, function() {
+ 
+   beforeEach(function() {
+    scope.base_filename = names.base_filename;
+   });
+ 
+   it(`preserves chinese characters`, async function() {
+     let result = await getSafeScenarioFilename( scope, { prefix: names.chinese_input });
+    test_filename( names.chinese_output, result );
+   });
+ 
+   it(`adds an underscore when there is none`, async function() {
+     let result = await getSafeScenarioFilename( scope, { prefix: names.no_underscore_input });
+    test_filename( names.no_underscore_output, result );
+   });
+ 
+   it(`preserves one underscore`, async function() {
+     let result = await getSafeScenarioFilename( scope, { prefix: names.one_underscore_input });
+    test_filename( names.one_underscore_output, result );
+   });
+ 
+   it(`preserves two underscores`, async function() {
+     let result = await getSafeScenarioFilename( scope, { prefix: names.two_underscores_input });
+    test_filename( names.two_underscores_output, result );
+   });
+ 
+   it(`does not add underscores to an empty string`, async function() {
+     let result = await getSafeScenarioFilename( scope, { prefix: names.empty_string_input });
+    test_filename( names.empty_string_output, result );
+   });
+ 
+   it(`converts undefined to an empty string`, async function() {
+     let result = await getSafeScenarioFilename( scope, { prefix: names.undefined_input });
+    test_filename( names.undefined_output, result );
+   });
+ 
+   it(`replaces invalid ':' with '_'`, async function() {
+     let result = await getSafeScenarioFilename( scope, { prefix: names.colon_input });
+    test_filename( names.colon_output, result );
+   });
+ 
+   it(`replaces invalid '/' with '_'`, async function() {
+     let result = await getSafeScenarioFilename( scope, { prefix: names.slash_input });
+    test_filename( names.slash_output, result );
+   });
+ 
+   it(`replaces two consecutive invalid chars with one '_' each`, async function() {
+     let result = await getSafeScenarioFilename( scope, { prefix: names.two_consecutive_invalid_input });
+    test_filename( names.two_consecutive_invalid_output, result );
+   });
+ 
+   it(`does not replace numbers`, async function() {
+     let result = await getSafeScenarioFilename( scope, { prefix: names.numerical_input });
+    test_filename( names.numerical_output, result );
+   });
+ 
+ });
+