Deprecate 'ignore' option in favor of blacklist

Author: Hans Kristian Flaatten

README.md

@@ -9,7 +9,7 @@ useful when building an API and accepting various user specificed queries.
 ## Features
 
 * Aliased query parameters
-* Ignored query parameters
+* Blacklisted query parameters
 * Basic operators
   * `$ne`
   * `$gt`
@@ -37,7 +37,7 @@ var MongoQS = require('mongo-querystring');
 
 * `Array` ops - list of supported operators
 * `object` alias - query param aliases
-* `object` ignore - ignored query params
+* `object` blacklist - blacklisted query params
 * `object` custom - custom query params
 
 #### Bult in custom queries

package.json

@@ -41,5 +41,8 @@
   "devDependencies": {
     "coffee-script": "^1.8.0",
     "mocha": "^1.21.4"
+  },
+  "dependencies": {
+    "depd": "1.0.0"
   }
 }

src/index.litcoffee

@@ -1,7 +1,11 @@
     module.exports = MongoQS = (opts) ->
+      if opts?.ignore
+        deprecate.property opts, 'ignore'
+        opts.blacklist = opts.ignore
+
       @ops = opts?.ops or ['!', '^', '$', '~', '>', '<']
       @alias = opts?.alias or {}
-      @ignore = opts?.ignore or {}
+      @blacklist = opts?.blacklist or {}
       @custom = opts?.custom or {}
 
       for param, field of @custom
@@ -79,7 +83,7 @@ Main query param parser method which follows the following order of operations.
       res = {}
 
       for key, val of query
-        continue if @ignore[key]
+        continue if @blacklist[key]
         continue if typeof val isnt 'string'
         continue if not /^[a-zæøå0-9-_.]+$/i.test key
 
@@ -122,3 +126,5 @@ instanciating `MongoQS` and the defaults are `!`, `^`, `$`, `~`, `>`, and `<`.
 
       res
 
+    deprecate = require('depd')('mongo-querystring')
+

test/suite.coffee

@@ -146,13 +146,13 @@ describe 'parse()', ->
       qs = new MongoQS alias: foo: 'bar', baz: 'bax'
       assert.deepEqual qs.parse({foo: 'bix', baz: 'box'}), bar: 'bix', bax: 'box'
 
-  describe 'ignoring', ->
-    it 'should ignore key', ->
-      qs = new MongoQS ignore: foo: true
+  describe 'blacklisting', ->
+    it 'should blacklist key', ->
+      qs = new MongoQS blacklist: foo: true
       assert.deepEqual qs.parse({foo: 'bar', bar: 'foo'}), bar: 'foo'
 
-    it 'should ingore multiple keys', ->
-      qs = new MongoQS ignore: foo: true, bar: true
+    it 'should blacklist multiple keys', ->
+      qs = new MongoQS blacklist: foo: true, bar: true
       assert.deepEqual qs.parse({foo: 'bar', bar: 'foo', baz: 'bax'}), baz: 'bax'
 
   describe 'custom', ->