jupyter-ijavascript-utils 1.37.0 → 1.38.0

package/DOCS.md

@@ -75,6 +75,8 @@ Give it a try here:
 
 ## What's New
 
+* 1.38 - {@link module:array.extract|array.extract} / {@link module:array.apply|array.apply} and {@link module:object.extract|object.extract} / {@link module:object.apply|object.apply}
+* 1.37 - {@link module:format.replaceString|format.replaceString} as convenience for replacing only a single string.
 * 1.36 - {@link module:format.replaceStrings|format.replaceStrings} to allow for replacement dictionaries and tuplets
 * 1.35 - {@link module:object.extractObjectProperties|extractObjectProperties} / {@link module:object.extractObjectProperty|extractObjectProperty} - to do horizontal transposes on objects
 * 1.34 - {@link module:format.mapArrayDomain|format.mapArrayDomain} and add notes in the header of {@link module:random|random} on using non-uniform distributions.

package/Dockerfile

@@ -1,3 +1,3 @@
 # syntax=docker/dockerfile:1
 
-FROM darkbluestudios/jupyter-ijavascript-utils:binder_1.35.0
+FROM darkbluestudios/jupyter-ijavascript-utils:binder_1.38.0

package/README.md

@@ -55,6 +55,8 @@ This is not intended to be the only way to accomplish many of these tasks, and a
 
 # What's New
 
+* 1.38 - array.extract / array.apply and object.extract / object.apply
+* 1.37 - {@link module:format.replaceString|format.replaceString} as convenience for replacing only a single string.
 * 1.36 - replaceStrings to allow for replacement dictionaries and tuplets
 * 1.35 - object.extractObjectProperties / object.extractObjectProperty - to do horizontal transposes on objects
 * 1.34 - format.mapArrayDomain and add notes in to random on using non-uniform distributions.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jupyter-ijavascript-utils",
-  "version": "1.37.0",
+  "version": "1.38.0",
   "description": "Utilities for working with iJavaScript - a Jupyter Kernel",
   "homepage": "https://jupyter-ijavascript-utils.onrender.com/",
   "license": "MIT",
@@ -17,6 +17,7 @@
     "test:debug": "TZ=UTC node --inspect-brk node_modules/jest/bin/jest.js --runInBand",
     "test:coverage": "TZ=UTC jest src --collectCoverage",
     "test:watch:coverage": "TZ=UTC jest src --watch --collectCoverage",
+    "doc:taffy": "npm install taffydb && npm run doc",
     "docs": "npm run doc",
     "doc": "npm run prep:docdash && node_modules/.bin/jsdoc -c ./jsdoc.json -u ./tutorials ./DOCS.md",
     "prep:docdash": "cp docResources/docdash/layout.tmpl node_modules/docdash/tmpl/layout.tmpl && rm -rf docResources/notebooks/node_modules",

package/src/format.js

@@ -20,6 +20,9 @@
  *   * {@link module:format.consoleLines|format.consoleLines(...)} - same as limit lines, only console.logs the string out.
  *   * {@link module:format.wordWrap|format.wordWrap(str, options)} - breaks apart string by line length
  *   * {@link module:format.lineCount|format.lineCount(str, options)} - counts the number of lines in a string
+ * * Replacing values in Strings
+ *   * {@link module:format.replaceString|format.replaceString(string, stringTupletsOrMap)} - applies replace from a collection of [matcher, replacement] tuplets or map based on key-> values
+ *   * {@link module:format.replaceStrings|format.replaceStrings(stringsArray, stringTupletsOrMap)} - applies replaceString on an array of values
  * * Formatting Time
  *   * {@link module:format.millisecondDuration|format.millisecondDuration}
  * * Mapping Values
@@ -1214,6 +1217,7 @@ module.exports.lineCount = function lineCount(str, newlineCharacter = '\n') {
  * //   'and jill came tumbling after' ]
  *
  * //-- or use tuplets of [find, replace] with regular expressions
+ * //-- and strings not in tuplets are simply removed.
  * replaceValues = [['jack', 'john'], [/\s+jill/i, ' ringo'], ' down'];
  * utils.format.replaceStrings(targetStrings, replaceValues);
  * expected = [
@@ -1267,3 +1271,18 @@ module.exports.replaceStrings = function replaceStrings(targetStr, stringTuplets
       ? result
       : result.replace(replaceSearch, replaceWith), stringToClean));
 };
+
+/**
+ * Conveience function for calling {@link module:format.replaceStrings|format.replaceStrings} -
+ * giving and receiving a single value (instead of an array of values).
+ * @param {String} targetStr - A Single string to replace values on.
+ * @param {Array|Map<string|RegExp,string>} stringTupletsOrMap - [[search, replace]] or Map<String|RegExp,String>
+ * @returns {string} - the targetStr with the values replaced
+ * @see {@link module:format.replaceStrings}
+ */
+module.exports.replaceString = function replaceString(targetStr, stringTupletsOrMap) {
+  if (Array.isArray(targetStr)) {
+    throw Error('replaceString(targetStr, stringTupletsOrMap): targetStr was sent an array - please use replaceStrings instead');
+  }
+  return FormatUtils.replaceStrings([targetStr], stringTupletsOrMap)[0];
+};

package/src/object.js

