Mirrors/chai
2
0
Fork 0
mirror of https://github.com/chaijs/chai synced 2024-11-14 15:57:10 +00:00
Code Issues Projects Releases Packages Wiki Activity
chai/ReleaseNotes.md
Jake Luer db4b9d7833 Release 1.7.2
2013-06-27 14:15:43 -04:00

11 KiB
Raw Blame History

Release Notes

1.7.2 / 2013-06-27

The following changes are required if you are upgrading from the previous version:

  • Users:
    • No changes required.
  • Plugin Developers:
    • No changes required
  • Core Contributors:
    • Refresh node_modules folder for updated dependencies.

Coverage Reporting

Coverage reporting has always been available for core-developers but the data has never been published for our end users. In our ongoing effort to improve accountability this data will now be published via the coveralls.io service. A badge has been added to the README and the full report can be viewed online at the chai coveralls project. Furthermore, PRs will receive automated messages indicating how their PR impacts test coverage. This service is tied to TravisCI.

Other Fixes

  • #175 Add bower.json. (Fix ignore all)

1.7.1 / 2013-06-24

The following changes are required if you are upgrading from the previous version:

  • Users:
    • No changes required.
  • Plugin Developers:
    • No changes required
  • Core Contributors:
    • Refresh node_modules folder for updated dependencies.

Official Bower Support

