jupyter-ijavascript-utils 1.20.0 → 1.21.0

package/DOCS.md

@@ -46,6 +46,7 @@ This is not intended to be the only way to accomplish many of these tasks, and a
 
 ## What's New
 
+* 1.21 - include {@link module:chain|chain} - simple monoid
 * 1.20 - fix vega dependency
 * 1.19 - add in {@link module:describe|describe} and {@link module:hashMap|hashMap} modules, along with {@link module:format.limitLines|format.limitLines}
 * 1.18 - tie to vega-datasets avoiding esmodules until ijavascript can support them

package/README.md

@@ -46,6 +46,7 @@ This is not intended to be the only way to accomplish many of these tasks, and a
 
 # What's New
 
+* 1.21 - include chain - simple monoid
 * 1.20 - fix vega dependency
 * 1.19 - add in describe and hashMap modules, along with format.limitLines
 * 1.18 - tie to vega-datasets avoiding esmodules until ijavascript can support them

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jupyter-ijavascript-utils",
-  "version": "1.20.0",
+  "version": "1.21.0",
   "description": "Utilities for working with iJavaScript - a Jupyter Kernel",
   "homepage": "https://jupyter-ijavascript-utils.onrender.com/",
   "license": "MIT",

package/src/chain.js

@@ -0,0 +1,62 @@
+/**
+ * Simple monad like wrapper.
+ * 
+ * Very helpful for taking values and then progressively working on them,
+ * instead of continually wrapping deeper in method calls.
+ * 
+ * Calling `chain(3)` - gives an object with two properties:
+ * 
+ * * .value - the original value passed - or 3 in this case
+ * * .chain(function) - where it is passed the value, and returns a new Chain with that value.
+ * * .debug() - console.logs the value, and returns a new Chain with that value
+ * 
+ * For example:
+ * 
+ * ```
+ * const addTwo = (value) => value + 2;
+ * 
+ * //-- we can always get the value
+ * console.log(
+ *  utils.chain(3).value
+ * ); // 3
+ * ```
+ * 
+ * but this is much easier if we continue to chain it
+ * 
+ * ```
+ * console.log(
+ *  utils.chain(3)
+ *    .chain(addTwo)
+ *    .chain(addTwo)
+ *    .debug()
+ *    .chain((value) => value + 3)
+ *    .value
+ * );
+ * // 7
+ * // 10
+ * 
+ * const addTwo = (value) => value + 2;
+ * 
+ * console.log(
+ *  utils.chain(3).value
+ * ); // 3
+ * 
+ * @exports chain
+ * @module chain
+ */
+module.exports = function chain(value) {
+  return ({
+    value,
+    chain: function innerChain(fn) {
+      return chain(fn(value));
+    },
+    debug: function debug(fn) {
+      if (fn) {
+        fn(value);
+      } else {
+        console.log(value);
+      }
+      return chain(value);
+    }
+  });
+};

package/src/index.js

@@ -1,6 +1,7 @@
 const aggregate = require('./aggregate');
 const array = require('./array');
 const base64 = require('./base64');
+const chain = require('./chain');
 const datasets = require('./datasets');
 const describe = require('./describe');
 const group = require('./group');
@@ -38,6 +39,8 @@ module.exports = {
   array,
   /** @see {@link module:base64} */
   base64,
+  /** @see {@link module:chain} */
+  chain,
   /** @see {@link module:datasets} */
   datasets,
   dataset: datasets,

package/src/object.js

@@ -107,7 +107,7 @@ module.exports.MAX_COLLAPSE_DEPTH = 50;
  * @param {any} value -
  * @returns {Object}
  */
-module.exports.objAssign = function objAssign(obj, propertyName, value, ...propertyNameValues) {
+module.exports.assign = function objAssign(obj, propertyName, value, ...propertyNameValues) {
   if ((propertyName === null || propertyName === undefined)) {
     throw Error('Expecting at least one property name to be passed');
   } else if (typeof propertyName !== 'string') {
@@ -123,6 +123,7 @@ module.exports.objAssign = function objAssign(obj, propertyName, value, ...prope
 
   return obj;
 };
+module.exports.objAssign = module.exports.assign;
 
 /**
  * Assigns multiple object entities [[property, value], [property, value], ...];
@@ -131,7 +132,7 @@ module.exports.objAssign = function objAssign(obj, propertyName, value, ...prope
  * @param {Array} entities - 2d array [[property, value], ...]
  * @returns {Object}
  */
-module.exports.objAssignEntities = function objAssignEntities(obj, entities) {
+module.exports.assignEntities = function objAssignEntities(obj, entities) {
   if (!obj) obj = {};
 
   if (!Array.isArray(entities)) {
@@ -146,6 +147,7 @@ module.exports.objAssignEntities = function objAssignEntities(obj, entities) {
 
   return obj;
 };
+module.exports.objAssignEntities = module.exports.assignEntities;
 
 /**
  * Runs a map over a collection, and adds properties the the objects.