Release 1.9.1

chaijs · Mar 19, 2014 · b7fdf49 · b7fdf49
1 parent 9243632
commit b7fdf49
Show file tree

Hide file tree

Showing 9 changed files with 295 additions and 88 deletions.
diff --git a/History.md b/History.md
@@ -1,4 +1,28 @@
 
+1.9.1 / 2014-03-19 
+==================
+
+  * deps update
+  * util: [getActual] select actual logic now allows undefined for actual. Closes #183
+  * docs: [config] make public, express param type
+  * Merge pull request #251 from romario333/threshold3
+  * Fix issue #166 - configurable threshold in objDisplay.
+  * Move configuration options to config.js.
+  * Merge pull request #233 from Empeeric/master
+  * Merge pull request #244 from leider/fix_for_contains
+  * Merge pull request #247 from didoarellano/typo-fixes
+  * Fix typos
+  * Merge pull request #245 from lfac-pt/patch-1
+  * Update `exports.version` to 1.9.0
+  * aborting loop on finding
+  * declaring variable only once
+  * additional test finds incomplete implementation
+  * simplified code
+  * fixing #239 (without changing chai.js)
+  * ssfi as it should be
+  * Merge pull request #228 from duncanbeevers/deep_members
+  * Deep equality check for collection membership
+
 1.9.0 / 2014-01-29 
 ==================
 

