@gorgonjs/gorgon 1.4.1 → 1.5.0

package/__tests__/debug.test.ts

@@ -2,42 +2,49 @@ import { describe, it, expect, beforeAll, afterAll, vi } from 'vitest';
 import Gorgon from '../index';
 
 describe('basic storage - date policy', () => {
-
   beforeAll(() => {
-    Gorgon.settings({debug: true});
+    Gorgon.settings({ debug: true });
   });
 
   afterAll(() => {
-    Gorgon.settings({debug: false});
+    Gorgon.settings({ debug: false });
   });
 
-  it('gets the results of a promise, console.info happens twice', async() => {
-
+  it('gets the results of a promise, console.info happens twice', async () => {
     const consoleSpy = vi.spyOn(console, 'info');
 
-    const res = await  Gorgon.get('debug1', async() => {
-      return 'success';
-    }, 1);
-
-    expect(consoleSpy).toHaveBeenCalledTimes(2)
-    return expect(consoleSpy).toHaveBeenLastCalledWith('[Gorgon] Cache resolved, resolved item for: debug1', "success");
+    const res = await Gorgon.get(
+      'debug1',
+      async () => {
+        return 'success';
+      },
+      1,
+    );
 
+    expect(consoleSpy).toHaveBeenCalledTimes(2);
+    return expect(consoleSpy).toHaveBeenLastCalledWith('[Gorgon] Cache resolved, resolved item for: debug1', 'success');
   });
 
-  it('gets the results of a promise, then places a resolver in the queue, console.info happens 4 times', async() => {
-
+  it('gets the results of a promise, then places a resolver in the queue, console.info happens 4 times', async () => {
     const consoleSpy = vi.spyOn(console, 'info');
 
-    const res = Gorgon.get('debug2', async() => {
-      return 'success';
-    }, 1000);
-
-    const res2 = await  Gorgon.get('debug2', async() => {
-      return 'success';
-    }, 1000);
-
-     expect(consoleSpy).toHaveBeenCalledTimes(4);
-    return expect(consoleSpy).toHaveBeenLastCalledWith('[Gorgon] Cache queue resolved for: debug2', "success");
+    const res = Gorgon.get(
+      'debug2',
+      async () => {
+        return 'success';
+      },
+      1000,
+    );
+
+    const res2 = await Gorgon.get(
+      'debug2',
+      async () => {
+        return 'success';
+      },
+      1000,
+    );
+
+    expect(consoleSpy).toHaveBeenCalledTimes(4);
+    return expect(consoleSpy).toHaveBeenLastCalledWith('[Gorgon] Cache queue resolved for: debug2', 'success');
   });
-
 });

package/__tests__/hooks.test.ts

@@ -0,0 +1,181 @@
+import { describe, it, expect, afterAll, beforeAll, vi } from 'vitest';
+import Gorgon from '../index';
+
+/*
+| 'settings'
+| 'addProvider'
+| 'put'
+| 'clear'
+| 'clearAll'
+| 'overwrite'
+| 'get'
+| 'valueError'*/
+
+describe('hooks', () => {
+  it('sets the settings hook and updates when called', () => {
+    const hook = { test: (key, input, oputput) => {} };
+    const hookSpy = vi.spyOn(hook, 'test');
+
+    Gorgon.addHook('settings', hook.test);
+    Gorgon.settings({ debug: true });
+    expect(hookSpy).toHaveBeenCalledWith(
+      'settings',
+      { debug: true },
+      {
+        debug: true,
+        defaultProvider: 'memory',
+        retry: 5000,
+      },
+    );
+  });
+
+  it('sets the addProvider hook and updates when called', () => {
+    const hook = { test: (key, input, oputput) => {} };
+    const hookSpy = vi.spyOn(hook, 'test');
+    const provider = {
+      init: () => Promise.resolve(),
+      get: (key: string) => Promise.resolve(),
+      set: (key: string, value: any, policy: any) => Promise.resolve(value),
+      clear: (key?: string) => Promise.resolve(true),
+      keys: () => Promise.resolve([]),
+    };
+
+    Gorgon.addHook('addProvider', hook.test);
+    Gorgon.addProvider('test', provider);
+    expect(hookSpy).toHaveBeenCalledWith('addProvider', { name: 'test', provider: provider }, undefined);
+  });
+
+  it('sets the put hook and updates when called', async () => {
+    const hook = { test: (key, input, oputput) => {} };
+    const hookSpy = vi.spyOn(hook, 'test');
+
+    Gorgon.addHook('put', hook.test);
+    await Gorgon.put('test', { a: 1 }, { expiry: false, provider: 'memory' });
+    expect(hookSpy).toHaveBeenCalledWith(
+      'put',
+      { key: 'test', value: { a: 1 }, policy: { expiry: false, provider: 'memory' } },
+      { a: 1 },
+    );
+  });
+
+  it('sets the clear hook and updates when called', async () => {
+    const hook = { test: (key, input, oputput) => {} };
+    const hookSpy = vi.spyOn(hook, 'test');
+
+    Gorgon.addHook('clear', hook.test);
+    await Gorgon.clear('test');
+    expect(hookSpy).toHaveBeenCalledWith('clear', { key: 'test', provider: undefined }, undefined);
+  });
+
+  it('sets the clearAll hook and updates when called', async () => {
+    const hook = { test: (key, input, oputput) => {} };
+    const hookSpy = vi.spyOn(hook, 'test');
+
+    Gorgon.addHook('clearAll', hook.test);
+    await Gorgon.clearAll();
+    expect(hookSpy).toHaveBeenCalledWith('clearAll', { provider: undefined }, undefined);
+  });
+
+  it('sets the overwrite hook and updates when called', async () => {
+    const hook = { test: (key, input, oputput) => {} };
+    const hookSpy = vi.spyOn(hook, 'test');
+    const funcy = async () => {
+      return 'overwritten';
+    };
+
+    Gorgon.addHook('overwrite', hook.test);
+    await Gorgon.overwrite('testO', funcy, { expiry: false, provider: 'memory' });
+    expect(hookSpy).toHaveBeenCalledWith(
+      'overwrite',
+      { key: 'testO', asyncFunc: funcy, policy: { expiry: false, provider: 'memory' } },
+      'overwritten',
+    );
+  });
+
+  it('sets the get hook and updates when called', async () => {
+    const hook = { test: (key, input, oputput) => {} };
+    const hookSpy = vi.spyOn(hook, 'test');
+    const funcy = async () => {
+      return 'gotten';
+    };
+
+    Gorgon.addHook('get', hook.test);
+    await Gorgon.get('testG', funcy, { expiry: false, provider: 'memory' });
+    expect(hookSpy).toHaveBeenCalledWith(
+      'get',
+      { key: 'testG', asyncFunc: funcy, policy: { expiry: false, provider: 'memory' }, cacheHit: false, queued: false },
+      Promise.resolve('gotten'),
+    );
+  });
+
+  it('sets the valueError hook and updates when called', async () => {
+    const hook = { test: (key, input, oputput) => {} };
+    const hookSpy = vi.spyOn(hook, 'test');
+    const funcy = async () => {
+      throw new Error('test');
+    };
+
+    Gorgon.addHook('valueError', hook.test);
+    try {
+      await Gorgon.get('testVE', funcy);
+    } catch (e) {
+      // error expected
+    }
+    expect(hookSpy).toHaveBeenCalledWith(
+      'valueError',
+      {
+        key: 'testVE',
+        cacheHit: false,
+        queued: false,
+        asyncFunc: funcy,
+        policy: { expiry: false, provider: 'memory' },
+      },
+      new Error('test'),
+    );
+  });
+
+  describe('hooks advanced functions', () => {
+    it('adds multiple hooks at once', async () => {
+      const hook = { test: (key, input, oputput) => {} };
+      const hookSpy = vi.spyOn(hook, 'test');
+
+      Gorgon.addHook('settings', [hook.test]);
+      Gorgon.settings({ debug: true });
+
+      expect(hookSpy).toHaveBeenCalledWith(
+        'settings',
+        { debug: true },
+        {
+          debug: true,
+          defaultProvider: 'memory',
+          retry: 5000,
+        },
+      );
+    });
+
+    it('console errors when a hook has an error', async () => {
+      const hook = {
+        test: (key, input, oputput) => {
+          throw new Error('this is a bad hook');
+        },
+      };
+      const hookSpy = vi.spyOn(hook, 'test');
+      const hookSpy2 = vi.spyOn(console, 'error');
+
+      Gorgon.addHook('settings', hook.test);
+      Gorgon.settings({ debug: true });
+
+      expect(hookSpy).toHaveBeenCalledWith(
+        'settings',
+        { debug: true },
+        {
+          debug: true,
+          defaultProvider: 'memory',
+          retry: 5000,
+        },
+      );
+
+      expect(hookSpy2).toHaveBeenCalledWith('[Gorgon] Hook error for hook: settings', new Error('this is a bad hook'));
+    });
+  });
+});

package/coverage/base.css

@@ -0,0 +1,224 @@
+body, html {
+  margin:0; padding: 0;
+  height: 100%;
+}
+body {
+    font-family: Helvetica Neue, Helvetica, Arial;
+    font-size: 14px;
+    color:#333;
+}
+.small { font-size: 12px; }
+*, *:after, *:before {
+  -webkit-box-sizing:border-box;
+     -moz-box-sizing:border-box;
+          box-sizing:border-box;
+  }
+h1 { font-size: 20px; margin: 0;}
+h2 { font-size: 14px; }
+pre {
+    font: 12px/1.4 Consolas, "Liberation Mono", Menlo, Courier, monospace;
+    margin: 0;
+    padding: 0;
+    -moz-tab-size: 2;
+    -o-tab-size:  2;
+    tab-size: 2;
+}
+a { color:#0074D9; text-decoration:none; }
+a:hover { text-decoration:underline; }
+.strong { font-weight: bold; }
+.space-top1 { padding: 10px 0 0 0; }
+.pad2y { padding: 20px 0; }
+.pad1y { padding: 10px 0; }
+.pad2x { padding: 0 20px; }
+.pad2 { padding: 20px; }
+.pad1 { padding: 10px; }
+.space-left2 { padding-left:55px; }
+.space-right2 { padding-right:20px; }
+.center { text-align:center; }
+.clearfix { display:block; }
+.clearfix:after {
+  content:'';
+  display:block;
+  height:0;
+  clear:both;
+  visibility:hidden;
+  }
+.fl { float: left; }
+@media only screen and (max-width:640px) {
+  .col3 { width:100%; max-width:100%; }
+  .hide-mobile { display:none!important; }
+}
+
+.quiet {
+  color: #7f7f7f;
+  color: rgba(0,0,0,0.5);
+}
+.quiet a { opacity: 0.7; }
+
+.fraction {
+  font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
+  font-size: 10px;
+  color: #555;
+  background: #E8E8E8;
+  padding: 4px 5px;
+  border-radius: 3px;
+  vertical-align: middle;
+}
+
+div.path a:link, div.path a:visited { color: #333; }
+table.coverage {
+  border-collapse: collapse;
+  margin: 10px 0 0 0;
+  padding: 0;
+}
+
+table.coverage td {
+  margin: 0;
+  padding: 0;
+  vertical-align: top;
+}
+table.coverage td.line-count {
+    text-align: right;
+    padding: 0 5px 0 20px;
+}
+table.coverage td.line-coverage {
+    text-align: right;
+    padding-right: 10px;
+    min-width:20px;
+}
+
+table.coverage td span.cline-any {
+    display: inline-block;
+    padding: 0 5px;
+    width: 100%;
+}
+.missing-if-branch {
+    display: inline-block;
+    margin-right: 5px;
+    border-radius: 3px;
+    position: relative;
+    padding: 0 4px;
+    background: #333;
+    color: yellow;
+}
+
+.skip-if-branch {
+    display: none;
+    margin-right: 10px;
+    position: relative;
+    padding: 0 4px;
+    background: #ccc;
+    color: white;
+}
+.missing-if-branch .typ, .skip-if-branch .typ {
+    color: inherit !important;
+}
+.coverage-summary {
+  border-collapse: collapse;
+  width: 100%;
+}
+.coverage-summary tr { border-bottom: 1px solid #bbb; }
+.keyline-all { border: 1px solid #ddd; }
+.coverage-summary td, .coverage-summary th { padding: 10px; }
+.coverage-summary tbody { border: 1px solid #bbb; }
+.coverage-summary td { border-right: 1px solid #bbb; }
+.coverage-summary td:last-child { border-right: none; }
+.coverage-summary th {
+  text-align: left;
+  font-weight: normal;
+  white-space: nowrap;
+}
+.coverage-summary th.file { border-right: none !important; }
+.coverage-summary th.pct { }
+.coverage-summary th.pic,
+.coverage-summary th.abs,
+.coverage-summary td.pct,
+.coverage-summary td.abs { text-align: right; }
+.coverage-summary td.file { white-space: nowrap;  }
+.coverage-summary td.pic { min-width: 120px !important;  }
+.coverage-summary tfoot td { }
+
+.coverage-summary .sorter {
+    height: 10px;
+    width: 7px;
+    display: inline-block;
+    margin-left: 0.5em;
+    background: url(sort-arrow-sprite.png) no-repeat scroll 0 0 transparent;
+}
+.coverage-summary .sorted .sorter {
+    background-position: 0 -20px;
+}
+.coverage-summary .sorted-desc .sorter {
+    background-position: 0 -10px;
+}
+.status-line {  height: 10px; }
+/* yellow */
+.cbranch-no { background: yellow !important; color: #111; }
+/* dark red */
+.red.solid, .status-line.low, .low .cover-fill { background:#C21F39 }
+.low .chart { border:1px solid #C21F39 }
+.highlighted,
+.highlighted .cstat-no, .highlighted .fstat-no, .highlighted .cbranch-no{
+  background: #C21F39 !important;
+}
+/* medium red */
+.cstat-no, .fstat-no, .cbranch-no, .cbranch-no { background:#F6C6CE }
+/* light red */
+.low, .cline-no { background:#FCE1E5 }
+/* light green */
+.high, .cline-yes { background:rgb(230,245,208) }
+/* medium green */
+.cstat-yes { background:rgb(161,215,106) }
+/* dark green */
+.status-line.high, .high .cover-fill { background:rgb(77,146,33) }
+.high .chart { border:1px solid rgb(77,146,33) }
+/* dark yellow (gold) */
+.status-line.medium, .medium .cover-fill { background: #f9cd0b; }
+.medium .chart { border:1px solid #f9cd0b; }
+/* light yellow */
+.medium { background: #fff4c2; }
+
+.cstat-skip { background: #ddd; color: #111; }
+.fstat-skip { background: #ddd; color: #111 !important; }
+.cbranch-skip { background: #ddd !important; color: #111; }
+
+span.cline-neutral { background: #eaeaea; }
+
+.coverage-summary td.empty {
+    opacity: .5;
+    padding-top: 4px;
+    padding-bottom: 4px;
+    line-height: 1;
+    color: #888;
+}
+
+.cover-fill, .cover-empty {
+  display:inline-block;
+  height: 12px;
+}
+.chart {
+  line-height: 0;
+}
+.cover-empty {
+    background: white;
+}
+.cover-full {
+    border-right: none !important;
+}
+pre.prettyprint {
+    border: none !important;
+    padding: 0 !important;
+    margin: 0 !important;
+}
+.com { color: #999 !important; }
+.ignore-none { color: #999; font-weight: normal; }
+
+.wrapper {
+  min-height: 100%;
+  height: auto !important;
+  height: 100%;
+  margin: 0 auto -48px;
+}
+.footer, .push {
+  height: 48px;
+}

package/coverage/block-navigation.js

@@ -0,0 +1,87 @@
+/* eslint-disable */
+var jumpToCode = (function init() {
+    // Classes of code we would like to highlight in the file view
+    var missingCoverageClasses = ['.cbranch-no', '.cstat-no', '.fstat-no'];
+
+    // Elements to highlight in the file listing view
+    var fileListingElements = ['td.pct.low'];
+
+    // We don't want to select elements that are direct descendants of another match
+    var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > `
+
+    // Selecter that finds elements on the page to which we can jump
+    var selector =
+        fileListingElements.join(', ') +
+        ', ' +
+        notSelector +
+        missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b`
+
+    // The NodeList of matching elements
+    var missingCoverageElements = document.querySelectorAll(selector);
+
+    var currentIndex;
+
+    function toggleClass(index) {
+        missingCoverageElements
+            .item(currentIndex)
+            .classList.remove('highlighted');
+        missingCoverageElements.item(index).classList.add('highlighted');
+    }
+
+    function makeCurrent(index) {
+        toggleClass(index);
+        currentIndex = index;
+        missingCoverageElements.item(index).scrollIntoView({
+            behavior: 'smooth',
+            block: 'center',
+            inline: 'center'
+        });
+    }
+
+    function goToPrevious() {
+        var nextIndex = 0;
+        if (typeof currentIndex !== 'number' || currentIndex === 0) {
+            nextIndex = missingCoverageElements.length - 1;
+        } else if (missingCoverageElements.length > 1) {
+            nextIndex = currentIndex - 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    function goToNext() {
+        var nextIndex = 0;
+
+        if (
+            typeof currentIndex === 'number' &&
+            currentIndex < missingCoverageElements.length - 1
+        ) {
+            nextIndex = currentIndex + 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    return function jump(event) {
+        if (
+            document.getElementById('fileSearch') === document.activeElement &&
+            document.activeElement != null
+        ) {
+            // if we're currently focused on the search input, we don't want to navigate
+            return;
+        }
+
+        switch (event.which) {
+            case 78: // n
+            case 74: // j
+                goToNext();
+                break;
+            case 66: // b
+            case 75: // k
+            case 80: // p
+                goToPrevious();
+                break;
+        }
+    };
+})();
+window.addEventListener('keydown', jumpToCode);