chai-as-promised 4.2.0 → 4.3.0

package/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright © 2012–2015 Domenic Denicola <d@domenic.me>
+
+This work is free. You can redistribute it and/or modify it under the
+terms of the Do What The Fuck You Want To Public License, Version 2,
+as published by Sam Hocevar. See below for more details.
+
+        DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

package/README.md

@@ -45,13 +45,13 @@ existing Chai assertion into one that acts on a promise:
 (2 + 2).should.equal(4);
 
 // becomes
-return promiseFor(2 + 2).should.eventually.equal(4);
+return Promise.resolve(2 + 2).should.eventually.equal(4);
 
 
 expect({ foo: "bar" }).to.have.property("foo");
 
 // becomes
-return expect(promiseFor({ foo: "bar" })).to.eventually.have.property("foo");
+return expect(Promise.resolve({ foo: "bar" })).to.eventually.have.property("foo");
 ```
 
 There are also a few promise-specific extensions (with the usual `expect` equivalents also available):
@@ -73,7 +73,7 @@ any existing Chai assertion to be used on a promise:
 assert.equal(2 + 2, 4, "This had better be true");
 
 // becomes
-return assert.eventually.equal(promiseFor(2 + 2), 4, "This had better be true, eventually");
+return assert.eventually.equal(Promise.resolve(2 + 2), 4, "This had better be true, eventually");
 ```
 
 And there are, of course, promise-specific extensions:
@@ -120,6 +120,37 @@ chaiAsPromised.transferPromiseness = function (assertion, promise) {
 };
 ```
 
+### Transforming Arguments to the Asserters
+
+Another advanced customization hook Chai as Promised allows is if you want to transform the arguments to the
+asserters, possibly asynchronously. Here is a toy example:
+
+```js
+chaiAsPromised.transformAsserterArgs = function (args) {
+    return args.map(function (x) { return x + 1; });
+}
+
+Promise.resolve(2).should.eventually.equal(2); // will now fail!
+Promise.resolve(2).should.eventually.equal(3); // will now pass!
+```
+
+The transform can even be asynchronous, returning a promise for an array instead of an array directly. An example
+of that might be using `Promise.all` so that an array of promises becomes a promise for an array. If you do that,
+then you can compare promises against other promises using the asserters:
+
+```js
+// This will normally fail, since within() only works on numbers.
+Promise.resolve(2).should.eventually.be.within(Promise.resolve(1), Promise.resolve(6));
+
+chaiAsPromised.transformAsserterArgs = function (args) {
+    return Promise.all(args);
+};
+
+// But now it will pass, since we transformed the array of promises for numbers into
+// (a promise for) an array of numbers
+Promise.resolve(2).should.eventually.be.within(Promise.resolve(1), Promise.resolve(6));
+```
+
 ### Compatibility
 
 Chai as Promised is compatible with all promises following the [Promises/A+ specification][spec]. Notably, jQuery's

package/lib/chai-as-promised.js

@@ -26,6 +26,10 @@
         assertion.then = promise.then.bind(promise);
     };
 
+    chaiAsPromised.transformAsserterArgs = function (values) {
+        return values;
+    };
+
     function chaiAsPromised(chai, utils) {
         var Assertion = chai.Assertion;
         var assert = chai.assert;
@@ -300,6 +304,9 @@
                 // just the base Chai code that we get to via the short-circuit above.
                 assertion._obj = value;
                 utils.flag(assertion, "eventually", false);
+
+                return args ? chaiAsPromised.transformAsserterArgs(args) : args;
+            }).then(function (args) {
                 asserter.apply(assertion, args);
 
                 // Because asserters, for example `property`, can change the value of `_obj` (i.e. change the "object"

package/package.json

@@ -8,7 +8,7 @@
         "promises",
         "promises-aplus"
     ],
-    "version": "4.2.0",
+    "version": "4.3.0",
     "author": "Domenic Denicola <d@domenic.me> (https://domenic.me)",
     "license": "WTFPL",
     "repository": "domenic/chai-as-promised",