@suffolklitlab/alkiln 3.0.9

package/tests/unit_tests/matches.fixtures.js

@@ -0,0 +1,168 @@
+let matches =  {}
+
+// ============================
+// Standard fields - no proxies, no showifs.
+// ============================
+// TODO: Add more complex fields. E.g `object_checkboxes` and dropdown with `object`.
+matches.standard = [
+  [ { var: 'checkboxes_yesno', value: 'True' } ],
+  [ { var: "checkboxes_other['checkbox_other_opt_1']", value: 'false' } ],
+  [ { var: "checkboxes_other['checkbox_other_opt_2']", value: 'true' } ],
+  [ { var: "checkboxes_other['checkbox_other_opt_3']", value: 'false' } ],
+  [ { var: "checkboxes_other['None']", value: 'false' } ],
+  [],
+  [ { var: 'radio_yesno', value: 'False' } ],
+  [],
+  [ { var: 'radio_other', value: 'radio_other_opt_2' } ],
+  [],
+  [ { var: 'text_input', value: 'Some one-line text' }, { var: 'text_input', value: 'Some conflicting text' } ],
+  [ { var: 'textarea', value: 'Some\nmulti-line\ntext' } ],
+  [ { 'var': 'date_input','value':'today-1' } ],
+  [ { var: 'dropdown_test', value: 'dropdown_opt_2' } ],
+  [ { var: 'direct_standard_fields', value: 'True' } ]
+];
+
+
+// ============================
+// Simple show if fields - no proxies
+// ============================
+matches.show_if = [
+  [ { var: 'show_2', value: 'True' } ],
+  [ { var: 'show_3', value: 'True' } ],
+  [ { var: 'showif_checkbox_yesno', value: 'True' } ],
+  [ { var: "showif_checkboxes_other['showif_checkboxes_nota_1']", value: 'false' } ],
+  [ { var: "showif_checkboxes_other['showif_checkboxes_nota_2']", value: 'true' } ],
+  [],
+  [ { var: "showif_checkboxes_other['None']", value: 'false' } ],
+  [],
+  [ { var: 'showif_yesnoradio', value: 'False' } ],
+  [],
+  [ { var: 'showif_radio_other', value: 'showif_radio_multi_2' } ],
+  [],
+  [ { var: 'showif_text_input', value: 'Some one-line text in show if input' } ],
+  [ { var: 'showif_textarea', value: 'Some\nmulti-line\ntext in show if textarea' } ],
+  [ { var: 'showif_dropdown', value: 'showif_dropdown_2' } ],
+  [ { var: 'direct_showifs', value: 'True' } ]
+];
+
+
+// ============================
+// Buttons
+// ============================
+// `continue button field:`
+matches.button_continue = [
+  [{"var":"button_continue","value":"True"}]
+];
+
+// `yesnomaybe:`
+matches.buttons_yesnomaybe_yes = [
+  [{"var":"buttons_yesnomaybe","value":"True"}],
+  [],
+  []
+];
+matches.buttons_yesnomaybe_no = [
+  [],
+  [{"var":"buttons_yesnomaybe","value":"False"}],
+  []
+];
+matches.buttons_yesnomaybe_none = [
+  [],
+  [],
+  [{"var":"buttons_yesnomaybe","value":"None"}]
+];
+
+// `field:` and `buttons:`
+matches.buttons_other_1 = [
+  [{"var":"buttons_other","value":"button_1"}],
+  [],
+  []
+];
+matches.buttons_other_2 = [
+  [],
+  [{"var":"buttons_other","value":"button_2"}],
+  []
+];
+matches.buttons_other_3 = [
+  [],
+  [],
+  [{"var":"buttons_other","value":"button_3"}]
+];
+
+// `field:` and `action buttons:`
+matches.buttons_event_action = [
+  [],
+  [{"var":"end","value":""}]
+];
+
+
+// ============================
+// Proxy vars (x, i, j, ...)
+// ============================
+// x[i].name.first
+matches.proxies_xi = [
+  [{"trigger":"proxy_list[0].name.first","var":"x[i].name.first","value":"Firstname"}],
+  []
+];
+
+// Multiple proxies by the same name are on the list (because of a loop)
+// x[i].name.first
+matches.proxies_multi = [
+  [{"trigger":"proxy_list[1].name.first","var":"x[i].name.first","value":"Firstname"}],
+  []
+];
+
+
+// ============================
+// Signature
+// ============================
+matches.signature = [
+  [{"trigger":"signature_1","var":"signature_1","value":"/sign"}]
+];
+
+
+// ============================
+// `choices:`
+// ============================
+// `field:` and `choices:`
+matches.choices = [
+  [{"var":"field_and_choices","value":"Choice 1"}],
+  [],
+  []
+];
+
+
+// ============================
+// dropdowns created with objects
+// ============================
+// ```
+// - Something: some_var
+//   datatype: object
+//   object labeler: |
+//     lambda y: y.short_label()```
+//   choices: some_obj
+// ```
+matches.object_dropdown = [
+  [{"var":"object_dropdown","value":"obj_opt_2"}],
+  [],
+  []
+];
+
+
+// ============================
+// quotes
+// ============================
+matches.mixed_quotes = [
+  [],
+  [ { var: `single_quote_dict["single_quote_key"]['sq_two']`, value: 'True', trigger: `double_quote_dict['double_quote_key']` } ],
+  [],
+  [],
+  [],
+  [ { var: `double_quote_dict['double_quote_key']["dq_two"]`, value: 'True', trigger: `double_quote_dict["double_quote_key"]` } ],
+  [],
+  [],
+  [],
+  [],
+];
+
+
+module.exports = matches;

