Features/add ignore case enhancement

lib/chai-sorted.js

@@ -2,8 +2,16 @@
 var isSorted = require('./is.sorted')
 
 var chaiIsSorted = function (chai, array, options) {
+  options = options === undefined ? {} : options
+
   var useDescendingOrder = typeof options === 'object' ? !!options.descending : false
 
+  if (options.ignoreCase) {
+    return array.map(function (item) {
+      return typeof item === 'string' ? item.toUpperCase() : item
+    })
+  }
+
   // Backwards compatibility
   if (typeof options === 'boolean') {
     useDescendingOrder = options
@@ -32,24 +40,28 @@ module.exports = function (chai, utils) {
     chaiIsSorted.call(this, chai, this._obj)
   })
 
+  utils.addProperty(chai.Assertion.prototype, 'ignoreCase', function () {
+    chaiIsSorted.call(this, chai, this._obj, { ignoreCase: true })
+  })
+
   chai.Assertion.addMethod('sortedBy', function (key, options) {
     var array = utils.flag(this, 'object').map(function (item) {
       return item[key]
     })
     chaiIsSorted.call(this, chai, array, options)
   })
 
-  chai.Assertion.addMethod('descendingBy', function (key) {
+  chai.Assertion.addMethod('descendingBy', function (key, options) {
     var array = utils.flag(this, 'object').map(function (item) {
       return item[key]
     })
-    chaiIsSorted.call(this, chai, array, { descending: true })
+    chaiIsSorted.call(this, chai, array, Object.assign({descending: true}, options))
   })
 
-  chai.Assertion.addMethod('ascendingBy', function (key) {
+  chai.Assertion.addMethod('ascendingBy', function (key, options) {
     var array = utils.flag(this, 'object').map(function (item) {
       return item[key]
     })
-    chaiIsSorted.call(this, chai, array)
+    chaiIsSorted.call(this, chai, array, options)
   })
 }

readme.md

@@ -69,6 +69,12 @@ Test for descending sort order of array by `name` attribute
 expect([{id:2,name:"bat"},{id:3,name:"apples"}]).to.be.sortedBy("name", {descending: true})
 ```
 
+Test for sort order of array by `name` attribute ignoring case
+
+```javascript
+expect([{id:2,name:"bat"},{id:3,name:"Apples"}]).to.be.sortedBy("name", {ignoreCase: true})
+```
+
 ### `.ascendingBy` method
 Alternate of `sortedBy` but more explicit
 
@@ -78,6 +84,12 @@ Test for ascending sort order of array by `name` attribute
 expect([{id:2,name:"apple"},{id:3,name:"bat"}]).to.be.ascendingBy("name")
 ```
 
+Test for ascending sort order of array by `name` attribute ignoring case
+
+```javascript
+expect([{id:2,name:"apple"},{id:3,name:"Bat"}]).to.be.ascendingBy("name", {ignoreCase: true})
+```
+
 ### `.descendingBy` method
 Alternate of `sortedBy` but does not require passing `true` as a second parameter to `sortedBy`. It is the same as doing `sortBy("name",true)`
 

test/chai-sorted.js

@@ -132,3 +132,39 @@ describe('to.be.ascendingBy(property)', function () {
     expect([{id: 1, name: 'a'}, {id: 34, name: 'boy'}, {id: 3, name: 'c'}, {size: 'large', name: 'cat'}]).to.be.ascendingBy('name')
   })
 })
+
+describe('to.be.sortedBy({ignoreCase: true})', function () {
+  it('key id of numbers', function () {
+    expect([{id: 1}, {id: 2}, {id: 3}]).to.be.sortedBy('id', {ignoreCase: true})
+  })
+  it('key id of strings', function () {
+    expect([{id: 'a'}, {id: 'B'}, {id: 'c'}]).to.be.sortedBy('id', {ignoreCase: true})
+  })
+  it('key name of words and letters', function () {
+    expect([{id: 1, name: 'a'}, {id: 34, name: 'Boy'}, {id: 3, name: 'c'}, {size: 'large', name: 'cat'}]).to.be.sortedBy('name', {ignoreCase: true})
+  })
+})
+
+describe('to.be.ascendingBy({ignoreCase: true})', function () {
+  it('key id of numbers', function () {
+    expect([{id: 1}, {id: 2}, {id: 3}]).to.be.ascendingBy('id', {ignoreCase: true})
+  })
+  it('key id of strings', function () {
+    expect([{id: 'a'}, {id: 'B'}, {id: 'c'}]).to.be.ascendingBy('id', {ignoreCase: true})
+  })
+  it('key name of words and letters', function () {
+    expect([{id: 1, name: 'a'}, {id: 34, name: 'Boy'}, {id: 3, name: 'c'}, {size: 'large', name: 'cat'}]).to.be.ascendingBy('name', {ignoreCase: true})
+  })
+})
+
+describe('to.be.descendingBy({ignoreCase: true})', function () {
+  it('key id of numbers', function () {
+    expect([{id: 3}, {id: 2}, {id: 1}]).to.be.descendingBy('id', {ignoreCase: true})
+  })
+  it('key id of strings', function () {
+    expect([{id: 'c'}, {id: 'B'}, {id: 'a'}]).to.be.descendingBy('id', {ignoreCase: true})
+  })
+  it('key name of words and letters', function () {
+    expect([{id: 1, name: 'cat'}, {id: 34, name: 'C'}, {id: 3, name: 'boy'}, {size: 'large', name: 'b'}]).to.be.descendingBy('name', {ignoreCase: true})
+  })
+})