kareem 2.4.1 → 2.5.0

package/Makefile

@@ -1,5 +0,0 @@
-docs:
-	node ./docs.js
-
-coverage:
-	./node_modules/istanbul/lib/cli.js cover ./node_modules/mocha/bin/_mocha -- -R spec ./test/*

package/docs.js

@@ -1,41 +0,0 @@
-'use strict';
-
-var acquit = require('acquit');
-
-require('acquit-ignore')();
-
-var content = require('fs').readFileSync('./test/examples.test.js').toString();
-var blocks = acquit.parse(content);
-
-var mdOutput =
-  '# kareem\n\n' +
-  '  [![Build Status](https://travis-ci.org/vkarpov15/kareem.svg?branch=master)](https://travis-ci.org/vkarpov15/kareem)\n' +
-  '  [![Coverage Status](https://img.shields.io/coveralls/vkarpov15/kareem.svg)](https://coveralls.io/r/vkarpov15/kareem)\n\n' +
-  'Re-imagined take on the [hooks](http://npmjs.org/package/hooks) module, ' +
-  'meant to offer additional flexibility in allowing you to execute hooks ' +
-  'whenever necessary, as opposed to simply wrapping a single function.\n\n' +
-  'Named for the NBA\'s all-time leading scorer Kareem Abdul-Jabbar, known ' +
-  'for his mastery of the [hook shot](http://en.wikipedia.org/wiki/Kareem_Abdul-Jabbar#Skyhook)\n\n' +
-  '<img src="http://upload.wikimedia.org/wikipedia/commons/0/00/Kareem-Abdul-Jabbar_Lipofsky.jpg" width="220">\n\n' +
-  '# API\n\n';
-
-for (var i = 0; i < blocks.length; ++i) {
-  var describe = blocks[i];
-  mdOutput += '## ' + describe.contents + '\n\n';
-  mdOutput += describe.comments[0] ?
-    acquit.trimEachLine(describe.comments[0]) + '\n\n' :
-    '';
-
-  for (var j = 0; j < describe.blocks.length; ++j) {
-    var it = describe.blocks[j];
-    mdOutput += '#### It ' + it.contents + '\n\n';
-    mdOutput += it.comments[0] ?
-      acquit.trimEachLine(it.comments[0]) + '\n\n' :
-      '';
-    mdOutput += '```javascript\n';
-    mdOutput += it.code + '\n';
-    mdOutput += '```\n\n';
-  }
-}
-
-require('fs').writeFileSync('README.md', mdOutput);

package/test/examples.test.js

@@ -1,429 +0,0 @@
-'use strict';
-
-var assert = require('assert');
-const { beforeEach, describe, it } = require('mocha');
-var Kareem = require('../');
-
-/* Much like [hooks](https://npmjs.org/package/hooks), kareem lets you define
- * pre and post hooks: pre hooks are called before a given function executes.
- * Unlike hooks, kareem stores hooks and other internal state in a separate
- * object, rather than relying on inheritance. Furthermore, kareem exposes
- * an `execPre()` function that allows you to execute your pre hooks when
- * appropriate, giving you more fine-grained control over your function hooks.
- */
-describe('pre hooks', function() {
-  var hooks;
-
-  beforeEach(function() {
-    hooks = new Kareem();
-  });
-
-  it('runs without any hooks specified', function(done) {
-    hooks.execPre('cook', null, function() {
-      // ...
-      // acquit:ignore:start
-      done();
-      // acquit:ignore:end
-    });
-  });
-
-  /* pre hook functions take one parameter, a "done" function that you execute
-   * when your pre hook is finished.
-   */
-  it('runs basic serial pre hooks', function(done) {
-    var count = 0;
-
-    hooks.pre('cook', function(done) {
-      ++count;
-      done();
-    });
-
-    hooks.execPre('cook', null, function() {
-      assert.equal(1, count);
-      // acquit:ignore:start
-      done();
-      // acquit:ignore:end
-    });
-  });
-
-  it('can run multipe pre hooks', function(done) {
-    var count1 = 0;
-    var count2 = 0;
-
-    hooks.pre('cook', function(done) {
-      ++count1;
-      done();
-    });
-
-    hooks.pre('cook', function(done) {
-      ++count2;
-      done();
-    });
-
-    hooks.execPre('cook', null, function() {
-      assert.equal(1, count1);
-      assert.equal(1, count2);
-      // acquit:ignore:start
-      done();
-      // acquit:ignore:end
-    });
-  });
-
-  /* If your pre hook function takes no parameters, its assumed to be
-   * fully synchronous.
-   */
-  it('can run fully synchronous pre hooks', function(done) {
-    var count1 = 0;
-    var count2 = 0;
-
-    hooks.pre('cook', function() {
-      ++count1;
-    });
-
-    hooks.pre('cook', function() {
-      ++count2;
-    });
-
-    hooks.execPre('cook', null, function(error) {
-      assert.equal(null, error);
-      assert.equal(1, count1);
-      assert.equal(1, count2);
-      // acquit:ignore:start
-      done();
-      // acquit:ignore:end
-    });
-  });
-
-  /* Pre save hook functions are bound to the second parameter to `execPre()`
-   */
-  it('properly attaches context to pre hooks', function(done) {
-    hooks.pre('cook', function(done) {
-      this.bacon = 3;
-      done();
-    });
-
-    hooks.pre('cook', function(done) {
-      this.eggs = 4;
-      done();
-    });
-
-    var obj = { bacon: 0, eggs: 0 };
-
-    // In the pre hooks, `this` will refer to `obj`
-    hooks.execPre('cook', obj, function(error) {
-      assert.equal(null, error);
-      assert.equal(3, obj.bacon);
-      assert.equal(4, obj.eggs);
-      // acquit:ignore:start
-      done();
-      // acquit:ignore:end
-    });
-  });
-
-  /* Like the hooks module, you can declare "async" pre hooks - these take two
-   * parameters, the functions `next()` and `done()`. `next()` passes control to
-   * the next pre hook, but the underlying function won't be called until all
-   * async pre hooks have called `done()`.
-   */
-  it('can execute parallel (async) pre hooks', function(done) {
-    hooks.pre('cook', true, function(next, done) {
-      this.bacon = 3;
-      next();
-      setTimeout(function() {
-        done();
-      }, 5);
-    });
-
-    hooks.pre('cook', true, function(next, done) {
-      next();
-      var _this = this;
-      setTimeout(function() {
-        _this.eggs = 4;
-        done();
-      }, 10);
-    });
-
-    hooks.pre('cook', function(next) {
-      this.waffles = false;
-      next();
-    });
-
-    var obj = { bacon: 0, eggs: 0 };
-
-    hooks.execPre('cook', obj, function() {
-      assert.equal(3, obj.bacon);
-      assert.equal(4, obj.eggs);
-      assert.equal(false, obj.waffles);
-      // acquit:ignore:start
-      done();
-      // acquit:ignore:end
-    });
-  });
-
-  /* You can also return a promise from your pre hooks instead of calling
-   * `next()`. When the returned promise resolves, kareem will kick off the
-   * next middleware.
-   */
-  it('supports returning a promise', function(done) {
-    hooks.pre('cook', function() {
-      return new Promise(resolve => {
-        setTimeout(() => {
-          this.bacon = 3;
-          resolve();
-        }, 100);
-      });
-    });
-
-    var obj = { bacon: 0 };
-
-    hooks.execPre('cook', obj, function() {
-      assert.equal(3, obj.bacon);
-      // acquit:ignore:start
-      done();
-      // acquit:ignore:end
-    });
-  });
-});
-
-describe('post hooks', function() {
-  var hooks;
-
-  beforeEach(function() {
-    hooks = new Kareem();
-  });
-
-  it('runs without any hooks specified', function(done) {
-    hooks.execPost('cook', null, [1], function(error, eggs) {
-      assert.ifError(error);
-      assert.equal(1, eggs);
-      done();
-    });
-  });
-
-  it('executes with parameters passed in', function(done) {
-    hooks.post('cook', function(eggs, bacon, callback) {
-      assert.equal(1, eggs);
-      assert.equal(2, bacon);
-      callback();
-    });
-
-    hooks.execPost('cook', null, [1, 2], function(error, eggs, bacon) {
-      assert.ifError(error);
-      assert.equal(1, eggs);
-      assert.equal(2, bacon);
-      // acquit:ignore:start
-      done();
-      // acquit:ignore:end
-    });
-  });
-
-  it('can use synchronous post hooks', function(done) {
-    var execed = {};
-
-    hooks.post('cook', function(eggs, bacon) {
-      execed.first = true;
-      assert.equal(1, eggs);
-      assert.equal(2, bacon);
-    });
-
-    hooks.post('cook', function(eggs, bacon, callback) {
-      execed.second = true;
-      assert.equal(1, eggs);
-      assert.equal(2, bacon);
-      callback();
-    });
-
-    hooks.execPost('cook', null, [1, 2], function(error, eggs, bacon) {
-      assert.ifError(error);
-      assert.equal(2, Object.keys(execed).length);
-      assert.ok(execed.first);
-      assert.ok(execed.second);
-      assert.equal(1, eggs);
-      assert.equal(2, bacon);
-      // acquit:ignore:start
-      done();
-      // acquit:ignore:end
-    });
-  });
-
-  /* You can also return a promise from your post hooks instead of calling
-   * `next()`. When the returned promise resolves, kareem will kick off the
-   * next middleware.
-   */
-  it('supports returning a promise', function(done) {
-    hooks.post('cook', function(bacon) {
-      return new Promise(resolve => {
-        setTimeout(() => {
-          this.bacon = 3;
-          resolve();
-        }, 100);
-      });
-    });
-
-    var obj = { bacon: 0 };
-
-    hooks.execPost('cook', obj, obj, function() {
-      assert.equal(obj.bacon, 3);
-      // acquit:ignore:start
-      done();
-      // acquit:ignore:end
-    });
-  });
-});
-
-describe('wrap()', function() {
-  var hooks;
-
-  beforeEach(function() {
-    hooks = new Kareem();
-  });
-
-  it('wraps pre and post calls into one call', function(done) {
-    hooks.pre('cook', true, function(next, done) {
-      this.bacon = 3;
-      next();
-      setTimeout(function() {
-        done();
-      }, 5);
-    });
-
-    hooks.pre('cook', true, function(next, done) {
-      next();
-      var _this = this;
-      setTimeout(function() {
-        _this.eggs = 4;
-        done();
-      }, 10);
-    });
-
-    hooks.pre('cook', function(next) {
-      this.waffles = false;
-      next();
-    });
-
-    hooks.post('cook', function(obj) {
-      obj.tofu = 'no';
-    });
-
-    var obj = { bacon: 0, eggs: 0 };
-
-    var args = [obj];
-    args.push(function(error, result) {
-      assert.ifError(error);
-      assert.equal(null, error);
-      assert.equal(3, obj.bacon);
-      assert.equal(4, obj.eggs);
-      assert.equal(false, obj.waffles);
-      assert.equal('no', obj.tofu);
-
-      assert.equal(obj, result);
-      // acquit:ignore:start
-      done();
-      // acquit:ignore:end
-    });
-
-    hooks.wrap(
-      'cook',
-      function(o, callback) {
-        assert.equal(3, obj.bacon);
-        assert.equal(4, obj.eggs);
-        assert.equal(false, obj.waffles);
-        assert.equal(undefined, obj.tofu);
-        callback(null, o);
-      },
-      obj,
-      args);
-  });
-});
-
-describe('createWrapper()', function() {
-  var hooks;
-
-  beforeEach(function() {
-    hooks = new Kareem();
-  });
-
-  it('wraps wrap() into a callable function', function(done) {
-    hooks.pre('cook', true, function(next, done) {
-      this.bacon = 3;
-      next();
-      setTimeout(function() {
-        done();
-      }, 5);
-    });
-
-    hooks.pre('cook', true, function(next, done) {
-      next();
-      var _this = this;
-      setTimeout(function() {
-        _this.eggs = 4;
-        done();
-      }, 10);
-    });
-
-    hooks.pre('cook', function(next) {
-      this.waffles = false;
-      next();
-    });
-
-    hooks.post('cook', function(obj) {
-      obj.tofu = 'no';
-    });
-
-    var obj = { bacon: 0, eggs: 0 };
-
-    var cook = hooks.createWrapper(
-      'cook',
-      function(o, callback) {
-        assert.equal(3, obj.bacon);
-        assert.equal(4, obj.eggs);
-        assert.equal(false, obj.waffles);
-        assert.equal(undefined, obj.tofu);
-        callback(null, o);
-      },
-      obj);
-
-    cook(obj, function(error, result) {
-      assert.ifError(error);
-      assert.equal(3, obj.bacon);
-      assert.equal(4, obj.eggs);
-      assert.equal(false, obj.waffles);
-      assert.equal('no', obj.tofu);
-
-      assert.equal(obj, result);
-      // acquit:ignore:start
-      done();
-      // acquit:ignore:end
-    });
-  });
-});
-
-describe('clone()', function() {
-  it('clones a Kareem object', function() {
-    var k1 = new Kareem();
-    k1.pre('cook', function() {});
-    k1.post('cook', function() {});
-
-    var k2 = k1.clone();
-    assert.deepEqual(Array.from(k2._pres.keys()), ['cook']);
-    assert.deepEqual(Array.from(k2._posts.keys()), ['cook']);
-  });
-});
-
-describe('merge()', function() {
-  it('pulls hooks from another Kareem object', function() {
-    var k1 = new Kareem();
-    var test1 = function() {};
-    k1.pre('cook', test1);
-    k1.post('cook', function() {});
-
-    var k2 = new Kareem();
-    var test2 = function() {};
-    k2.pre('cook', test2);
-    var k3 = k2.merge(k1);
-    assert.equal(k3._pres.get('cook').length, 2);
-    assert.equal(k3._pres.get('cook')[0].fn, test2);
-    assert.equal(k3._pres.get('cook')[1].fn, test1);
-    assert.equal(k3._posts.get('cook').length, 1);
-  });
-});

