kareem 2.2.3 → 2.3.3

package/docs.js

@@ -1,5 +1,7 @@
 var acquit = require('acquit');
 
+require('acquit-ignore')();
+
 var content = require('fs').readFileSync('./test/examples.test.js').toString();
 var blocks = acquit.parse(content);
 
@@ -29,7 +31,7 @@ for (var i = 0; i < blocks.length; ++i) {
       acquit.trimEachLine(it.comments[0]) + '\n\n' :
       '';
     mdOutput += '```javascript\n';
-    mdOutput += '    ' + it.code + '\n';
+    mdOutput += it.code + '\n';
     mdOutput += '```\n\n';
   }
 }

package/index.js

@@ -57,12 +57,13 @@ Kareem.prototype.execPre = function(name, context, args, callback) {
 
       callMiddlewareFunction(pre.fn, context, args, args[0]);
     } else {
-      let error = null;
       let maybePromise = null;
       try {
         maybePromise = pre.fn.call(context);
       } catch (err) {
-        error = err;
+        if (err != null) {
+          return callback(err);
+        }
       }
 
       if (isPromise(maybePromise)) {
@@ -74,11 +75,11 @@ Kareem.prototype.execPre = function(name, context, args, callback) {
             return;
           } else {
             return process.nextTick(function() {
-              callback(error);
+              callback(null);
             });
           }
         }
-        next(error);
+        next();
       }
     }
   };