diff --git a/README.md b/README.md
@@ -9,6 +9,14 @@ For more information or to download plugins, view the [documentation](http://cha
 
 [![Selenium Test Status](https://saucelabs.com/browser-matrix/chaijs.svg)](https://saucelabs.com/u/chaijs)
 
+### Plugins
+
+Chai offers a robust Plugin architecture for extending Chai's assertions and interfaces.
+
+- Need a plugin? View the [official plugin list](http://chaijs.com/plugins).
+- Have a plugin and want it listed? Open a Pull Request at [chaijs/chai-docs:plugin.js](https://github.com/chaijs/chai-docs/blob/master/plugins.js#L1-L12). 
+- Want to build a plugin? Read the [plugin api documentation](http://chaijs.com/guide/plugins/).
+
 ### Related Projects
 
 - [chaijs / assertion-error](https://github.com/chaijs/assertion-error): Custom `Error` constructor thrown upon an assertion failing.
@@ -17,44 +25,49 @@ For more information or to download plugins, view the [documentation](http://cha
 ### Contributors
 
      project  : chai
-     repo age : 2 years, 2 months ago
-     commits  : 735
-     active   : 158 days
-     files    : 56
+     repo age : 2 years, 3 months ago
+     commits  : 756
+     active   : 170 days
+     files    : 57
      authors  :
-       532  Jake Luer               72.4%
-        79  Veselin Todorov         10.7%
-        43  Domenic Denicola        5.9%
+       540  Jake Luer               71.4%
+        79  Veselin Todorov         10.4%
+        43  Domenic Denicola        5.7%
          6  Ruben Verborgh          0.8%
          5  George Kats             0.7%
          5  Jo Liss                 0.7%
          5  Juliusz Gonera          0.7%
          5  Scott Nonnenberg        0.7%
+         5  leider                  0.7%
          4  John Firebaugh          0.5%
          4  Max Edmands             0.5%
          4  Nick Heiner             0.5%
          4  josher19                0.5%
          3  Andrei Neculau          0.4%
+         3  Duncan Beevers          0.4%
          3  Jake Rosoman            0.4%
          3  Jeff Barczewski         0.4%
          3  Ryunosuke SATO          0.4%
+         3  Veselin                 0.4%
          2  Bartvds                 0.3%
-         2  Duncan Beevers          0.3%
          2  Edwin Shao              0.3%
          2  Jakub Nešetřil          0.3%
+         2  Roman Masek             0.3%
          2  Teddy Cross             0.3%
          1  Anand Patil             0.1%
          1  Benjamin Horsleben      0.1%
          1  Brandon Payton          0.1%
          1  Chris Connelly          0.1%
          1  Chun-Yi                 0.1%
          1  DD                      0.1%
+         1  Dido Arellano           0.1%
          1  Jeff Welch              0.1%
          1  Kilian Ciuffolo         0.1%
+         1  Luís Cardoso            0.1%
          1  Niklas Närhinen         0.1%
          1  Paul Miller             0.1%
+         1  Refael Ackermann        0.1%
          1  Sasha Koss              0.1%
-         1  Veselin                 0.1%
          1  Victor Costan           0.1%
          1  Vinay Pulim             0.1%
          1  Virginie BARDALES       0.1%

diff --git a/ReleaseNotes.md b/ReleaseNotes.md
@@ -1,5 +1,89 @@
 # Release Notes
 
+## 1.9.1 / 2014-03-19 
+
+The following changes are required if you are upgrading from the previous version:
+
+- **Users:**
+  - Migrate configuration options to new interface. (see notes)
+- **Plugin Developers:** 
+  - No changes required
+- **Core Contributors:** 
+  - Refresh `node_modules` folder for updated dependencies. 
+
+### Configuration
+
+There have been requests for changes and additions to the configuration mechanisms
+and their impact in the Chai architecture. As such, we have decoupled the 
+configuration from the `Assertion` constructor. This not only allows for centralized
+configuration, but will allow us to shift the responsibility from the `Assertion` 
+constructor to the `assert` interface in future releases.
+
+These changes have been implemented in a non-breaking way, but a depretiation
+warning will be presented to users until they migrate. The old config method will 
+be removed in either `v1.11.0` or `v2.0.0`, whichever comes first.
+
+#### Quick Migration
+
+```js
+// change this:
+chai.Assertion.includeStack = true;
+chai.Assertion.showDiff = false;
+
+// ... to this:
+chai.config.includeStack = true;
+chai.config.showDiff = false;
+```
+
+#### All Config Options
+
+##### config.includeStack
+
+- **@param** _{Boolean}_
+- **@default** `false`
+
+User configurable property, influences whether stack trace is included in 
+Assertion error message. Default of `false` suppresses stack trace in the error 
+message.
+
+##### config.showDiff
+
+- **@param** _{Boolean}_
+- **@default** `true`
+
+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.
+
+##### config.truncateThreshold **(NEW)**
+
+- **@param** _{Number}_
+- **@default** `40`
+
+User configurable property, sets length threshold for actual and expected values 
+in assertion errors. If this threshold is exceeded, the value is truncated.
+
+Set it to zero if you want to disable truncating altogether.
+
+```js
+chai.config.truncateThreshold = 0; // disable truncating
+```
+
+### Community Contributions
+
+- [#228](https://github.com/chaijs/chai/pull/228) Deep equality check for memebers. [@duncanbeevers](https://github.com/duncanbeevers)
+- [#247](https://github.com/chaijs/chai/pull/247) Proofreading. [@didorellano](https://github.com/didoarellano)
+- [#244](https://github.com/chaijs/chai/pull/244) Fix `contain`/`include` 1.9.0 regression. [@leider](https://github.com/leider)
+- [#233](https://github.com/chaijs/chai/pull/233) Improvements to `ssfi` for `assert` interface. [@refack](https://github.com/refack)
+- [#251](https://github.com/chaijs/chai/pull/251) New config option: object display threshold. [@romario333](https://github.com/romario333)
+
+Thank you to all who took time to contribute!
+
+### Other Bug Fixes
+
+- [#183](https://github.com/chaijs/chai/issues/183) Allow `undefined` for actual. (internal api)
+- Update Karam(+plugins)/Istanbul to most recent versions.
+
 ## 1.9.0 / 2014-01-29 
 
 The following changes are required if you are upgrading from the previous version:

diff --git a/bower.json b/bower.json
@@ -1,6 +1,6 @@
 {
     "name": "chai"
-  , "version": "1.9.0"
+  , "version": "1.9.1"
   , "description": "BDD/TDD assertion library for node.js and the browser. Test framework agnostic."
   , "license": "MIT"
   , "keywords": [