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.
106 lines
2.1 KiB
JavaScript
106 lines
2.1 KiB
JavaScript
getJasmineRequireObj().asymmetricEqualityTesterArgCompatShim = function(j$) {
|
|
/*
|
|
Older versions of Jasmine passed an array of custom equality testers as the
|
|
second argument to each asymmetric equality tester's `asymmetricMatch`
|
|
method. Newer versions will pass a `MatchersUtil` instance. The
|
|
asymmetricEqualityTesterArgCompatShim allows for a graceful migration from
|
|
the old interface to the new by "being" both an array of custom equality
|
|
testers and a `MatchersUtil` at the same time.
|
|
|
|
This code should be removed in the next major release.
|
|
*/
|
|
|
|
var likelyArrayProps = [
|
|
'concat',
|
|
'constructor',
|
|
'copyWithin',
|
|
'entries',
|
|
'every',
|
|
'fill',
|
|
'filter',
|
|
'find',
|
|
'findIndex',
|
|
'flat',
|
|
'flatMap',
|
|
'forEach',
|
|
'includes',
|
|
'indexOf',
|
|
'join',
|
|
'keys',
|
|
'lastIndexOf',
|
|
'length',
|
|
'map',
|
|
'pop',
|
|
'push',
|
|
'reduce',
|
|
'reduceRight',
|
|
'reverse',
|
|
'shift',
|
|
'slice',
|
|
'some',
|
|
'sort',
|
|
'splice',
|
|
'toLocaleString',
|
|
'toSource',
|
|
'toString',
|
|
'unshift',
|
|
'values'
|
|
];
|
|
|
|
function asymmetricEqualityTesterArgCompatShim(
|
|
matchersUtil,
|
|
customEqualityTesters
|
|
) {
|
|
var self = Object.create(matchersUtil),
|
|
props,
|
|
i,
|
|
k;
|
|
|
|
copy(self, customEqualityTesters, 'length');
|
|
|
|
for (i = 0; i < customEqualityTesters.length; i++) {
|
|
copy(self, customEqualityTesters, i);
|
|
}
|
|
|
|
var props = arrayProps();
|
|
|
|
for (i = 0; i < props.length; i++) {
|
|
k = props[i];
|
|
if (k !== 'length') {
|
|
copy(self, Array.prototype, k);
|
|
}
|
|
}
|
|
|
|
return self;
|
|
}
|
|
|
|
function copy(dest, src, propName) {
|
|
Object.defineProperty(dest, propName, {
|
|
get: function() {
|
|
return src[propName];
|
|
}
|
|
});
|
|
}
|
|
|
|
function arrayProps() {
|
|
var props, a, k;
|
|
|
|
if (!Object.getOwnPropertyDescriptors) {
|
|
return likelyArrayProps.filter(function(k) {
|
|
return Array.prototype.hasOwnProperty(k);
|
|
});
|
|
}
|
|
|
|
props = Object.getOwnPropertyDescriptors(Array.prototype);
|
|
a = [];
|
|
|
|
for (k in props) {
|
|
a.push(k);
|
|
}
|
|
|
|
return a;
|
|
}
|
|
|
|
return asymmetricEqualityTesterArgCompatShim;
|
|
};
|