package/tests/unit_tests/names.fixtures.js

@@ -0,0 +1,35 @@
+let names = {};
+
+names.base_filename = `a_safe_id`;
+
+names.chinese_input = `是汉字`;
+names.chinese_output = `是汉字_`;
+
+names.no_underscore_input = `ends_in_no_underscore`;
+names.no_underscore_output = `ends_in_no_underscore_`;
+
+names.one_underscore_input = `ends_in_one_underscore_`;
+names.one_underscore_output = `ends_in_one_underscore__`;
+
+names.two_underscores_input = `ends_in_two_underscores__`;
+names.two_underscores_output = `ends_in_two_underscores___`;
+
+names.empty_string_input = ``;
+names.empty_string_output = ``;
+
+names.undefined_input;
+names.undefined_output = ``;
+
+names.colon_input = `invalid:colon`;
+names.colon_output = `invalid_colon_`;
+
+names.slash_input = `invalid/slash`;
+names.slash_output = `invalid_slash_`;
+
+names.two_consecutive_invalid_input = `two_consecutive//invalid`;
+names.two_consecutive_invalid_output = `two_consecutive__invalid_`;
+
+names.numerical_input = `scenario_w1th_number00`;
+names.numerical_output = `scenario_w1th_number00_`;
+
+module.exports = names;

package/tests/unit_tests/normalizeTable.test.js

@@ -0,0 +1,22 @@
+const chai = require('chai');
+const expect = chai.expect;
+// We need jest or something, right? To do fancy stuff.
+
+
+const tables = require('./tables.fixtures.js');
+const scope = require('../../lib/scope.js');
+const normalizeTable = scope.normalizeTable;
+
+
+// ============================
+// Change old table into new table
+// ============================
+it("normalizes a table with standard formatting correctly", async function() {
+  let result = await normalizeTable( scope, { var_data: tables.standard_formatting });
+  expect( result ).to.deep.equal( tables.standard_normalized_formatting );
+});
+
+it("normalizes a table with missng `trigger` column correctly", async function() {
+  let result = await normalizeTable( scope, { var_data: tables.missing_sought });
+  expect( result ).to.deep.equal( tables.missing_sought_to_normalized_formatting );
+});

package/tests/unit_tests/special_rows.fixtures.js