@@ -137,7 +138,7 @@ Kareem.prototype.execPost = function(name, context, args, options, callback) {
   }
 
   var next = function() {
-    var post = posts[currentPost];
+    var post = posts[currentPost].fn;
     var numArgs = 0;
     var argLength = args.length;
     var newArgs = [];
@@ -222,7 +223,7 @@ Kareem.prototype.execPostSync = function(name, context, args) {
   const numPosts = posts.length;
 
   for (let i = 0; i < numPosts; ++i) {
-    posts[i].apply(context, args || []);
+    posts[i].fn.apply(context, args || []);
   }
 };
 
@@ -275,7 +276,12 @@ Kareem.prototype.wrap = function(name, fn, context, args, options) {
 
     const end = (typeof lastArg === 'function' ? args.length - 1 : args.length);
     const numParameters = fn.length;
-    const ret = fn.apply(context, args.slice(0, end).concat(_cb));
+    let ret;
+    try {
+      ret = fn.apply(context, args.slice(0, end).concat(_cb));
+    } catch (err) {
+      return _cb(err);
+    }
 
     if (checkForPromise) {
       if (ret != null && typeof ret.then === 'function') {
@@ -320,6 +326,42 @@ Kareem.prototype.wrap = function(name, fn, context, args, options) {
   });
 };
 
+Kareem.prototype.filter = function(fn) {
+  const clone = this.clone();
+
+  const pres = Array.from(clone._pres.keys());
+  for (const name of pres) {
+    const hooks = this._pres.get(name).
+      map(h => Object.assign({}, h, { name: name })).
+      filter(fn);
+
+    if (hooks.length === 0) {
+      clone._pres.delete(name);
+      continue;
+    }
+
+    hooks.numAsync = hooks.filter(h => h.isAsync).length;
+
+    clone._pres.set(name, hooks);
+  }
+
+  const posts = Array.from(clone._posts.keys());
+  for (const name of posts) {
+    const hooks = this._posts.get(name).
+      map(h => Object.assign({}, h, { name: name })).
+      filter(fn);
+
+    if (hooks.length === 0) {
+      clone._posts.delete(name);
+      continue;
+    }
+
+    clone._posts.set(name, hooks);
+  }
+
+  return clone;
+};
+
 Kareem.prototype.hasHooks = function(name) {
   return this._pres.has(name) || this._posts.has(name);
 };
@@ -341,7 +383,11 @@ Kareem.prototype.createWrapper = function(name, fn, context, options) {
 };
 
 Kareem.prototype.pre = function(name, isAsync, fn, error, unshift) {
-  if (typeof arguments[1] !== 'boolean') {
+  let options = {};
+  if (typeof isAsync === 'object' && isAsync != null) {
+    options = isAsync;
+    isAsync = options.isAsync;
+  } else if (typeof arguments[1] !== 'boolean') {
     error = fn;
     fn = isAsync;
     isAsync = false;
@@ -355,22 +401,36 @@ Kareem.prototype.pre = function(name, isAsync, fn, error, unshift) {
     ++pres.numAsync;
   }
 
+  if (typeof fn !== 'function') {
+    throw new Error('pre() requires a function, got "' + typeof fn + '"');
+  }
+
   if (unshift) {
-    pres.unshift({ fn: fn, isAsync: isAsync });
+    pres.unshift(Object.assign({}, options, { fn: fn, isAsync: isAsync }));
   } else {
-    pres.push({ fn: fn, isAsync: isAsync });
+    pres.push(Object.assign({}, options, { fn: fn, isAsync: isAsync }));
   }
 
   return this;
 };
 
-Kareem.prototype.post = function(name, fn, unshift) {
+Kareem.prototype.post = function(name, options, fn, unshift) {
   const hooks = get(this._posts, name, []);
 
+  if (typeof options === 'function') {
+    unshift = !!fn;
+    fn = options;
+    options = {};
+  }
+
+  if (typeof fn !== 'function') {
+    throw new Error('post() requires a function, got "' + typeof fn + '"');
+  }
+
   if (unshift) {
-    hooks.unshift(fn);
+    hooks.unshift(Object.assign({}, options, { fn: fn }));
   } else {
-    hooks.push(fn);
+    hooks.push(Object.assign({}, options, { fn: fn }));
   }
   this._posts.set(name, hooks);
   return this;

package/package.json

@@ -1,29 +1,21 @@
 {
   "name": "kareem",
-  "version": "2.2.3",
+  "version": "2.3.3",
   "description": "Next-generation take on pre/post function hooks",
   "main": "index.js",
   "scripts": {
-    "test": "./node_modules/mocha/bin/mocha ./test/*",
-    "test-travis": "./node_modules/istanbul/lib/cli.js cover ./node_modules/mocha/bin/_mocha -- -R spec ./test/*"
+    "test": "mocha ./test/*",
+    "test-travis": "nyc mocha ./test/*"
   },
   "repository": {
     "type": "git",
     "url": "git://github.com/vkarpov15/kareem.git"
   },
   "devDependencies": {
-    "acquit": "0.5.1",
-    "gulp": "3.8.10",
-    "gulp-mocha": "2.0.0",
-    "gulp-jscs": "1.4.0",
-    "istanbul": "0.4.5",
-    "jscs": "1.9.0",
-    "mocha": "3.2.0"
-  },
-  "jscsConfig": {
-    "preset": "airbnb",
-    "requireMultipleVarDecl": null,
-    "disallowMultipleVarDecl": true
+    "acquit": "1.x",
+    "acquit-ignore": "0.1.x",
+    "nyc": "11.x",
+    "mocha": "5.x"
   },
   "author": "Valeri Karpov <val@karpov.io>",
   "license": "Apache-2.0"

package/test/examples.test.js

@@ -17,7 +17,10 @@ describe('pre hooks', function() {
 
   it('runs without any hooks specified', function(done) {
     hooks.execPre('cook', null, function() {
+      // ...
+      // acquit:ignore:start
       done();
+      // acquit:ignore:end
     });
   });
 
@@ -34,7 +37,9 @@ describe('pre hooks', function() {
 
     hooks.execPre('cook', null, function() {
       assert.equal(1, count);
+      // acquit:ignore:start
       done();
+      // acquit:ignore:end
     });
   });
 
@@ -55,7 +60,9 @@ describe('pre hooks', function() {
     hooks.execPre('cook', null, function() {
       assert.equal(1, count1);
       assert.equal(1, count2);
+      // acquit:ignore:start
       done();
+      // acquit:ignore:end
     });
   });
 
@@ -78,7 +85,9 @@ describe('pre hooks', function() {
       assert.equal(null, error);
       assert.equal(1, count1);
       assert.equal(1, count2);
+      // acquit:ignore:start
       done();
+      // acquit:ignore:end
     });
   });
 
@@ -102,7 +111,9 @@ describe('pre hooks', function() {
       assert.equal(null, error);
       assert.equal(3, obj.bacon);
       assert.equal(4, obj.eggs);
+      // acquit:ignore:start
       done();
+      // acquit:ignore:end
     });
   });
 
@@ -140,7 +151,9 @@ describe('pre hooks', function() {
       assert.equal(3, obj.bacon);
       assert.equal(4, obj.eggs);
       assert.equal(false, obj.waffles);
+      // acquit:ignore:start
       done();
+      // acquit:ignore:end
     });
   });
 
@@ -162,7 +175,9 @@ describe('pre hooks', function() {
 
     hooks.execPre('cook', obj, function() {
       assert.equal(3, obj.bacon);
+      // acquit:ignore:start
       done();
+      // acquit:ignore:end
     });
   });
 });
@@ -193,7 +208,9 @@ describe('post hooks', function() {
       assert.ifError(error);
       assert.equal(1, eggs);
       assert.equal(2, bacon);
+      // acquit:ignore:start
       done();
+      // acquit:ignore:end
     });
   });
 
