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.9 KiB
JavaScript
52 lines
1.9 KiB
JavaScript
describe("ArrayWithExactContents", function() {
|
|
it("matches an array with the same items in a different order", function() {
|
|
var matcher = new jasmineUnderTest.ArrayWithExactContents(['a', 2, /a/]);
|
|
var matchersUtil = new jasmineUnderTest.MatchersUtil();
|
|
|
|
expect(matcher.asymmetricMatch([2, 'a', /a/], matchersUtil)).toBe(true);
|
|
});
|
|
|
|
it("does not work when not passed an array", function() {
|
|
var matcher = new jasmineUnderTest.ArrayWithExactContents("foo");
|
|
|
|
expect(function() {
|
|
matcher.asymmetricMatch([]);
|
|
}).toThrowError(/not 'foo'/);
|
|
});
|
|
|
|
it("does not match when an item is missing", function() {
|
|
var matcher = new jasmineUnderTest.ArrayWithExactContents(['a', 2, /a/]);
|
|
var matchersUtil = new jasmineUnderTest.MatchersUtil();
|
|
|
|
expect(matcher.asymmetricMatch(['a', 2], matchersUtil)).toBe(false);
|
|
expect(matcher.asymmetricMatch(['a', 2, undefined], matchersUtil)).toBe(false);
|
|
});
|
|
|
|
it("does not match when there is an extra item", function() {
|
|
var matcher = new jasmineUnderTest.ArrayWithExactContents(['a']);
|
|
var matchersUtil = new jasmineUnderTest.MatchersUtil();
|
|
|
|
expect(matcher.asymmetricMatch(['a', 2], matchersUtil)).toBe(false);
|
|
});
|
|
|
|
it("jasmineToStrings itself", function() {
|
|
var matcher = new jasmineUnderTest.ArrayWithExactContents([]);
|
|
|
|
expect(matcher.jasmineToString()).toMatch("<jasmine.arrayWithExactContents");
|
|
});
|
|
|
|
it("uses custom equality testers", function() {
|
|
var tester = function(a, b) {
|
|
// All "foo*" strings match each other.
|
|
if (typeof a == "string" && typeof b == "string" &&
|
|
a.substr(0, 3) == "foo" && b.substr(0, 3) == "foo") {
|
|
return true;
|
|
}
|
|
};
|
|
var matcher = new jasmineUnderTest.ArrayWithExactContents(["fooVal"]);
|
|
var matchersUtil = new jasmineUnderTest.MatchersUtil({customTesters: [tester]});
|
|
|
|
expect(matcher.asymmetricMatch(["fooBar"], matchersUtil)).toBe(true);
|
|
});
|
|
});
|