@@ -0,0 +1,101 @@
+let special_rows = {};
+
+// Includes `.there_is_another` and `.target_nubmer`.
+// In the future, maybe some false positives/negatives.
+
+// ==============================
+// `.target_number`
+// ==============================
+// 3 `users`, 2 `parents`
+
+// 1st press (Yes)
+special_rows.target_num_first_input = [
+  {
+    "original": { "var": "x.target_number", "value": "2", "trigger": "parents.there_is_another" },
+    "var": "x.target_number", "value": "2", "trigger": "parents.there_is_another", times_used: 0,
+  },
+  {
+    "original": { "var": "x.target_number", "value": "3", "trigger": "users.there_is_another" },
+    "var": "x.target_number", "value": "3", "trigger": "users.there_is_another", times_used: 0,
+  },
+];
+// Same as input plus`.there_is_another` rows
+special_rows.target_num_first_output = [ ...special_rows.target_num_first_input ];
+special_rows.target_num_first_output.push({
+  "artificial": true, "source": special_rows.target_num_first_input[0],
+  "var": "x.there_is_another", "value": "True", "trigger": "parents.there_is_another",
+});
+special_rows.target_num_first_output.push(  {
+  "artificial": true, "source": special_rows.target_num_first_input[1],
+  "var": "x.there_is_another", "value": "True", "trigger": "users.there_is_another",
+});
+
+// 2nd press (Yes and No)
+special_rows.target_num_half_way_input = [
+  {
+    "original": { "var": "x.target_number", "value": "2", "trigger": "parents.there_is_another" },
+    "var": "x.target_number", "value": "2", "trigger": "parents.there_is_another", times_used: 1,
+  },
+  {
+    "original": { "var": "x.target_number", "value": "3", "trigger": "users.there_is_another" },
+    "var": "x.target_number", "value": "3", "trigger": "users.there_is_another", times_used: 1,
+  },
+];
+// Same as input plus `.there_is_another` rows
+special_rows.target_num_half_way_output = [ ...special_rows.target_num_half_way_input ];
+special_rows.target_num_half_way_output.push({
+  "var": "x.there_is_another", "value": "False", "trigger": "parents.there_is_another",
+  "artificial": true, "source": special_rows.target_num_half_way_input[0],
+});
+special_rows.target_num_half_way_output.push(  {
+  "var": "x.there_is_another", "value": "True", "trigger": "users.there_is_another",
+  "artificial": true, "source": special_rows.target_num_half_way_input[1],
+});
+
+// 3rd press (No and No)
+special_rows.target_num_last_input = [
+  {
+    "original": { "var": "x.target_number", "value": "2", "trigger": "parents.there_is_another" },
+    "var": "x.target_number", "value": "2", "trigger": "parents.there_is_another", times_used: 2,
+  },
+  {
+    "original": { "var": "x.target_number", "value": "3", "trigger": "users.there_is_another" },
+    "var": "x.target_number", "value": "3", "trigger": "users.there_is_another", times_used: 2,
+  },
+];
+// Same as input plus `.there_is_another` rows
+special_rows.target_num_last_output = [ ...special_rows.target_num_last_input ];
+special_rows.target_num_last_output.push({
+  "var": "x.there_is_another", "value": "False", "trigger": "parents.there_is_another",
+  "artificial": true, "source": special_rows.target_num_last_input[0],
+});
+special_rows.target_num_last_output.push(  {
+  "var": "x.there_is_another", "value": "False", "trigger": "users.there_is_another",
+  "artificial": true, "source": special_rows.target_num_last_input[1],
+});
+
+// trigger uses `.target_number`
+// devs are supposed to use the right `trigger` name, but they might not
+special_rows.target_number_trigger_input = [
+  {
+    "original": { "var": "x.target_number", "value": "2", "trigger": "parents.target_number" },
+    "var": "x.target_number", "value": "2", "trigger": "parents.target_number", times_used: 0,
+  },
+  {
+    "original": { "var": "x.target_number", "value": "3", "trigger": "users.target_number" },
+    "var": "x.target_number", "value": "3", "trigger": "users.target_number", times_used: 0,
+  },
+];
+// Same as input plus`.there_is_another` rows
+special_rows.target_number_trigger_output = [ ...special_rows.target_number_trigger_input ];
+special_rows.target_number_trigger_output.push({
+  "artificial": true, "source": special_rows.target_number_trigger_input[0],
+  "var": "x.there_is_another", "value": "True", "trigger": "parents.there_is_another",
+});
+special_rows.target_number_trigger_output.push(  {
+  "artificial": true, "source": special_rows.target_number_trigger_input[1],
+  "var": "x.there_is_another", "value": "True", "trigger": "users.there_is_another",
+});
+
+
+module.exports = special_rows;