jupyter-ijavascript-utils 1.21.1 → 1.21.3

package/DOCS.md

@@ -1,3 +1,22 @@
+<p align="center">
+    <a href="https://jupyter-ijavascript-utils.onrender.com/" alt="Documentation">
+        <img src="https://img.shields.io/badge/Documentation-here-informational" />
+    </a>
+    <a href="https://jupyter-ijavascript-utils.onrender.com/LICENSE" alt="License">
+        <img src="https://img.shields.io/badge/License-MIT-green" />
+    </a>
+    <img src="https://img.shields.io/badge/Coverage-98-green" />
+    <a href="https://www.npmjs.com/package/jupyter-ijavascript-utils" alt="npm">
+        <img src="https://img.shields.io/badge/npm-%5E1.X-red" />
+    </a>
+    <a href="https://github.com/paulroth3d/jupyter-ijavascript-utils" alt="npm">
+        <img src="https://img.shields.io/badge/github-here-black" />
+    </a>
+    <a href="https://mybinder.org/v2/gh/paulroth3d/jupyter-ijavascript-utils/main" alt="Launch Binder">
+                <img src="https://mybinder.org/badge_logo.svg" />
+    </a>
+</p>
+
 # Overview
 
 This is a library to help people that understand JavaScript

package/Dockerfile

@@ -1,34 +1,3 @@
-# per https://github.com/n-riesco/ijavascript/issues/273
-# and https://github.com/paulroth3d/jupyter-ijavascript-utils/issues/4
+# syntax=docker/dockerfile:1
 
-# as of today this is python-3.7.1
-FROM jupyter/base-notebook:latest
-
-# for nbhosting
-USER root
-COPY start-in-dir-as-uid.sh /usr/local/bin
-
-# prerequisites with apt-get
-# we do install python(2) here because
-# some npm build part named gyp still requires it
-RUN apt-get update && apt-get install -y gcc g++ make python
-
-# !!! dirty trick!!!
-# original PATH is
-# /opt/conda/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
-# move conda's path **at the end**
-# so that python resolves in /usr/bin/python(2)
-# but node is still found in conda
-ENV PATH="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/opt/conda/bin"
-USER jovyan
-RUN npm install -g ijavascript
-RUN ijsinstall
-
-# for displaying html fragments
-RUN npm install -g jsdom d3
-
-# !!! clean up!!!
-USER root
-RUN apt-get autoremove -y python
-ENV PATH="/opt/conda/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
-USER jovyan
+FROM darkbluestudios/jupyter-ijavascript-utils:binder

package/README.md

@@ -6,8 +6,14 @@
         <img src="https://img.shields.io/badge/License-MIT-green" />
     </a>
     <img src="https://img.shields.io/badge/Coverage-98-green" />
+    <a href="https://www.npmjs.com/package/jupyter-ijavascript-utils" alt="npm">
+        <img src="https://img.shields.io/badge/npm-%5E1.X-red" />
+    </a>
     <a href="https://github.com/paulroth3d/jupyter-ijavascript-utils" alt="npm">
-        <img src="https://img.shields.io/badge/npm-%5E1.15-red" />
+        <img src="https://img.shields.io/badge/github-here-black" />
+    </a>
+    <a href="https://mybinder.org/v2/gh/paulroth3d/jupyter-ijavascript-utils/main" alt="Launch Binder">
+                <img src="https://mybinder.org/badge_logo.svg" />
     </a>
 </p>
 
@@ -23,6 +29,9 @@ Notebooks are a way to explore and experiment, in addition to write and explain
 
 ![Screenshot](docResources/img/started_jupyterSideBySide.jpg)
 