package/test/misc.test.js

@@ -1,71 +0,0 @@
-'use strict';
-
-const assert = require('assert');
-const Kareem = require('../');
-const { describe, it } = require('mocha');
-
-describe('hasHooks', function() {
-  it('returns false for toString (Automattic/mongoose#6538)', function() {
-    const k = new Kareem();
-    assert.ok(!k.hasHooks('toString'));
-  });
-});
-
-describe('merge', function() {
-  it('handles async pres if source doesnt have them', function() {
-    const k1 = new Kareem();
-    k1.pre('cook', true, function(next, done) {
-      setTimeout(
-        function() {
-          done('error!');
-        },
-        5);
-
-      next();
-    });
-
-    assert.equal(k1._pres.get('cook').numAsync, 1);
-
-    const k2 = new Kareem();
-    const k3 = k2.merge(k1);
-    assert.equal(k3._pres.get('cook').numAsync, 1);
-  });
-});
-
-describe('filter', function() {
-  it('returns clone with only hooks that match `fn()`', function() {
-    const k1 = new Kareem();
-
-    k1.pre('update', { document: true }, f1);
-    k1.pre('update', { query: true }, f2);
-    k1.pre('remove', { document: true }, f3);
-
-    k1.post('update', { document: true }, f1);
-    k1.post('update', { query: true }, f2);
-    k1.post('remove', { document: true }, f3);
-
-    const k2 = k1.filter(hook => hook.document);
-    assert.equal(k2._pres.get('update').length, 1);
-    assert.equal(k2._pres.get('update')[0].fn, f1);
-    assert.equal(k2._pres.get('remove').length, 1);
-    assert.equal(k2._pres.get('remove')[0].fn, f3);
-
-    assert.equal(k2._posts.get('update').length, 1);
-    assert.equal(k2._posts.get('update')[0].fn, f1);
-    assert.equal(k2._posts.get('remove').length, 1);
-    assert.equal(k2._posts.get('remove')[0].fn, f3);
-
-    const k3 = k1.filter(hook => hook.query);
-    assert.equal(k3._pres.get('update').length, 1);
-    assert.equal(k3._pres.get('update')[0].fn, f2);
-    assert.ok(!k3._pres.has('remove'));
-
-    assert.equal(k3._posts.get('update').length, 1);
-    assert.equal(k3._posts.get('update')[0].fn, f2);
-    assert.ok(!k3._posts.has('remove'));
-
-    function f1() {}
-    function f2() {}
-    function f3() {}
-  });
-});