rename cls to class_name

and remove unused findSlotNamesForClass()

Author: ddooley

lib/AppContext.js

@@ -5,7 +5,6 @@ import { DataHarmonizer } from '.';
 import { findLocalesForLangcodes } from './utils/i18n';
 import {
   Template,
-  findSlotNamesForClass,
   getTemplatePathInScope,
 } from '../lib/utils/templates';
 import { wait } from '../lib/utils/general';
@@ -158,13 +157,13 @@ function updateWithChildrenAndSharedKeys(data) {
  * @returns {Object|null} The schema tree object, or null if no "Container" classes are found.
  */
 function buildSchemaTree(schema) {
-  const isContainerMissing = typeof schema.classes['Container'] === 'undefined';
 
   const classNames = Object.keys(schema.classes).filter(
-    (key) => key !== 'dh_interface' && key !== 'Container'
+    (key) => !(key == 'dh_interface' || key == 'Container')
   );
 
-  if (isContainerMissing) {
+  if (!('Container' in schema.classes)) {
+    // FIX THIS to pay attention to class foreign keys
     return createFlatSchemaTree(classNames);
   }
 
@@ -399,11 +398,7 @@ export default class AppContext {
       });
     });
   }
-  /*
-  getExportFormats() {
-    return this.export_formats;
-  }
-  */
+
   clearContext() {
     this.schema_tree = {};
     this.dhs = {};
@@ -432,7 +427,9 @@ export default class AppContext {
   makeDataHarmonizersFromSchemaTree(schema, template_name) {
     let data_harmonizers = {};
     const template = this.appConfig.template_path.split('/')[1];
+
     console.log("SCHEMA TREE", this.schema_tree)
+
     Object.entries(this.schema_tree)
       // Container class is only used in input and output file coordination.
       .filter(([class_name]) => class_name !== 'Container')
@@ -464,9 +461,10 @@ export default class AppContext {
             // NOTE: this may be running twice?.
             // in 1-M, different DataHarmonizers have fewer rows to start with
             // and visible if a child. Override the default HoT settings.
-            data_harmonizers[class_name] = new DataHarmonizer(dhSubroot, this, {
+            const dh = new DataHarmonizer(dhSubroot, this, {
               loadingScreenRoot: document.body,
               class_assignment: class_name,
+              schema: schema, // assign during constructor so validator can init on it.
               hot_override_settings: {
                 minRows: is_child ? 0 : 100,
                 minSpareRows: is_child ? 0 : 100,
@@ -477,12 +475,15 @@ export default class AppContext {
               },
             });
 
-            data_harmonizers[class_name].useSchema(schema, template_name);
+            data_harmonizers[class_name] = dh;
+            dh.useTemplate(class_name);
+            dh.validator.useTargetClass(class_name);
+
 
             // Initialization of each child table is to hide all rows until
             // parent primary key record is selected as a foreign key index.
             if (is_child) {
-              data_harmonizers[class_name].filterAll();
+              dh.filterAll();
             }
           }
         }

lib/DataHarmonizer.js

@@ -9,7 +9,7 @@ import i18next from 'i18next';
 import { utils as XlsxUtils, read as xlsxRead } from 'xlsx/xlsx.js';
 import { renderContent, urlToClickableAnchor } from './utils/content';
 import { readFileAsync, updateSheetRange } from '../lib/utils/files';
-import { findSlotNamesForClass } from '../lib/utils/templates';
+//import { findSlotNamesForClass } from '../lib/utils/templates';
 import {
   isValidHeaderRow,
   rowIsEmpty,
@@ -38,7 +38,6 @@ import {
   itemCompare,
   validateValAgainstVocab,
   validateValsAgainstVocab,
-  // validateUniqueValues,
 } from './utils/validation';
 
 import 'handsontable/dist/handsontable.full.css';
@@ -116,7 +115,8 @@ class DataHarmonizer {
 
     this.class_assignment = options.class_assignment || null;
     this.field_settings = options.fieldSettings || {};
-    this.slot_names = options.slot_names || [];
+    this.slots = null;
+    this.slot_names = null;
     this.hot_override_settings = options.hot_override_settings || {};
 
     this.helpSidebarOptions = Object.assign(
@@ -187,20 +187,9 @@ class DataHarmonizer {
     this.hot.render();
   }
 
-  useSchema(schema, template_name) {
-    console.log("useSchema", template_name)
-    this.schema = schema;
-    this.validator = new Validator(this.schema, MULTIVALUED_DELIMITER, {
-      dateFormat: this.dateFormat,
-      datetimeFormat: this.datetimeFormat,
-      timeFormat: this.timeFormat,
-    });
-  
-    this.useTemplate(template_name);
-  }
 
   /**
-   * Revise user interface elements to match template name
+   * Revise user interface elements to match template content
    *
    * @param {String} template_name: name of template within current schema
    */
@@ -221,8 +210,8 @@ class DataHarmonizer {
     )
       .filter(
         ([cls_key]) =>
-          cls_key !== 'dh_interface' &&
-          cls_key !== 'Container' &&
+          //cls_key !== 'dh_interface' &&
+          //cls_key !== 'Container' &&
           cls_key === this.class_assignment
       )
       .reduce((acc, [, spec]) => {
@@ -498,15 +487,35 @@ class DataHarmonizer {
       this.sections[ptr]['children'].sort((a, b) => a.rank - b.rank);
     }
 
-
+    // Easy lookup arrays.
     this.slots = this.getFields();
-    this.slot_names = findSlotNamesForClass(this.context.template.default.schema, template_name),
-    //console.log(this.slot_names)
-    this.validator.useTargetClass(this.class_assignment);
+    this.slot_names = this.slots.map((field) => field.name);
 
     this.createHot();
   }
 
+
+  /**
+   * Get a flat array of all fields (slot definitions) in TEMPLATE.
+   * @return {Array<Object>} Array of all objects under `children` in TEMPLATE.
+   */
+  getFields() {
+    let fields = Array.prototype.concat.apply(
+      [],
+      this.sections.map((section) => section.children)
+    );
+
+    /* NOTE: Possibly a result of attempting to add other slots besides one in
+     * template.
+
+    fields =
+      this.slot_names.length > 0
+        ? fields.filter((field) => this.slot_names.includes(field.name))
+        : fields;
+    */
+    return fields;
+  }
+
   /**
    * Open file specified by user.
    * Only opens `xlsx`, `xlsx`, `csv` and `tsv` files. Will launch the specify
@@ -960,10 +969,12 @@ class DataHarmonizer {
     this.hideColumns(hiddenColumns);
   }
 
+  /*
   showColumnsByNames(names) {
     if (names.length > 0)
       this._updateVisibility((field) => !names.includes(field.name));
   }
+  */
 
   showRequiredColumns() {
     this._updateVisibility((field) => !field.required);
@@ -1630,25 +1641,6 @@ class DataHarmonizer {
     };
   }
 
-  /**
-   * Get a flat array of all fields (slot definitions) in TEMPLATE.
-   * @return {Array<Object>} Array of all objects under `children` in TEMPLATE.
-   */
-  getFields() {
-    let fields = Array.prototype.concat.apply(
-      [],
-      this.sections.map((section) => section.children)
-    );
-
-    fields =
-      this.slot_names.length > 0
-        ? fields.filter((field) => this.slot_names.includes(field.name))
-        : fields;
-
-    console.log("FILTERS", this.slot_names)
-    console.log("FIELDS", fields )
-    return fields;
-  }
 
   /**
    * Create a matrix containing the nested headers supplied to Handsontable.
@@ -2184,7 +2176,6 @@ class DataHarmonizer {
       ...options,
     };
     const listData = this.hot.getData();
-    //const fields = this.getFields();
     const arrayOfObjects = listData
       .filter((row) => !rowIsEmpty(row))
       .map((row) =>
@@ -2689,11 +2680,8 @@ class DataHarmonizer {
    * @return {Array<Array<String>>} Modified matrix.
    */
   matrixFieldChangeRules(matrix) {
-    //const fields = this.slots;
-    Object.entries(this.slots).forEach((field, col) => {
 
-    //for (let col = 0; col < this.slots.length; col++) {
-    //  const field = fields[col];
+    Object.entries(this.slots).forEach((field, col) => {
 
       // Test field against capitalization change.
       if (field.capitalize) {
@@ -2877,8 +2865,8 @@ class DataHarmonizer {
    *     `{0: {0: 'Required cells cannot be empty'}}`
    */
   getInvalidCells(data) {
-    const fieldNames = this.getFields().map((field) => field.name);
-    return this.validator.validate(data, fieldNames);
+    //const fieldNames = this.slots.map((field) => field.name);
+    return this.validator.validate(data, this.slot_names); // fieldNames);
   }
 
   /**

lib/utils/templates.js

@@ -220,25 +220,25 @@ class TemplateProxy {
   async _init(template, locale = null) {
 
     // Handling case where DataHarmonizer < 2.0 schema is being loaded.
-    // 1 tab per dh_interface case here.
+    // Dynamically adding a Container class, with 1 tabular holding
+    // class for each underlying class within schema classes (in range). 
     if (typeof template.default.schema.classes['Container'] === 'undefined') {
       let fake_container = {
         name: 'Container',
         from_schema: template.default.schema.id,
         attributes: {},
       };
 
-      const class_names = Object.keys(template.default.schema.classes).filter(
-        (key) => key !== 'dh_interface'
-      );
+      const class_names = Object.keys(template.default.schema.classes)
+      .filter((key) => key !== 'dh_interface');
 
-      class_names.forEach((cls) => {
-        fake_container.attributes[cls] = {
+      class_names.forEach((class_name) => {
+        fake_container.attributes[class_name] = {
           owner: 'Container',
           domain_of: ['Container'],
-          name: cls,
-          range: cls,
-          alias: cls,
+          name: class_name+'s', // plural
+          range: class_name,
+          //alias: class_name,
           from_schema: template.default.schema.id,
           multivalued: false,
           inlined_as_list: true,
@@ -321,18 +321,6 @@ export const rangeToContainerClass = (Container, cls_key) => {
   }
 };
 
-/**
- * Finds the slot names for a given class within the schema.
- * @param {Object} schema - The schema object containing "classes".
- * @param {string} class_name - The name of the class to search for slot names.
- * @returns {Array} An array of slot names.
- */
-export function findSlotNamesForClass(schema, class_name) {
-  return Object.keys(schema.classes[class_name].slot_usage).map((field) => {
-    return schema.classes[class_name].slot_usage[field].name;
-  });
-}
-
 // Usage example:
 // const proxyInstance = await TemplateProxy.create('template_name', 'en-US');
 // proxyInstance.updateLocale('fr-FR');  // IETF language code designations