Support has been added for the Bower Package Manager ([bower.io])(http://bower.io/). Though Chai could be installed via Bower in the past, this update adds official support via the bower.json specification file.

  • #175 Add bower.json.

1.7.0 / 2013-06-17

The following changes are required if you are upgrading from the previous version:

  • Users:
    • No changes required.
  • Plugin Developers:
    • Review AssertionError update notice.
  • Core Contributors:
    • Refresh node_modules folder for updated dependencies.

AssertionError Update Notice

Chai now uses chaijs/assertion-error instead an internal constructor. This will allow for further iteration/experimentation of the AssertionError constructor independant of Chai. Future plans include stack parsing for callsite support.

This update constructor has a different constructor param signature that conforms more with the standard Error object. If your plugin throws and AssertionError directly you will need to update your plugin with the new signature.

var AssertionError = require('chai').AssertionError;

/**
 * previous
 *
 * @param {Object} options
 */

throw new AssertionError({
    message: 'An assertion error occurred'
  , actual: actual
  , expect: expect
  , startStackFunction: arguments.callee
  , showStack: true
});

/**
 * new
 *
 * @param {String} message
 * @param {Object} options
 * @param {Function} start stack function
 */

throw new AssertionError('An assertion error occurred', {
    actual: actual
  , expect: expect
  , showStack: true
}, arguments.callee);

// other signatures
throw new AssertionError('An assertion error occurred');
throw new AssertionError('An assertion error occurred', null, arguments.callee);

External Dependencies

This is the first non-developement dependency for Chai. As Chai continues to evolve we will begin adding more; the next will likely be improved type detection and deep equality. With Chai's userbase continually growing there is an higher need for accountability and documentation. External dependencies will allow us to iterate and test on features independent from our interfaces.

Note: The browser packaged version chai.js will ALWAYS contain all dependencies needed to run Chai.

Community Contributions

Thank you to all who took the time to contribute!

1.6.1 / 2013-06-05

The following changes are required if you are upgrading from the previous version:

  • Users:
    • No changes required.
  • Plugin Developers:
    • No changes required.
  • Core Contributors:
    • Refresh node_modules folder for updated developement dependencies.

Deep Equality

Regular Expressions are now tested as part of all deep equality assertions. In previous versions they silently passed for all scenarios. Thanks to @katsgeorgeek for the contribution.

Community Contributions

Thank you to all who took the time to contribute!

Additional Notes

  • Mocha has been locked at version 1.8.x to ensure mocha-phantomjs compatibility.

1.6.0 / 2013-04-29

The following changes are required if you are upgrading from the previous version:

  • Users:
    • No changes required.
  • Plugin Developers:
    • No changes required.
  • Core Contributors:
    • Refresh node_modules folder for updated developement dependencies.

New Assertions

Array Members Inclusion

Asserts that the target is a superset of set, or that the target and set have the same members. Order is not taken into account. Thanks to @NickHeiner for the contribution.

// (expect/should) full set
expect([4, 2]).to.have.members([2, 4]);
expect([5, 2]).to.not.have.members([5, 2, 1]);

// (expect/should) inclusion
expect([1, 2, 3]).to.include.members([3, 2]);
expect([1, 2, 3]).to.not.include.members([3, 2, 8]);

// (assert) full set
assert.sameMembers([ 1, 2, 3 ], [ 2, 1, 3 ], 'same members');

// (assert) inclusion 
assert.includeMembers([ 1, 2, 3 ], [ 2, 1 ], 'include members');

Non-inclusion for Assert Interface

Most assert functions have a negative version, like instanceOf() has a corresponding notInstaceOf(). However include() did not have a corresponding notInclude(). This has been added.

assert.notInclude([ 1, 2, 3 ], 8);
assert.notInclude('foobar', 'baz');

Community Contributions

Thank you to all who took time to contribute!

Other Bug Fixes

  • #142 assert#include will no longer silently pass on wrong-type haystack.
  • #158 assert#notInclude has been added.
  • Travis-CI now tests Node.js v0.10.x. Support for v0.6.x has been removed. v0.8.x is still tested as before.

1.5.0 / 2013-02-03

Migration Requirements

The following changes are required if you are upgrading from the previous version:

  • Users:
    • Update [2013-02-04]: Some users may notice a small subset of deep equality assertions will no longer pass. This is the result of #120, an improvement to our deep equality algorithm. Users will need to revise their assertions to be more granular should this occur. Further information: #139.
  • Plugin Developers:
    • No changes required.
  • Core Contributors:
    • Refresh node_modules folder for updated developement dependencies.

Community Contributions

Thank you to all who took time to contribute!

Other Bug Fixes

  • Improve type detection of .a()/.an() to work in cross-browser scenarios.
  • #116: .throw() has cleaner display of errors when WebKit browsers.
  • #120: .eql() now works to compare dom nodes in browsers.

Usage Updates

For Users

1. Component Support: Chai now included the proper configuration to be installed as a component. Component users are encouraged to consult chaijs.com for the latest version number as using the master branch does not gaurantee stability.

// relevant component.json
  devDependencies: {
    "chaijs/chai": "1.5.0"
  }

Alternatively, bleeding-edge is available:

$ component install chaijs/chai

2. Configurable showDiff: Some test runners (such as mocha) include support for showing the diff of strings and objects when an equality error occurs. Chai has already included support for this, however some users may not prefer this display behavior. To revert to no diff display, the following configuration is available:

chai.Assertion.showDiff = false; // diff output disabled
chai.Assertion.showDiff = true; // default, diff output enabled

For Plugin Developers

1. New Utility - type: The new utility .type() is available as a better implementation of typeof that can be used cross-browser. It handles the inconsistencies of Array, null, and undefined detection.

  • @param {Mixed} object to detect type of
  • @return {String} object type
chai.use(function (c, utils) {
  // some examples
  utils.type({}); // 'object'
  utils.type(null); // `null'
  utils.type(undefined); // `undefined`
  utils.type([]); // `array`
});

For Core Contributors

1. Browser Testing: Browser testing of the ./chai.js file is now available in the command line via PhantomJS. make test and Travis-CI will now also rebuild and test ./chai.js. Consequently, all pull requests will now be browser tested in this way.

Note: Contributors opening pull requests should still NOT include the browser build.

2. SauceLabs Testing: Early SauceLab support has been enabled with the file ./support/mocha-cloud.js. Those interested in trying it out should create a free Open Sauce account and include their credentials in ./test/auth/sauce.json.