Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(132)

Side by Side Diff: bower_components/chai/ReleaseNotes.md

Issue 786953007: npm_modules: Fork bower_components into Polymer 0.4.0 and 0.5.0 versions (Closed) Base URL: https://chromium.googlesource.com/infra/third_party/npm_modules.git@master
Patch Set: Created 5 years, 11 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « bower_components/chai/README.md ('k') | bower_components/chai/bower.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 # Release Notes
2
3 ## 1.9.2 / 2014-09-29
4
5 The following changes are required if you are upgrading from the previous versio n:
6
7 - **Users:**
8 - No changes required
9 - **Plugin Developers:**
10 - No changes required
11 - **Core Contributors:**
12 - Refresh `node_modules` folder for updated dependencies.
13
14 ### Community Contributions
15
16 - [#264](https://github.com/chaijs/chai/pull/264) Show diff for keys assertions [@cjthompson](https://github.com/cjthompson)
17 - [#267](https://github.com/chaijs/chai/pull/267) Use SVG badges [@shinnn](https ://github.com/shinnn)
18 - [#268](https://github.com/chaijs/chai/pull/268) Allow messages to be functions (sinon-compat) [@charlierudolph](https://github.com/charlierudolph)
19 - [#269](https://github.com/chaijs/chai/pull/269) Remove unused argument for #le ngthOf [@charlierudolph](https://github.com/charlierudolph)
20 - [#275](https://github.com/chaijs/chai/pull/275) Rewrite pretty-printing HTML e lements to prevent throwing internal errors [@DrRataplan](https://github.com/DrR ataplan)
21 - [#277](https://github.com/chaijs/chai/pull/277) Fix assert documentation for # sameMembers [@charlierudolph](https://github.com/charlierudolph)
22 - [#279](https://github.com/chaijs/chai/pull/279) closeTo should check value's t ype before assertion [@mohayonao](https://github.com/mohayonao)
23 - [#289](https://github.com/chaijs/chai/pull/289) satisfy is called twice [@char lierudolph](https://github.com/charlierudolph)
24 - [#292](https://github.com/chaijs/chai/pull/292) resolve conflicts with node-we bkit and global usage [@boneskull](https://github.com/boneskull)
25
26 Thank you to all who took time to contribute!
27
28 ## 1.9.1 / 2014-03-19
29
30 The following changes are required if you are upgrading from the previous versio n:
31
32 - **Users:**
33 - Migrate configuration options to new interface. (see notes)
34 - **Plugin Developers:**
35 - No changes required
36 - **Core Contributors:**
37 - Refresh `node_modules` folder for updated dependencies.
38
39 ### Configuration
40
41 There have been requests for changes and additions to the configuration mechanis ms
42 and their impact in the Chai architecture. As such, we have decoupled the
43 configuration from the `Assertion` constructor. This not only allows for central ized
44 configuration, but will allow us to shift the responsibility from the `Assertion `
45 constructor to the `assert` interface in future releases.
46
47 These changes have been implemented in a non-breaking way, but a depretiation
48 warning will be presented to users until they migrate. The old config method wil l
49 be removed in either `v1.11.0` or `v2.0.0`, whichever comes first.
50
51 #### Quick Migration
52
53 ```js
54 // change this:
55 chai.Assertion.includeStack = true;
56 chai.Assertion.showDiff = false;
57
58 // ... to this:
59 chai.config.includeStack = true;
60 chai.config.showDiff = false;
61 ```
62
63 #### All Config Options
64
65 ##### config.includeStack
66
67 - **@param** _{Boolean}_
68 - **@default** `false`
69
70 User configurable property, influences whether stack trace is included in
71 Assertion error message. Default of `false` suppresses stack trace in the error
72 message.
73
74 ##### config.showDiff
75
76 - **@param** _{Boolean}_
77 - **@default** `true`
78
79 User configurable property, influences whether or not the `showDiff` flag
80 should be included in the thrown AssertionErrors. `false` will always be `false` ;
81 `true` will be true when the assertion has requested a diff be shown.
82
83 ##### config.truncateThreshold **(NEW)**
84
85 - **@param** _{Number}_
86 - **@default** `40`
87
88 User configurable property, sets length threshold for actual and expected values
89 in assertion errors. If this threshold is exceeded, the value is truncated.
90
91 Set it to zero if you want to disable truncating altogether.
92
93 ```js
94 chai.config.truncateThreshold = 0; // disable truncating
95 ```
96
97 ### Community Contributions
98
99 - [#228](https://github.com/chaijs/chai/pull/228) Deep equality check for memebe rs. [@duncanbeevers](https://github.com/duncanbeevers)
100 - [#247](https://github.com/chaijs/chai/pull/247) Proofreading. [@didorellano](h ttps://github.com/didoarellano)
101 - [#244](https://github.com/chaijs/chai/pull/244) Fix `contain`/`include` 1.9.0 regression. [@leider](https://github.com/leider)
102 - [#233](https://github.com/chaijs/chai/pull/233) Improvements to `ssfi` for `as sert` interface. [@refack](https://github.com/refack)
103 - [#251](https://github.com/chaijs/chai/pull/251) New config option: object disp lay threshold. [@romario333](https://github.com/romario333)
104
105 Thank you to all who took time to contribute!
106
107 ### Other Bug Fixes
108
109 - [#183](https://github.com/chaijs/chai/issues/183) Allow `undefined` for actual . (internal api)
110 - Update Karam(+plugins)/Istanbul to most recent versions.
111
112 ## 1.9.0 / 2014-01-29
113
114 The following changes are required if you are upgrading from the previous versio n:
115
116 - **Users:**
117 - No changes required
118 - **Plugin Developers:**
119 - Review [#219](https://github.com/chaijs/chai/pull/219).
120 - **Core Contributors:**
121 - Refresh `node_modules` folder for updated dependencies.
122
123 ### Community Contributions
124
125 - [#202](https://github.com/chaijs/chai/pull/201) Improve error message for .thr ow(). [@andreineculau](https://github.com/andreineculau)
126 - [#217](https://github.com/chaijs/chai/pull/217) Chai tests can be run with `-- watch`. [@demands](https://github.com/demands)
127 - [#219](https://github.com/chaijs/chai/pull/219) Add overwriteChainableMethod u tility. [@demands](https://github.com/demands)
128 - [#224](https://github.com/chaijs/chai/pull/224) Return error on throw method t o chain on error properties. [@vbardales](https://github.com/vbardales)
129 - [#226](https://github.com/chaijs/chai/pull/226) Add `has` to language chains. [@duncanbeevers](https://github.com/duncanbeevers)
130 - [#230](https://github.com/chaijs/chai/pull/230) Support `{a:1,b:2}.should.incl ude({a:1})` [@jkroso](https://github.com/jkroso)
131 - [#231](https://github.com/chaijs/chai/pull/231) Update Copyright notices to 20 14 [@duncanbeevers](https://github.com/duncanbeevers)
132 - [#232](https://github.com/chaijs/chai/pull/232) Avoid error instantiation if p ossible on assert.throws. [@laconbass](https://github.com/laconbass)
133
134 Thank you to all who took time to contribute!
135
136 ### Other Bug Fixes
137
138 - [#225](https://github.com/chaijs/chai/pull/225) Improved AMD wrapper provided by upstream `component(1)`.
139 - [#185](https://github.com/chaijs/chai/issues/185) `assert.throws()` returns th rown error for further assertions.
140 - [#237](https://github.com/chaijs/chai/pull/237) Remove coveralls/jscoverage, i nclude istanbul coverage report in travis test.
141 - Update Karma and Sauce runner versions for consistent CI results. No more karm a@canary.
142
143 ## 1.8.1 / 2013-10-10
144
145 The following changes are required if you are upgrading from the previous versio n:
146
147 - **Users:**
148 - Refresh `node_modules` folder for updated dependencies.
149 - **Plugin Developers:**
150 - No changes required
151 - **Core Contributors:**
152 - Refresh `node_modules` folder for updated dependencies.
153
154 ### Browserify
155
156 This is a small patch that updates the dependency tree so browserify users can i nstall
157 chai. (Remove conditional requires)
158
159 ## 1.8.0 / 2013-09-18
160
161 The following changes are required if you are upgrading from the previous versio n:
162
163 - **Users:**
164 - See `deep.equal` notes.
165 - **Plugin Developers:**
166 - No changes required
167 - **Core Contributors:**
168 - Refresh `node_modules` folder for updated dependencies.
169
170 ### Deep Equals
171
172 This version of Chai focused on a overhaul to the deep equal utility. The code f or this
173 tool has been removed from the core lib and can now be found at:
174 [chai / deep-eql](https://github.com/chaijs/deep-eql). As stated in previous rel eases,
175 this is part of a larger initiative to provide transparency, independent testing , and coverage for
176 some of the more complicated internal tools.
177
178 For the most part `.deep.equal` will behave the same as it has. However, in orde r to provide a
179 consistent ruleset across all types being tested, the following changes have bee n made and _might_
180 require changes to your tests.
181
182 **1.** Strict equality for non-traversable nodes according to [egal](http://wiki .ecmascript.org/doku.php?id=harmony:egal).
183
184 _Previously:_ Non-traversable equal via `===`.
185
186 ```js
187 expect(NaN).to.deep.equal(NaN);
188 expect(-0).to.not.deep.equal(+0);
189 ```
190
191 **2.** Arguments are not Arrays (and all types must be equal):
192
193 _Previously:_ Some crazy nonsense that led to empty arrays deep equaling empty o bjects deep equaling dates.
194
195 ```js
196 expect(arguments).to.not.deep.equal([]);
197 expect(Array.prototype.slice.call(arguments)).to.deep.equal([]);
198 ```
199
200 - [#156](https://github.com/chaijs/chai/issues/156) Empty object is eql to empty array
201 - [#192](https://github.com/chaijs/chai/issues/192) empty object is eql to a Dat e object
202 - [#194](https://github.com/chaijs/chai/issues/194) refactor deep-equal utility
203
204 ### CI and Browser Testing
205
206 Chai now runs the browser CI suite using [Karma](http://karma-runner.github.io/) directed at
207 [SauceLabs](https://saucelabs.com/). This means we get to know where our browser support stands...
208 and we get a cool badge:
209
210 [![Selenium Test Status](https://saucelabs.com/browser-matrix/logicalparadox.svg )](https://saucelabs.com/u/logicalparadox)
211
212 Look for the list of browsers/versions to expand over the coming releases.
213
214 - [#195](https://github.com/chaijs/chai/issues/195) karma test framework
215
216 ## 1.7.2 / 2013-06-27
217
218 The following changes are required if you are upgrading from the previous versio n:
219
220 - **Users:**
221 - No changes required.
222 - **Plugin Developers:**
223 - No changes required
224 - **Core Contributors:**
225 - Refresh `node_modules` folder for updated dependencies.
226
227 ### Coverage Reporting
228
229 Coverage reporting has always been available for core-developers but the data ha s never been published
230 for our end users. In our ongoing effort to improve accountability this data wil l now be published via
231 the [coveralls.io](https://coveralls.io/) service. A badge has been added to the README and the full report
232 can be viewed online at the [chai coveralls project](https://coveralls.io/r/chai js/chai). Furthermore, PRs
233 will receive automated messages indicating how their PR impacts test coverage. T his service is tied to TravisCI.
234
235 ### Other Fixes
236
237 - [#175](https://github.com/chaijs/chai/issues/175) Add `bower.json`. (Fix ignor e all)
238
239 ## 1.7.1 / 2013-06-24
240
241 The following changes are required if you are upgrading from the previous versio n:
242
243 - **Users:**
244 - No changes required.
245 - **Plugin Developers:**
246 - No changes required
247 - **Core Contributors:**
248 - Refresh `node_modules` folder for updated dependencies.
249
250 ### Official Bower Support
251
252 Support has been added for the Bower Package Manager ([bower.io])(http://bower.i o/). Though
253 Chai could be installed via Bower in the past, this update adds official support via the `bower.json`
254 specification file.
255
256 - [#175](https://github.com/chaijs/chai/issues/175) Add `bower.json`.
257
258 ## 1.7.0 / 2013-06-17
259
260 The following changes are required if you are upgrading from the previous versio n:
261
262 - **Users:**
263 - No changes required.
264 - **Plugin Developers:**
265 - Review AssertionError update notice.
266 - **Core Contributors:**
267 - Refresh `node_modules` folder for updated dependencies.
268
269 ### AssertionError Update Notice
270
271 Chai now uses [chaijs/assertion-error](https://github.com/chaijs/assertion-error ) instead an internal
272 constructor. This will allow for further iteration/experimentation of the Assert ionError constructor
273 independant of Chai. Future plans include stack parsing for callsite support.
274
275 This update constructor has a different constructor param signature that conform s more with the standard
276 `Error` object. If your plugin throws and `AssertionError` directly you will nee d to update your plugin
277 with the new signature.
278
279 ```js
280 var AssertionError = require('chai').AssertionError;
281
282 /**
283 * previous
284 *
285 * @param {Object} options
286 */
287
288 throw new AssertionError({
289 message: 'An assertion error occurred'
290 , actual: actual
291 , expect: expect
292 , startStackFunction: arguments.callee
293 , showStack: true
294 });
295
296 /**
297 * new
298 *
299 * @param {String} message
300 * @param {Object} options
301 * @param {Function} start stack function
302 */
303
304 throw new AssertionError('An assertion error occurred', {
305 actual: actual
306 , expect: expect
307 , showStack: true
308 }, arguments.callee);
309
310 // other signatures
311 throw new AssertionError('An assertion error occurred');
312 throw new AssertionError('An assertion error occurred', null, arguments.callee);
313 ```
314
315 #### External Dependencies
316
317 This is the first non-developement dependency for Chai. As Chai continues to evo lve we will begin adding
318 more; the next will likely be improved type detection and deep equality. With Ch ai's userbase continually growing
319 there is an higher need for accountability and documentation. External dependenc ies will allow us to iterate and
320 test on features independent from our interfaces.
321
322 Note: The browser packaged version `chai.js` will ALWAYS contain all dependencie s needed to run Chai.
323
324 ### Community Contributions
325
326 - [#169](https://github.com/chaijs/chai/pull/169) Fix deep equal comparison for Date/Regexp types. [@katsgeorgeek](https://github.com/katsgeorgeek)
327 - [#171](https://github.com/chaijs/chai/pull/171) Add `assert.notOk()`. [@Bartvd s](https://github.com/Bartvds)
328 - [#173](https://github.com/chaijs/chai/pull/173) Fix `inspect` utility. [@domen ic](https://github.com/domenic)
329
330 Thank you to all who took the time to contribute!
331
332 ## 1.6.1 / 2013-06-05
333
334 The following changes are required if you are upgrading from the previous versio n:
335
336 - **Users:**
337 - No changes required.
338 - **Plugin Developers:**
339 - No changes required.
340 - **Core Contributors:**
341 - Refresh `node_modules` folder for updated developement dependencies.
342
343 ### Deep Equality
344
345 Regular Expressions are now tested as part of all deep equality assertions. In p revious versions
346 they silently passed for all scenarios. Thanks to [@katsgeorgeek](https://github .com/katsgeorgeek) for the contribution.
347
348 ### Community Contributions
349
350 - [#161](https://github.com/chaijs/chai/pull/161) Fix documented name for assert interface's isDefined method. [@brandonpayton](https://github.com/brandonpayton )
351 - [#168](https://github.com/chaijs/chai/pull/168) Fix comparison equality of two regexps for when using deep equality. [@katsgeorgeek](https://github.com/katsge orgeek)
352
353 Thank you to all who took the time to contribute!
354
355 ### Additional Notes
356
357 - Mocha has been locked at version `1.8.x` to ensure `mocha-phantomjs` compatibi lity.
358
359 ## 1.6.0 / 2013-04-29
360
361 The following changes are required if you are upgrading from the previous versio n:
362
363 - **Users:**
364 - No changes required.
365 - **Plugin Developers:**
366 - No changes required.
367 - **Core Contributors:**
368 - Refresh `node_modules` folder for updated developement dependencies.
369
370 ### New Assertions
371
372 #### Array Members Inclusion
373
374 Asserts that the target is a superset of `set`, or that the target and `set` hav e the same members.
375 Order is not taken into account. Thanks to [@NickHeiner](https://github.com/Nick Heiner) for the contribution.
376
377 ```js
378 // (expect/should) full set
379 expect([4, 2]).to.have.members([2, 4]);
380 expect([5, 2]).to.not.have.members([5, 2, 1]);
381
382 // (expect/should) inclusion
383 expect([1, 2, 3]).to.include.members([3, 2]);
384 expect([1, 2, 3]).to.not.include.members([3, 2, 8]);
385
386 // (assert) full set
387 assert.sameMembers([ 1, 2, 3 ], [ 2, 1, 3 ], 'same members');
388
389 // (assert) inclusion
390 assert.includeMembers([ 1, 2, 3 ], [ 2, 1 ], 'include members');
391
392 ```
393
394 #### Non-inclusion for Assert Interface
395
396 Most `assert` functions have a negative version, like `instanceOf()` has a corre sponding `notInstaceOf()`.
397 However `include()` did not have a corresponding `notInclude()`. This has been a dded.
398
399 ```js
400 assert.notInclude([ 1, 2, 3 ], 8);
401 assert.notInclude('foobar', 'baz');
402 ```
403
404 ### Community Contributions
405
406 - [#140](https://github.com/chaijs/chai/pull/140) Restore `call`/`apply` methods for plugin interface. [@RubenVerborgh](https://github.com/RubenVerborgh)
407 - [#148](https://github.com/chaijs/chai/issues/148)/[#153](https://github.com/ch aijs/chai/pull/153) Add `members` and `include.members` assertions. [#NickHeiner ](https://github.com/NickHeiner)
408
409 Thank you to all who took time to contribute!
410
411 ### Other Bug Fixes
412
413 - [#142](https://github.com/chaijs/chai/issues/142) `assert#include` will no lon ger silently pass on wrong-type haystack.
414 - [#158](https://github.com/chaijs/chai/issues/158) `assert#notInclude` has been added.
415 - 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.
416
417 ## 1.5.0 / 2013-02-03
418
419 ### Migration Requirements
420
421 The following changes are required if you are upgrading from the previous versio n:
422
423 - **Users:**
424 - _Update [2013-02-04]:_ Some users may notice a small subset of deep equality assertions will no longer pass. This is the result of
425 [#120](https://github.com/chaijs/chai/issues/120), an improvement to our deep equality algorithm. Users will need to revise their assertions
426 to be more granular should this occur. Further information: [#139](https://git hub.com/chaijs/chai/issues/139).
427 - **Plugin Developers:**
428 - No changes required.
429 - **Core Contributors:**
430 - Refresh `node_modules` folder for updated developement dependencies.
431
432 ### Community Contributions
433
434 - [#126](https://github.com/chaijs/chai/pull/126): Add `eqls` alias for `eql`. [ @RubenVerborgh](https://github.com/RubenVerborgh)
435 - [#127](https://github.com/chaijs/chai/issues/127): Performance refactor for ch ainable methods. [@RubenVerborgh](https://github.com/RubenVerborgh)
436 - [#133](https://github.com/chaijs/chai/pull/133): Assertion `.throw` support fo r primitives. [@RubenVerborgh](https://github.com/RubenVerborgh)
437 - [#137](https://github.com/chaijs/chai/issues/137): Assertion `.throw` support for empty messages. [@timnew](https://github.com/timnew)
438 - [#136](https://github.com/chaijs/chai/pull/136): Fix backward negation message s when using `.above()` and `.below()`. [@whatthejeff](https://github.com/whatth ejeff)
439
440 Thank you to all who took time to contribute!
441
442 ### Other Bug Fixes
443
444 - Improve type detection of `.a()`/`.an()` to work in cross-browser scenarios.
445 - [#116](https://github.com/chaijs/chai/issues/116): `.throw()` has cleaner disp lay of errors when WebKit browsers.
446 - [#120](https://github.com/chaijs/chai/issues/120): `.eql()` now works to compa re dom nodes in browsers.
447
448
449 ### Usage Updates
450
451 #### For Users
452
453 **1. Component Support:** Chai now included the proper configuration to be insta lled as a
454 [component](https://github.com/component/component). Component users are encoura ged to consult
455 [chaijs.com](http://chaijs.com) for the latest version number as using the maste r branch
456 does not gaurantee stability.
457
458 ```js
459 // relevant component.json
460 devDependencies: {
461 "chaijs/chai": "1.5.0"
462 }
463 ```
464
465 Alternatively, bleeding-edge is available:
466
467 $ component install chaijs/chai
468
469 **2. Configurable showDiff:** Some test runners (such as [mocha](http://visionme dia.github.com/mocha/))
470 include support for showing the diff of strings and objects when an equality err or occurs. Chai has
471 already included support for this, however some users may not prefer this displa y behavior. To revert to
472 no diff display, the following configuration is available:
473
474 ```js
475 chai.Assertion.showDiff = false; // diff output disabled
476 chai.Assertion.showDiff = true; // default, diff output enabled
477 ```
478
479 #### For Plugin Developers
480
481 **1. New Utility - type**: The new utility `.type()` is available as a better im plementation of `typeof`
482 that can be used cross-browser. It handles the inconsistencies of Array, `null`, and `undefined` detection.
483
484 - **@param** _{Mixed}_ object to detect type of
485 - **@return** _{String}_ object type
486
487 ```js
488 chai.use(function (c, utils) {
489 // some examples
490 utils.type({}); // 'object'
491 utils.type(null); // `null'
492 utils.type(undefined); // `undefined`
493 utils.type([]); // `array`
494 });
495 ```
496
497 #### For Core Contributors
498
499 **1. Browser Testing**: Browser testing of the `./chai.js` file is now available in the command line
500 via PhantomJS. `make test` and Travis-CI will now also rebuild and test `./chai. js`. Consequently, all
501 pull requests will now be browser tested in this way.
502
503 _Note: Contributors opening pull requests should still NOT include the browser b uild._
504
505 **2. SauceLabs Testing**: Early SauceLab support has been enabled with the file `./support/mocha-cloud.js`.
506 Those interested in trying it out should create a free [Open Sauce](https://sauc elabs.com/signup/plan) account
507 and include their credentials in `./test/auth/sauce.json`.
OLDNEW
« no previous file with comments | « bower_components/chai/README.md ('k') | bower_components/chai/bower.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698