jupyter-ijavascript-utils 1.2.0 → 1.3.0

package/DOCS.md

@@ -14,17 +14,18 @@ See the [#Installation section for requirements and installation](#install)
 | {@link module:format}         | Utilities for formatting and massaging data to be legible.                                          |
 | {@link module:group}          | Library to group collections of objects - generating Maps of records ({@link SourceMap})            |
 | {@link module:ijs}            | Utility methods to support working within the iJavaScript kernel within Jupyter.                    |
+| {@link module:leaflet}        | Library to simplify rendering maps.                                                                 |
 | {@link module:object}         | Utilities for massaging and managing JavaScript Objects or collections of Objects.                  |
 | {@link module:set}            | Functional Utilities for managing JavaScript Sets - allowing for chaining.                          |
 | {@link module:vega}           | Simple utility to streamline showing Vega-Lite charts within iJS Notebooks.                         |
-| {@link SourceMap}             | SubClass of Maps - generated by the {@link module:group} and reducible with {@link module:aggregate} |
+| {@link SourceMap}             | SubClass of Maps - generated by the {@link module:group} and reducible with {@link module:aggregate}|
 | {@link TableGenerator}        | Class that can filter, sorts, manage and then generate HTML, CSV, Markdown, etc.                    |
 
 -------
 
 ## What's New
 
-5.2 - bumped vega-lite to latest
+5.3 - Add {@link module:leaflet|Leaflet} for Maps, allow Vega to use {@link module:vega.svgFromSpec|explicit specs} (so [Examples can be copied and pasted](https://vega.github.io/vega-lite/examples/), and add in {@link module:ijs.htmlScript|htmlScripts}
 
 -------
 
@@ -173,6 +174,28 @@ utils.vega.svg((vl) => vl.markPoint()
 
 ![Screenshot of Vega Cell](img/BarleyYieldBySite.png)
 
+## Render Maps
+
+({@link module:leaflet|See the Leaflet module for more})
+
+![Screenshot of Leaflet](img/leafletRenderMarkers.png)
+
+## Render Other Libraries
+
+(See the {@tutorial htmlScript} tutorial for more)
+
+```
+utils.ijs.htmlScript({
+    scripts: ['https://cdnjs.cloudflare.com/ajax/libs/qrcodejs/1.0.0/qrcode.min.js'],
+    height: '100%',
+    onReady: ({rootEl}) => {
+        new QRCode(rootEl, "https://jupyter-ijavascript-utils.onrender.com/");
+    }
+});
+```
+
+![Screenshot of QR Code](img/htmlScript_qrCode.png)
+
 <a name="install">&nbsp;</a>
 # Install
 

package/README.md

@@ -18,7 +18,7 @@ See documentation at: [https://jupyter-ijavascript-utils.onrender.com/](https://
 
 # What's New
 
-5.2 - bumped vega-lite to latest
+5.3 - Add Leaflet for Maps, allow Vega to use explicit specs (so [Examples can be copied and pasted](https://vega.github.io/vega-lite/examples/), and add in htmlScripts
 
 # For Example
 
@@ -157,8 +157,28 @@ utils.vega.svg((vl) => vl.markPoint()
 )
 ```
 
+## Render Charts
+
 ![Screenshot of Vega Cell](https://jupyter-ijavascript-utils.onrender.com/img/BarleyYieldBySite.png)
 
+## Render Maps
+
+![Screenshot of Leaflet](https://jupyter-ijavascript-utils.onrender.com/img/leafletRenderMarkers.png)
+
+## Render Other Libraries
+
+```
+utils.ijs.htmlScript({
+    scripts: ['https://cdnjs.cloudflare.com/ajax/libs/qrcodejs/1.0.0/qrcode.min.js'],
+    height: '100%',
+    onReady: ({rootEl}) => {
+        new QRCode(rootEl, "https://jupyter-ijavascript-utils.onrender.com/");
+    }
+});
+```
+
+![Screenshot of QR Code](https://jupyter-ijavascript-utils.onrender.com/img/htmlScript_qrCode.png)
+
 # License
 
 See [License](https://jupyter-ijavascript-utils.onrender.com/LICENSE) (MIT License).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jupyter-ijavascript-utils",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Utilities for working with iJavaScript - a Jupyter Kernel",
   "main": "src/index.js",
   "scripts": {
@@ -45,6 +45,7 @@
     "pino-pretty": "^5.1.2",
     "plantuml-encoder": "^1.4.0",
     "promise-sequential": "^1.1.1",
+    "uuid": "^8.3.2",
     "vega": "^5.22.0",
     "vega-datasets": "^2.3.0",
     "vega-lite": "^5.2.0",

package/src/__tests__/TableGenerator__spec.js

@@ -3,7 +3,7 @@
 const ArrayUtils = require('../array');
 
 // eslint-disable-next-line no-unused-vars
-const FileUtil = require('../file');
+// const FileUtil = require('../file');
 
 const TableGenerator = require('../TableGenerator');
 
@@ -362,7 +362,7 @@ global.describe('tableGenerator', () => {
         const results = new TableGenerator(data)
           .printOptions({ collapseObjects: true, dateFormat: 'toISOString' })
           .generateMarkdown();
-        // FileUtil.writeFileStd('/tmp/tmp', results);
+        // FileUtil.writeFileStd('./tmp/tmp', results);
         global.expect(results).toStrictEqual(expected);
       });
     });
@@ -430,7 +430,7 @@ global.describe('tableGenerator', () => {
 \t<td >2.68</td>
 </tr>
 </table>`;
-        // FileUtil.writeFileStd('/tmp/tmp', results);
+        // FileUtil.writeFileStd('./tmp/tmp', results);
         global.expect(results).toBe(expected);
       });
     });
@@ -461,7 +461,7 @@ global.describe('tableGenerator', () => {
 \t<td >2.68</td>
 </tr>
 </table>`;
-        // FileUtil.writeFileStd('/tmp/tmp', results);
+        // FileUtil.writeFileStd('./tmp/tmp', results);
         global.expect(results).toBe(expected);
       });
     });
@@ -493,7 +493,7 @@ global.describe('tableGenerator', () => {
         const results = new TableGenerator(weather)
           .styleRow(styleRowFn)
           .generateHTML();
-        // FileUtil.writeFileStd('/tmp/tmp', results);
+        // FileUtil.writeFileStd('./tmp/tmp', results);
         global.expect(results).toBe(expected);
       });
     });
@@ -524,7 +524,7 @@ global.describe('tableGenerator', () => {
         const results = new TableGenerator(weather)
           .styleCell(styleRowFn)
           .generateHTML();
-        // FileUtil.writeFileStd('/tmp/tmp', results);
+        // FileUtil.writeFileStd('./tmp/tmp', results);
         global.expect(results).toBe(expected);
       });
     });
@@ -560,7 +560,7 @@ global.describe('tableGenerator', () => {
           .augment(({ fullMonth: (row) => monthMap.get(row.month) }))
           .columns(['id', 'city', 'precip', 'month', 'fullMonth'])
           .generateHTML();
-        //FileUtil.writeFileStd('/tmp/tmp', results);
+        //FileUtil.writeFileStd('./tmp/tmp', results);
         global.expect(results).toBe(expected);
       });
       global.it('clears the format if we send a null formatter', () => {
@@ -588,7 +588,7 @@ global.describe('tableGenerator', () => {
         const results = new TableGenerator(weather)
           .augment(null)
           .generateHTML();
-        // FileUtil.writeFileStd('/tmp/tmp', results);
+        // FileUtil.writeFileStd('./tmp/tmp', results);
         global.expect(results).toBe(expected);
       });
 
@@ -745,7 +745,7 @@ global.describe('tableGenerator', () => {
 </tr>
 </table>`;
         const results = htmlSpy.mock.calls[0][0];
-        // FileUtil.writeFileStd('/tmp/tmp', results);
+        // FileUtil.writeFileStd('./tmp/tmp', results);
 
         global.expect(results).toBe(expected);
       });
@@ -776,7 +776,7 @@ global.describe('tableGenerator', () => {
 1 |Seattle|Aug  |0.87  
 0 |Seattle|Apr  |2.68  `;
         const results = consoleSpy.mock.calls[0][0];
-        //FileUtil.writeFileStd('/tmp/tmp', results);
+        //FileUtil.writeFileStd('./tmp/tmp', results);
 
         global.expect(results).toBe(expected);
       });
@@ -806,7 +806,7 @@ global.describe('tableGenerator', () => {
 "1","Seattle","Aug","0.87"
 "0","Seattle","Apr","2.68"`;
         const results = consoleSpy.mock.calls[0][0];
-        FileUtil.writeFileStd('/tmp/tmp', results);
+        // FileUtil.writeFileStd('./tmp/tmp', results);
 
         global.expect(results).toBe(expected);
       });

package/src/__tests__/file__spec.js

@@ -179,6 +179,19 @@ global.describe('FileUtil', () => {
   });
 
   global.describe('writeFileStd', () => {
+    //-- disable warning about using filestd in tests
+    const ORIGINAL_CONSOLE = global.console;
+    global.beforeEach(() => {
+      global.console = ({
+        error: jest.fn(),
+        log: jest.fn(),
+        warn: jest.fn()
+      });
+    });
+    global.afterAll(() => {
+      global.console = ORIGINAL_CONSOLE;
+    });
+
     global.it('writes text', () => {
       const path = './tmp/sampleFile';
       const message = 'Success';

package/src/__tests__/ijs__spec.js

@@ -7,6 +7,9 @@
 // const { UNIT_CHANNELS } = require('vega-lite/build/src/channel');
 const IJSUtils = require('../ijs');
 
+// eslint-disable-next-line no-unused-vars
+const FileUtil = require('../file');
+
 const removeIJSContext = () => {
   delete global.$$;
 };