+See Example binder here:
+[![Binder:what can I do with this](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/paulroth3d/jupyter-ijavascript-utils/main?labpath=example.ipynb)
+
 # Documentation
 
 See documentation at: [https://jupyter-ijavascript-utils.onrender.com/](https://jupyter-ijavascript-utils.onrender.com/)

package/package.json

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

package/src/chain.js

@@ -8,12 +8,14 @@
  * 
  * * .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.
+ * * .chainMap(function) -> where it treats value as an array, and maps function on every item in the array
+ * * .chainReduce(function, initialValue) -> where it treats value as an array, and reduces the value array
  * * .debug() - console.logs the value, and returns a new Chain with that value
  * 
  * For example:
  * 
  * ```
- * const addTwo = (value) => value + 2;
+ * addTwo = (value) => value + 2;
  * 
  * //-- we can always get the value
  * console.log(
@@ -24,22 +26,66 @@
  * but this is much easier if we continue to chain it
  * 
  * ```
+ * addTwo = (value) => value + 2;
+ * addTwo(3); // 5
+ * 
  * console.log(
  *  utils.chain(3)
- *    .chain(addTwo)
- *    .chain(addTwo)
- *    .debug()
- *    .chain((value) => value + 3)
+ *    .chain(addTwo) // (3 + 2)
+ *    .chain(addTwo) // (5 + 2)
+ *    .debug() // consoles 7 and passes the value along
+ *    // define a function inline
+ *    .chain((value) => value + 3) // (7 + 3)
  *    .value
  * );
+ * 
  * // 7
  * // 10
+ * ```
  * 
- * const addTwo = (value) => value + 2;
+ * Note that we can also map against values in the array
  * 
- * console.log(
- *  utils.chain(3).value
- * ); // 3
+ * ```
+ * initializeArray = (size) => Array.from(Array(size)).map((val, index) => index);
+ * initializeArray(3); // [0, 1, 2]
+ * 
+ * addTwo = (value) => value + 2;
+ * addTwo(3); // 5
+ * 
+ * utils.chain(3)
+ *   .chain(initializeArray) // [0, 1, 2]
+ *   .chainMap(addTwo) // [2, 3, 4] or [0 + 2, 1 + 2, 2 + 2]
+ *   .chainMap(addTwo)
+ *   .value;
+ * // [4, 5, 6]
+ * ```
+ * 
+ * Or even combine with other utility methods
+ * 
+ * ```
+ * badStr = 'I%20am%20the%20very%20model%20of%20a%20modern%20Major'
+ *  + '-General%0AI\'ve%20information%20vegetable%2C%20animal%2C%20'
+ *  + 'and%20mineral%0AI%20know%20the%20kings%20of%20England%2C%20'
+ *  + 'and%20I%20quote%20the%20fights%0AHistorical%0AFrom%20Marath'
+ *  + 'on%20to%20Waterloo%2C%20in%20order%20categorical';
+ * 
+ * chain(badStr)
+ *     .chain(decodeURIComponent)
+ *     .chain(v => v.split('\n'))
+ *     // .debug()                  // check the values along the way
+ *     .chainMap(line => ({ line, length: line.length }))
+ *     .chain(values => utils.table(values).render());
+ * ```
+ * 
+ * and it renders out a lovely table like this:
+ * 
+ * line                                               |length
+ * --                                                 |--    
+ * I am the very model of a modern Major-General      |45    
+ * I've information vegetable, animal, and mineral    |47    
+ * I know the kings of England, and I quote the fights|51    
+ * Historical                                         |10    
+ * From Marathon to Waterloo, in order categorical    |47    
  * 
  * @exports chain
  * @module chain
@@ -50,6 +96,14 @@ module.exports = function chain(value) {
     chain: function innerChain(fn) {
       return chain(fn(value));
     },
+    chainMap: function chainMap(fn) {
+      if (!Array.isArray(value)) throw Error(`chainMap expected an array, but was passed:${value}`);
+      return chain(value.map(fn));
+    },
+    chainReduce: function chainReduce(fn, initialValue) {
+      if (!Array.isArray(value)) throw Error(`chainReduce expected an array, but was passed:${value}`);
+      return chain(value.reduce(fn, initialValue));
+    },
     debug: function debug(fn) {
       if (fn) {
         fn(value);