@@ -498,46 +498,6 @@ module.exports.filterObjectProperties = function filterObjectProperties(list, pr
   });
 };
 
-/**
- * Options for fetching object properties
- * @typedef {Object} FetchObjectOptions
- * @property {Boolean} safeAccess - whether to safely access, even if the path cannot be found
- * @property {Boolean} append - whether to only return the properties (default) or append
- */
-
-/**
- * Fetches multiple properties from an object or list of objects.
- * @param {Object | Object[]} list - collection of objects to reduce
- * @param {Map<String,any>} propertyNames - Object with the keys as the properties
- *    and the values using dot notation to access related records and properties
- *    (ex: {parentName: 'somePropertyObject.parent.parent.name', childName: 'child.Name'})
- * @param {FetchObjectOptions} options - {@link module:object~FetchObjectOptions|See FetchObjectOptions} 
- * @returns {Object[]} - objects with the properties resolved
- *    (ex: {parentname, childName, etc.})
- */
-module.exports.fetchObjectProperties = function fetchObjectProperties(list, propertyNames, options = {}) {
-  const {
-    //-- whether to safely access even if object path cannot be found
-    safeAccess = false,
-
-    //-- whether to fetch only those specific properties, or append to the object
-    append = false
-  } = options;
-
-  if (!list) return [];
-  const targetList = Array.isArray(list) ? list : [list];
-
-  const props = Object.getOwnPropertyNames(propertyNames);
-
-  return targetList.map((obj) => {
-    const result = append ? { ...obj } : {};
-    props.forEach((prop) => {
-      result[prop] = ObjectUtils.fetchObjectProperty(obj, propertyNames[prop], safeAccess);
-    });
-    return result;
-  });
-};
-
 /**
  * Similar to a transpose, this finds all the values of a particular property
  * within a list of objects.
@@ -632,6 +592,42 @@ module.exports.extractObjectProperties = function extractObjectProperties(list,
   return results;
 };
 
+/**
+ * Options for fetching object properties
+ * @typedef {Object} FetchObjectOptions
+ * @property {Boolean} safeAccess - whether to safely access, even if the path cannot be found
+ */
+
+/**
+ * Fetches multiple properties from an object or list of objects.
+ * @param {Object | Object[]} list - collection of objects to reduce
+ * @param {Map<String,any>} propertyNames - Object with the keys as the properties
+ *    and the values using dot notation to access related records and properties
+ *    (ex: {parentName: 'somePropertyObject.parent.parent.name', childName: 'child.Name'})
+ * @param {FetchObjectOptions} options - {@link module:object~FetchObjectOptions|See FetchObjectOptions} 
+ * @returns {Object[]} - objects with the properties resolved
+ *    (ex: {parentname, childName, etc.})
+ */
+module.exports.fetchObjectProperties = function fetchObjectProperties(list, propertyNames, options = {}) {
+  if (!list) return [];
+  const targetList = Array.isArray(list) ? list : [list];
+  
+  const {
+    //-- whether to fetch only those specific properties, or append to the object
+    append = false
+  } = options;
+
+  const props = Object.getOwnPropertyNames(propertyNames);
+
+  return targetList.map((obj) => {
+    const result = append ? { ...obj } : {};
+    props.forEach((prop) => {
+      result[prop] = ObjectUtils.fetchObjectProperty(obj, propertyNames[prop], options);
+    });
+    return result;
+  });
+};
+
 /**
  * Accesses a property using a string
  * @param {Object} obj - object to access the properties on
@@ -640,15 +636,25 @@ module.exports.extractObjectProperties = function extractObjectProperties(list,
  * @param {FetchObjectOptions} options - {@link module:object~FetchObjectOptions|See FetchObjectOptions}
  * @returns {any} - the value accessed at the end ofthe property chain
  */
-module.exports.fetchObjectProperty = function fetchObjectProperty(obj, propertyAccess, safeAccess) {
+module.exports.fetchObjectProperty = function fetchObjectProperty(obj, propertyAccess, options = {}) {
   if (!obj || !propertyAccess) return null;
+  const {
+    //-- whether to safely access even if object path cannot be found
+    safeAccess = false
+  } = options;
 
   //-- @TODO - should we be safe or support elvis operators?
   return propertyAccess.split('.')
     .reduce((currentVal, prop) => {
+      let isElvis = false;
+      let cleanProp = prop;
+      if (prop && prop.length > 0 && prop[0] === '?') {
+        isElvis = true;
+        cleanProp = prop.slice(1);
+      }
       if (currentVal) {
-        return currentVal[prop];
-      } else if (safeAccess || prop[0] === '?') {
+        return currentVal[cleanProp];
+      } else if (safeAccess || isElvis) {
         return null;
       }
       throw Error(`Invalid property ${propertyAccess} [${prop}] does not exist - safeAccess:${safeAccess}`);

package/src/plantuml.js

@@ -214,7 +214,7 @@ module.exports.render = function render(plantUMLText, plantUMLOptions) {
     const targetURL = this.generateURL(plantUMLText, plantUMLOptions);
     if (showURL || debug) console.log(`url:${targetURL}`);
 
-    const result = await fetch(targetURL);
+    const result = await global.fetch(targetURL);
 
     if (format === 'png') {
       const buf = await result.buffer();