linny-r 2.0.8 → 2.0.10

package/static/scripts/linny-r-gui-repository-browser.js

@@ -342,7 +342,7 @@ class GUIRepositoryBrowser extends RepositoryBrowser {
   }
 
   getRepositories() {
-    // Gets the list of repository names from the server
+    // Gets the list of repository names from the server.
     this.repositories.length = 0;
     fetch('repo/', postData({action: 'list'}))
       .then((response) => {
@@ -353,14 +353,13 @@ class GUIRepositoryBrowser extends RepositoryBrowser {
         })
       .then((data) => {
           if(UI.postResponseOK(data)) {
-            // NOTE: trim to prevent empty name strings
-            const rl = data.trim().split('\n');
-            for(let i = 0; i < rl.length; i++) {
-              this.addRepository(rl[i].trim());
+            // NOTE: Trim to prevent empty name strings.
+            for(const r of data.trim().split('\n')) {
+              this.addRepository(r.trim());
             }
           }
-          // NOTE: set index to first repository on list (typically local host)
-          // unless the list is empty
+          // NOTE: Set index to first repository on list (typically local host)
+          // unless the list is empty.
           this.repository_index = Math.min(0, this.repositories.length - 1);
           this.updateDialog();
         })
@@ -545,7 +544,7 @@ class GUIRepositoryBrowser extends RepositoryBrowser {
   }
 
   updateModulesTable() {
-    // Refresh the module table
+    // Refresh the module table.
     let mcount = 0;
     const trl = [];
     if(this.repository_index >= 0) {
@@ -565,7 +564,7 @@ class GUIRepositoryBrowser extends RepositoryBrowser {
     this.modules_count.innerHTML = pluralS(mcount, 'module');
     if(this.module_index >= 0) {
       UI.enableButtons('repo-load repo-include');
-      // NOTE: only allow deletion from local host repository
+      // NOTE: Only allow deletion from local host repository.
       if(this.repository_index === 0 && this.isLocalHost) {
         UI.enableButtons(' repo-delete');
       } else {
@@ -577,7 +576,7 @@ class GUIRepositoryBrowser extends RepositoryBrowser {
   }
   
   updateDialog() {
-    // Refreshes all dialog elements
+    // Refreshe all dialog elements.
     const ol = [];
     for(let i = 0; i < this.repositories.length; i++) {
       ol.push('<option value="', i,
@@ -586,7 +585,7 @@ class GUIRepositoryBrowser extends RepositoryBrowser {
     }
     this.repository_selector.innerHTML = ol.join('');
     UI.disableButtons('repo-access repo-remove repo-store');
-    // NOTE: on remote installation, do not allow add/remove/store
+    // NOTE: On remote installation, do not allow add/remove/store.
     if(!this.isLocalHost) {
       UI.disableButtons('repo-add');
     } else if(this.repository_index >= 0) {
@@ -597,7 +596,7 @@ class GUIRepositoryBrowser extends RepositoryBrowser {
         UI.enableButtons('repo-access');
       }
       if(r.name !== 'local host') {
-        // NOTE: cannot remove 'local host'
+        // NOTE: Cannot remove 'local host'.
         UI.enableButtons('repo-remove');
       }
     }
@@ -605,7 +604,7 @@ class GUIRepositoryBrowser extends RepositoryBrowser {
   }
 
   promptForInclusion(repo, file, node) {
-    // Add entities defined in the parsed XML tree with root `node`
+    // Add entities defined in the parsed XML tree with root `node`.
     IO_CONTEXT = new IOContext(repo, file, node);
     const md = this.include_modal;
     md.element('name').innerHTML = IO_CONTEXT.file_name;
@@ -616,8 +615,8 @@ class GUIRepositoryBrowser extends RepositoryBrowser {
   }
   
   updateActors() {
-    // Adds actor (if specified) to model, and then updates the selector options
-    // for each actor binding selector
+    // Add actor (if specified) to model, and then updates the selector options
+    // for each actor binding selector.
     if(!IO_CONTEXT) return;
     const
         aname = this.include_modal.element('actor').value.trim(),
@@ -637,25 +636,24 @@ class GUIRepositoryBrowser extends RepositoryBrowser {
   }
   
   parameterBinding(name) {
-    // Returns the selected option (as DOM element) of the the parameter
-    // selector identified by its element name (!) in the Include modal
-    const lst = document.getElementsByName(name);
-    let e = null;
-    for(let i = 0; i < lst.length; i++) {
-      if(lst[i].type.indexOf('select') === 0) {
-        e = lst[i];
+    // Return the selected option (as DOM element) of the the parameter
+    // selector identified by its element name (!) in the Include modal.
+    let sel = null;
+    for(const e of document.getElementsByName(name)) {
+      if(e.type.indexOf('select') === 0) {
+        sel = e;
         break;
       }
     }
-    if(!e) UI.alert(`Parameter selector "${b.id}" not found`);
-    return e;
+    if(!sel) UI.alert(`Parameter selector "${name}" not found`);
+    return sel;
   }
   
   performInclusion() {
-    // Includes the selected model as "module" cluster in the model;
-    // this is effectuated by "re-initializing" the current model using
+    // Include the selected model as "module" cluster in the model.
+    // This is effectuated by "re-initializing" the current model using
     // the XML of the model-to-be-included with the contextualization as
-    // indicated by the modeler
+    // indicated by the modeler.
     if(!IO_CONTEXT) {
       UI.alert('Cannot include module without context');
       return;
@@ -667,7 +665,7 @@ class GUIRepositoryBrowser extends RepositoryBrowser {
       pref.focus();
       return;
     }
-    // NOTE: prefix must not already be in use as entity name
+    // NOTE: Prefix must not already be in use as entity name.
     let obj = MODEL.objectByName(IO_CONTEXT.prefix);
     if(obj) {
       UI.warningEntityExists(obj, IO_CONTEXT.prefix);
@@ -678,10 +676,10 @@ class GUIRepositoryBrowser extends RepositoryBrowser {
     IO_CONTEXT.actor_name = this.include_modal.element('actor').value.trim();
     MODEL.clearSelection();
     IO_CONTEXT.bindParameters();
-    // NOTE: including may affect focal cluster, so store it...
+    // NOTE: Including may affect focal cluster, so store it...
     const fc = MODEL.focal_cluster;
     MODEL.initFromXML(IO_CONTEXT.xml);
-    // ... and restore it afterwards
+    // ... and restore it afterwards.
     MODEL.focal_cluster = fc;
     let counts = `: ${pluralS(IO_CONTEXT.added_nodes.length, 'node')}, ` +
         pluralS(IO_CONTEXT.added_links.length, 'link');
@@ -691,9 +689,9 @@ class GUIRepositoryBrowser extends RepositoryBrowser {
     }
     UI.notify(`Model <tt>${IO_CONTEXT.file_name}</tt> included from ` +
         `<strong>${IO_CONTEXT.repo_name}</strong>${counts}`);
-    // Get the containing cluster
+    // Get the containing cluster.
     obj = MODEL.objectByName(IO_CONTEXT.clusterName);
-    // Position it in the focal cluster
+    // Position it in the focal cluster.
     if(obj instanceof Cluster) {
       obj.x = IO_CONTEXT.centroid_x;
       obj.y = IO_CONTEXT.centroid_y;
@@ -701,20 +699,20 @@ class GUIRepositoryBrowser extends RepositoryBrowser {
     } else {
       UI.alert('Include failed to create a cluster');
     }
-    // Reset the IO context
+    // Reset the IO context.
     IO_CONTEXT = null;
     this.include_modal.hide();
     MODEL.cleanUpActors();
     MODEL.focal_cluster.clearAllProcesses();
     UI.drawDiagram(MODEL);
-    // Select the newly added cluster
+    // Select the newly added cluster.
     if(obj) MODEL.select(obj);
-    // Update dataset manager if shown (as new datasets may have been added)
+    // Update dataset manager if shown (as new datasets may have been added).
     if(DATASET_MANAGER.visible) DATASET_MANAGER.updateDialog();
   }
   
   cancelInclusion() {
-    // Clears the IO context and closes the inclusion dialog
+    // Clear the IO context and closes the inclusion dialog.
     IO_CONTEXT = null;
     this.include_modal.hide();
   }
@@ -724,7 +722,7 @@ class GUIRepositoryBrowser extends RepositoryBrowser {
       this.store_modal.element('name').innerText =
           this.repositories[this.repository_index].name;
       this.store_modal.element('model-name').value =
-          this.asFileName(MODEL.name);
+          asFileName(MODEL.name);
       this.store_modal.show('model-name');
     }
   }
@@ -746,7 +744,7 @@ class GUIRepositoryBrowser extends RepositoryBrowser {
       this.store_bb_modal.element('name').innerText =
           this.repositories[this.repository_index].name;
       this.store_bb_modal.element('model-name').value =
-          this.asFileName(MODEL.name);
+          asFileName(MODEL.name);
       this.store_bb_modal.show('model-name');
     }
   }
@@ -757,7 +755,7 @@ class GUIRepositoryBrowser extends RepositoryBrowser {
           mn = this.store_bb_modal.element('model-name').value.trim(),
           r = this.repositories[this.repository_index];
       if(mn.length > 1) {
-        // NOTE: second parameter indicates: store with "black box XML"
+        // NOTE: Second parameter indicates: store with "black box XML".
         r.storeModelAsModule(mn, true);
         this.store_bb_modal.hide();
       }
@@ -765,19 +763,19 @@ class GUIRepositoryBrowser extends RepositoryBrowser {
   }
   
   loadModuleAsModel() {
-    // Loads selected module as model
+    // Load selected module as model.
     this.confirm_load_modal.hide();
     if(this.repository_index >= 0 && this.module_index >= 0) {
-      // NOTE: when loading new model, the stay-on-top dialogs must be reset
+      // NOTE: When loading new model, the stay-on-top dialogs must be reset.
       UI.hideStayOnTopDialogs();
       const r = this.repositories[this.repository_index];
-      // NOTE: pass FALSE to indicate "no inclusion; load XML as model"
+      // NOTE: Pass FALSE to indicate "no inclusion; load XML as model".
       r.loadModule(this.module_index, false);
     }
   }
   
   includeModule() {
-    // Includes selected module into the current model
+    // Include selected module into the current model.
     if(this.repository_index >= 0 && this.module_index >= 0) {
       const r = this.repositories[this.repository_index];
       r.loadModule(this.module_index, true);
@@ -785,7 +783,7 @@ class GUIRepositoryBrowser extends RepositoryBrowser {
   }
 
   confirmLoadModuleAsModel() {
-    // Prompts modeler to confirm loading the selected module as model
+    // Prompt modeler to confirm loading the selected module as model.
     if(this.repository_index >= 0 && this.module_index >= 0 &&
         document.getElementById('repo-load-btn').classList.contains('enab')) {
       const r = this.repositories[this.repository_index];
@@ -796,7 +794,7 @@ class GUIRepositoryBrowser extends RepositoryBrowser {
   }
   
   confirmDeleteFromRepository() {
-    // Prompts modeler to confirm deletion of the selected module
+    // Prompt modeler to confirm deletion of the selected module.
     if(this.repository_index >= 0 && this.module_index >= 0 &&
         document.getElementById('repo-delete-btn').classList.contains('enab')) {
       const r = this.repositories[this.repository_index];
@@ -808,7 +806,7 @@ class GUIRepositoryBrowser extends RepositoryBrowser {
   }
   
   deleteFromRepository() {
-    // Deletes the selected modulle from the current repository
+    // Delete the selected modulle from the current repository.
     if(this.repository_index >= 0 && this.module_index >= 0) {
       const r = this.repositories[this.repository_index];
       if(r) r.deleteModule(this.module_index);

package/static/scripts/linny-r-gui-scale-unit-manager.js

@@ -35,18 +35,18 @@ SOFTWARE.
 // CLASS ScaleUnitManager (modal dialog!)
 class ScaleUnitManager {
   constructor() {
-    // Add the scale units modal
+    // Add the scale units modal.
     this.dialog = new ModalDialog('scale-units');
     this.dialog.close.addEventListener('click',
         () => SCALE_UNIT_MANAGER.dialog.hide());
-    // Make the add, edit and delete buttons of this modal responsive
+    // Make the add, edit and delete buttons of this modal responsive.
     this.dialog.element('new-btn').addEventListener('click',
         () => SCALE_UNIT_MANAGER.promptForScaleUnit());
     this.dialog.element('edit-btn').addEventListener('click',
         () => SCALE_UNIT_MANAGER.editScaleUnit());
     this.dialog.element('delete-btn').addEventListener('click',
         () => SCALE_UNIT_MANAGER.deleteScaleUnit());
-    // Add the scale unit definition modal
+    // Add the scale unit definition modal.
     this.new_scale_unit_modal = new ModalDialog('new-scale-unit');
     this.new_scale_unit_modal.ok.addEventListener(
         'click', () => SCALE_UNIT_MANAGER.addNewScaleUnit());
@@ -57,19 +57,19 @@ class ScaleUnitManager {
   }
   
   get selectedUnitIsBaseUnit() {
-    // Returns TRUE iff selected unit is used as base unit for some unit
-    for(let u in this.scale_units) if(this.scale_units.hasOwnProperty(u)) {
-      if(this.scale_units[u].base_unit === this.selected_unit) return true;
+    // Return TRUE iff selected unit is used as base unit for some unit.
+    for(let k in this.scale_units) if(this.scale_units.hasOwnProperty(k)) {
+      if(this.scale_units[k].base_unit === this.selected_unit) return true;
     }
     return false;
   }
 
   show() {
-    // Show the user-defined scale units for the current model
-    // NOTE: add/edit/delete actions operate on this list, so changes
-    // take immediate effect
+    // Show the user-defined scale units for the current model.
+    // NOTE: Add/edit/delete actions operate on this list, so changes
+    // take immediate effect.
     MODEL.cleanUpScaleUnits();
-    // NOTE: unit name is key in the scale units object
+    // NOTE: Unit name is key in the scale units object.
     this.selected_unit = '';
     this.last_time_selected = 0;
     this.updateDialog();
@@ -78,7 +78,7 @@ class ScaleUnitManager {
   
   updateDialog() {
     // Create the HTML for the scale units table and update the state
-    // of the action buttons
+    // of the action buttons.
     if(!MODEL.scale_units.hasOwnProperty(this.selected_unit)) {
       this.selected_unit = '';
     }
@@ -88,7 +88,7 @@ class ScaleUnitManager {
         ss = this.selected_unit;
     let ssid = 'scntr';
     if(keys.length <= 1) {
-      // Only one key => must be the default '1'
+      // Only one key => must be the default '1'.
       sl.push('<tr><td><em>No units defined</em></td></tr>');
     } else {
       for(let i = 1; i < keys.length; i++) {
@@ -118,14 +118,14 @@ class ScaleUnitManager {
   }
 
   selectScaleUnit(event, symbol, focus) {
-    // Select scale unit, and when double-clicked, allow to edit it
+    // Select scale unit, and when double-clicked, allow to edit it.
     const
         ss = this.selected_unit,
         now = Date.now(),
         dt = now - this.last_time_selected,
-        // NOTE: Alt-click and double-click indicate: edit
+        // NOTE: Alt-click and double-click indicate: edit.
         // Consider click to be "double" if the same modifier was clicked
-        // less than 300 ms ago
+        // less than 300 ms ago.
         edit = event.altKey || (symbol === ss && dt < 300);
     this.selected_unit = symbol;
     this.last_time_selected = now;
@@ -138,9 +138,9 @@ class ScaleUnitManager {
   }
   
   promptForScaleUnit(action='Define new', focus='name') {
-    // Show the Add/Edit scale unit dialog for the indicated action 
+    // Show the Add/Edit scale unit dialog for the indicated action.
     const md = this.new_scale_unit_modal;
-    // NOTE: by default, let name and base unit be empty strings, not '1'
+    // NOTE: By default, let name and base unit be empty strings, not '1'.
     let sv = {name: '', scalar: '1', base_unit: '' };
     if(action === 'Edit' && this.selected_unit) {
       sv = MODEL.scale_units[this.selected_unit];
@@ -154,23 +154,23 @@ class ScaleUnitManager {
   }
 
   addNewScaleUnit() {
-    // Add the new scale unit or update the one being edited 
+    // Add the new scale unit or update the one being edited.
     const
         md = this.new_scale_unit_modal,
         edited = md.element('action').innerText === 'Edit',
-        // NOTE: unit name cannot contain single quotes
+        // NOTE: Unit name cannot contain single quotes.
         s = UI.cleanName(md.element('name').value).replace("'", ''),
         v = md.element('scalar').value.trim(),
-        // NOTE: accept empty base unit to denote '1'
+        // NOTE: Accept empty base unit to denote '1'.
         b = md.element('base').value.trim() || '1';
     if(!s) {
-      // Do not accept empty string as name
+      // Do not accept empty string as name.
       UI.warn('Scale unit must have a name');
       md.element('name').focus();
       return;
     }
     if(MODEL.scale_units.hasOwnProperty(s) && !edited) {
-      // Do not accept existing unit as name for new unit
+      // Do not accept existing unit as name for new unit.
       UI.warn(`Scale unit "${s}" is already defined`);
       md.element('name').focus();
       return;      
@@ -194,7 +194,7 @@ class ScaleUnitManager {
       }      
       const selu = this.selected_unit;
       if(edited && b !== s) {
-        // Prevent inconsistencies across scalars
+        // Prevent inconsistencies across scalars.
         const cr = MODEL.scale_units[b].conversionRates();
         if(cr.hasOwnProperty(s)) {
           UI.warn(`Defining ${s} in terms of ${b} introduces a circular reference`);
@@ -203,13 +203,13 @@ class ScaleUnitManager {
         }
       }
       if(edited && s !== selu) {
-         // First rename base units
-        for(let u in MODEL.scale_units) if(MODEL.scale_units.hasOwnProperty(u)) {
-          if(MODEL.scale_units[u].base_unit === selu) {
-            MODEL.scale_units[u].base_unit = s;
+         // First rename base units.
+        for(let k in MODEL.scale_units) if(MODEL.scale_units.hasOwnProperty(k)) {
+          if(MODEL.scale_units[k].base_unit === selu) {
+            MODEL.scale_units[k].base_unit = s;
           }
         }
-        // NOTE: renameScaleUnit replaces references to `s`, not the entry
+        // NOTE: renameScaleUnit replaces references to `s`, not the entry.
         MODEL.renameScaleUnit(selu, s);
         delete MODEL.scale_units[this.selected_unit];
       }
@@ -222,13 +222,13 @@ class ScaleUnitManager {
   }
   
   editScaleUnit() {
-    // Allow user to edit name and/or value
+    // Allow user to edit name and/or value.
     if(this.selected_unit) this.promptForScaleUnit('Edit', 'scalar');
   }
   
   deleteScaleUnit() {
-    // Allow user to delete
-    // @@@TO DO: check whether scale unit is used in the model
+    // Allow user to delete.
+    // @@@TO DO: Check whether scale unit is used in the model.
     if(this.selected_unit && !this.selectedUnitIsBaseUnit) {
       delete MODEL.scale_units[this.selected_unit];
       this.updateDialog();
@@ -236,7 +236,7 @@ class ScaleUnitManager {
   }
   
   updateScaleUnits() {
-    // Replace scale unit definitions of model by the new definitions
+    // Replace scale unit definitions of model by the new definitions.
     UI.updateScaleUnitList();
     this.dialog.hide();
   }