chai/chai.js

5352 lines
135 KiB
JavaScript
Raw Normal View History

(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.chai = f()}})(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s})({1:[function(require,module,exports){
/*!
* chai
* Copyright(c) 2011-2014 Jake Luer <jake@alogicalparadox.com>
* MIT Licensed
2013-04-29 22:15:27 +00:00
*/
var used = []
, exports = module.exports = {};
2013-04-29 22:15:27 +00:00
/*!
* Chai version
2013-04-29 22:15:27 +00:00
*/
2015-06-03 23:19:52 +00:00
exports.version = '3.0.0';
2013-04-29 22:15:27 +00:00
/*!
* Assertion Error
2013-04-29 22:15:27 +00:00
*/
exports.AssertionError = require('assertion-error');
2013-04-29 22:15:27 +00:00
/*!
* Utils for plugins (not exported)
2013-04-29 22:15:27 +00:00
*/
var util = require('./chai/utils');
2013-04-29 22:15:27 +00:00
/**
* # .use(function)
2013-04-29 22:15:27 +00:00
*
* Provides a way to extend the internals of Chai
2013-04-29 22:15:27 +00:00
*
* @param {Function}
* @returns {this} for chaining
* @api public
2013-04-29 22:15:27 +00:00
*/
exports.use = function (fn) {
if (!~used.indexOf(fn)) {
fn(this, util);
used.push(fn);
}
return this;
2013-04-29 22:15:27 +00:00
};
2013-06-17 20:06:38 +00:00
/*!
* Utility Functions
2013-06-17 20:06:38 +00:00
*/
exports.util = util;
2013-06-17 20:06:38 +00:00
/*!
* Configuration
2013-06-17 20:06:38 +00:00
*/
var config = require('./chai/config');
exports.config = config;
2013-06-17 20:06:38 +00:00
/*!
* Primary `Assertion` prototype
2013-06-17 20:06:38 +00:00
*/
var assertion = require('./chai/assertion');
exports.use(assertion);
2013-06-17 20:06:38 +00:00
/*!
* Core Assertions
*/
2013-06-17 20:06:38 +00:00
var core = require('./chai/core/assertions');
exports.use(core);
2013-06-17 20:06:38 +00:00
/*!
* Expect interface
2013-06-17 20:06:38 +00:00
*/
var expect = require('./chai/interface/expect');
exports.use(expect);
2013-06-17 20:06:38 +00:00
/*!
* Should interface
2013-06-17 20:06:38 +00:00
*/
var should = require('./chai/interface/should');
exports.use(should);
2013-06-17 20:06:38 +00:00
/*!
* Assert interface
2013-06-17 20:06:38 +00:00
*/
var assert = require('./chai/interface/assert');
exports.use(assert);
2013-06-17 20:06:38 +00:00
2015-06-03 23:19:52 +00:00
},{"./chai/assertion":2,"./chai/config":3,"./chai/core/assertions":4,"./chai/interface/assert":5,"./chai/interface/expect":6,"./chai/interface/should":7,"./chai/utils":20,"assertion-error":28}],2:[function(require,module,exports){
/*!
* chai
* http://chaijs.com
* Copyright(c) 2011-2014 Jake Luer <jake@alogicalparadox.com>
* MIT Licensed
2013-06-17 20:06:38 +00:00
*/
var config = require('./config');
2013-06-17 20:06:38 +00:00
module.exports = function (_chai, util) {
/*!
* Module dependencies.
*/
2013-06-17 20:06:38 +00:00
var AssertionError = _chai.AssertionError
, flag = util.flag;
2013-06-17 20:06:38 +00:00
/*!
* Module export.
*/
2014-11-10 14:06:08 +00:00
_chai.Assertion = Assertion;
2013-09-18 19:04:00 +00:00
/*!
* Assertion Constructor
*
* Creates object for chaining.
*
* @api private
*/
2013-09-18 19:04:00 +00:00
function Assertion (obj, msg, stack) {
flag(this, 'ssfi', stack || arguments.callee);
flag(this, 'object', obj);
flag(this, 'message', msg);
}
2013-09-18 19:04:00 +00:00
Object.defineProperty(Assertion, 'includeStack', {
get: function() {
console.warn('Assertion.includeStack is deprecated, use chai.config.includeStack instead.');
return config.includeStack;
},
set: function(value) {
console.warn('Assertion.includeStack is deprecated, use chai.config.includeStack instead.');
config.includeStack = value;
}
});
2013-09-18 19:04:00 +00:00
Object.defineProperty(Assertion, 'showDiff', {
get: function() {
console.warn('Assertion.showDiff is deprecated, use chai.config.showDiff instead.');
return config.showDiff;
},
set: function(value) {
console.warn('Assertion.showDiff is deprecated, use chai.config.showDiff instead.');
config.showDiff = value;
}
});
2013-09-18 19:04:00 +00:00
Assertion.addProperty = function (name, fn) {
util.addProperty(this.prototype, name, fn);
};
2013-09-18 19:04:00 +00:00
Assertion.addMethod = function (name, fn) {
util.addMethod(this.prototype, name, fn);
};
2013-09-18 19:04:00 +00:00
Assertion.addChainableMethod = function (name, fn, chainingBehavior) {
util.addChainableMethod(this.prototype, name, fn, chainingBehavior);
};
2013-04-29 22:15:27 +00:00
2013-06-17 20:06:38 +00:00
Assertion.overwriteProperty = function (name, fn) {
util.overwriteProperty(this.prototype, name, fn);
};
2013-04-29 22:15:27 +00:00
2013-06-17 20:06:38 +00:00
Assertion.overwriteMethod = function (name, fn) {
util.overwriteMethod(this.prototype, name, fn);
};
2013-04-29 22:15:27 +00:00
2014-01-29 23:38:57 +00:00
Assertion.overwriteChainableMethod = function (name, fn, chainingBehavior) {
util.overwriteChainableMethod(this.prototype, name, fn, chainingBehavior);
};
/**
* ### .assert(expression, message, negateMessage, expected, actual, showDiff)
2013-06-17 20:06:38 +00:00
*
* Executes an expression and check expectations. Throws AssertionError for reporting if test doesn't pass.
*
* @name assert
* @param {Philosophical} expression to be tested
2015-03-04 20:19:52 +00:00
* @param {String or Function} message or function that returns message to display if expression fails
2014-09-29 23:24:59 +00:00
* @param {String or Function} negatedMessage or function that returns negatedMessage to display if negated expression fails
2013-06-17 20:06:38 +00:00
* @param {Mixed} expected value (remember to check for negation)
* @param {Mixed} actual (optional) will default to `this.obj`
2015-03-04 20:19:52 +00:00
* @param {Boolean} showDiff (optional) when set to `true`, assert will display a diff in addition to the message if expression fails
2013-06-17 20:06:38 +00:00
* @api private
*/
2013-04-29 22:15:27 +00:00
2013-06-17 20:06:38 +00:00
Assertion.prototype.assert = function (expr, msg, negateMsg, expected, _actual, showDiff) {
var ok = util.test(this, arguments);
if (true !== showDiff) showDiff = false;
2014-03-19 16:22:08 +00:00
if (true !== config.showDiff) showDiff = false;
2013-06-17 20:06:38 +00:00
if (!ok) {
var msg = util.getMessage(this, arguments)
, actual = util.getActual(this, arguments);
throw new AssertionError(msg, {
actual: actual
, expected: expected
, showDiff: showDiff
2014-03-19 16:22:08 +00:00
}, (config.includeStack) ? this.assert : flag(this, 'ssfi'));
2013-04-29 22:15:27 +00:00
}
2013-06-17 20:06:38 +00:00
};
2013-04-29 22:15:27 +00:00
2013-06-17 20:06:38 +00:00
/*!
* ### ._obj
*
* Quick reference to stored `actual` value for plugin developers.
*
* @api private
*/
2013-04-29 22:15:27 +00:00
2013-06-17 20:06:38 +00:00
Object.defineProperty(Assertion.prototype, '_obj',
{ get: function () {
return flag(this, 'object');
}
, set: function (val) {
flag(this, 'object', val);
}
});
2013-04-29 22:15:27 +00:00
};
},{"./config":3}],3:[function(require,module,exports){
2014-03-19 16:22:08 +00:00
module.exports = {
/**
* ### config.includeStack
*
* User configurable property, influences whether stack trace
* is included in Assertion error message. Default of false
* suppresses stack trace in the error message.
*
* chai.config.includeStack = true; // enable stack on error
*
* @param {Boolean}
* @api public
*/
includeStack: false,
/**
* ### config.showDiff
*
* User configurable property, influences whether or not
* the `showDiff` flag should be included in the thrown
* AssertionErrors. `false` will always be `false`; `true`
* will be true when the assertion has requested a diff
* be shown.
*
* @param {Boolean}
* @api public
*/
showDiff: true,
/**
* ### config.truncateThreshold
*
* User configurable property, sets length threshold for actual and
* expected values in assertion errors. If this threshold is exceeded, for
* example for large data structures, the value is replaced with something
* like `[ Array(3) ]` or `{ Object (prop1, prop2) }`.
2014-03-19 16:22:08 +00:00
*
* Set it to zero if you want to disable truncating altogether.
*
* This is especially userful when doing assertions on arrays: having this
* set to a reasonable large value makes the failure messages readily
* inspectable.
*
2014-03-19 16:22:08 +00:00
* chai.config.truncateThreshold = 0; // disable truncating
*
* @param {Number}
* @api public
*/
truncateThreshold: 40
};
},{}],4:[function(require,module,exports){
2013-04-29 22:15:27 +00:00
/*!
* chai
* http://chaijs.com
2014-01-29 23:38:57 +00:00
* Copyright(c) 2011-2014 Jake Luer <jake@alogicalparadox.com>
2013-04-29 22:15:27 +00:00
* MIT Licensed
*/
module.exports = function (chai, _) {
var Assertion = chai.Assertion
, toString = Object.prototype.toString
, flag = _.flag;
/**
* ### Language Chains
*
2014-01-29 23:38:57 +00:00
* The following are provided as chainable getters to
2013-04-29 22:15:27 +00:00
* improve the readability of your assertions. They
2014-03-19 16:22:08 +00:00
* do not provide testing capabilities unless they
2013-04-29 22:15:27 +00:00
* have been overwritten by a plugin.
*
* **Chains**
*
* - to
* - be
* - been
* - is
* - that
2015-02-09 18:43:58 +00:00
* - which
2013-04-29 22:15:27 +00:00
* - and
2014-01-29 23:38:57 +00:00
* - has
2013-04-29 22:15:27 +00:00
* - have
* - with
* - at
* - of
2013-04-30 00:15:39 +00:00
* - same
2013-04-29 22:15:27 +00:00
*
* @name language chains
* @api public
*/
[ 'to', 'be', 'been'
2014-01-29 23:38:57 +00:00
, 'is', 'and', 'has', 'have'
2015-02-09 18:43:58 +00:00
, 'with', 'that', 'which', 'at'
2013-04-29 22:15:27 +00:00
, 'of', 'same' ].forEach(function (chain) {
Assertion.addProperty(chain, function () {
2012-07-01 02:55:04 +00:00
return this;
2013-04-29 22:15:27 +00:00
});
});
/**
* ### .not
*
* Negates any of assertions following in the chain.
*
* expect(foo).to.not.equal('bar');
* expect(goodFn).to.not.throw(Error);
* expect({ foo: 'baz' }).to.have.property('foo')
* .and.not.equal('bar');
*
* @name not
* @api public
*/
Assertion.addProperty('not', function () {
flag(this, 'negate', true);
});
/**
* ### .deep
*
* Sets the `deep` flag, later used by the `equal` and
* `property` assertions.
*
* expect(foo).to.deep.equal({ bar: 'baz' });
* expect({ foo: { bar: { baz: 'quux' } } })
* .to.have.deep.property('foo.bar.baz', 'quux');
*
2015-03-26 18:03:02 +00:00
* `.deep.property` special characters can be escaped
* by adding two slashes before the `.` or `[]`.
*
* var deepCss = { '.link': { '[target]': 42 }};
* expect(deepCss).to.have.deep.property('\\.link.\\[target\\]', 42);
*
2013-04-29 22:15:27 +00:00
* @name deep
* @api public
*/
Assertion.addProperty('deep', function () {
flag(this, 'deep', true);
});
2015-02-09 18:43:58 +00:00
/**
* ### .any
*
* Sets the `any` flag, (opposite of the `all` flag)
2015-04-26 16:13:17 +00:00
* later used in the `keys` assertion.
2015-02-09 18:43:58 +00:00
*
* expect(foo).to.have.any.keys('bar', 'baz');
*
* @name any
* @api public
*/
Assertion.addProperty('any', function () {
flag(this, 'any', true);
flag(this, 'all', false)
});
/**
* ### .all
*
2015-04-26 16:13:17 +00:00
* Sets the `all` flag (opposite of the `any` flag)
2015-02-09 18:43:58 +00:00
* later used by the `keys` assertion.
*
* expect(foo).to.have.all.keys('bar', 'baz');
*
* @name all
* @api public
*/
Assertion.addProperty('all', function () {
flag(this, 'all', true);
flag(this, 'any', false);
});
2013-04-29 22:15:27 +00:00
/**
* ### .a(type)
*
* The `a` and `an` assertions are aliases that can be
* used either as language chains or to assert a value's
* type.
*
* // typeof
* expect('test').to.be.a('string');
* expect({ foo: 'bar' }).to.be.an('object');
* expect(null).to.be.a('null');
* expect(undefined).to.be.an('undefined');
2015-06-03 23:19:52 +00:00
* expect(new Promise).to.be.a('promise');
* expect(new Float32Array()).to.be.a('float32array');
* expect(Symbol()).to.be.a('symbol');
*
* // es6 overrides
* expect({[Symbol.toStringTag]:()=>'foo'}).to.be.a('foo');
2013-04-29 22:15:27 +00:00
*
* // language chain
* expect(foo).to.be.an.instanceof(Foo);
*
* @name a
* @alias an
* @param {String} type
* @param {String} message _optional_
* @api public
*/
function an (type, msg) {
if (msg) flag(this, 'message', msg);
type = type.toLowerCase();
var obj = flag(this, 'object')
, article = ~[ 'a', 'e', 'i', 'o', 'u' ].indexOf(type.charAt(0)) ? 'an ' : 'a ';
this.assert(
type === _.type(obj)
, 'expected #{this} to be ' + article + type
, 'expected #{this} not to be ' + article + type
);
}
2013-04-29 22:15:27 +00:00
Assertion.addChainableMethod('an', an);
Assertion.addChainableMethod('a', an);
/**
* ### .include(value)
*
* The `include` and `contain` assertions can be used as either property
* based language chains or as methods to assert the inclusion of an object
* in an array or a substring in a string. When used as language chains,
2015-02-09 18:43:58 +00:00
* they toggle the `contains` flag for the `keys` assertion.
2013-04-29 22:15:27 +00:00
*
* expect([1,2,3]).to.include(2);
* expect('foobar').to.contain('foo');
* expect({ foo: 'bar', hello: 'universe' }).to.include.keys('foo');
*
* @name include
* @alias contain
2015-02-09 18:43:58 +00:00
* @alias includes
* @alias contains
2013-04-29 22:15:27 +00:00
* @param {Object|String|Number} obj
* @param {String} message _optional_
* @api public
*/
function includeChainingBehavior () {
flag(this, 'contains', true);
}
2011-12-07 06:10:58 +00:00
2013-04-29 22:15:27 +00:00
function include (val, msg) {
if (msg) flag(this, 'message', msg);
2014-01-29 23:38:57 +00:00
var obj = flag(this, 'object');
2014-03-19 16:22:08 +00:00
var expected = false;
if (_.type(obj) === 'array' && _.type(val) === 'object') {
for (var i in obj) {
if (_.eql(obj[i], val)) {
expected = true;
break;
}
}
} else if (_.type(val) === 'object') {
2014-01-29 23:38:57 +00:00
if (!flag(this, 'negate')) {
for (var k in val) new Assertion(obj).property(k, val[k]);
return;
}
2015-02-09 18:43:58 +00:00
var subset = {};
for (var k in val) subset[k] = obj[k];
2014-03-19 16:22:08 +00:00
expected = _.eql(subset, val);
2014-01-29 23:38:57 +00:00
} else {
2015-02-09 18:43:58 +00:00
expected = obj && ~obj.indexOf(val);
2014-01-29 23:38:57 +00:00
}
2013-04-29 22:15:27 +00:00
this.assert(
2014-01-29 23:38:57 +00:00
expected
2013-04-29 22:15:27 +00:00
, 'expected #{this} to include ' + _.inspect(val)
, 'expected #{this} to not include ' + _.inspect(val));
}
2011-12-07 06:10:58 +00:00
2013-04-29 22:15:27 +00:00
Assertion.addChainableMethod('include', include, includeChainingBehavior);
Assertion.addChainableMethod('contain', include, includeChainingBehavior);
2015-02-09 18:43:58 +00:00
Assertion.addChainableMethod('contains', include, includeChainingBehavior);
Assertion.addChainableMethod('includes', include, includeChainingBehavior);
2013-04-29 22:15:27 +00:00
/**
* ### .ok
*
* Asserts that the target is truthy.
*
* expect('everthing').to.be.ok;
* expect(1).to.be.ok;
* expect(false).to.not.be.ok;
* expect(undefined).to.not.be.ok;
* expect(null).to.not.be.ok;
*
* @name ok
* @api public
*/
2015-02-09 18:43:58 +00:00
Assertion.addProperty('ok', function () {
2013-04-29 22:15:27 +00:00
this.assert(
flag(this, 'object')
, 'expected #{this} to be truthy'
, 'expected #{this} to be falsy');
});
/**
* ### .true
*
* Asserts that the target is `true`.
*
* expect(true).to.be.true;
* expect(1).to.not.be.true;
*
* @name true
* @api public
*/
2015-02-09 18:43:58 +00:00
Assertion.addProperty('true', function () {
2013-04-29 22:15:27 +00:00
this.assert(
true === flag(this, 'object')
, 'expected #{this} to be true'
, 'expected #{this} to be false'
, this.negate ? false : true
);
});
/**
* ### .false
*
* Asserts that the target is `false`.
*
* expect(false).to.be.false;
* expect(0).to.not.be.false;
*
* @name false
* @api public
*/
2015-02-09 18:43:58 +00:00
Assertion.addProperty('false', function () {
2013-04-29 22:15:27 +00:00
this.assert(
false === flag(this, 'object')
, 'expected #{this} to be false'
, 'expected #{this} to be true'
, this.negate ? true : false
);
});
/**
* ### .null
*
* Asserts that the target is `null`.
*
* expect(null).to.be.null;
2015-04-26 16:13:17 +00:00
* expect(undefined).to.not.be.null;
2013-04-29 22:15:27 +00:00
*
* @name null
* @api public
*/
2015-02-09 18:43:58 +00:00
Assertion.addProperty('null', function () {
2013-04-29 22:15:27 +00:00
this.assert(
null === flag(this, 'object')
, 'expected #{this} to be null'
, 'expected #{this} not to be null'
);
});
/**
* ### .undefined
*
* Asserts that the target is `undefined`.
*
* expect(undefined).to.be.undefined;
* expect(null).to.not.be.undefined;
2013-04-29 22:15:27 +00:00
*
* @name undefined
* @api public
*/
2015-02-09 18:43:58 +00:00
Assertion.addProperty('undefined', function () {
2013-04-29 22:15:27 +00:00
this.assert(
undefined === flag(this, 'object')
, 'expected #{this} to be undefined'
, 'expected #{this} not to be undefined'
);
});
/**
* ### .exist
*
* Asserts that the target is neither `null` nor `undefined`.
*
* var foo = 'hi'
* , bar = null
* , baz;
*
* expect(foo).to.exist;
* expect(bar).to.not.exist;
* expect(baz).to.not.exist;
*
* @name exist
* @api public
*/
2015-02-09 18:43:58 +00:00
Assertion.addProperty('exist', function () {
2013-04-29 22:15:27 +00:00
this.assert(
null != flag(this, 'object')
, 'expected #{this} to exist'
, 'expected #{this} to not exist'
);
});
/**
* ### .empty
*
2015-03-04 20:19:52 +00:00
* Asserts that the target's length is `0`. For arrays and strings, it checks
2013-04-29 22:15:27 +00:00
* the `length` property. For objects, it gets the count of
* enumerable keys.
*
* expect([]).to.be.empty;
* expect('').to.be.empty;
* expect({}).to.be.empty;
*
* @name empty
* @api public
*/
2015-02-09 18:43:58 +00:00
Assertion.addProperty('empty', function () {
2013-04-29 22:15:27 +00:00
var obj = flag(this, 'object')
, expected = obj;
if (Array.isArray(obj) || 'string' === typeof object) {
expected = obj.length;
} else if (typeof obj === 'object') {
expected = Object.keys(obj).length;
}
2011-12-07 06:10:58 +00:00
2013-04-29 22:15:27 +00:00
this.assert(
!expected
, 'expected #{this} to be empty'
, 'expected #{this} not to be empty'
);
});
/**
* ### .arguments
*
* Asserts that the target is an arguments object.
*
* function test () {
* expect(arguments).to.be.arguments;
* }
*
* @name arguments
* @alias Arguments
* @api public
*/
function checkArguments () {
var obj = flag(this, 'object')
, type = Object.prototype.toString.call(obj);
this.assert(
'[object Arguments]' === type
, 'expected #{this} to be arguments but got ' + type
, 'expected #{this} to not be arguments'
);
}
2011-12-15 12:07:27 +00:00
2015-02-09 18:43:58 +00:00
Assertion.addProperty('arguments', checkArguments);
Assertion.addProperty('Arguments', checkArguments);
2013-04-29 22:15:27 +00:00
/**
* ### .equal(value)
*
* Asserts that the target is strictly equal (`===`) to `value`.
* Alternately, if the `deep` flag is set, asserts that
* the target is deeply equal to `value`.
*
* expect('hello').to.equal('hello');
* expect(42).to.equal(42);
* expect(1).to.not.equal(true);
* expect({ foo: 'bar' }).to.not.equal({ foo: 'bar' });
* expect({ foo: 'bar' }).to.deep.equal({ foo: 'bar' });
*
* @name equal
* @alias equals
* @alias eq
* @alias deep.equal
* @param {Mixed} value
* @param {String} message _optional_
* @api public
*/
function assertEqual (val, msg) {
if (msg) flag(this, 'message', msg);
var obj = flag(this, 'object');
if (flag(this, 'deep')) {
return this.eql(val);
} else {
this.assert(
val === obj
, 'expected #{this} to equal #{exp}'
, 'expected #{this} to not equal #{exp}'
, val
, this._obj
, true
);
}
}
2012-07-01 02:55:04 +00:00
2013-04-29 22:15:27 +00:00
Assertion.addMethod('equal', assertEqual);
Assertion.addMethod('equals', assertEqual);
Assertion.addMethod('eq', assertEqual);
/**
* ### .eql(value)
*
* Asserts that the target is deeply equal to `value`.
*
* expect({ foo: 'bar' }).to.eql({ foo: 'bar' });
* expect([ 1, 2, 3 ]).to.eql([ 1, 2, 3 ]);
*
* @name eql
* @alias eqls
* @param {Mixed} value
* @param {String} message _optional_
* @api public
*/
function assertEql(obj, msg) {
if (msg) flag(this, 'message', msg);
this.assert(
_.eql(obj, flag(this, 'object'))
, 'expected #{this} to deeply equal #{exp}'
, 'expected #{this} to not deeply equal #{exp}'
, obj
, this._obj
, true
);
}
2012-07-01 02:55:04 +00:00
2013-04-29 22:15:27 +00:00
Assertion.addMethod('eql', assertEql);
Assertion.addMethod('eqls', assertEql);
/**
* ### .above(value)
*
* Asserts that the target is greater than `value`.
*
* expect(10).to.be.above(5);
*
* Can also be used in conjunction with `length` to
* assert a minimum length. The benefit being a
* more informative error message than if the length
* was supplied directly.
*
* expect('foo').to.have.length.above(2);
* expect([ 1, 2, 3 ]).to.have.length.above(2);
*
* @name above
* @alias gt
* @alias greaterThan
* @param {Number} value
* @param {String} message _optional_
* @api public
*/
function assertAbove (n, msg) {
if (msg) flag(this, 'message', msg);
var obj = flag(this, 'object');
if (flag(this, 'doLength')) {
new Assertion(obj, msg).to.have.property('length');
var len = obj.length;
this.assert(
len > n
, 'expected #{this} to have a length above #{exp} but got #{act}'
, 'expected #{this} to not have a length above #{exp}'
, n
, len
);
} else {
this.assert(
obj > n
, 'expected #{this} to be above ' + n
, 'expected #{this} to be at most ' + n
);
}
}
2011-12-15 12:07:27 +00:00
2013-04-29 22:15:27 +00:00
Assertion.addMethod('above', assertAbove);
Assertion.addMethod('gt', assertAbove);
Assertion.addMethod('greaterThan', assertAbove);
/**
* ### .least(value)
*
* Asserts that the target is greater than or equal to `value`.
*
* expect(10).to.be.at.least(10);
*
* Can also be used in conjunction with `length` to
* assert a minimum length. The benefit being a
* more informative error message than if the length
* was supplied directly.
*
* expect('foo').to.have.length.of.at.least(2);
* expect([ 1, 2, 3 ]).to.have.length.of.at.least(3);
*
* @name least
* @alias gte
* @param {Number} value
* @param {String} message _optional_
* @api public
*/
function assertLeast (n, msg) {
if (msg) flag(this, 'message', msg);
var obj = flag(this, 'object');
if (flag(this, 'doLength')) {
new Assertion(obj, msg).to.have.property('length');
var len = obj.length;
this.assert(
len >= n
, 'expected #{this} to have a length at least #{exp} but got #{act}'
, 'expected #{this} to have a length below #{exp}'
, n
, len
);
} else {
this.assert(
obj >= n
, 'expected #{this} to be at least ' + n
, 'expected #{this} to be below ' + n
);
}
}
2012-06-24 11:44:00 +00:00
2013-04-29 22:15:27 +00:00
Assertion.addMethod('least', assertLeast);
Assertion.addMethod('gte', assertLeast);
/**
* ### .below(value)
*
* Asserts that the target is less than `value`.
*
* expect(5).to.be.below(10);
*
* Can also be used in conjunction with `length` to
* assert a maximum length. The benefit being a
* more informative error message than if the length
* was supplied directly.
*
* expect('foo').to.have.length.below(4);
* expect([ 1, 2, 3 ]).to.have.length.below(4);
*
* @name below
* @alias lt
* @alias lessThan
* @param {Number} value
* @param {String} message _optional_
* @api public
*/
function assertBelow (n, msg) {
if (msg) flag(this, 'message', msg);
var obj = flag(this, 'object');
if (flag(this, 'doLength')) {
new Assertion(obj, msg).to.have.property('length');
var len = obj.length;
this.assert(
len < n
, 'expected #{this} to have a length below #{exp} but got #{act}'
, 'expected #{this} to not have a length below #{exp}'
, n
, len
);
} else {
this.assert(
obj < n
, 'expected #{this} to be below ' + n
, 'expected #{this} to be at least ' + n
);
}
}
2012-07-01 02:55:04 +00:00
2013-04-29 22:15:27 +00:00
Assertion.addMethod('below', assertBelow);
Assertion.addMethod('lt', assertBelow);
Assertion.addMethod('lessThan', assertBelow);
/**
* ### .most(value)
*
* Asserts that the target is less than or equal to `value`.
*
* expect(5).to.be.at.most(5);
*
* Can also be used in conjunction with `length` to
* assert a maximum length. The benefit being a
* more informative error message than if the length
* was supplied directly.
*
* expect('foo').to.have.length.of.at.most(4);
* expect([ 1, 2, 3 ]).to.have.length.of.at.most(3);
*
* @name most
* @alias lte
* @param {Number} value
* @param {String} message _optional_
* @api public
*/
function assertMost (n, msg) {
if (msg) flag(this, 'message', msg);
var obj = flag(this, 'object');
if (flag(this, 'doLength')) {
new Assertion(obj, msg).to.have.property('length');
var len = obj.length;
this.assert(
len <= n
, 'expected #{this} to have a length at most #{exp} but got #{act}'
, 'expected #{this} to have a length above #{exp}'
, n
, len
);
} else {
this.assert(
obj <= n
, 'expected #{this} to be at most ' + n
, 'expected #{this} to be above ' + n
);
2011-12-18 12:02:18 +00:00
}
2013-04-29 22:15:27 +00:00
}
2011-12-07 06:10:58 +00:00
2013-04-29 22:15:27 +00:00
Assertion.addMethod('most', assertMost);
Assertion.addMethod('lte', assertMost);
/**
* ### .within(start, finish)
*
* Asserts that the target is within a range.
*
* expect(7).to.be.within(5,10);
*
* Can also be used in conjunction with `length` to
* assert a length range. The benefit being a
* more informative error message than if the length
* was supplied directly.
*
* expect('foo').to.have.length.within(2,4);
* expect([ 1, 2, 3 ]).to.have.length.within(2,4);
*
* @name within
* @param {Number} start lowerbound inclusive
* @param {Number} finish upperbound inclusive
* @param {String} message _optional_
* @api public
*/
Assertion.addMethod('within', function (start, finish, msg) {
if (msg) flag(this, 'message', msg);
var obj = flag(this, 'object')
, range = start + '..' + finish;
if (flag(this, 'doLength')) {
new Assertion(obj, msg).to.have.property('length');
var len = obj.length;
this.assert(
len >= start && len <= finish
, 'expected #{this} to have a length within ' + range
, 'expected #{this} to not have a length within ' + range
);
} else {
this.assert(
obj >= start && obj <= finish
, 'expected #{this} to be within ' + range
, 'expected #{this} to not be within ' + range
);
}
});
/**
* ### .instanceof(constructor)
*
* Asserts that the target is an instance of `constructor`.
*
* var Tea = function (name) { this.name = name; }
* , Chai = new Tea('chai');
*
* expect(Chai).to.be.an.instanceof(Tea);
* expect([ 1, 2, 3 ]).to.be.instanceof(Array);
*
* @name instanceof
* @param {Constructor} constructor
* @param {String} message _optional_
* @alias instanceOf
* @api public
*/
function assertInstanceOf (constructor, msg) {
if (msg) flag(this, 'message', msg);
var name = _.getName(constructor);
this.assert(
flag(this, 'object') instanceof constructor
, 'expected #{this} to be an instance of ' + name
, 'expected #{this} to not be an instance of ' + name
);
};
2012-02-24 19:55:30 +00:00
2013-04-29 22:15:27 +00:00
Assertion.addMethod('instanceof', assertInstanceOf);
Assertion.addMethod('instanceOf', assertInstanceOf);
/**
* ### .property(name, [value])
*
* Asserts that the target has a property `name`, optionally asserting that
* the value of that property is strictly equal to `value`.
* If the `deep` flag is set, you can use dot- and bracket-notation for deep
* references into objects and arrays.
*
* // simple referencing
* var obj = { foo: 'bar' };
* expect(obj).to.have.property('foo');
* expect(obj).to.have.property('foo', 'bar');
*
* // deep referencing
* var deepObj = {
* green: { tea: 'matcha' }
* , teas: [ 'chai', 'matcha', { tea: 'konacha' } ]
* };
2015-04-26 16:13:17 +00:00
*
2013-04-29 22:15:27 +00:00
* expect(deepObj).to.have.deep.property('green.tea', 'matcha');
* expect(deepObj).to.have.deep.property('teas[1]', 'matcha');
* expect(deepObj).to.have.deep.property('teas[2].tea', 'konacha');
*
* You can also use an array as the starting point of a `deep.property`
* assertion, or traverse nested arrays.
*
* var arr = [
* [ 'chai', 'matcha', 'konacha' ]
* , [ { tea: 'chai' }
* , { tea: 'matcha' }
* , { tea: 'konacha' } ]
* ];
*
* expect(arr).to.have.deep.property('[0][1]', 'matcha');
* expect(arr).to.have.deep.property('[1][2].tea', 'konacha');
*
* Furthermore, `property` changes the subject of the assertion
* to be the value of that property from the original object. This
* permits for further chainable assertions on that property.
*
* expect(obj).to.have.property('foo')
* .that.is.a('string');
* expect(deepObj).to.have.property('green')
* .that.is.an('object')
* .that.deep.equals({ tea: 'matcha' });
* expect(deepObj).to.have.property('teas')
* .that.is.an('array')
* .with.deep.property('[2]')
* .that.deep.equals({ tea: 'konacha' });
*
2015-03-26 18:03:02 +00:00
* Note that dots and bracket in `name` must be backslash-escaped when
* the `deep` flag is set, while they must NOT be escaped when the `deep`
* flag is not set.
*
* // simple referencing
* var css = { '.link[target]': 42 };
* expect(css).to.have.property('.link[target]', 42);
*
* // deep referencing
* var deepCss = { '.link': { '[target]': 42 }};
* expect(deepCss).to.have.deep.property('\\.link.\\[target\\]', 42);
*
2013-04-29 22:15:27 +00:00
* @name property
* @alias deep.property
* @param {String} name
* @param {Mixed} value (optional)
* @param {String} message _optional_
* @returns value of property for chaining
* @api public
*/
Assertion.addMethod('property', function (name, val, msg) {
if (msg) flag(this, 'message', msg);
2015-02-09 18:43:58 +00:00
var isDeep = !!flag(this, 'deep')
, descriptor = isDeep ? 'deep property ' : 'property '
2013-04-29 22:15:27 +00:00
, negate = flag(this, 'negate')
, obj = flag(this, 'object')
2015-02-09 18:43:58 +00:00
, pathInfo = isDeep ? _.getPathInfo(name, obj) : null
, hasProperty = isDeep
? pathInfo.exists
: _.hasProperty(name, obj)
, value = isDeep
? pathInfo.value
2013-04-29 22:15:27 +00:00
: obj[name];
2015-06-03 23:19:52 +00:00
if (negate && arguments.length > 1) {
2013-04-29 22:15:27 +00:00
if (undefined === value) {
msg = (msg != null) ? msg + ': ' : '';
throw new Error(msg + _.inspect(obj) + ' has no ' + descriptor + _.inspect(name));
}
} else {
this.assert(
2015-02-09 18:43:58 +00:00
hasProperty
2013-04-29 22:15:27 +00:00
, 'expected #{this} to have a ' + descriptor + _.inspect(name)
, 'expected #{this} to not have ' + descriptor + _.inspect(name));
}
2012-06-24 13:16:16 +00:00
2015-06-03 23:19:52 +00:00
if (arguments.length > 1) {
2013-04-29 22:15:27 +00:00
this.assert(
val === value
, 'expected #{this} to have a ' + descriptor + _.inspect(name) + ' of #{exp}, but got #{act}'
, 'expected #{this} to not have a ' + descriptor + _.inspect(name) + ' of #{act}'
, val
, value
);
}
2012-07-01 02:55:04 +00:00
2013-04-29 22:15:27 +00:00
flag(this, 'object', value);
});
/**
* ### .ownProperty(name)
*
* Asserts that the target has an own property `name`.
*
* expect('test').to.have.ownProperty('length');
*
* @name ownProperty
* @alias haveOwnProperty
* @param {String} name
* @param {String} message _optional_
* @api public
*/
function assertOwnProperty (name, msg) {
if (msg) flag(this, 'message', msg);
var obj = flag(this, 'object');
this.assert(
obj.hasOwnProperty(name)
, 'expected #{this} to have own property ' + _.inspect(name)
, 'expected #{this} to not have own property ' + _.inspect(name)
);
}
2012-07-01 02:55:04 +00:00
2013-04-29 22:15:27 +00:00
Assertion.addMethod('ownProperty', assertOwnProperty);
Assertion.addMethod('haveOwnProperty', assertOwnProperty);
2015-04-26 16:13:17 +00:00
/**
* ### .ownPropertyDescriptor(name[, descriptor[, message]])
*
* Asserts that the target has an own property descriptor `name`, that optionally matches `descriptor`.
*
* expect('test').to.have.ownPropertyDescriptor('length');
* expect('test').to.have.ownPropertyDescriptor('length', { enumerable: false, configurable: false, writable: false, value: 4 });
* expect('test').not.to.have.ownPropertyDescriptor('length', { enumerable: false, configurable: false, writable: false, value: 3 });
* expect('test').ownPropertyDescriptor('length').to.have.property('enumerable', false);
* expect('test').ownPropertyDescriptor('length').to.have.keys('value');
*
* @name ownPropertyDescriptor
* @alias haveOwnPropertyDescriptor
* @param {String} name
* @param {Object} descriptor _optional_
* @param {String} message _optional_
* @api public
*/
function assertOwnPropertyDescriptor (name, descriptor, msg) {
if (typeof descriptor === 'string') {
msg = descriptor;
descriptor = null;
}
if (msg) flag(this, 'message', msg);
var obj = flag(this, 'object');
var actualDescriptor = Object.getOwnPropertyDescriptor(Object(obj), name);
if (actualDescriptor && descriptor) {
this.assert(
_.eql(descriptor, actualDescriptor)
, 'expected the own property descriptor for ' + _.inspect(name) + ' on #{this} to match ' + _.inspect(descriptor) + ', got ' + _.inspect(actualDescriptor)
, 'expected the own property descriptor for ' + _.inspect(name) + ' on #{this} to not match ' + _.inspect(descriptor)
, descriptor
, actualDescriptor
, true
);
} else {
this.assert(
actualDescriptor
, 'expected #{this} to have an own property descriptor for ' + _.inspect(name)
, 'expected #{this} to not have an own property descriptor for ' + _.inspect(name)
);
}
flag(this, 'object', actualDescriptor);
}
Assertion.addMethod('ownPropertyDescriptor', assertOwnPropertyDescriptor);
Assertion.addMethod('haveOwnPropertyDescriptor', assertOwnPropertyDescriptor);
2013-04-29 22:15:27 +00:00
/**
* ### .length
2013-04-29 22:15:27 +00:00
*
* Sets the `doLength` flag later used as a chain precursor to a value
* comparison for the `length` property.
2013-04-29 22:15:27 +00:00
*
* expect('foo').to.have.length.above(2);
* expect([ 1, 2, 3 ]).to.have.length.above(2);
* expect('foo').to.have.length.below(4);
* expect([ 1, 2, 3 ]).to.have.length.below(4);
* expect('foo').to.have.length.within(2,4);
* expect([ 1, 2, 3 ]).to.have.length.within(2,4);
*
* *Deprecation notice:* Using `length` as an assertion will be deprecated
* in version 2.4.0 and removed in 3.0.0. Code using the old style of
* asserting for `length` property value using `length(value)` should be
* switched to use `lengthOf(value)` instead.
*
2013-04-29 22:15:27 +00:00
* @name length
* @api public
*/
/**
* ### .lengthOf(value[, message])
*
* Asserts that the target's `length` property has
* the expected value.
*
* expect([ 1, 2, 3]).to.have.lengthOf(3);
* expect('foobar').to.have.lengthOf(6);
*
* @name lengthOf
2013-04-29 22:15:27 +00:00
* @param {Number} length
* @param {String} message _optional_
* @api public
*/
function assertLengthChain () {
flag(this, 'doLength', true);
}
2012-07-01 02:55:04 +00:00
2013-04-29 22:15:27 +00:00
function assertLength (n, msg) {
if (msg) flag(this, 'message', msg);
var obj = flag(this, 'object');
new Assertion(obj, msg).to.have.property('length');
var len = obj.length;
this.assert(
len == n
, 'expected #{this} to have a length of #{exp} but got #{act}'
, 'expected #{this} to not have a length of #{act}'
, n
, len
);
}
2012-06-02 16:41:54 +00:00
2013-04-29 22:15:27 +00:00
Assertion.addChainableMethod('length', assertLength, assertLengthChain);
2014-09-29 23:24:59 +00:00
Assertion.addMethod('lengthOf', assertLength);
2013-04-29 22:15:27 +00:00
/**
* ### .match(regexp)
*
* Asserts that the target matches a regular expression.
*
* expect('foobar').to.match(/^foo/);
*
* @name match
* @alias matches
2013-04-29 22:15:27 +00:00
* @param {RegExp} RegularExpression
* @param {String} message _optional_
* @api public
*/
function assertMatch(re, msg) {
2013-04-29 22:15:27 +00:00
if (msg) flag(this, 'message', msg);
var obj = flag(this, 'object');
this.assert(
re.exec(obj)
, 'expected #{this} to match ' + re
, 'expected #{this} not to match ' + re
);
}
Assertion.addMethod('match', assertMatch);
Assertion.addMethod('matches', assertMatch);
2013-04-29 22:15:27 +00:00
/**
* ### .string(string)
*
* Asserts that the string target contains another string.
*
* expect('foobar').to.have.string('bar');
*
* @name string
* @param {String} string
* @param {String} message _optional_
* @api public
*/
Assertion.addMethod('string', function (str, msg) {
if (msg) flag(this, 'message', msg);
var obj = flag(this, 'object');
new Assertion(obj, msg).is.a('string');
this.assert(
~obj.indexOf(str)
, 'expected #{this} to contain ' + _.inspect(str)
, 'expected #{this} to not contain ' + _.inspect(str)
);
});
/**
* ### .keys(key1, [key2], [...])
*
2015-02-09 18:43:58 +00:00
* Asserts that the target contains any or all of the passed-in keys.
2015-04-26 16:13:17 +00:00
* Use in combination with `any`, `all`, `contains`, or `have` will affect
2015-02-09 18:43:58 +00:00
* what will pass.
2015-04-26 16:13:17 +00:00
*
* When used in conjunction with `any`, at least one key that is passed
* in must exist in the target object. This is regardless whether or not
2015-02-09 18:43:58 +00:00
* the `have` or `contain` qualifiers are used. Note, either `any` or `all`
* should be used in the assertion. If neither are used, the assertion is
* defaulted to `all`.
2015-04-26 16:13:17 +00:00
*
* When both `all` and `contain` are used, the target object must have at
2015-02-09 18:43:58 +00:00
* least all of the passed-in keys but may have more keys not listed.
2015-04-26 16:13:17 +00:00
*
2015-02-09 18:43:58 +00:00
* When both `all` and `have` are used, the target object must both contain
* all of the passed-in keys AND the number of keys in the target object must
2015-04-26 16:13:17 +00:00
* match the number of keys passed in (in other words, a target object must
2015-02-09 18:43:58 +00:00
* have all and only all of the passed-in keys).
2015-04-26 16:13:17 +00:00
*
2015-02-09 18:43:58 +00:00
* expect({ foo: 1, bar: 2 }).to.have.any.keys('foo', 'baz');
* expect({ foo: 1, bar: 2 }).to.have.any.keys('foo');
* expect({ foo: 1, bar: 2 }).to.contain.any.keys('bar', 'baz');
* expect({ foo: 1, bar: 2 }).to.contain.any.keys(['foo']);
* expect({ foo: 1, bar: 2 }).to.contain.any.keys({'foo': 6});
* expect({ foo: 1, bar: 2 }).to.have.all.keys(['bar', 'foo']);
2015-04-26 16:13:17 +00:00
* expect({ foo: 1, bar: 2 }).to.have.all.keys({'bar': 6, 'foo': 7});
2015-02-09 18:43:58 +00:00
* expect({ foo: 1, bar: 2, baz: 3 }).to.contain.all.keys(['bar', 'foo']);
* expect({ foo: 1, bar: 2, baz: 3 }).to.contain.all.keys({'bar': 6});
2013-04-29 22:15:27 +00:00
*
*
* @name keys
* @alias key
2015-02-09 18:43:58 +00:00
* @param {String...|Array|Object} keys
2013-04-29 22:15:27 +00:00
* @api public
*/
function assertKeys (keys) {
var obj = flag(this, 'object')
, str
2015-02-09 18:43:58 +00:00
, ok = true
, mixedArgsMsg = 'keys must be given single argument of Array|Object|String, or multiple String arguments';
switch (_.type(keys)) {
case "array":
if (arguments.length > 1) throw (new Error(mixedArgsMsg));
break;
case "object":
if (arguments.length > 1) throw (new Error(mixedArgsMsg));
keys = Object.keys(keys);
break;
default:
keys = Array.prototype.slice.call(arguments);
}
2013-04-29 22:15:27 +00:00
if (!keys.length) throw new Error('keys required');
var actual = Object.keys(obj)
2014-09-29 23:24:59 +00:00
, expected = keys
2015-02-09 18:43:58 +00:00
, len = keys.length
, any = flag(this, 'any')
, all = flag(this, 'all');
2013-04-29 22:15:27 +00:00
2015-02-09 18:43:58 +00:00
if (!any && !all) {
all = true;
}
2012-03-18 21:42:08 +00:00
2015-02-09 18:43:58 +00:00
// Has any
if (any) {
var intersection = expected.filter(function(key) {
return ~actual.indexOf(key);
});
ok = intersection.length > 0;
}
// Has all
if (all) {
ok = keys.every(function(key){
return ~actual.indexOf(key);
});
if (!flag(this, 'negate') && !flag(this, 'contains')) {
ok = ok && keys.length == actual.length;
}
2013-04-29 22:15:27 +00:00
}
2012-03-18 21:42:08 +00:00
2013-04-29 22:15:27 +00:00
// Key string
if (len > 1) {
keys = keys.map(function(key){
return _.inspect(key);
2012-07-01 02:55:04 +00:00
});
2013-04-29 22:15:27 +00:00
var last = keys.pop();
2015-02-09 18:43:58 +00:00
if (all) {
str = keys.join(', ') + ', and ' + last;
}
if (any) {
str = keys.join(', ') + ', or ' + last;
}
2013-04-29 22:15:27 +00:00
} else {
str = _.inspect(keys[0]);
}
2012-07-01 02:55:04 +00:00
2013-04-29 22:15:27 +00:00
// Form
str = (len > 1 ? 'keys ' : 'key ') + str;
2012-07-01 02:55:04 +00:00
2013-04-29 22:15:27 +00:00
// Have / include
str = (flag(this, 'contains') ? 'contain ' : 'have ') + str;
2012-07-01 02:55:04 +00:00
2013-04-29 22:15:27 +00:00
// Assertion
this.assert(
ok
, 'expected #{this} to ' + str
, 'expected #{this} to not ' + str
2015-02-09 18:43:58 +00:00
, expected.slice(0).sort()
2014-09-29 23:24:59 +00:00
, actual.sort()
, true
2013-04-29 22:15:27 +00:00
);
}
2012-03-18 21:42:08 +00:00
2013-04-29 22:15:27 +00:00
Assertion.addMethod('keys', assertKeys);
Assertion.addMethod('key', assertKeys);
/**
* ### .throw(constructor)
*
* Asserts that the function target will throw a specific error, or specific type of error
* (as determined using `instanceof`), optionally with a RegExp or string inclusion test
* for the error's message.
*
* var err = new ReferenceError('This is a bad function.');
* var fn = function () { throw err; }
* expect(fn).to.throw(ReferenceError);
* expect(fn).to.throw(Error);
* expect(fn).to.throw(/bad function/);
* expect(fn).to.not.throw('good function');
* expect(fn).to.throw(ReferenceError, /bad function/);
* expect(fn).to.throw(err);
* expect(fn).to.not.throw(new RangeError('Out of range.'));
*
* Please note that when a throw expectation is negated, it will check each
* parameter independently, starting with error constructor type. The appropriate way
* to check for the existence of a type of error but for a message that does not match
* is to use `and`.
*
* expect(fn).to.throw(ReferenceError)
* .and.not.throw(/good function/);
*
* @name throw
* @alias throws
* @alias Throw
* @param {ErrorConstructor} constructor
* @param {String|RegExp} expected error message
* @param {String} message _optional_
* @see https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error#Error_types
2014-01-29 23:38:57 +00:00
* @returns error for chaining (null if no error)
2013-04-29 22:15:27 +00:00
* @api public
*/
function assertThrows (constructor, errMsg, msg) {
if (msg) flag(this, 'message', msg);
var obj = flag(this, 'object');
new Assertion(obj, msg).is.a('function');
var thrown = false
, desiredError = null
, name = null
, thrownError = null;
if (arguments.length === 0) {
errMsg = null;
constructor = null;
} else if (constructor && (constructor instanceof RegExp || 'string' === typeof constructor)) {
errMsg = constructor;
constructor = null;
} else if (constructor && constructor instanceof Error) {
desiredError = constructor;
constructor = null;
errMsg = null;
} else if (typeof constructor === 'function') {
2014-01-29 23:38:57 +00:00
name = constructor.prototype.name || constructor.name;
if (name === 'Error' && constructor !== Error) {
name = (new constructor()).name;
}
2013-04-29 22:15:27 +00:00
} else {
constructor = null;
}
2012-03-18 21:42:08 +00:00
2013-04-29 22:15:27 +00:00
try {
obj();
} catch (err) {
// first, check desired error
if (desiredError) {
2012-07-01 02:55:04 +00:00
this.assert(
2013-04-29 22:15:27 +00:00
err === desiredError
, 'expected #{this} to throw #{exp} but #{act} was thrown'
, 'expected #{this} to not throw #{exp}'
2014-01-29 23:38:57 +00:00
, (desiredError instanceof Error ? desiredError.toString() : desiredError)
, (err instanceof Error ? err.toString() : err)
2012-07-01 02:55:04 +00:00
);
2012-01-27 00:14:24 +00:00
2014-01-29 23:38:57 +00:00
flag(this, 'object', err);
2013-04-29 22:15:27 +00:00
return this;
}
2014-01-29 23:38:57 +00:00
2013-04-29 22:15:27 +00:00
// next, check constructor
if (constructor) {
2012-07-01 02:55:04 +00:00
this.assert(
2013-04-29 22:15:27 +00:00
err instanceof constructor
, 'expected #{this} to throw #{exp} but #{act} was thrown'
, 'expected #{this} to not throw #{exp} but #{act} was thrown'
, name
2014-01-29 23:38:57 +00:00
, (err instanceof Error ? err.toString() : err)
2012-07-01 02:55:04 +00:00
);
2012-01-27 00:14:24 +00:00
2014-01-29 23:38:57 +00:00
if (!errMsg) {
flag(this, 'object', err);
return this;
}
2013-04-29 22:15:27 +00:00
}
2014-01-29 23:38:57 +00:00
2013-04-29 22:15:27 +00:00
// next, check message
2015-06-03 23:19:52 +00:00
var message = 'error' === _.type(err) && "message" in err
2013-04-29 22:15:27 +00:00
? err.message
: '' + err;
2012-04-11 17:31:26 +00:00
2013-04-29 22:15:27 +00:00
if ((message != null) && errMsg && errMsg instanceof RegExp) {
2012-07-01 02:55:04 +00:00
this.assert(
2013-04-29 22:15:27 +00:00
errMsg.exec(message)
, 'expected #{this} to throw error matching #{exp} but got #{act}'
, 'expected #{this} to throw error not matching #{exp}'
, errMsg
, message
2012-07-01 02:55:04 +00:00
);
2011-12-07 06:10:58 +00:00
2014-01-29 23:38:57 +00:00
flag(this, 'object', err);
2013-04-29 22:15:27 +00:00
return this;
} else if ((message != null) && errMsg && 'string' === typeof errMsg) {
2012-07-01 02:55:04 +00:00
this.assert(
2013-04-29 22:15:27 +00:00
~message.indexOf(errMsg)
, 'expected #{this} to throw error including #{exp} but got #{act}'
, 'expected #{this} to throw error not including #{act}'
, errMsg
, message
2012-07-01 02:55:04 +00:00
);
2014-01-29 23:38:57 +00:00
flag(this, 'object', err);
2013-04-29 22:15:27 +00:00
return this;
} else {
thrown = true;
thrownError = err;
2012-07-01 02:55:04 +00:00
}
2013-04-29 22:15:27 +00:00
}
2013-04-29 22:15:27 +00:00
var actuallyGot = ''
, expectedThrown = name !== null
? name
: desiredError
? '#{exp}' //_.inspect(desiredError)
: 'an error';
2013-02-03 17:59:23 +00:00
2013-04-29 22:15:27 +00:00
if (thrown) {
actuallyGot = ' but #{act} was thrown'
}
2011-12-07 06:10:58 +00:00
2013-04-29 22:15:27 +00:00
this.assert(
thrown === true
, 'expected #{this} to throw ' + expectedThrown + actuallyGot
, 'expected #{this} to not throw ' + expectedThrown + actuallyGot
2014-01-29 23:38:57 +00:00
, (desiredError instanceof Error ? desiredError.toString() : desiredError)
, (thrownError instanceof Error ? thrownError.toString() : thrownError)
2013-04-29 22:15:27 +00:00
);
2014-01-29 23:38:57 +00:00
flag(this, 'object', thrownError);
2013-04-29 22:15:27 +00:00
};
2012-11-29 08:20:08 +00:00
2013-04-29 22:15:27 +00:00
Assertion.addMethod('throw', assertThrows);
Assertion.addMethod('throws', assertThrows);
Assertion.addMethod('Throw', assertThrows);
/**
* ### .respondTo(method)
*
* Asserts that the object or class target will respond to a method.
*
* Klass.prototype.bar = function(){};
* expect(Klass).to.respondTo('bar');
* expect(obj).to.respondTo('bar');
*
* To check if a constructor will respond to a static function,
* set the `itself` flag.
*
* Klass.baz = function(){};
* expect(Klass).itself.to.respondTo('baz');
2013-04-29 22:15:27 +00:00
*
* @name respondTo
* @param {String} method
* @param {String} message _optional_
* @api public
*/
Assertion.addMethod('respondTo', function (method, msg) {
if (msg) flag(this, 'message', msg);
var obj = flag(this, 'object')
, itself = flag(this, 'itself')
, context = ('function' === _.type(obj) && !itself)
? obj.prototype[method]
: obj[method];
this.assert(
'function' === typeof context
, 'expected #{this} to respond to ' + _.inspect(method)
, 'expected #{this} to not respond to ' + _.inspect(method)
);
});
/**
* ### .itself
*
* Sets the `itself` flag, later used by the `respondTo` assertion.
*
* function Foo() {}
* Foo.bar = function() {}
* Foo.prototype.baz = function() {}
2013-04-29 22:15:27 +00:00
*
* expect(Foo).itself.to.respondTo('bar');
* expect(Foo).itself.not.to.respondTo('baz');
2013-04-29 22:15:27 +00:00
*
* @name itself
* @api public
*/
Assertion.addProperty('itself', function () {
flag(this, 'itself', true);
});
/**
* ### .satisfy(method)
*
* Asserts that the target passes a given truth test.
*
* expect(1).to.satisfy(function(num) { return num > 0; });
*
* @name satisfy
* @param {Function} matcher
* @param {String} message _optional_
* @api public
*/
Assertion.addMethod('satisfy', function (matcher, msg) {
if (msg) flag(this, 'message', msg);
var obj = flag(this, 'object');
2014-09-29 23:24:59 +00:00
var result = matcher(obj);
2013-04-29 22:15:27 +00:00
this.assert(
2014-09-29 23:24:59 +00:00
result
2013-04-29 22:15:27 +00:00
, 'expected #{this} to satisfy ' + _.objDisplay(matcher)
, 'expected #{this} to not satisfy' + _.objDisplay(matcher)
, this.negate ? false : true
2014-09-29 23:24:59 +00:00
, result
2013-04-29 22:15:27 +00:00
);
});
/**
* ### .closeTo(expected, delta)
*
* Asserts that the target is equal `expected`, to within a +/- `delta` range.
*
* expect(1.5).to.be.closeTo(1, 0.5);
*
* @name closeTo
* @param {Number} expected
* @param {Number} delta
* @param {String} message _optional_
* @api public
*/
Assertion.addMethod('closeTo', function (expected, delta, msg) {
if (msg) flag(this, 'message', msg);
var obj = flag(this, 'object');
2014-09-29 23:24:59 +00:00
new Assertion(obj, msg).is.a('number');
if (_.type(expected) !== 'number' || _.type(delta) !== 'number') {
throw new Error('the arguments to closeTo must be numbers');
}
2013-04-29 22:15:27 +00:00
this.assert(
Math.abs(obj - expected) <= delta
, 'expected #{this} to be close to ' + expected + ' +/- ' + delta
, 'expected #{this} not to be close to ' + expected + ' +/- ' + delta
);
});
2014-03-19 16:22:08 +00:00
function isSubsetOf(subset, superset, cmp) {
2013-04-29 22:15:27 +00:00
return subset.every(function(elem) {
2014-03-19 16:22:08 +00:00
if (!cmp) return superset.indexOf(elem) !== -1;
return superset.some(function(elem2) {
return cmp(elem, elem2);
});
2013-04-29 22:15:27 +00:00
})
}
2011-12-07 06:10:58 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .members(set)
2013-04-29 22:15:27 +00:00
*
* Asserts that the target is a superset of `set`,
2014-03-19 16:22:08 +00:00
* or that the target and `set` have the same strictly-equal (===) members.
* Alternately, if the `deep` flag is set, set members are compared for deep
* equality.
2013-04-29 22:15:27 +00:00
*
* expect([1, 2, 3]).to.include.members([3, 2]);
* expect([1, 2, 3]).to.not.include.members([3, 2, 8]);
2013-04-29 22:15:27 +00:00
*
* expect([4, 2]).to.have.members([2, 4]);
* expect([5, 2]).to.not.have.members([5, 2, 1]);
2013-04-29 22:15:27 +00:00
*
2014-03-19 16:22:08 +00:00
* expect([{ id: 1 }]).to.deep.include.members([{ id: 1 }]);
*
2013-04-29 22:15:27 +00:00
* @name members
* @param {Array} set
* @param {String} message _optional_
* @api public
*/
Assertion.addMethod('members', function (subset, msg) {
if (msg) flag(this, 'message', msg);
var obj = flag(this, 'object');
new Assertion(obj).to.be.an('array');
new Assertion(subset).to.be.an('array');
2014-03-19 16:22:08 +00:00
var cmp = flag(this, 'deep') ? _.eql : undefined;
2013-04-29 22:15:27 +00:00
if (flag(this, 'contains')) {
return this.assert(
2014-03-19 16:22:08 +00:00
isSubsetOf(subset, obj, cmp)
2013-04-29 22:15:27 +00:00
, 'expected #{this} to be a superset of #{act}'
, 'expected #{this} to not be a superset of #{act}'
, obj
, subset
);
}
2012-11-29 08:20:08 +00:00
2013-04-29 22:15:27 +00:00
this.assert(
2014-03-19 16:22:08 +00:00
isSubsetOf(obj, subset, cmp) && isSubsetOf(subset, obj, cmp)
2013-04-29 22:15:27 +00:00
, 'expected #{this} to have the same members as #{act}'
, 'expected #{this} to not have the same members as #{act}'
, obj
, subset
);
});
2015-02-09 18:43:58 +00:00
/**
* ### .change(function)
*
* Asserts that a function changes an object property
*
* var obj = { val: 10 };
* var fn = function() { obj.val += 3 };
* var noChangeFn = function() { return 'foo' + 'bar'; }
* expect(fn).to.change(obj, 'val');
* expect(noChangFn).to.not.change(obj, 'val')
*
* @name change
* @alias changes
* @alias Change
* @param {String} object
* @param {String} property name
* @param {String} message _optional_
* @api public
*/
function assertChanges (object, prop, msg) {
if (msg) flag(this, 'message', msg);
var fn = flag(this, 'object');
new Assertion(object, msg).to.have.property(prop);
new Assertion(fn).is.a('function');
var initial = object[prop];
fn();
this.assert(
initial !== object[prop]
, 'expected .' + prop + ' to change'
, 'expected .' + prop + ' to not change'
);
}
Assertion.addChainableMethod('change', assertChanges);
Assertion.addChainableMethod('changes', assertChanges);
/**
* ### .increase(function)
*
* Asserts that a function increases an object property
*
* var obj = { val: 10 };
* var fn = function() { obj.val = 15 };
* expect(fn).to.increase(obj, 'val');
*
* @name increase
* @alias increases
* @alias Increase
* @param {String} object
* @param {String} property name
* @param {String} message _optional_
* @api public
*/
function assertIncreases (object, prop, msg) {
if (msg) flag(this, 'message', msg);
var fn = flag(this, 'object');
new Assertion(object, msg).to.have.property(prop);
new Assertion(fn).is.a('function');
var initial = object[prop];
fn();
this.assert(
object[prop] - initial > 0
, 'expected .' + prop + ' to increase'
, 'expected .' + prop + ' to not increase'
);
}
Assertion.addChainableMethod('increase', assertIncreases);
Assertion.addChainableMethod('increases', assertIncreases);
/**
* ### .decrease(function)
*
* Asserts that a function decreases an object property
*
* var obj = { val: 10 };
* var fn = function() { obj.val = 5 };
* expect(fn).to.decrease(obj, 'val');
*
* @name decrease
* @alias decreases
* @alias Decrease
* @param {String} object
* @param {String} property name
* @param {String} message _optional_
* @api public
*/
function assertDecreases (object, prop, msg) {
if (msg) flag(this, 'message', msg);
var fn = flag(this, 'object');
new Assertion(object, msg).to.have.property(prop);
new Assertion(fn).is.a('function');
var initial = object[prop];
fn();
this.assert(
object[prop] - initial < 0
, 'expected .' + prop + ' to decrease'
, 'expected .' + prop + ' to not decrease'
);
}
Assertion.addChainableMethod('decrease', assertDecreases);
Assertion.addChainableMethod('decreases', assertDecreases);
2013-04-29 22:15:27 +00:00
};
},{}],5:[function(require,module,exports){
2013-04-29 22:15:27 +00:00
/*!
* chai
2014-01-29 23:38:57 +00:00
* Copyright(c) 2011-2014 Jake Luer <jake@alogicalparadox.com>
2013-04-29 22:15:27 +00:00
* MIT Licensed
*/
module.exports = function (chai, util) {
/*!
* Chai dependencies.
*/
var Assertion = chai.Assertion
, flag = util.flag;
/*!
* Module export.
*/
/**
* ### assert(expression, message)
*
* Write your own test expressions.
*
* assert('foo' !== 'bar', 'foo is not bar');
* assert(Array.isArray([]), 'empty arrays are arrays');
*
* @param {Mixed} expression to test for truthiness
* @param {String} message to display on error
* @name assert
* @api public
*/
var assert = chai.assert = function (express, errmsg) {
2014-03-19 16:22:08 +00:00
var test = new Assertion(null, null, chai.assert);
2013-04-29 22:15:27 +00:00
test.assert(
express
, errmsg
, '[ negation message unavailable ]'
);
};
2011-12-07 06:10:58 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .fail(actual, expected, [message], [operator])
*
* Throw a failure. Node.js `assert` module-compatible.
*
* @name fail
* @param {Mixed} actual
* @param {Mixed} expected
* @param {String} message
* @param {String} operator
* @api public
*/
assert.fail = function (actual, expected, message, operator) {
2014-01-29 23:38:57 +00:00
message = message || 'assert.fail()';
throw new chai.AssertionError(message, {
2013-04-29 22:15:27 +00:00
actual: actual
, expected: expected
, operator: operator
2014-01-29 23:38:57 +00:00
}, assert.fail);
2013-04-29 22:15:27 +00:00
};
2011-12-07 06:10:58 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .ok(object, [message])
*
* Asserts that `object` is truthy.
*
* assert.ok('everything', 'everything is ok');
* assert.ok(false, 'this will fail');
*
* @name ok
* @param {Mixed} object to test
* @param {String} message
* @api public
*/
assert.ok = function (val, msg) {
new Assertion(val, msg).is.ok;
};
2011-12-07 06:10:58 +00:00
2013-06-17 20:06:38 +00:00
/**
* ### .notOk(object, [message])
*
* Asserts that `object` is falsy.
*
* assert.notOk('everything', 'this will fail');
* assert.notOk(false, 'this will pass');
*
* @name notOk
* @param {Mixed} object to test
* @param {String} message
* @api public
*/
assert.notOk = function (val, msg) {
new Assertion(val, msg).is.not.ok;
};
2013-04-29 22:15:27 +00:00
/**
* ### .equal(actual, expected, [message])
*
* Asserts non-strict equality (`==`) of `actual` and `expected`.
*
* assert.equal(3, '3', '== coerces values to strings');
*
* @name equal
* @param {Mixed} actual
* @param {Mixed} expected
* @param {String} message
* @api public
*/
assert.equal = function (act, exp, msg) {
2014-03-19 16:22:08 +00:00
var test = new Assertion(act, msg, assert.equal);
2013-04-29 22:15:27 +00:00
test.assert(
exp == flag(test, 'object')
, 'expected #{this} to equal #{exp}'
, 'expected #{this} to not equal #{act}'
, exp
, act
);
};
2011-12-07 06:10:58 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .notEqual(actual, expected, [message])
*
* Asserts non-strict inequality (`!=`) of `actual` and `expected`.
*
* assert.notEqual(3, 4, 'these numbers are not equal');
*
* @name notEqual
* @param {Mixed} actual
* @param {Mixed} expected
* @param {String} message
* @api public
*/
assert.notEqual = function (act, exp, msg) {
2014-03-19 16:22:08 +00:00
var test = new Assertion(act, msg, assert.notEqual);
2013-04-29 22:15:27 +00:00
test.assert(
exp != flag(test, 'object')
, 'expected #{this} to not equal #{exp}'
, 'expected #{this} to equal #{act}'
, exp
, act
);
};
2011-12-07 06:10:58 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .strictEqual(actual, expected, [message])
*
* Asserts strict equality (`===`) of `actual` and `expected`.
*
* assert.strictEqual(true, true, 'these booleans are strictly equal');
*
* @name strictEqual
* @param {Mixed} actual
* @param {Mixed} expected
* @param {String} message
* @api public
*/
assert.strictEqual = function (act, exp, msg) {
new Assertion(act, msg).to.equal(exp);
};
2012-03-14 21:01:37 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .notStrictEqual(actual, expected, [message])
*
* Asserts strict inequality (`!==`) of `actual` and `expected`.
*
* assert.notStrictEqual(3, '3', 'no coercion for strict equality');
*
* @name notStrictEqual
* @param {Mixed} actual
* @param {Mixed} expected
* @param {String} message
* @api public
*/
assert.notStrictEqual = function (act, exp, msg) {
new Assertion(act, msg).to.not.equal(exp);
};
2011-12-07 06:10:58 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .deepEqual(actual, expected, [message])
*
* Asserts that `actual` is deeply equal to `expected`.
*
* assert.deepEqual({ tea: 'green' }, { tea: 'green' });
*
* @name deepEqual
* @param {Mixed} actual
* @param {Mixed} expected
* @param {String} message
* @api public
*/
assert.deepEqual = function (act, exp, msg) {
new Assertion(act, msg).to.eql(exp);
};
2012-04-11 17:31:26 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .notDeepEqual(actual, expected, [message])
*
* Assert that `actual` is not deeply equal to `expected`.
*
* assert.notDeepEqual({ tea: 'green' }, { tea: 'jasmine' });
*
* @name notDeepEqual
* @param {Mixed} actual
* @param {Mixed} expected
* @param {String} message
* @api public
*/
assert.notDeepEqual = function (act, exp, msg) {
new Assertion(act, msg).to.not.eql(exp);
};
2011-12-07 06:10:58 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .isTrue(value, [message])
*
* Asserts that `value` is true.
*
* var teaServed = true;
* assert.isTrue(teaServed, 'the tea has been served');
*
* @name isTrue
* @param {Mixed} value
* @param {String} message
* @api public
*/
2015-02-09 18:43:58 +00:00
assert.isAbove = function (val, abv, msg) {
new Assertion(val, msg).to.be.above(abv);
};
/**
* ### .isAbove(valueToCheck, valueToBeAbove, [message])
*
* Asserts `valueToCheck` is strictly greater than (>) `valueToBeAbove`
*
* assert.isAbove(5, 2, '5 is strictly greater than 2');
*
* @name isAbove
* @param {Mixed} valueToCheck
* @param {Mixed} valueToBeAbove
* @param {String} message
* @api public
*/
assert.isBelow = function (val, blw, msg) {
new Assertion(val, msg).to.be.below(blw);
};
/**
* ### .isBelow(valueToCheck, valueToBeBelow, [message])
*
* Asserts `valueToCheck` is strictly less than (<) `valueToBeBelow`
*
* assert.isBelow(3, 6, '3 is strictly less than 6');
*
* @name isBelow
* @param {Mixed} valueToCheck
* @param {Mixed} valueToBeBelow
* @param {String} message
* @api public
*/
2013-04-29 22:15:27 +00:00
assert.isTrue = function (val, msg) {
new Assertion(val, msg).is['true'];
};
2012-04-11 17:31:26 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .isFalse(value, [message])
*
* Asserts that `value` is false.
*
* var teaServed = false;
* assert.isFalse(teaServed, 'no tea yet? hmm...');
*
* @name isFalse
* @param {Mixed} value
* @param {String} message
* @api public
*/
assert.isFalse = function (val, msg) {
new Assertion(val, msg).is['false'];
};
2011-12-07 06:10:58 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .isNull(value, [message])
*
* Asserts that `value` is null.
*
* assert.isNull(err, 'there was no error');
*
* @name isNull
* @param {Mixed} value
* @param {String} message
* @api public
*/
assert.isNull = function (val, msg) {
new Assertion(val, msg).to.equal(null);
};
2012-04-11 17:31:26 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .isNotNull(value, [message])
*
* Asserts that `value` is not null.
*
* var tea = 'tasty chai';
* assert.isNotNull(tea, 'great, time for tea!');
*
* @name isNotNull
* @param {Mixed} value
* @param {String} message
* @api public
*/
assert.isNotNull = function (val, msg) {
new Assertion(val, msg).to.not.equal(null);
};
2013-04-29 22:15:27 +00:00
/**
* ### .isUndefined(value, [message])
*
* Asserts that `value` is `undefined`.
*
* var tea;
* assert.isUndefined(tea, 'no tea defined');
*
* @name isUndefined
* @param {Mixed} value
* @param {String} message
* @api public
*/
assert.isUndefined = function (val, msg) {
new Assertion(val, msg).to.equal(undefined);
};
2011-12-07 06:10:58 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .isDefined(value, [message])
*
* Asserts that `value` is not `undefined`.
*
* var tea = 'cup of chai';
* assert.isDefined(tea, 'tea has been defined');
*
* @name isDefined
2013-04-29 22:15:27 +00:00
* @param {Mixed} value
* @param {String} message
* @api public
*/
assert.isDefined = function (val, msg) {
new Assertion(val, msg).to.not.equal(undefined);
};
2012-04-11 17:31:26 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .isFunction(value, [message])
*
* Asserts that `value` is a function.
*
* function serveTea() { return 'cup of tea'; };
* assert.isFunction(serveTea, 'great, we can have tea now');
*
* @name isFunction
* @param {Mixed} value
* @param {String} message
* @api public
*/
assert.isFunction = function (val, msg) {
new Assertion(val, msg).to.be.a('function');
};
2011-12-07 06:10:58 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .isNotFunction(value, [message])
*
* Asserts that `value` is _not_ a function.
*
* var serveTea = [ 'heat', 'pour', 'sip' ];
* assert.isNotFunction(serveTea, 'great, we have listed the steps');
*
* @name isNotFunction
* @param {Mixed} value
* @param {String} message
* @api public
*/
assert.isNotFunction = function (val, msg) {
new Assertion(val, msg).to.not.be.a('function');
};
2012-04-11 17:31:26 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .isObject(value, [message])
*
* Asserts that `value` is an object (as revealed by
* `Object.prototype.toString`).
*
* var selection = { name: 'Chai', serve: 'with spices' };
* assert.isObject(selection, 'tea selection is an object');
*
* @name isObject
* @param {Mixed} value
* @param {String} message
* @api public
*/
assert.isObject = function (val, msg) {
new Assertion(val, msg).to.be.a('object');
};
2011-12-07 06:10:58 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .isNotObject(value, [message])
*
* Asserts that `value` is _not_ an object.
*
* var selection = 'chai'
2014-03-19 16:22:08 +00:00
* assert.isNotObject(selection, 'tea selection is not an object');
* assert.isNotObject(null, 'null is not an object');
2013-04-29 22:15:27 +00:00
*
* @name isNotObject
* @param {Mixed} value
* @param {String} message
* @api public
*/
assert.isNotObject = function (val, msg) {
new Assertion(val, msg).to.not.be.a('object');
};
2012-04-11 17:31:26 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .isArray(value, [message])
*
* Asserts that `value` is an array.
*
* var menu = [ 'green', 'chai', 'oolong' ];
* assert.isArray(menu, 'what kind of tea do we want?');
*
* @name isArray
* @param {Mixed} value
* @param {String} message
* @api public
*/
assert.isArray = function (val, msg) {
new Assertion(val, msg).to.be.an('array');
};
2011-12-07 06:10:58 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .isNotArray(value, [message])
*
* Asserts that `value` is _not_ an array.
*
* var menu = 'green|chai|oolong';
* assert.isNotArray(menu, 'what kind of tea do we want?');
*
* @name isNotArray
* @param {Mixed} value
* @param {String} message
* @api public
*/
assert.isNotArray = function (val, msg) {
new Assertion(val, msg).to.not.be.an('array');
};
2013-02-03 23:03:50 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .isString(value, [message])
*
* Asserts that `value` is a string.
*
* var teaOrder = 'chai';
* assert.isString(teaOrder, 'order placed');
*
* @name isString
* @param {Mixed} value
* @param {String} message
* @api public
*/
assert.isString = function (val, msg) {
new Assertion(val, msg).to.be.a('string');
};
2012-04-11 17:31:26 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .isNotString(value, [message])
*
* Asserts that `value` is _not_ a string.
*
* var teaOrder = 4;
* assert.isNotString(teaOrder, 'order placed');
*
* @name isNotString
* @param {Mixed} value
* @param {String} message
* @api public
*/
assert.isNotString = function (val, msg) {
new Assertion(val, msg).to.not.be.a('string');
};
2011-12-07 06:10:58 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .isNumber(value, [message])
*
* Asserts that `value` is a number.
*
* var cups = 2;
* assert.isNumber(cups, 'how many cups');
*
* @name isNumber
* @param {Number} value
* @param {String} message
* @api public
*/
assert.isNumber = function (val, msg) {
new Assertion(val, msg).to.be.a('number');
};
2011-12-07 06:10:58 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .isNotNumber(value, [message])
*
* Asserts that `value` is _not_ a number.
*
* var cups = '2 cups please';
* assert.isNotNumber(cups, 'how many cups');
*
* @name isNotNumber
* @param {Mixed} value
* @param {String} message
* @api public
*/
assert.isNotNumber = function (val, msg) {
new Assertion(val, msg).to.not.be.a('number');
};
2012-05-04 21:57:16 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .isBoolean(value, [message])
*
* Asserts that `value` is a boolean.
*
* var teaReady = true
* , teaServed = false;
*
* assert.isBoolean(teaReady, 'is the tea ready');
* assert.isBoolean(teaServed, 'has tea been served');
*
* @name isBoolean
* @param {Mixed} value
* @param {String} message
* @api public
*/
assert.isBoolean = function (val, msg) {
new Assertion(val, msg).to.be.a('boolean');
};
2012-05-04 21:57:16 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .isNotBoolean(value, [message])
*
* Asserts that `value` is _not_ a boolean.
*
* var teaReady = 'yep'
* , teaServed = 'nope';
*
* assert.isNotBoolean(teaReady, 'is the tea ready');
* assert.isNotBoolean(teaServed, 'has tea been served');
*
* @name isNotBoolean
* @param {Mixed} value
* @param {String} message
* @api public
*/
assert.isNotBoolean = function (val, msg) {
new Assertion(val, msg).to.not.be.a('boolean');
};
2012-05-04 21:57:16 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .typeOf(value, name, [message])
*
* Asserts that `value`'s type is `name`, as determined by
* `Object.prototype.toString`.
*
* assert.typeOf({ tea: 'chai' }, 'object', 'we have an object');
* assert.typeOf(['chai', 'jasmine'], 'array', 'we have an array');
* assert.typeOf('tea', 'string', 'we have a string');
* assert.typeOf(/tea/, 'regexp', 'we have a regular expression');
* assert.typeOf(null, 'null', 'we have a null');
* assert.typeOf(undefined, 'undefined', 'we have an undefined');
*
* @name typeOf
* @param {Mixed} value
* @param {String} name
* @param {String} message
* @api public
*/
assert.typeOf = function (val, type, msg) {
new Assertion(val, msg).to.be.a(type);
};
2012-05-18 18:24:29 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .notTypeOf(value, name, [message])
*
* Asserts that `value`'s type is _not_ `name`, as determined by
* `Object.prototype.toString`.
*
* assert.notTypeOf('tea', 'number', 'strings are not numbers');
*
* @name notTypeOf
* @param {Mixed} value
* @param {String} typeof name
* @param {String} message
* @api public
*/
assert.notTypeOf = function (val, type, msg) {
new Assertion(val, msg).to.not.be.a(type);
};
2013-04-29 22:15:27 +00:00
/**
* ### .instanceOf(object, constructor, [message])
*
* Asserts that `value` is an instance of `constructor`.
*
* var Tea = function (name) { this.name = name; }
* , chai = new Tea('chai');
*
* assert.instanceOf(chai, Tea, 'chai is an instance of tea');
*
* @name instanceOf
* @param {Object} object
* @param {Constructor} constructor
* @param {String} message
* @api public
*/
assert.instanceOf = function (val, type, msg) {
new Assertion(val, msg).to.be.instanceOf(type);
};
2013-04-29 22:15:27 +00:00
/**
* ### .notInstanceOf(object, constructor, [message])
*
* Asserts `value` is not an instance of `constructor`.
*
* var Tea = function (name) { this.name = name; }
* , chai = new String('chai');
*
* assert.notInstanceOf(chai, Tea, 'chai is not an instance of tea');
*
* @name notInstanceOf
* @param {Object} object
* @param {Constructor} constructor
* @param {String} message
* @api public
*/
assert.notInstanceOf = function (val, type, msg) {
new Assertion(val, msg).to.not.be.instanceOf(type);
};
2013-04-29 22:15:27 +00:00
/**
* ### .include(haystack, needle, [message])
*
* Asserts that `haystack` includes `needle`. Works
* for strings and arrays.
*
* assert.include('foobar', 'bar', 'foobar contains string "bar"');
* assert.include([ 1, 2, 3 ], 3, 'array contains value');
*
* @name include
* @param {Array|String} haystack
* @param {Mixed} needle
* @param {String} message
* @api public
*/
assert.include = function (exp, inc, msg) {
2014-03-19 16:22:08 +00:00
new Assertion(exp, msg, assert.include).include(inc);
2013-04-29 23:37:31 +00:00
};
/**
* ### .notInclude(haystack, needle, [message])
*
* Asserts that `haystack` does not include `needle`. Works
* for strings and arrays.
2015-06-03 23:19:52 +00:00
*
2013-04-29 23:37:31 +00:00
* assert.notInclude('foobar', 'baz', 'string not include substring');
* assert.notInclude([ 1, 2, 3 ], 4, 'array not include contain value');
*
* @name notInclude
* @param {Array|String} haystack
* @param {Mixed} needle
* @param {String} message
* @api public
*/
assert.notInclude = function (exp, inc, msg) {
2014-03-19 16:22:08 +00:00
new Assertion(exp, msg, assert.notInclude).not.include(inc);
2013-04-29 22:15:27 +00:00
};
2013-04-29 22:15:27 +00:00
/**
* ### .match(value, regexp, [message])
*
* Asserts that `value` matches the regular expression `regexp`.
*
* assert.match('foobar', /^foo/, 'regexp matches');
*
* @name match
* @param {Mixed} value
* @param {RegExp} regexp
* @param {String} message
* @api public
*/
assert.match = function (exp, re, msg) {
new Assertion(exp, msg).to.match(re);
};
2013-04-29 22:15:27 +00:00
/**
* ### .notMatch(value, regexp, [message])
*
* Asserts that `value` does not match the regular expression `regexp`.
*
* assert.notMatch('foobar', /^foo/, 'regexp does not match');
*
* @name notMatch
* @param {Mixed} value
* @param {RegExp} regexp
* @param {String} message
* @api public
*/
assert.notMatch = function (exp, re, msg) {
new Assertion(exp, msg).to.not.match(re);
};
2012-05-18 18:24:29 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .property(object, property, [message])
*
* Asserts that `object` has a property named by `property`.
*
* assert.property({ tea: { green: 'matcha' }}, 'tea');
*
* @name property
* @param {Object} object
* @param {String} property
* @param {String} message
* @api public
*/
assert.property = function (obj, prop, msg) {
new Assertion(obj, msg).to.have.property(prop);
};
2012-05-04 21:57:16 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .notProperty(object, property, [message])
*
* Asserts that `object` does _not_ have a property named by `property`.
*
* assert.notProperty({ tea: { green: 'matcha' }}, 'coffee');
*
* @name notProperty
* @param {Object} object
* @param {String} property
* @param {String} message
* @api public
*/
assert.notProperty = function (obj, prop, msg) {
new Assertion(obj, msg).to.not.have.property(prop);
};
2012-05-04 21:57:16 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .deepProperty(object, property, [message])
*
* Asserts that `object` has a property named by `property`, which can be a
* string using dot- and bracket-notation for deep reference.
*
* assert.deepProperty({ tea: { green: 'matcha' }}, 'tea.green');
*
* @name deepProperty
* @param {Object} object
* @param {String} property
* @param {String} message
* @api public
*/
assert.deepProperty = function (obj, prop, msg) {
new Assertion(obj, msg).to.have.deep.property(prop);
};
2012-05-18 18:24:29 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .notDeepProperty(object, property, [message])
*
* Asserts that `object` does _not_ have a property named by `property`, which
* can be a string using dot- and bracket-notation for deep reference.
*
* assert.notDeepProperty({ tea: { green: 'matcha' }}, 'tea.oolong');
*
* @name notDeepProperty
* @param {Object} object
* @param {String} property
* @param {String} message
* @api public
*/
assert.notDeepProperty = function (obj, prop, msg) {
new Assertion(obj, msg).to.not.have.deep.property(prop);
};
2012-05-18 18:24:29 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .propertyVal(object, property, value, [message])
*
* Asserts that `object` has a property named by `property` with value given
* by `value`.
*
* assert.propertyVal({ tea: 'is good' }, 'tea', 'is good');
*
* @name propertyVal
* @param {Object} object
* @param {String} property
* @param {Mixed} value
* @param {String} message
* @api public
*/
assert.propertyVal = function (obj, prop, val, msg) {
new Assertion(obj, msg).to.have.property(prop, val);
};
2011-12-07 06:10:58 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .propertyNotVal(object, property, value, [message])
*
* Asserts that `object` has a property named by `property`, but with a value
* different from that given by `value`.
*
* assert.propertyNotVal({ tea: 'is good' }, 'tea', 'is bad');
*
* @name propertyNotVal
* @param {Object} object
* @param {String} property
* @param {Mixed} value
* @param {String} message
* @api public
*/
assert.propertyNotVal = function (obj, prop, val, msg) {
new Assertion(obj, msg).to.not.have.property(prop, val);
};
2013-04-29 22:15:27 +00:00
/**
* ### .deepPropertyVal(object, property, value, [message])
*
* Asserts that `object` has a property named by `property` with value given
* by `value`. `property` can use dot- and bracket-notation for deep
* reference.
*
* assert.deepPropertyVal({ tea: { green: 'matcha' }}, 'tea.green', 'matcha');
*
* @name deepPropertyVal
* @param {Object} object
* @param {String} property
* @param {Mixed} value
* @param {String} message
* @api public
*/
assert.deepPropertyVal = function (obj, prop, val, msg) {
new Assertion(obj, msg).to.have.deep.property(prop, val);
};
2013-04-29 22:15:27 +00:00
/**
* ### .deepPropertyNotVal(object, property, value, [message])
*
* Asserts that `object` has a property named by `property`, but with a value
* different from that given by `value`. `property` can use dot- and
* bracket-notation for deep reference.
*
* assert.deepPropertyNotVal({ tea: { green: 'matcha' }}, 'tea.green', 'konacha');
*
* @name deepPropertyNotVal
* @param {Object} object
* @param {String} property
* @param {Mixed} value
* @param {String} message
* @api public
*/
assert.deepPropertyNotVal = function (obj, prop, val, msg) {
new Assertion(obj, msg).to.not.have.deep.property(prop, val);
};
2013-04-29 22:15:27 +00:00
/**
* ### .lengthOf(object, length, [message])
*
* Asserts that `object` has a `length` property with the expected value.
*
* assert.lengthOf([1,2,3], 3, 'array has length of 3');
* assert.lengthOf('foobar', 5, 'string has length of 6');
*
* @name lengthOf
* @param {Mixed} object
* @param {Number} length
* @param {String} message
* @api public
*/
assert.lengthOf = function (exp, len, msg) {
new Assertion(exp, msg).to.have.length(len);
};
2013-04-29 22:15:27 +00:00
/**
* ### .throws(function, [constructor/string/regexp], [string/regexp], [message])
*
* Asserts that `function` will throw an error that is an instance of
* `constructor`, or alternately that it will throw an error with message
* matching `regexp`.
*
* assert.throw(fn, 'function throws a reference error');
* assert.throw(fn, /function throws a reference error/);
* assert.throw(fn, ReferenceError);
* assert.throw(fn, ReferenceError, 'function throws a reference error');
* assert.throw(fn, ReferenceError, /function throws a reference error/);
*
* @name throws
* @alias throw
* @alias Throw
* @param {Function} function
* @param {ErrorConstructor} constructor
* @param {RegExp} regexp
* @param {String} message
* @see https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error#Error_types
* @api public
*/
assert.Throw = function (fn, errt, errs, msg) {
if ('string' === typeof errt || errt instanceof RegExp) {
errs = errt;
errt = null;
}
2012-03-02 13:49:25 +00:00
2014-01-29 23:38:57 +00:00
var assertErr = new Assertion(fn, msg).to.Throw(errt, errs);
return flag(assertErr, 'object');
2013-04-29 22:15:27 +00:00
};
2012-01-02 06:12:52 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .doesNotThrow(function, [constructor/regexp], [message])
*
* Asserts that `function` will _not_ throw an error that is an instance of
* `constructor`, or alternately that it will not throw an error with message
* matching `regexp`.
*
* assert.doesNotThrow(fn, Error, 'function does not throw');
*
* @name doesNotThrow
* @param {Function} function
* @param {ErrorConstructor} constructor
* @param {RegExp} regexp
* @param {String} message
* @see https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error#Error_types
* @api public
*/
assert.doesNotThrow = function (fn, type, msg) {
if ('string' === typeof type) {
msg = type;
type = null;
}
2013-04-29 22:15:27 +00:00
new Assertion(fn, msg).to.not.Throw(type);
};
2011-12-15 12:07:27 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .operator(val1, operator, val2, [message])
*
* Compares two values using `operator`.
*
* assert.operator(1, '<', 2, 'everything is ok');
* assert.operator(1, '>', 2, 'this will fail');
*
* @name operator
* @param {Mixed} val1
* @param {String} operator
* @param {Mixed} val2
* @param {String} message
* @api public
*/
assert.operator = function (val, operator, val2, msg) {
2015-03-26 18:03:02 +00:00
var ok;
switch(operator) {
case '==':
ok = val == val2;
break;
case '===':
ok = val === val2;
break;
case '>':
ok = val > val2;
break;
case '>=':
ok = val >= val2;
break;
case '<':
ok = val < val2;
break;
case '<=':
ok = val <= val2;
break;
case '!=':
ok = val != val2;
break;
case '!==':
ok = val !== val2;
break;
default:
throw new Error('Invalid operator "' + operator + '"');
2013-04-29 22:15:27 +00:00
}
2015-03-26 18:03:02 +00:00
var test = new Assertion(ok, msg);
2013-04-29 22:15:27 +00:00
test.assert(
true === flag(test, 'object')
, 'expected ' + util.inspect(val) + ' to be ' + operator + ' ' + util.inspect(val2)
, 'expected ' + util.inspect(val) + ' to not be ' + operator + ' ' + util.inspect(val2) );
};
2011-12-15 13:02:26 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .closeTo(actual, expected, delta, [message])
*
* Asserts that the target is equal `expected`, to within a +/- `delta` range.
*
* assert.closeTo(1.5, 1, 0.5, 'numbers are close');
*
* @name closeTo
* @param {Number} actual
* @param {Number} expected
* @param {Number} delta
* @param {String} message
* @api public
*/
assert.closeTo = function (act, exp, delta, msg) {
new Assertion(act, msg).to.be.closeTo(exp, delta);
};
2011-12-15 13:02:26 +00:00
2013-04-30 00:15:39 +00:00
/**
* ### .sameMembers(set1, set2, [message])
*
* Asserts that `set1` and `set2` have the same members.
* Order is not taken into account.
*
* assert.sameMembers([ 1, 2, 3 ], [ 2, 1, 3 ], 'same members');
*
* @name sameMembers
2014-09-29 23:24:59 +00:00
* @param {Array} set1
* @param {Array} set2
2013-04-30 00:15:39 +00:00
* @param {String} message
* @api public
*/
2011-12-15 13:02:26 +00:00
2013-04-29 22:15:27 +00:00
assert.sameMembers = function (set1, set2, msg) {
new Assertion(set1, msg).to.have.same.members(set2);
}
2011-12-15 13:02:26 +00:00
2015-02-09 18:43:58 +00:00
/**
* ### .sameDeepMembers(set1, set2, [message])
*
* Asserts that `set1` and `set2` have the same members - using a deep equality checking.
* Order is not taken into account.
*
* assert.sameDeepMembers([ {b: 3}, {a: 2}, {c: 5} ], [ {c: 5}, {b: 3}, {a: 2} ], 'same deep members');
*
* @name sameDeepMembers
* @param {Array} set1
* @param {Array} set2
* @param {String} message
* @api public
*/
assert.sameDeepMembers = function (set1, set2, msg) {
new Assertion(set1, msg).to.have.same.deep.members(set2);
}
2013-04-30 00:15:39 +00:00
/**
* ### .includeMembers(superset, subset, [message])
*
* Asserts that `subset` is included in `superset`.
* Order is not taken into account.
*
* assert.includeMembers([ 1, 2, 3 ], [ 2, 1 ], 'include members');
*
* @name includeMembers
* @param {Array} superset
* @param {Array} subset
* @param {String} message
* @api public
*/
assert.includeMembers = function (superset, subset, msg) {
new Assertion(superset, msg).to.include.members(subset);
}
2015-02-09 18:43:58 +00:00
/**
* ### .changes(function, object, property)
*
* Asserts that a function changes the value of a property
*
* var obj = { val: 10 };
* var fn = function() { obj.val = 22 };
* assert.changes(fn, obj, 'val');
*
* @name changes
* @param {Function} modifier function
* @param {Object} object
* @param {String} property name
* @param {String} message _optional_
* @api public
*/
assert.changes = function (fn, obj, prop) {
new Assertion(fn).to.change(obj, prop);
}
/**
* ### .doesNotChange(function, object, property)
*
* Asserts that a function does not changes the value of a property
*
* var obj = { val: 10 };
* var fn = function() { console.log('foo'); };
* assert.doesNotChange(fn, obj, 'val');
*
* @name doesNotChange
* @param {Function} modifier function
* @param {Object} object
* @param {String} property name
* @param {String} message _optional_
* @api public
*/
assert.doesNotChange = function (fn, obj, prop) {
new Assertion(fn).to.not.change(obj, prop);
}
/**
* ### .increases(function, object, property)
*
* Asserts that a function increases an object property
*
* var obj = { val: 10 };
* var fn = function() { obj.val = 13 };
* assert.increases(fn, obj, 'val');
*
* @name increases
* @param {Function} modifier function
* @param {Object} object
* @param {String} property name
* @param {String} message _optional_
* @api public
*/
assert.increases = function (fn, obj, prop) {
new Assertion(fn).to.increase(obj, prop);
}
/**
* ### .doesNotIncrease(function, object, property)
*
* Asserts that a function does not increase object property
*
* var obj = { val: 10 };
* var fn = function() { obj.val = 8 };
* assert.doesNotIncrease(fn, obj, 'val');
*
* @name doesNotIncrease
* @param {Function} modifier function
* @param {Object} object
* @param {String} property name
* @param {String} message _optional_
* @api public
*/
assert.doesNotIncrease = function (fn, obj, prop) {
new Assertion(fn).to.not.increase(obj, prop);
}
/**
* ### .decreases(function, object, property)
*
* Asserts that a function decreases an object property
*
* var obj = { val: 10 };
* var fn = function() { obj.val = 5 };
* assert.decreases(fn, obj, 'val');
*
* @name decreases
* @param {Function} modifier function
* @param {Object} object
* @param {String} property name
* @param {String} message _optional_
* @api public
*/
assert.decreases = function (fn, obj, prop) {
new Assertion(fn).to.decrease(obj, prop);
}
/**
* ### .doesNotDecrease(function, object, property)
*
* Asserts that a function does not decreases an object property
*
* var obj = { val: 10 };
* var fn = function() { obj.val = 15 };
* assert.doesNotDecrease(fn, obj, 'val');
*
* @name doesNotDecrease
* @param {Function} modifier function
* @param {Object} object
* @param {String} property name
* @param {String} message _optional_
* @api public
*/
assert.doesNotDecrease = function (fn, obj, prop) {
new Assertion(fn).to.not.decrease(obj, prop);
}
2013-04-29 22:15:27 +00:00
/*!
2015-06-03 23:19:52 +00:00
* ### .ifError(object)
*
* Asserts if value is not a false value, and throws if it is a true value.
* This is added to allow for chai to be a drop-in replacement for Node's
* assert class.
*
* var err = new Error('I am a custom error');
* assert.ifError(err); // Rethrows err!
*
* @name ifError
* @param {Object} object
* @api public
2013-04-29 22:15:27 +00:00
*/
2011-12-18 12:02:18 +00:00
2015-06-03 23:19:52 +00:00
assert.ifError = function (val) {
if (val) {
throw(val);
}
2013-04-29 22:15:27 +00:00
};
2012-07-01 02:55:04 +00:00
2013-04-29 22:15:27 +00:00
/*!
* Aliases.
*/
(function alias(name, as){
assert[as] = assert[name];
return alias;
})
('Throw', 'throw')
('Throw', 'throws');
};
},{}],6:[function(require,module,exports){
2013-04-29 22:15:27 +00:00
/*!
* chai
2014-01-29 23:38:57 +00:00
* Copyright(c) 2011-2014 Jake Luer <jake@alogicalparadox.com>
2013-04-29 22:15:27 +00:00
* MIT Licensed
*/
module.exports = function (chai, util) {
chai.expect = function (val, message) {
return new chai.Assertion(val, message);
};
2015-02-23 21:03:27 +00:00
/**
* ### .fail(actual, expected, [message], [operator])
*
* Throw a failure.
*
* @name fail
* @param {Mixed} actual
* @param {Mixed} expected
* @param {String} message
* @param {String} operator
* @api public
*/
chai.expect.fail = function (actual, expected, message, operator) {
message = message || 'expect.fail()';
throw new chai.AssertionError(message, {
actual: actual
, expected: expected
, operator: operator
}, chai.expect.fail);
};
};
2013-04-29 22:15:27 +00:00
},{}],7:[function(require,module,exports){
2013-04-29 22:15:27 +00:00
/*!
* chai
2014-01-29 23:38:57 +00:00
* Copyright(c) 2011-2014 Jake Luer <jake@alogicalparadox.com>
2013-04-29 22:15:27 +00:00
* MIT Licensed
*/
module.exports = function (chai, util) {
var Assertion = chai.Assertion;
function loadShould () {
2014-03-19 16:22:08 +00:00
// explicitly define this method as function as to have it's name to include as `ssfi`
function shouldGetter() {
2015-03-04 20:19:52 +00:00
if (this instanceof String || this instanceof Number || this instanceof Boolean ) {
return new Assertion(this.valueOf(), null, shouldGetter);
2014-03-19 16:22:08 +00:00
}
return new Assertion(this, null, shouldGetter);
}
function shouldSetter(value) {
// See https://github.com/chaijs/chai/issues/86: this makes
// `whatever.should = someValue` actually set `someValue`, which is
// especially useful for `global.should = require('chai').should()`.
//
// Note that we have to use [[DefineProperty]] instead of [[Put]]
// since otherwise we would trigger this very setter!
Object.defineProperty(this, 'should', {
value: value,
enumerable: true,
configurable: true,
writable: true
});
}
2013-04-29 22:15:27 +00:00
// modify Object.prototype to have `should`
2014-03-19 16:22:08 +00:00
Object.defineProperty(Object.prototype, 'should', {
set: shouldSetter
, get: shouldGetter
2013-04-29 22:15:27 +00:00
, configurable: true
});
2012-01-02 05:50:47 +00:00
2013-04-29 22:15:27 +00:00
var should = {};
2011-12-18 12:02:18 +00:00
2015-02-23 21:03:27 +00:00
/**
* ### .fail(actual, expected, [message], [operator])
*
* Throw a failure.
*
* @name fail
* @param {Mixed} actual
* @param {Mixed} expected
* @param {String} message
* @param {String} operator
* @api public
*/
should.fail = function (actual, expected, message, operator) {
message = message || 'should.fail()';
throw new chai.AssertionError(message, {
actual: actual
, expected: expected
, operator: operator
}, should.fail);
};
2013-04-29 22:15:27 +00:00
should.equal = function (val1, val2, msg) {
new Assertion(val1, msg).to.equal(val2);
2012-07-01 02:55:04 +00:00
};
2011-12-18 12:02:18 +00:00
2013-04-29 22:15:27 +00:00
should.Throw = function (fn, errt, errs, msg) {
new Assertion(fn, msg).to.Throw(errt, errs);
};
2013-02-03 17:59:23 +00:00
2013-04-29 22:15:27 +00:00
should.exist = function (val, msg) {
new Assertion(val, msg).to.exist;
2012-07-01 02:55:04 +00:00
}
2012-04-22 19:27:03 +00:00
2013-04-29 22:15:27 +00:00
// negation
should.not = {}
2011-12-14 20:58:24 +00:00
2013-04-29 22:15:27 +00:00
should.not.equal = function (val1, val2, msg) {
new Assertion(val1, msg).to.not.equal(val2);
};
2011-12-14 20:58:24 +00:00
2013-04-29 22:15:27 +00:00
should.not.Throw = function (fn, errt, errs, msg) {
new Assertion(fn, msg).to.not.Throw(errt, errs);
};
2011-12-14 20:58:24 +00:00
2013-04-29 22:15:27 +00:00
should.not.exist = function (val, msg) {
new Assertion(val, msg).to.not.exist;
2011-12-14 20:58:24 +00:00
}
2013-04-29 22:15:27 +00:00
should['throw'] = should['Throw'];
should.not['throw'] = should.not['Throw'];
2012-07-01 02:55:04 +00:00
2013-04-29 22:15:27 +00:00
return should;
};
2012-11-29 08:20:08 +00:00
2013-04-29 22:15:27 +00:00
chai.should = loadShould;
chai.Should = loadShould;
};
},{}],8:[function(require,module,exports){
2013-04-29 22:15:27 +00:00
/*!
* Chai - addChainingMethod utility
2014-01-29 23:38:57 +00:00
* Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
2013-04-29 22:15:27 +00:00
* MIT Licensed
*/
/*!
* Module dependencies
*/
var transferFlags = require('./transferFlags');
var flag = require('./flag');
var config = require('../config');
2013-04-29 22:15:27 +00:00
/*!
* Module variables
*/
// Check whether `__proto__` is supported
var hasProtoSupport = '__proto__' in Object;
// Without `__proto__` support, this module will need to add properties to a function.
// However, some Function.prototype methods cannot be overwritten,
// and there seems no easy cross-platform way to detect them (@see chaijs/chai/issues/69).
var excludeNames = /^(?:length|name|arguments|caller)$/;
// Cache `Function` properties
var call = Function.prototype.call,
apply = Function.prototype.apply;
/**
* ### addChainableMethod (ctx, name, method, chainingBehavior)
*
* Adds a method to an object, such that the method can also be chained.
*
* utils.addChainableMethod(chai.Assertion.prototype, 'foo', function (str) {
* var obj = utils.flag(this, 'object');
* new chai.Assertion(obj).to.be.equal(str);
* });
*
* Can also be accessed directly from `chai.Assertion`.
*
* chai.Assertion.addChainableMethod('foo', fn, chainingBehavior);
*
* The result can then be used as both a method assertion, executing both `method` and
* `chainingBehavior`, or as a language chain, which only executes `chainingBehavior`.
*
* expect(fooStr).to.be.foo('bar');
* expect(fooStr).to.be.foo.equal('foo');
*
* @param {Object} ctx object to which the method is added
* @param {String} name of method to add
* @param {Function} method function to be used for `name`, when called
* @param {Function} chainingBehavior function to be called every time the property is accessed
* @name addChainableMethod
* @api public
*/
module.exports = function (ctx, name, method, chainingBehavior) {
2014-01-29 23:38:57 +00:00
if (typeof chainingBehavior !== 'function') {
2013-04-29 22:15:27 +00:00
chainingBehavior = function () { };
2014-01-29 23:38:57 +00:00
}
var chainableBehavior = {
method: method
, chainingBehavior: chainingBehavior
};
// save the methods so we can overwrite them later, if we need to.
if (!ctx.__methods) {
ctx.__methods = {};
}
ctx.__methods[name] = chainableBehavior;
2013-04-29 22:15:27 +00:00
Object.defineProperty(ctx, name,
{ get: function () {
2014-01-29 23:38:57 +00:00
chainableBehavior.chainingBehavior.call(this);
2013-04-29 22:15:27 +00:00
2014-03-19 16:22:08 +00:00
var assert = function assert() {
var old_ssfi = flag(this, 'ssfi');
if (old_ssfi && config.includeStack === false)
flag(this, 'ssfi', assert);
2014-01-29 23:38:57 +00:00
var result = chainableBehavior.method.apply(this, arguments);
2013-04-29 22:15:27 +00:00
return result === undefined ? this : result;
};
2012-11-29 08:20:08 +00:00
2013-04-29 22:15:27 +00:00
// Use `__proto__` if available
if (hasProtoSupport) {
// Inherit all properties from the object by replacing the `Function` prototype
var prototype = assert.__proto__ = Object.create(this);
// Restore the `call` and `apply` methods from `Function`
prototype.call = call;
prototype.apply = apply;
2012-11-29 08:20:08 +00:00
}
2013-04-29 22:15:27 +00:00
// Otherwise, redefine all properties (slow!)
else {
var asserterNames = Object.getOwnPropertyNames(ctx);
asserterNames.forEach(function (asserterName) {
if (!excludeNames.test(asserterName)) {
var pd = Object.getOwnPropertyDescriptor(ctx, asserterName);
Object.defineProperty(assert, asserterName, pd);
}
});
2012-07-01 02:55:04 +00:00
}
2013-04-29 22:15:27 +00:00
transferFlags(this, assert);
return assert;
2012-07-01 02:55:04 +00:00
}
2013-04-29 22:15:27 +00:00
, configurable: true
});
};
},{"../config":3,"./flag":11,"./transferFlags":27}],9:[function(require,module,exports){
2013-04-29 22:15:27 +00:00
/*!
* Chai - addMethod utility
2014-01-29 23:38:57 +00:00
* Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
2013-04-29 22:15:27 +00:00
* MIT Licensed
*/
var config = require('../config');
2014-03-19 16:22:08 +00:00
2013-04-29 22:15:27 +00:00
/**
* ### .addMethod (ctx, name, method)
*
* Adds a method to the prototype of an object.
*
* utils.addMethod(chai.Assertion.prototype, 'foo', function (str) {
* var obj = utils.flag(this, 'object');
* new chai.Assertion(obj).to.be.equal(str);
* });
*
* Can also be accessed directly from `chai.Assertion`.
*
* chai.Assertion.addMethod('foo', fn);
*
* Then can be used as any other assertion.
*
* expect(fooStr).to.be.foo('bar');
*
* @param {Object} ctx object to which the method is added
* @param {String} name of method to add
* @param {Function} method function to be used for name
* @name addMethod
* @api public
*/
var flag = require('./flag');
2013-04-29 22:15:27 +00:00
module.exports = function (ctx, name, method) {
ctx[name] = function () {
2014-03-19 16:22:08 +00:00
var old_ssfi = flag(this, 'ssfi');
if (old_ssfi && config.includeStack === false)
flag(this, 'ssfi', ctx[name]);
2013-04-29 22:15:27 +00:00
var result = method.apply(this, arguments);
return result === undefined ? this : result;
};
};
},{"../config":3,"./flag":11}],10:[function(require,module,exports){
2013-04-29 22:15:27 +00:00
/*!
* Chai - addProperty utility
2014-01-29 23:38:57 +00:00
* Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
2013-04-29 22:15:27 +00:00
* MIT Licensed
*/
/**
* ### addProperty (ctx, name, getter)
*
* Adds a property to the prototype of an object.
*
* utils.addProperty(chai.Assertion.prototype, 'foo', function () {
* var obj = utils.flag(this, 'object');
* new chai.Assertion(obj).to.be.instanceof(Foo);
* });
*
* Can also be accessed directly from `chai.Assertion`.
*
* chai.Assertion.addProperty('foo', fn);
*
* Then can be used as any other assertion.
*
* expect(myFoo).to.be.foo;
*
* @param {Object} ctx object to which the property is added
* @param {String} name of property to add
* @param {Function} getter function to be used for name
* @name addProperty
* @api public
*/
module.exports = function (ctx, name, getter) {
Object.defineProperty(ctx, name,
{ get: function () {
var result = getter.call(this);
return result === undefined ? this : result;
2012-07-01 02:55:04 +00:00
}
2013-04-29 22:15:27 +00:00
, configurable: true
});
};
},{}],11:[function(require,module,exports){
2013-04-29 22:15:27 +00:00
/*!
* Chai - flag utility
2014-01-29 23:38:57 +00:00
* Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
2013-04-29 22:15:27 +00:00
* MIT Licensed
*/
/**
2015-02-09 18:43:58 +00:00
* ### flag(object, key, [value])
2013-04-29 22:15:27 +00:00
*
* Get or set a flag value on an object. If a
* value is provided it will be set, else it will
* return the currently set value or `undefined` if
* the value is not set.
*
* utils.flag(this, 'foo', 'bar'); // setter
* utils.flag(this, 'foo'); // getter, returns `bar`
*
2015-02-09 18:43:58 +00:00
* @param {Object} object constructed Assertion
2013-04-29 22:15:27 +00:00
* @param {String} key
* @param {Mixed} value (optional)
* @name flag
* @api private
*/
module.exports = function (obj, key, value) {
var flags = obj.__flags || (obj.__flags = Object.create(null));
if (arguments.length === 3) {
flags[key] = value;
} else {
return flags[key];
}
};
},{}],12:[function(require,module,exports){
2013-04-29 22:15:27 +00:00
/*!
* Chai - getActual utility
2014-01-29 23:38:57 +00:00
* Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
2013-04-29 22:15:27 +00:00
* MIT Licensed
*/
/**
* # getActual(object, [actual])
*
* Returns the `actual` value for an Assertion
*
* @param {Object} object (constructed Assertion)
* @param {Arguments} chai.Assertion.prototype.assert arguments
*/
module.exports = function (obj, args) {
2014-03-19 16:22:08 +00:00
return args.length > 4 ? args[4] : obj._obj;
2013-04-29 22:15:27 +00:00
};
},{}],13:[function(require,module,exports){
2013-04-29 22:15:27 +00:00
/*!
* Chai - getEnumerableProperties utility
2014-01-29 23:38:57 +00:00
* Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
2013-04-29 22:15:27 +00:00
* MIT Licensed
*/
/**
* ### .getEnumerableProperties(object)
*
* This allows the retrieval of enumerable property names of an object,
* inherited or not.
*
* @param {Object} object
* @returns {Array}
* @name getEnumerableProperties
* @api public
*/
module.exports = function getEnumerableProperties(object) {
var result = [];
for (var name in object) {
result.push(name);
}
return result;
};
},{}],14:[function(require,module,exports){
2013-04-29 22:15:27 +00:00
/*!
* Chai - message composition utility
2014-01-29 23:38:57 +00:00
* Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
2013-04-29 22:15:27 +00:00
* MIT Licensed
*/
/*!
* Module dependancies
*/
var flag = require('./flag')
, getActual = require('./getActual')
, inspect = require('./inspect')
, objDisplay = require('./objDisplay');
2013-04-29 22:15:27 +00:00
/**
* ### .getMessage(object, message, negateMessage)
*
* Construct the error message based on flags
* and template tags. Template tags will return
* a stringified inspection of the object referenced.
*
2013-06-16 14:01:17 +00:00
* Message template tags:
2013-04-29 22:15:27 +00:00
* - `#{this}` current asserted object
* - `#{act}` actual value
* - `#{exp}` expected value
*
* @param {Object} object (constructed Assertion)
* @param {Arguments} chai.Assertion.prototype.assert arguments
* @name getMessage
* @api public
*/
module.exports = function (obj, args) {
var negate = flag(obj, 'negate')
, val = flag(obj, 'object')
, expected = args[3]
, actual = getActual(obj, args)
, msg = negate ? args[2] : args[1]
, flagMsg = flag(obj, 'message');
2014-09-29 23:24:59 +00:00
if(typeof msg === "function") msg = msg();
2013-04-29 22:15:27 +00:00
msg = msg || '';
msg = msg
.replace(/#{this}/g, objDisplay(val))
.replace(/#{act}/g, objDisplay(actual))
.replace(/#{exp}/g, objDisplay(expected));
return flagMsg ? flagMsg + ': ' + msg : msg;
};
},{"./flag":11,"./getActual":12,"./inspect":21,"./objDisplay":22}],15:[function(require,module,exports){
2013-04-29 22:15:27 +00:00
/*!
* Chai - getName utility
2014-01-29 23:38:57 +00:00
* Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
2013-04-29 22:15:27 +00:00
* MIT Licensed
*/
/**
* # getName(func)
*
* Gets the name of a function, in a cross-browser way.
*
* @param {Function} a function (usually a constructor)
*/
module.exports = function (func) {
if (func.name) return func.name;
var match = /^\s?function ([^(]*)\(/.exec(func);
return match && match[1] ? match[1] : "";
};
},{}],16:[function(require,module,exports){
2015-02-09 18:43:58 +00:00
/*!
* Chai - getPathInfo utility
* Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
* MIT Licensed
*/
var hasProperty = require('./hasProperty');
2015-02-09 18:43:58 +00:00
/**
* ### .getPathInfo(path, object)
*
* This allows the retrieval of property info in an
* object given a string path.
*
* The path info consists of an object with the
* following properties:
*
* * parent - The parent object of the property referenced by `path`
* * name - The name of the final property, a number if it was an array indexer
* * value - The value of the property, if it exists, otherwise `undefined`
* * exists - Whether the property exists or not
*
* @param {String} path
* @param {Object} object
* @returns {Object} info
* @name getPathInfo
* @api public
*/
module.exports = function getPathInfo(path, obj) {
var parsed = parsePath(path),
last = parsed[parsed.length - 1];
var info = {
2015-03-04 20:19:52 +00:00
parent: parsed.length > 1 ? _getPathValue(parsed, obj, parsed.length - 1) : obj,
2015-02-09 18:43:58 +00:00
name: last.p || last.i,
2015-06-03 23:19:52 +00:00
value: _getPathValue(parsed, obj)
2015-02-09 18:43:58 +00:00
};
info.exists = hasProperty(info.name, info.parent);
return info;
2013-04-29 22:15:27 +00:00
};
2015-02-09 18:43:58 +00:00
2013-04-29 22:15:27 +00:00
/*!
* ## parsePath(path)
*
* Helper function used to parse string object
* paths. Use in conjunction with `_getPathValue`.
*
* var parsed = parsePath('myobject.property.subprop');
*
* ### Paths:
*
* * Can be as near infinitely deep and nested
* * Arrays are also valid using the formal `myobject.document[3].property`.
2015-03-26 18:03:02 +00:00
* * Literal dots and brackets (not delimiter) must be backslash-escaped.
2013-04-29 22:15:27 +00:00
*
* @param {String} path
* @returns {Object} parsed
* @api private
*/
function parsePath (path) {
2015-03-26 18:03:02 +00:00
var str = path.replace(/([^\\])\[/g, '$1.[')
2013-04-29 22:15:27 +00:00
, parts = str.match(/(\\\.|[^.]+?)+/g);
return parts.map(function (value) {
2015-03-26 18:03:02 +00:00
var re = /^\[(\d+)\]$/
2015-02-09 18:43:58 +00:00
, mArr = re.exec(value);
2013-04-29 22:15:27 +00:00
if (mArr) return { i: parseFloat(mArr[1]) };
2015-03-26 18:03:02 +00:00
else return { p: value.replace(/\\([.\[\]])/g, '$1') };
2013-04-29 22:15:27 +00:00
});
2015-02-09 18:43:58 +00:00
}
2013-04-29 22:15:27 +00:00
/*!
* ## _getPathValue(parsed, obj)
*
* Helper companion function for `.parsePath` that returns
* the value located at the parsed address.
*
* var value = getPathValue(parsed, obj);
*
* @param {Object} parsed definition from `parsePath`.
* @param {Object} object to search against
2015-02-09 18:43:58 +00:00
* @param {Number} object to search against
2013-04-29 22:15:27 +00:00
* @returns {Object|Undefined} value
* @api private
*/
2015-02-09 18:43:58 +00:00
function _getPathValue (parsed, obj, index) {
2013-04-29 22:15:27 +00:00
var tmp = obj
, res;
2015-02-09 18:43:58 +00:00
index = (index === undefined ? parsed.length : index);
for (var i = 0, l = index; i < l; i++) {
var part = parsed[i];
if (tmp) {
if ('undefined' !== typeof part.p)
tmp = tmp[part.p];
else if ('undefined' !== typeof part.i)
tmp = tmp[part.i];
if (i == (l - 1)) res = tmp;
} else {
res = undefined;
}
}
return res;
}
},{"./hasProperty":19}],17:[function(require,module,exports){
/*!
* Chai - getPathValue utility
* Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
* @see https://github.com/logicalparadox/filtr
* MIT Licensed
*/
var getPathInfo = require('./getPathInfo');
/**
* ### .getPathValue(path, object)
*
* This allows the retrieval of values in an
* object given a string path.
*
* var obj = {
* prop1: {
* arr: ['a', 'b', 'c']
* , str: 'Hello'
* }
* , prop2: {
* arr: [ { nested: 'Universe' } ]
* , str: 'Hello again!'
* }
* }
*
* The following would be the results.
*
* getPathValue('prop1.str', obj); // Hello
* getPathValue('prop1.att[2]', obj); // b
* getPathValue('prop2.arr[0].nested', obj); // Universe
*
* @param {String} path
* @param {Object} object
* @returns {Object} value or `undefined`
* @name getPathValue
* @api public
*/
module.exports = function(path, obj) {
var info = getPathInfo(path, obj);
return info.value;
};
},{"./getPathInfo":16}],18:[function(require,module,exports){
/*!
* Chai - getProperties utility
* Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
* MIT Licensed
*/
/**
* ### .getProperties(object)
*
* This allows the retrieval of property names of an object, enumerable or not,
* inherited or not.
*
* @param {Object} object
* @returns {Array}
* @name getProperties
* @api public
*/
module.exports = function getProperties(object) {
var result = Object.getOwnPropertyNames(subject);
2015-02-09 18:43:58 +00:00
function addProperty(property) {
if (result.indexOf(property) === -1) {
result.push(property);
2013-04-29 22:15:27 +00:00
}
}
2015-02-09 18:43:58 +00:00
var proto = Object.getPrototypeOf(subject);
while (proto !== null) {
Object.getOwnPropertyNames(proto).forEach(addProperty);
proto = Object.getPrototypeOf(proto);
}
return result;
};
2015-02-09 18:43:58 +00:00
},{}],19:[function(require,module,exports){
2015-02-09 18:43:58 +00:00
/*!
* Chai - hasProperty utility
* Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
* MIT Licensed
*/
2015-06-03 23:19:52 +00:00
var type = require('type-detect');
2015-02-09 18:43:58 +00:00
/**
* ### .hasProperty(object, name)
*
* This allows checking whether an object has
* named property or numeric array index.
*
* Basically does the same thing as the `in`
* operator but works properly with natives
* and null/undefined values.
*
* var obj = {
* arr: ['a', 'b', 'c']
* , str: 'Hello'
* }
*
* The following would be the results.
*
* hasProperty('str', obj); // true
* hasProperty('constructor', obj); // true
* hasProperty('bar', obj); // false
2015-03-26 18:03:02 +00:00
*
2015-02-09 18:43:58 +00:00
* hasProperty('length', obj.str); // true
* hasProperty(1, obj.str); // true
* hasProperty(5, obj.str); // false
*
* hasProperty('length', obj.arr); // true
* hasProperty(2, obj.arr); // true
* hasProperty(3, obj.arr); // false
*
* @param {Objuect} object
* @param {String|Number} name
* @returns {Boolean} whether it exists
* @name getPathInfo
* @api public
*/
var literals = {
'number': Number
, 'string': String
};
module.exports = function hasProperty(name, obj) {
var ot = type(obj);
// Bad Object, obviously no props at all
if(ot === 'null' || ot === 'undefined')
return false;
// The `in` operator does not work with certain literals
// box these before the check
if(literals[ot] && typeof obj !== 'object')
obj = new literals[ot](obj);
return name in obj;
2013-04-29 22:15:27 +00:00
};
2015-06-03 23:19:52 +00:00
},{"type-detect":33}],20:[function(require,module,exports){
2013-04-29 22:15:27 +00:00
/*!
* chai
* Copyright(c) 2011 Jake Luer <jake@alogicalparadox.com>
* MIT Licensed
*/
2012-04-11 17:31:26 +00:00
2013-04-29 22:15:27 +00:00
/*!
* Main exports
*/
2012-04-11 17:31:26 +00:00
2013-04-29 22:15:27 +00:00
var exports = module.exports = {};
2012-05-22 18:51:09 +00:00
2013-04-29 22:15:27 +00:00
/*!
* test utility
*/
2012-05-22 18:51:09 +00:00
exports.test = require('./test');
2013-02-03 20:14:49 +00:00
2013-04-29 22:15:27 +00:00
/*!
* type utility
*/
2013-02-03 20:14:49 +00:00
2015-06-03 23:19:52 +00:00
exports.type = require('type-detect');
2012-03-18 21:42:08 +00:00
2013-04-29 22:15:27 +00:00
/*!
* message utility
*/
2012-03-18 21:42:08 +00:00
exports.getMessage = require('./getMessage');
2012-04-11 17:31:26 +00:00
2013-04-29 22:15:27 +00:00
/*!
* actual utility
*/
2012-04-11 17:31:26 +00:00
exports.getActual = require('./getActual');
2012-04-22 19:27:03 +00:00
2013-04-29 22:15:27 +00:00
/*!
* Inspect util
*/
2012-04-22 19:27:03 +00:00
exports.inspect = require('./inspect');
2012-08-07 04:59:00 +00:00
2013-04-29 22:15:27 +00:00
/*!
* Object Display util
*/
2012-08-07 04:59:00 +00:00
exports.objDisplay = require('./objDisplay');
2012-04-22 19:27:03 +00:00
2013-04-29 22:15:27 +00:00
/*!
* Flag utility
*/
2012-04-22 19:27:03 +00:00
exports.flag = require('./flag');
2012-04-22 19:27:03 +00:00
2013-04-29 22:15:27 +00:00
/*!
* Flag transferring utility
*/
2012-04-22 19:27:03 +00:00
exports.transferFlags = require('./transferFlags');
2012-04-22 19:27:03 +00:00
2013-04-29 22:15:27 +00:00
/*!
* Deep equal utility
*/
2012-04-22 19:27:03 +00:00
exports.eql = require('deep-eql');
2012-04-22 19:27:03 +00:00
2013-04-29 22:15:27 +00:00
/*!
* Deep path value
*/
2012-04-11 17:31:26 +00:00
exports.getPathValue = require('./getPathValue');
2015-02-09 18:43:58 +00:00
/*!
* Deep path info
*/
exports.getPathInfo = require('./getPathInfo');
2015-02-09 18:43:58 +00:00
/*!
* Check if a property exists
*/
exports.hasProperty = require('./hasProperty');
2015-02-09 18:43:58 +00:00
2013-04-29 22:15:27 +00:00
/*!
* Function name
*/
exports.getName = require('./getName');
2013-04-29 22:15:27 +00:00
/*!
* add Property
*/
2012-03-18 21:42:08 +00:00
exports.addProperty = require('./addProperty');
2011-12-15 12:07:27 +00:00
2013-04-29 22:15:27 +00:00
/*!
* add Method
*/
2012-04-22 19:27:03 +00:00
exports.addMethod = require('./addMethod');
2011-12-15 12:07:27 +00:00
2013-04-29 22:15:27 +00:00
/*!
* overwrite Property
*/
2011-12-15 12:07:27 +00:00
exports.overwriteProperty = require('./overwriteProperty');
2011-12-15 12:07:27 +00:00
2013-04-29 22:15:27 +00:00
/*!
* overwrite Method
*/
2011-12-15 12:07:27 +00:00
exports.overwriteMethod = require('./overwriteMethod');
2011-12-15 12:07:27 +00:00
2013-04-29 22:15:27 +00:00
/*!
* Add a chainable method
*/
2011-12-15 12:07:27 +00:00
exports.addChainableMethod = require('./addChainableMethod');
2011-12-15 12:07:27 +00:00
2014-01-29 23:38:57 +00:00
/*!
* Overwrite chainable method
*/
exports.overwriteChainableMethod = require('./overwriteChainableMethod');
2011-12-15 12:07:27 +00:00
2014-11-10 14:06:08 +00:00
2015-06-03 23:19:52 +00:00
},{"./addChainableMethod":8,"./addMethod":9,"./addProperty":10,"./flag":11,"./getActual":12,"./getMessage":14,"./getName":15,"./getPathInfo":16,"./getPathValue":17,"./hasProperty":19,"./inspect":21,"./objDisplay":22,"./overwriteChainableMethod":23,"./overwriteMethod":24,"./overwriteProperty":25,"./test":26,"./transferFlags":27,"deep-eql":29,"type-detect":33}],21:[function(require,module,exports){
2013-04-29 22:15:27 +00:00
// This is (almost) directly from Node.js utils
// https://github.com/joyent/node/blob/f8c335d0caf47f16d31413f89aa28eda3878e3aa/lib/util.js
2011-12-15 12:07:27 +00:00
var getName = require('./getName');
var getProperties = require('./getProperties');
var getEnumerableProperties = require('./getEnumerableProperties');
2011-12-15 12:07:27 +00:00
2013-04-29 22:15:27 +00:00
module.exports = inspect;
2011-12-15 12:07:27 +00:00
2013-04-29 22:15:27 +00:00
/**
* Echos the value of a value. Trys to print the value out
* in the best way possible given the different types.
*
* @param {Object} obj The object to print out.
* @param {Boolean} showHidden Flag that shows hidden (not enumerable)
* properties of objects.
* @param {Number} depth Depth in which to descend in object. Default is 2.
* @param {Boolean} colors Flag to turn on ANSI escape codes to color the
* output. Default is false (no coloring).
*/
function inspect(obj, showHidden, depth, colors) {
var ctx = {
showHidden: showHidden,
seen: [],
stylize: function (str) { return str; }
};
return formatValue(ctx, obj, (typeof depth === 'undefined' ? 2 : depth));
}
// Returns true if object is a DOM element.
var isDOMElement = function (object) {
if (typeof HTMLElement === 'object') {
return object instanceof HTMLElement;
} else {
return object &&
typeof object === 'object' &&
object.nodeType === 1 &&
typeof object.nodeName === 'string';
}
};
function formatValue(ctx, value, recurseTimes) {
// Provide a hook for user-specified inspect functions.
// Check that value is an object with an inspect function on it
if (value && typeof value.inspect === 'function' &&
// Filter out the util module, it's inspect function is special
value.inspect !== exports.inspect &&
// Also filter out any prototype objects using the circular check.
!(value.constructor && value.constructor.prototype === value)) {
2013-06-17 20:06:38 +00:00
var ret = value.inspect(recurseTimes);
if (typeof ret !== 'string') {
ret = formatValue(ctx, ret, recurseTimes);
}
return ret;
2013-04-29 22:15:27 +00:00
}
2013-02-03 17:59:23 +00:00
2013-04-29 22:15:27 +00:00
// Primitive types cannot have properties
var primitive = formatPrimitive(ctx, value);
if (primitive) {
return primitive;
}
2014-09-29 23:24:59 +00:00
// If this is a DOM element, try to get the outer HTML.
2013-04-29 22:15:27 +00:00
if (isDOMElement(value)) {
2014-09-29 23:24:59 +00:00
if ('outerHTML' in value) {
return value.outerHTML;
// This value does not have an outerHTML attribute,
// it could still be an XML element
} else {
// Attempt to serialize it
try {
if (document.xmlVersion) {
var xmlSerializer = new XMLSerializer();
return xmlSerializer.serializeToString(value);
} else {
// Firefox 11- do not support outerHTML
// It does, however, support innerHTML
// Use the following to render the element
var ns = "http://www.w3.org/1999/xhtml";
var container = document.createElementNS(ns, '_');
container.appendChild(value.cloneNode(false));
html = container.innerHTML
.replace('><', '>' + value.innerHTML + '<');
container.innerHTML = '';
return html;
}
} catch (err) {
// This could be a non-native DOM implementation,
// continue with the normal flow:
// printing the element as if it is an object.
}
}
2013-04-29 22:15:27 +00:00
}
2012-07-01 02:55:04 +00:00
2013-04-29 22:15:27 +00:00
// Look up the keys of the object.
var visibleKeys = getEnumerableProperties(value);
var keys = ctx.showHidden ? getProperties(value) : visibleKeys;
// Some type of object without properties can be shortcutted.
// In IE, errors have a single `stack` property, or if they are vanilla `Error`,
// a `stack` plus `description` property; ignore those for consistency.
if (keys.length === 0 || (isError(value) && (
(keys.length === 1 && keys[0] === 'stack') ||
(keys.length === 2 && keys[0] === 'description' && keys[1] === 'stack')
))) {
if (typeof value === 'function') {
var name = getName(value);
var nameSuffix = name ? ': ' + name : '';
return ctx.stylize('[Function' + nameSuffix + ']', 'special');
}
if (isRegExp(value)) {
return ctx.stylize(RegExp.prototype.toString.call(value), 'regexp');
}
if (isDate(value)) {
return ctx.stylize(Date.prototype.toUTCString.call(value), 'date');
}
if (isError(value)) {
return formatError(value);
}
}
2011-12-15 12:07:27 +00:00
2013-04-29 22:15:27 +00:00
var base = '', array = false, braces = ['{', '}'];
2013-04-29 22:15:27 +00:00
// Make Array say that they are Array
if (isArray(value)) {
array = true;
braces = ['[', ']'];
}
2011-12-15 12:07:27 +00:00
2013-04-29 22:15:27 +00:00
// Make functions say that they are functions
if (typeof value === 'function') {
var name = getName(value);
var nameSuffix = name ? ': ' + name : '';
base = ' [Function' + nameSuffix + ']';
}
2011-12-15 12:07:27 +00:00
2013-04-29 22:15:27 +00:00
// Make RegExps say that they are RegExps
if (isRegExp(value)) {
base = ' ' + RegExp.prototype.toString.call(value);
}
2012-07-01 02:55:04 +00:00
2013-04-29 22:15:27 +00:00
// Make dates with properties first say the date
if (isDate(value)) {
base = ' ' + Date.prototype.toUTCString.call(value);
}
2011-12-15 12:07:27 +00:00
2013-04-29 22:15:27 +00:00
// Make error with message first say the error
if (isError(value)) {
return formatError(value);
}
2011-12-15 12:07:27 +00:00
2013-04-29 22:15:27 +00:00
if (keys.length === 0 && (!array || value.length == 0)) {
return braces[0] + base + braces[1];
}
2011-12-15 12:07:27 +00:00
2013-04-29 22:15:27 +00:00
if (recurseTimes < 0) {
if (isRegExp(value)) {
return ctx.stylize(RegExp.prototype.toString.call(value), 'regexp');
} else {
return ctx.stylize('[Object]', 'special');
}
}
2011-12-15 12:07:27 +00:00
2013-04-29 22:15:27 +00:00
ctx.seen.push(value);
2011-12-15 12:07:27 +00:00
2013-04-29 22:15:27 +00:00
var output;
if (array) {
output = formatArray(ctx, value, recurseTimes, visibleKeys, keys);
} else {
output = keys.map(function(key) {
return formatProperty(ctx, value, recurseTimes, visibleKeys, key, array);
});
}
2011-12-15 12:07:27 +00:00
2013-04-29 22:15:27 +00:00
ctx.seen.pop();
2011-12-15 12:07:27 +00:00
2013-04-29 22:15:27 +00:00
return reduceToSingleString(output, base, braces);
}
2011-12-15 12:07:27 +00:00
2013-04-29 22:15:27 +00:00
function formatPrimitive(ctx, value) {
switch (typeof value) {
case 'undefined':
return ctx.stylize('undefined', 'undefined');
2011-12-15 12:07:27 +00:00
2013-04-29 22:15:27 +00:00
case 'string':
var simple = '\'' + JSON.stringify(value).replace(/^"|"$/g, '')
.replace(/'/g, "\\'")
.replace(/\\"/g, '"') + '\'';
return ctx.stylize(simple, 'string');
2011-12-15 12:07:27 +00:00
2013-04-29 22:15:27 +00:00
case 'number':
2014-11-10 14:06:08 +00:00
if (value === 0 && (1/value) === -Infinity) {
return ctx.stylize('-0', 'number');
}
2013-04-29 22:15:27 +00:00
return ctx.stylize('' + value, 'number');
2012-07-01 02:55:04 +00:00
2013-04-29 22:15:27 +00:00
case 'boolean':
return ctx.stylize('' + value, 'boolean');
}
// For some reason typeof null is "object", so special case here.
if (value === null) {
return ctx.stylize('null', 'null');
}
}
2012-07-01 02:55:04 +00:00
2013-04-29 22:15:27 +00:00
function formatError(value) {
return '[' + Error.prototype.toString.call(value) + ']';
}
2012-07-01 02:55:04 +00:00
2013-04-29 22:15:27 +00:00
function formatArray(ctx, value, recurseTimes, visibleKeys, keys) {
var output = [];
for (var i = 0, l = value.length; i < l; ++i) {
if (Object.prototype.hasOwnProperty.call(value, String(i))) {
output.push(formatProperty(ctx, value, recurseTimes, visibleKeys,
String(i), true));
} else {
output.push('');
2012-07-01 02:55:04 +00:00
}
2013-04-29 22:15:27 +00:00
}
keys.forEach(function(key) {
if (!key.match(/^\d+$/)) {
output.push(formatProperty(ctx, value, recurseTimes, visibleKeys,
key, true));
2012-07-01 02:55:04 +00:00
}
2013-04-29 22:15:27 +00:00
});
return output;
}
2012-07-01 02:55:04 +00:00
2013-04-29 22:15:27 +00:00
function formatProperty(ctx, value, recurseTimes, visibleKeys, key, array) {
var name, str;
if (value.__lookupGetter__) {
if (value.__lookupGetter__(key)) {
if (value.__lookupSetter__(key)) {
str = ctx.stylize('[Getter/Setter]', 'special');
} else {
str = ctx.stylize('[Getter]', 'special');
2012-07-01 02:55:04 +00:00
}
2013-04-29 22:15:27 +00:00
} else {
if (value.__lookupSetter__(key)) {
str = ctx.stylize('[Setter]', 'special');
2012-07-01 02:55:04 +00:00
}
2013-04-29 22:15:27 +00:00
}
}
if (visibleKeys.indexOf(key) < 0) {
name = '[' + key + ']';
}
if (!str) {
if (ctx.seen.indexOf(value[key]) < 0) {
if (recurseTimes === null) {
str = formatValue(ctx, value[key], null);
} else {
str = formatValue(ctx, value[key], recurseTimes - 1);
2011-12-15 12:07:27 +00:00
}
2013-04-29 22:15:27 +00:00
if (str.indexOf('\n') > -1) {
if (array) {
str = str.split('\n').map(function(line) {
return ' ' + line;
}).join('\n').substr(2);
2011-12-15 12:07:27 +00:00
} else {
2013-04-29 22:15:27 +00:00
str = '\n' + str.split('\n').map(function(line) {
return ' ' + line;
}).join('\n');
2011-12-15 12:07:27 +00:00
}
}
2013-04-29 22:15:27 +00:00
} else {
str = ctx.stylize('[Circular]', 'special');
2011-12-15 12:07:27 +00:00
}
2013-04-29 22:15:27 +00:00
}
if (typeof name === 'undefined') {
if (array && key.match(/^\d+$/)) {
return str;
2012-07-01 02:55:04 +00:00
}
2013-04-29 22:15:27 +00:00
name = JSON.stringify('' + key);
if (name.match(/^"([a-zA-Z_][a-zA-Z_0-9]*)"$/)) {
name = name.substr(1, name.length - 2);
name = ctx.stylize(name, 'name');
} else {
name = name.replace(/'/g, "\\'")
.replace(/\\"/g, '"')
.replace(/(^"|"$)/g, "'");
name = ctx.stylize(name, 'string');
2012-07-01 02:55:04 +00:00
}
2013-04-29 22:15:27 +00:00
}
2012-07-01 02:55:04 +00:00
2013-04-29 22:15:27 +00:00
return name + ': ' + str;
}
function reduceToSingleString(output, base, braces) {
var numLinesEst = 0;
var length = output.reduce(function(prev, cur) {
numLinesEst++;
if (cur.indexOf('\n') >= 0) numLinesEst++;
return prev + cur.length + 1;
}, 0);
if (length > 60) {
return braces[0] +
(base === '' ? '' : base + '\n ') +
' ' +
output.join(',\n ') +
' ' +
braces[1];
}
2012-07-01 02:55:04 +00:00
2013-04-29 22:15:27 +00:00
return braces[0] + base + ' ' + output.join(', ') + ' ' + braces[1];
}
function isArray(ar) {
return Array.isArray(ar) ||
(typeof ar === 'object' && objectToString(ar) === '[object Array]');
}
function isRegExp(re) {
return typeof re === 'object' && objectToString(re) === '[object RegExp]';
}
function isDate(d) {
return typeof d === 'object' && objectToString(d) === '[object Date]';
}
function isError(e) {
return typeof e === 'object' && objectToString(e) === '[object Error]';
}
function objectToString(o) {
return Object.prototype.toString.call(o);
}
},{"./getEnumerableProperties":13,"./getName":15,"./getProperties":18}],22:[function(require,module,exports){
/*!
* Chai - flag utility
* Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
* MIT Licensed
*/
/*!
* Module dependancies
*/
var inspect = require('./inspect');
var config = require('../config');
/**
* ### .objDisplay (object)
*
* Determines if an object or an array matches
* criteria to be inspected in-line for error
* messages or should be truncated.
*
* @param {Mixed} javascript object to inspect
* @name objDisplay
* @api public
*/
module.exports = function (obj) {
var str = inspect(obj)
, type = Object.prototype.toString.call(obj);
if (config.truncateThreshold && str.length >= config.truncateThreshold) {
if (type === '[object Function]') {
return !obj.name || obj.name === ''
? '[Function]'
: '[Function: ' + obj.name + ']';
} else if (type === '[object Array]') {
return '[ Array(' + obj.length + ') ]';
} else if (type === '[object Object]') {
var keys = Object.keys(obj)
, kstr = keys.length > 2
? keys.splice(0, 2).join(', ') + ', ...'
: keys.join(', ');
return '{ Object (' + kstr + ') }';
} else {
return str;
}
} else {
return str;
}
};
},{"../config":3,"./inspect":21}],23:[function(require,module,exports){
/*!
* Chai - overwriteChainableMethod utility
* Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
* MIT Licensed
*/
/**
* ### overwriteChainableMethod (ctx, name, method, chainingBehavior)
*
* Overwites an already existing chainable method
* and provides access to the previous function or
* property. Must return functions to be used for
* name.
*
* utils.overwriteChainableMethod(chai.Assertion.prototype, 'length',
* function (_super) {
* }
* , function (_super) {
* }
* );
*
* Can also be accessed directly from `chai.Assertion`.
*
* chai.Assertion.overwriteChainableMethod('foo', fn, fn);
*
* Then can be used as any other assertion.
*
* expect(myFoo).to.have.length(3);
* expect(myFoo).to.have.length.above(3);
*
* @param {Object} ctx object whose method / property is to be overwritten
* @param {String} name of method / property to overwrite
* @param {Function} method function that returns a function to be used for name
* @param {Function} chainingBehavior function that returns a function to be used for property
* @name overwriteChainableMethod
* @api public
*/
module.exports = function (ctx, name, method, chainingBehavior) {
var chainableBehavior = ctx.__methods[name];
var _chainingBehavior = chainableBehavior.chainingBehavior;
chainableBehavior.chainingBehavior = function () {
var result = chainingBehavior(_chainingBehavior).call(this);
return result === undefined ? this : result;
};
var _method = chainableBehavior.method;
chainableBehavior.method = function () {
var result = method(_method).apply(this, arguments);
return result === undefined ? this : result;
};
};
},{}],24:[function(require,module,exports){
/*!
* Chai - overwriteMethod utility
* Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
* MIT Licensed
*/
/**
* ### overwriteMethod (ctx, name, fn)
*
* Overwites an already existing method and provides
* access to previous function. Must return function
* to be used for name.
*
* utils.overwriteMethod(chai.Assertion.prototype, 'equal', function (_super) {
* return function (str) {
* var obj = utils.flag(this, 'object');
* if (obj instanceof Foo) {
* new chai.Assertion(obj.value).to.equal(str);
* } else {
* _super.apply(this, arguments);
* }
* }
* });
*
* Can also be accessed directly from `chai.Assertion`.
*
* chai.Assertion.overwriteMethod('foo', fn);
*
* Then can be used as any other assertion.
*
* expect(myFoo).to.equal('bar');
*
* @param {Object} ctx object whose method is to be overwritten
* @param {String} name of method to overwrite
* @param {Function} method function that returns a function to be used for name
* @name overwriteMethod
* @api public
*/
module.exports = function (ctx, name, method) {
var _method = ctx[name]
, _super = function () { return this; };
if (_method && 'function' === typeof _method)
_super = _method;
ctx[name] = function () {
var result = method(_super).apply(this, arguments);
return result === undefined ? this : result;
}
};
},{}],25:[function(require,module,exports){
/*!
* Chai - overwriteProperty utility
* Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
* MIT Licensed
*/
/**
* ### overwriteProperty (ctx, name, fn)
*
* Overwites an already existing property getter and provides
* access to previous value. Must return function to use as getter.
*
* utils.overwriteProperty(chai.Assertion.prototype, 'ok', function (_super) {
* return function () {
* var obj = utils.flag(this, 'object');
* if (obj instanceof Foo) {
* new chai.Assertion(obj.name).to.equal('bar');
* } else {
* _super.call(this);
* }
* }
* });
*
*
* Can also be accessed directly from `chai.Assertion`.
*
* chai.Assertion.overwriteProperty('foo', fn);
*
* Then can be used as any other assertion.
*
* expect(myFoo).to.be.ok;
*
* @param {Object} ctx object whose property is to be overwritten
* @param {String} name of property to overwrite
* @param {Function} getter function that returns a getter function to be used for name
* @name overwriteProperty
* @api public
*/
module.exports = function (ctx, name, getter) {
var _get = Object.getOwnPropertyDescriptor(ctx, name)
, _super = function () {};
2013-04-29 22:15:27 +00:00
if (_get && 'function' === typeof _get.get)
_super = _get.get
2013-04-29 22:15:27 +00:00
Object.defineProperty(ctx, name,
{ get: function () {
var result = getter(_super).call(this);
return result === undefined ? this : result;
}
, configurable: true
});
};
2014-11-10 14:06:08 +00:00
},{}],26:[function(require,module,exports){
2013-04-29 22:15:27 +00:00
/*!
* Chai - test utility
2014-01-29 23:38:57 +00:00
* Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
2013-04-29 22:15:27 +00:00
* MIT Licensed
*/
/*!
* Module dependancies
*/
var flag = require('./flag');
2013-04-29 22:15:27 +00:00
/**
* # test(object, expression)
2013-04-29 22:15:27 +00:00
*
* Test and object for expression.
2013-04-29 22:15:27 +00:00
*
* @param {Object} object (constructed Assertion)
* @param {Arguments} chai.Assertion.prototype.assert arguments
2013-04-29 22:15:27 +00:00
*/
module.exports = function (obj, args) {
var negate = flag(obj, 'negate')
, expr = args[0];
return negate ? !expr : expr;
};
2013-04-29 22:15:27 +00:00
},{"./flag":11}],27:[function(require,module,exports){
/*!
* Chai - transferFlags utility
* Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
* MIT Licensed
*/
/**
* ### transferFlags(assertion, object, includeAll = true)
*
* Transfer all the flags for `assertion` to `object`. If
* `includeAll` is set to `false`, then the base Chai
* assertion flags (namely `object`, `ssfi`, and `message`)
* will not be transferred.
*
*
* var newAssertion = new Assertion();
* utils.transferFlags(assertion, newAssertion);
*
* var anotherAsseriton = new Assertion(myObj);
* utils.transferFlags(assertion, anotherAssertion, false);
*
* @param {Assertion} assertion the assertion to transfer the flags from
* @param {Object} object the object to transfer the flags to; usually a new assertion
* @param {Boolean} includeAll
* @name transferFlags
* @api private
*/
module.exports = function (assertion, object, includeAll) {
var flags = assertion.__flags || (assertion.__flags = Object.create(null));
if (!object.__flags) {
object.__flags = Object.create(null);
}
includeAll = arguments.length === 3 ? includeAll : true;
for (var flag in flags) {
if (includeAll ||
(flag !== 'object' && flag !== 'ssfi' && flag != 'message')) {
object.__flags[flag] = flags[flag];
2012-07-01 02:55:04 +00:00
}
2013-04-29 22:15:27 +00:00
}
};
},{}],28:[function(require,module,exports){
/*!
* assertion-error
* Copyright(c) 2013 Jake Luer <jake@qualiancy.com>
* MIT Licensed
*/
/*!
* Return a function that will copy properties from
* one object to another excluding any originally
* listed. Returned function will create a new `{}`.
2013-04-29 22:15:27 +00:00
*
* @param {String} excluded properties ...
* @return {Function}
*/
function exclude () {
var excludes = [].slice.call(arguments);
function excludeProps (res, obj) {
Object.keys(obj).forEach(function (key) {
if (!~excludes.indexOf(key)) res[key] = obj[key];
});
}
return function extendExclude () {
var args = [].slice.call(arguments)
, i = 0
, res = {};
for (; i < args.length; i++) {
excludeProps(res, args[i]);
}
return res;
};
};
/*!
* Primary Exports
*/
module.exports = AssertionError;
/**
* ### AssertionError
2013-04-29 22:15:27 +00:00
*
* An extension of the JavaScript `Error` constructor for
* assertion and validation scenarios.
2013-04-29 22:15:27 +00:00
*
* @param {String} message
* @param {Object} properties to include (optional)
* @param {callee} start stack function (optional)
*/
function AssertionError (message, _props, ssf) {
var extend = exclude('name', 'message', 'stack', 'constructor', 'toJSON')
, props = extend(_props || {});
// default values
this.message = message || 'Unspecified AssertionError';
this.showDiff = false;
// copy from properties
for (var key in props) {
this[key] = props[key];
}
// capture stack trace
ssf = ssf || arguments.callee;
if (ssf && Error.captureStackTrace) {
Error.captureStackTrace(this, ssf);
} else {
this.stack = new Error().stack;
}
}
/*!
* Inherit from Error.prototype
*/
AssertionError.prototype = Object.create(Error.prototype);
/*!
* Statically set name
*/
AssertionError.prototype.name = 'AssertionError';
/*!
* Ensure correct constructor
2013-04-29 22:15:27 +00:00
*/
AssertionError.prototype.constructor = AssertionError;
2013-04-29 22:15:27 +00:00
/**
* Allow errors to be converted to JSON for static transfer.
*
* @param {Boolean} include stack (default: `true`)
* @return {Object} object that can be `JSON.stringify`
*/
2013-04-29 22:15:27 +00:00
AssertionError.prototype.toJSON = function (stack) {
var extend = exclude('constructor', 'toJSON', 'stack')
, props = extend({ name: this.name }, this);
// include stack if exists and not turned off
if (false !== stack && this.stack) {
props.stack = this.stack;
2013-04-29 22:15:27 +00:00
}
return props;
2013-04-29 22:15:27 +00:00
};
2015-06-03 23:19:52 +00:00
},{}],29:[function(require,module,exports){
module.exports = require('./lib/eql');
2014-11-10 14:06:08 +00:00
2015-06-03 23:19:52 +00:00
},{"./lib/eql":30}],30:[function(require,module,exports){
2013-04-29 22:15:27 +00:00
/*!
* deep-eql
* Copyright(c) 2013 Jake Luer <jake@alogicalparadox.com>
2013-04-29 22:15:27 +00:00
* MIT Licensed
*/
/*!
* Module dependencies
2013-04-29 22:15:27 +00:00
*/
var type = require('type-detect');
2013-04-29 22:15:27 +00:00
/*!
* Buffer.isBuffer browser shim
*/
2013-04-29 22:15:27 +00:00
var Buffer;
try { Buffer = require('buffer').Buffer; }
catch(ex) {
Buffer = {};
Buffer.isBuffer = function() { return false; }
}
2014-11-10 14:06:08 +00:00
2014-01-29 23:38:57 +00:00
/*!
* Primary Export
2014-01-29 23:38:57 +00:00
*/
module.exports = deepEqual;
2014-01-29 23:38:57 +00:00
/**
* Assert super-strict (egal) equality between
* two objects of any type.
2014-01-29 23:38:57 +00:00
*
* @param {Mixed} a
* @param {Mixed} b
* @param {Array} memoised (optional)
* @return {Boolean} equal match
*/
function deepEqual(a, b, m) {
if (sameValue(a, b)) {
return true;
} else if ('date' === type(a)) {
return dateEqual(a, b);
} else if ('regexp' === type(a)) {
return regexpEqual(a, b);
} else if (Buffer.isBuffer(a)) {
return bufferEqual(a, b);
} else if ('arguments' === type(a)) {
return argumentsEqual(a, b, m);
} else if (!typeEqual(a, b)) {
return false;
} else if (('object' !== type(a) && 'object' !== type(b))
&& ('array' !== type(a) && 'array' !== type(b))) {
return sameValue(a, b);
} else {
return objectEqual(a, b, m);
}
}
/*!
* Strict (egal) equality test. Ensures that NaN always
* equals NaN and `-0` does not equal `+0`.
2014-01-29 23:38:57 +00:00
*
* @param {Mixed} a
* @param {Mixed} b
* @return {Boolean} equal match
*/
function sameValue(a, b) {
if (a === b) return a !== 0 || 1 / a === 1 / b;
return a !== a && b !== b;
}
/*!
* Compare the types of two given objects and
* return if they are equal. Note that an Array
* has a type of `array` (not `object`) and arguments
* have a type of `arguments` (not `array`/`object`).
2014-01-29 23:38:57 +00:00
*
* @param {Mixed} a
* @param {Mixed} b
* @return {Boolean} result
*/
function typeEqual(a, b) {
return type(a) === type(b);
}
/*!
* Compare two Date objects by asserting that
* the time values are equal using `saveValue`.
2014-01-29 23:38:57 +00:00
*
* @param {Date} a
* @param {Date} b
* @return {Boolean} result
*/
function dateEqual(a, b) {
if ('date' !== type(b)) return false;
return sameValue(a.getTime(), b.getTime());
}
/*!
* Compare two regular expressions by converting them
* to string and checking for `sameValue`.
2014-01-29 23:38:57 +00:00
*
* @param {RegExp} a
* @param {RegExp} b
* @return {Boolean} result
*/
function regexpEqual(a, b) {
if ('regexp' !== type(b)) return false;
return sameValue(a.toString(), b.toString());
}
/*!
* Assert deep equality of two `arguments` objects.
* Unfortunately, these must be sliced to arrays
* prior to test to ensure no bad behavior.
2014-01-29 23:38:57 +00:00
*
* @param {Arguments} a
* @param {Arguments} b
* @param {Array} memoize (optional)
* @return {Boolean} result
*/
function argumentsEqual(a, b, m) {
if ('arguments' !== type(b)) return false;
a = [].slice.call(a);
b = [].slice.call(b);
return deepEqual(a, b, m);
}
/*!
* Get enumerable properties of a given object.
2014-01-29 23:38:57 +00:00
*
* @param {Object} a
* @return {Array} property names
2014-01-29 23:38:57 +00:00
*/
function enumerable(a) {
var res = [];
for (var key in a) res.push(key);
return res;
}
2014-01-29 23:38:57 +00:00
/*!
* Simple equality for flat iterable objects
* such as Arrays or Node.js buffers.
*
* @param {Iterable} a
* @param {Iterable} b
* @return {Boolean} result
*/
2014-01-29 23:38:57 +00:00
function iterableEqual(a, b) {
if (a.length !== b.length) return false;
var i = 0;
var match = true;
for (; i < a.length; i++) {
if (a[i] !== b[i]) {
match = false;
break;
}
}
2014-01-29 23:38:57 +00:00
return match;
}
2014-11-10 14:06:08 +00:00
2013-04-29 22:15:27 +00:00
/*!
* Extension to `iterableEqual` specifically
* for Node.js Buffers.
*
* @param {Buffer} a
* @param {Mixed} b
* @return {Boolean} result
2013-04-29 22:15:27 +00:00
*/
function bufferEqual(a, b) {
if (!Buffer.isBuffer(b)) return false;
return iterableEqual(a, b);
}
2013-04-29 22:15:27 +00:00
/*!
* Block for `objectEqual` ensuring non-existing
* values don't get in.
*
* @param {Mixed} object
* @return {Boolean} result
2013-04-29 22:15:27 +00:00
*/
function isValue(a) {
return a !== null && a !== undefined;
}
2013-04-29 22:15:27 +00:00
/*!
* Recursively check the equality of two objects.
* Once basic sameness has been established it will
* defer to `deepEqual` for each enumerable key
* in the object.
2013-04-29 22:15:27 +00:00
*
* @param {Mixed} a
* @param {Mixed} b
* @return {Boolean} result
2013-04-29 22:15:27 +00:00
*/
function objectEqual(a, b, m) {
if (!isValue(a) || !isValue(b)) {
return false;
}
2013-04-29 22:15:27 +00:00
if (a.prototype !== b.prototype) {
return false;
}
2014-11-10 14:06:08 +00:00
var i;
if (m) {
for (i = 0; i < m.length; i++) {
if ((m[i][0] === a && m[i][1] === b)
|| (m[i][0] === b && m[i][1] === a)) {
return true;
}
}
} else {
m = [];
}
2013-04-29 22:15:27 +00:00
try {
var ka = enumerable(a);
var kb = enumerable(b);
} catch (ex) {
return false;
}
2013-04-29 22:15:27 +00:00
ka.sort();
kb.sort();
2013-04-29 22:15:27 +00:00
if (!iterableEqual(ka, kb)) {
return false;
2013-04-29 22:15:27 +00:00
}
2013-02-03 20:14:49 +00:00
m.push([ a, b ]);
2011-12-07 06:10:58 +00:00
var key;
for (i = ka.length - 1; i >= 0; i--) {
key = ka[i];
if (!deepEqual(a[key], b[key], m)) {
return false;
2013-04-29 22:15:27 +00:00
}
}
return true;
}
2015-06-03 23:19:52 +00:00
},{"buffer":undefined,"type-detect":31}],31:[function(require,module,exports){
module.exports = require('./lib/type');
2014-11-10 14:06:08 +00:00
2015-06-03 23:19:52 +00:00
},{"./lib/type":32}],32:[function(require,module,exports){
2013-04-29 22:15:27 +00:00
/*!
* type-detect
* Copyright(c) 2013 jake luer <jake@alogicalparadox.com>
2013-04-29 22:15:27 +00:00
* MIT Licensed
*/
/*!
* Primary Exports
*/
var exports = module.exports = getType;
2013-04-29 22:15:27 +00:00
/*!
* Detectable javascript natives
*/
var natives = {
'[object Array]': 'array'
2013-04-29 22:15:27 +00:00
, '[object RegExp]': 'regexp'
, '[object Function]': 'function'
, '[object Arguments]': 'arguments'
, '[object Date]': 'date'
2013-04-29 22:15:27 +00:00
};
/**
* ### typeOf (obj)
2013-04-29 22:15:27 +00:00
*
* Use several different techniques to determine
* the type of object being tested.
2013-04-29 22:15:27 +00:00
*
*
* @param {Mixed} object
* @return {String} object type
* @api public
2013-04-29 22:15:27 +00:00
*/
function getType (obj) {
2013-04-29 22:15:27 +00:00
var str = Object.prototype.toString.call(obj);
if (natives[str]) return natives[str];
if (obj === null) return 'null';
if (obj === undefined) return 'undefined';
if (obj === Object(obj)) return 'object';
return typeof obj;
}
exports.Library = Library;
2013-04-29 22:15:27 +00:00
/**
* ### Library
*
* Create a repository for custom type detection.
*
* ```js
* var lib = new type.Library;
* ```
*
*/
2013-09-18 19:04:00 +00:00
function Library () {
this.tests = {};
2014-11-10 14:06:08 +00:00
}
/**
* #### .of (obj)
*
* Expose replacement `typeof` detection to the library.
*
* ```js
* if ('string' === lib.of('hello world')) {
* // ...
* }
* ```
*
* @param {Mixed} object to test
* @return {String} type
*/
Library.prototype.of = getType;
/**
* #### .define (type, test)
*
* Add a test to for the `.test()` assertion.
*
* Can be defined as a regular expression:
*
* ```js
* lib.define('int', /^[0-9]+$/);
* ```
*
* ... or as a function:
*
* ```js
* lib.define('bln', function (obj) {
* if ('boolean' === lib.of(obj)) return true;
* var blns = [ 'yes', 'no', 'true', 'false', 1, 0 ];
* if ('string' === lib.of(obj)) obj = obj.toLowerCase();
* return !! ~blns.indexOf(obj);
* });
* ```
*
* @param {String} type
* @param {RegExp|Function} test
* @api public
*/
Library.prototype.define = function (type, test) {
if (arguments.length === 1) return this.tests[type];
this.tests[type] = test;
return this;
};
/**
* #### .test (obj, test)
*
* Assert that an object is of type. Will first
* check natives, and if that does not pass it will
* use the user defined custom tests.
*
* ```js
* assert(lib.test('1', 'int'));
* assert(lib.test('yes', 'bln'));
* ```
*
* @param {Mixed} object
* @param {String} type
* @return {Boolean} result
* @api public
*/
Library.prototype.test = function (obj, type) {
if (type === getType(obj)) return true;
var test = this.tests[type];
if (test && 'regexp' === getType(test)) {
return test.test(obj);
} else if (test && 'function' === getType(test)) {
return test(obj);
} else {
throw new ReferenceError('Type test "' + type + '" not defined or invalid.');
}
};
2015-06-03 23:19:52 +00:00
},{}],33:[function(require,module,exports){
arguments[4][31][0].apply(exports,arguments)
},{"./lib/type":34,"dup":31}],34:[function(require,module,exports){
/*!
* type-detect
* Copyright(c) 2013 jake luer <jake@alogicalparadox.com>
* MIT Licensed
*/
/*!
* Primary Exports
*/
var exports = module.exports = getType;
/**
* ### typeOf (obj)
*
* Use several different techniques to determine
* the type of object being tested.
*
*
* @param {Mixed} object
* @return {String} object type
* @api public
*/
var objectTypeRegexp = /^\[object (.*)\]$/;
function getType(obj) {
var type = Object.prototype.toString.call(obj).match(objectTypeRegexp)[1].toLowerCase();
// Let "new String('')" return 'object'
if (typeof Promise === 'function' && obj instanceof Promise) return 'promise';
// PhantomJS has type "DOMWindow" for null
if (obj === null) return 'null';
// PhantomJS has type "DOMWindow" for undefined
if (obj === undefined) return 'undefined';
return type;
}
exports.Library = Library;
/**
* ### Library
*
* Create a repository for custom type detection.
*
* ```js
* var lib = new type.Library;
* ```
*
*/
function Library() {
if (!(this instanceof Library)) return new Library();
this.tests = {};
}
/**
* #### .of (obj)
*
* Expose replacement `typeof` detection to the library.
*
* ```js
* if ('string' === lib.of('hello world')) {
* // ...
* }
* ```
*
* @param {Mixed} object to test
* @return {String} type
*/
Library.prototype.of = getType;
/**
* #### .define (type, test)
*
* Add a test to for the `.test()` assertion.
*
* Can be defined as a regular expression:
*
* ```js
* lib.define('int', /^[0-9]+$/);
* ```
*
* ... or as a function:
*
* ```js
* lib.define('bln', function (obj) {
* if ('boolean' === lib.of(obj)) return true;
* var blns = [ 'yes', 'no', 'true', 'false', 1, 0 ];
* if ('string' === lib.of(obj)) obj = obj.toLowerCase();
* return !! ~blns.indexOf(obj);
* });
* ```
*
* @param {String} type
* @param {RegExp|Function} test
* @api public
*/
Library.prototype.define = function(type, test) {
if (arguments.length === 1) return this.tests[type];
this.tests[type] = test;
return this;
};
/**
* #### .test (obj, test)
*
* Assert that an object is of type. Will first
* check natives, and if that does not pass it will
* use the user defined custom tests.
*
* ```js
* assert(lib.test('1', 'int'));
* assert(lib.test('yes', 'bln'));
* ```
*
* @param {Mixed} object
* @param {String} type
* @return {Boolean} result
* @api public
*/
Library.prototype.test = function(obj, type) {
if (type === getType(obj)) return true;
var test = this.tests[type];
if (test && 'regexp' === getType(test)) {
return test.test(obj);
} else if (test && 'function' === getType(test)) {
return test(obj);
} else {
throw new ReferenceError('Type test "' + type + '" not defined or invalid.');
}
};
},{}],35:[function(require,module,exports){
module.exports = require('./lib/chai');
2015-06-03 23:19:52 +00:00
},{"./lib/chai":1}]},{},[35])(35)
});