@@ -220,7 +237,33 @@ describe('post hooks', function() {
       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
     });
   });
 });
@@ -271,7 +314,9 @@ describe('wrap()', function() {
       assert.equal('no', obj.tofu);
 
       assert.equal(obj, result);
+      // acquit:ignore:start
       done();
+      // acquit:ignore:end
     });
 
     hooks.wrap(
@@ -343,7 +388,9 @@ describe('createWrapper()', function() {
       assert.equal('no', obj.tofu);
 
       assert.equal(obj, result);
+      // acquit:ignore:start
       done();
+      // acquit:ignore:end
     });
   });
 });

package/test/misc.test.js

@@ -31,3 +31,41 @@ describe('merge', function() {
     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() {}
+  });
+});

package/test/post.test.js

@@ -27,10 +27,23 @@ describe('execPost', function() {
     var f2 = function() {};
     hooks.post('cook', f1);
     hooks.post('cook', f2, true);
-    assert.strictEqual(hooks._posts.get('cook')[0], f2);
-    assert.strictEqual(hooks._posts.get('cook')[1], f1);
+    assert.strictEqual(hooks._posts.get('cook')[0].fn, f2);
+    assert.strictEqual(hooks._posts.get('cook')[1].fn, f1);
   });
 
+  it('arbitrary options', function() {
+    const f1 = function() {};
+    const f2 = function() {};
+    hooks.post('cook', { foo: 'bar' }, f1);
+    hooks.post('cook', { bar: 'baz' }, f2, true);
+    assert.equal(hooks._posts.get('cook')[1].foo, 'bar');
+    assert.equal(hooks._posts.get('cook')[0].bar, 'baz');
+  });
+
+  it('throws error if no function', function() {
+    assert.throws(() => hooks.post('test'), /got "undefined"/);
+  });
+ 
   it('multiple posts', function(done) {
     hooks.post('cook', function(eggs, callback) {
       setTimeout(

package/test/pre.test.js

@@ -65,6 +65,19 @@ describe('execPre', function() {
     assert.strictEqual(hooks._pres.get('cook')[1].fn, f1);
   });
 
+  it('throws error if no function', function() {
+    assert.throws(() => hooks.pre('test'), /got "undefined"/);
+  });
+
+  it('arbitrary options', function() {
+    const f1 = function() {};
+    const f2 = function() {};
+    hooks.pre('cook', { foo: 'bar' }, f1);
+    hooks.pre('cook', { bar: 'baz' }, f2, null, true);
+    assert.equal(hooks._pres.get('cook')[1].foo, 'bar');
+    assert.equal(hooks._pres.get('cook')[0].bar, 'baz');
+  });
+
   it('handles async errors', function(done) {
     var execed = {};
 
@@ -274,6 +287,26 @@ describe('execPre', function() {
       done();
     });
   });
+
+  it('handles sync errors in pre if there are more hooks', function(done) {
+    var execed = {};
+
+    hooks.pre('cook', function() {
+      execed.first = true;
+      throw new Error('Oops!');
+    });
+
+    hooks.pre('cook', function() {
+      execed.second = true;
+    });
+
+    hooks.execPre('cook', null, function(err) {
+      assert.ok(err);
+      assert.ok(execed.first);
+      assert.equal(err.message, 'Oops!');
+      done();
+    });
+  });
 });
 
 describe('execPreSync', function() {

package/test/wrap.test.js

@@ -319,6 +319,30 @@ describe('wrap()', function() {
       25);
   });
 
+  it('catches sync errors', function(done) {
+    hooks.pre('cook', function(done) {
+      done();
+    });
+
+    hooks.post('cook', function(callback) {
+      callback();
+    });
+
+    var args = [];
+    args.push(function(error) {
+      assert.equal(error.message, 'oops!');
+      done();
+    });
+
+    hooks.wrap(
+      'cook',
+      function() {
+        throw new Error('oops!');
+      },
+      null,
+      args);
+  });
+
   it('sync wrappers', function() {
     var calledPre = 0;
     var calledFn = 0;