ember-cli-custom-assertions-collection - npm Package Compare versions

Comparing version 0.1.0 to 0.2.1

CHANGELOG.md

@@ -9,4 +9,33 @@ # Change Log
 
-## [0.0.1] - 2015-09-22
 
+
+## [0.2.1] - 2015-09-23
+
+### Changed
+- `numbersAlmostEqual` accepts an optional precision value, 6 by default.
+
+### Refactored
+- Message generatino is extracted into a reusable helper.
+
+## Documentation
+- Added a link for the Travis badge.
+
+
+
+
+## [0.2.0] - 2015-09-23
+
+### Added
+- `numbersAlmostEqual`
+
+### Documentation
+- Added Travis badge.
+- Formatting.
+- Fixed method footprints.
+- Added code examples.
+- Fixed version numbers in Changelog.
+
+
+
+## [0.1.0] - 2015-09-22
 Initial release.
@@ -13,0 +42,0 @@

package.json

 {
   "name": "ember-cli-custom-assertions-collection",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "The default blueprint for ember-cli addons.",
@@ -5,0 +5,0 @@ "directories": {

README.md

@@ -0,1 +1,3 @@
+[![travis](https://travis-ci.org/lolmaus/ember-cli-custom-assertions-collection.svg)](https://travis-ci.org/lolmaus/ember-cli-custom-assertions-collection)
+
 # ember-cli-custom-assertions-collection
@@ -44,20 +46,53 @@
 
-### `isFalse( obj[, message] )`
+#### `isFalse( obj [, message] )`
 
 Checks if `obj` is exactly `false`.
 
+```js
+assert.isFalse( false )   // pass
+assert.isFalse( 1 === 2 ) // pass
+assert.isFalse( null )    // fail
+```
 
 
-### `arraysSameMembers( arr1, arr2, [, message] )`
 
+#### `arraysSameMembers( arr1, arr2 [, message] )`
+
 Checks if both arrays have identical content, in any order. Members are compared via `===`.
 
+```js
+assert.arraysSameMembers( ['foo', 'bar'], ['bar', 'foo'] ) // pass
+assert.arraysSameMembers( ['foo', 'bar'], ['bar', 'baz'] ) // fail
+assert.arraysSameMembers( ['foo', 'bar'], ['bar']        ) // fail
+```
 
+#### `arraysSameMembersOrdered( arr1, arr2 [, message] )`
 
-### `arraysSameMembersOrdered( arr1, arr2, [, message] )`
-
 Checks if both arrays identical content, in identical order. Members are compared via `===`.
 
+```js
+assert.arraysSameMembersOrdered( ['foo', 'bar'], ['foo', 'bar'] ) // pass
+assert.arraysSameMembersOrdered( ['foo', 'bar'], ['bar', 'foo'] ) // fail
+assert.arraysSameMembersOrdered( ['foo', 'bar'], ['bar', 'baz'] ) // fail
+assert.arraysSameMembersOrdered( ['foo', 'bar'], ['bar']        ) // fail
+```
 
 
+#### `numbersAlmostEqual( number1, number2 [, precision = 6] [, message] )`
+
+You know how `1 - 0.9 === 0.1` is `false` in JS? That's because in JS float-point operations aren't precise.
+
+Use this to compare them loosely:
+
+```js
+assert.numbersAlmostEqual( 1 - 0.9, 1                     ) // pass
+assert.numbersAlmostEqual( 1 - 1/3, 2/3                   ) // pass
+assert.numbersAlmostEqual( 1,       0.00001               ) // fail
+assert.numbersAlmostEqual( 1,       0.00001, precision: 4 ) // pass
+```
+
+This assertion uses a method [suggested](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/EPSILON#Testing_equality) by MDN. Not sure whether it'll work correctly every time.
+
+
+
 ## Plans
@@ -64,0 +99,0 @@

test-support/assertions/arrays-same-members-ordered.js

 import _ from 'npm:lodash';
+import assertionMessage from '../helpers/assertion-message';
 
@@ -9,5 +10,5 @@ export default function arraysSameMembers(context, actual, expected, message = "") {
 
-  const finalMessage = `${message.length ? `${message}: ` : ''}Expected to have same members.`
+  const finalMessage = assertionMessage("Expected to have same members.", message);
 
   this.push(result, actual, expected, finalMessage);
 }

test-support/assertions/arrays-same-members.js

 import _ from 'npm:lodash';
+import assertionMessage from '../helpers/assertion-message';
 
@@ -9,5 +10,5 @@ export default function arraysSameMembers(context, actual, expected, message = "") {
 
-  const finalMessage = `${message.length ? `${message}: ` : ''}Expected to have same members.`;
+  const finalMessage = assertionMessage("Expected to have same members.", message);
 
   this.push(result, actual, expected, finalMessage);
 }

test-support/assertions/is-false.js

@@ -0,5 +1,7 @@
+import assertionMessage from '../helpers/assertion-message';
+
 export default function isFalse(context, testee, message = "") {
   const result       = testee === false;
-  const finalMessage = (message.length ? message + ": " : '') + "Expected to be false.";
+  const finalMessage = assertionMessage("Expected to be false.", message);
   this.push(result, testee, false, finalMessage);
 }

No alert changes

Improved metrics

Total package byte prevSize

73925

increased by28.5%

Number of package files

26

increased by8.33%

Lines of code

84

increased by29.23%

Number of lines in readme file

110

increased by46.67%

No dependency changes