dec67bd535
This makes it easier to write high quality matchers and asymmetric equality
testers, and is also a step toward supporting custom object formatters.
Previously, Jasmine passed custom object formatters as the second argument
to matcher factories and as and the second argument to asymmetric equality
testers' `asymmetricMatch` method. Matchers and asymmetric equality testers
were responsible for passing the custom object formatters to methods like
`matchersUtil#equals`:
function toEqual(util, customEqualityTesters) {
return {
compare: function(actual, expected) {
// ...
result.pass = util.equals(actual, expected, customEqualityTesters, diffBuilder);
And:
ArrayContaining.prototype.asymmetricMatch = function(other, customTesters) {
// ...
for (var i = 0; i < this.sample.length; i++) {
var item = this.sample[i];
if (!j$.matchersUtil.contains(other, item, customTesters)) {
return false;
}
}
With this change, that is no longer necessary. Matchers and asymmetric
equality testers can ignore the existence of custom equality testers and
still fully support them:
function toEqual(util) {
return {
compare: function(actual, expected) {
// ...
result.pass = util.equals(actual, expected, diffBuilder);
And:
ArrayContaining.prototype.asymmetricMatch = function(other, matchersUtil) {
// ...
for (var i = 0; i < this.sample.length; i++) {
var item = this.sample[i];
if (!matchersUtil.contains(other, item)) {
return false;
}
}
The old interfaces are still supported, for now, but will be deprecated
in a future commit and removed in the next major release after that.
In addition to making matchers and custom equality testers simpler,
this change sets the stage for adding support for custom object
formatters. Those will be architecturally similar to custom equality
testers, and by injecting a `MatchersUtil` instance everywhere we can
add them without requiring user code to pass them around as used to be
the case with custom object formatters.
52 lines
1.5 KiB
JavaScript
52 lines
1.5 KiB
JavaScript
getJasmineRequireObj().toBeRejectedWith = function(j$) {
|
|
/**
|
|
* Expect a promise to be rejected with a value equal to the expected, using deep equality comparison.
|
|
* @function
|
|
* @async
|
|
* @name async-matchers#toBeRejectedWith
|
|
* @since 3.3.0
|
|
* @param {Object} expected - Value that the promise is expected to be rejected with
|
|
* @example
|
|
* await expectAsync(aPromise).toBeRejectedWith({prop: 'value'});
|
|
* @example
|
|
* return expectAsync(aPromise).toBeRejectedWith({prop: 'value'});
|
|
*/
|
|
return function toBeRejectedWith(util) {
|
|
return {
|
|
compare: function(actualPromise, expectedValue) {
|
|
if (!j$.isPromiseLike(actualPromise)) {
|
|
throw new Error('Expected toBeRejectedWith to be called on a promise.');
|
|
}
|
|
|
|
function prefix(passed) {
|
|
return 'Expected a promise ' +
|
|
(passed ? 'not ' : '') +
|
|
'to be rejected with ' + j$.pp(expectedValue);
|
|
}
|
|
|
|
return actualPromise.then(
|
|
function() {
|
|
return {
|
|
pass: false,
|
|
message: prefix(false) + ' but it was resolved.'
|
|
};
|
|
},
|
|
function(actualValue) {
|
|
if (util.equals(actualValue, expectedValue)) {
|
|
return {
|
|
pass: true,
|
|
message: prefix(true) + '.'
|
|
};
|
|
} else {
|
|
return {
|
|
pass: false,
|
|
message: prefix(false) + ' but it was rejected with ' + j$.pp(actualValue) + '.'
|
|
};
|
|
}
|
|
}
|
|
);
|
|
}
|
|
};
|
|
};
|
|
};
|