Merge pull request #3 from Turistforeningen/feat/in-operator

Add supoort for $in and $nin operators

Author: Starefossen

README.md

@@ -15,11 +15,14 @@ useful when building an API and accepting various user specificed queries.
 * Blacklisted query parameters
 * Whitelisted query parameters
 * Basic operators
-  * `$ne`
+  * `$eq`
   * `$gt`
   * `$lt`
-  * `$regex`
+  * `$ne`
+  * `$in`
+  * `$nin`
   * `$exists`
+  * `$regex`
 
 | operation | query string  | query object |
 |-----------|---------------|--------------|
@@ -32,6 +35,8 @@ useful when building an API and accepting various user specificed queries.
 | starts with | `?foo=^bar` | `{ foo: { $regex: "^foo", $options: "i" }}` |
 | ends with | `?foo=$bar`   | `{ foo: { $regex: "foo$", $options: "i" }}` |
 | contains  | `?foo=~bar`   | `{ foo: { $regex: "foo", $options: "i" }}` |
+| in array  | `?foo[]=bar&foo[]=baz` | `{ foo: { $in: ['bar', 'baz'] }}` |
+| not in array | `?foo[]=!bar&foo[]=!baz` | `{ foo: { $nin: ['bar', 'baz'] }}` |
 
 * Geospatial operators
   * `$geoWithin` (polygon)

index.js

@@ -4,12 +4,15 @@
 module.exports = function MongoQS(opts) {
   opts = opts || {};
 
-  this.ops = opts.ops || ['!', '^', '$', '~', '>', '<'];
+  this.ops = opts.ops || ['!', '^', '$', '~', '>', '<', '$in'];
   this.alias = opts.alias || {};
   this.blacklist = opts.blacklist || {};
   this.whitelist = opts.whitelist || {};
   this.custom = opts.custom || {};
 
+  this.keyRegex = opts.keyRegex || /^[a-zæøå0-9-_.]+$/i;
+  this.arrRegex = opts.arrRegex || /^[a-zæøå0-9-_.]+\[\]$/i;
+
   for (var param in this.custom) {
     switch (param) {
       case 'bbox':
@@ -104,24 +107,55 @@ module.exports.prototype.parse = function(query) {
   for (var key in query) {
     val = query[key];
 
+    // whitelist
     if (Object.keys(this.whitelist).length && !this.whitelist[key]) {
       continue;
     }
 
+    // blacklist
     if (this.blacklist[key]) {
       continue;
     }
 
-    if (typeof val !== 'string') {
+    // alias
+    if (this.alias[key]) {
+      key = this.alias[key];
+    }
+
+    // string key
+    if (typeof val === 'string' && !this.keyRegex.test(key)) {
       continue;
     }
 
-    if (!/^[a-zæøå0-9-_.]+$/i.test(key)) {
+    // array key
+    if (val instanceof Array && this.arrRegex.test(key)) {
+      if (this.ops.indexOf('$in') >= 0) {
+        key = key.substr(0, key.length-2);
+
+        // $in query
+        if (val[0][0] !== '!') {
+          res[key] = {$in: val.filter(function(element) {
+            return element[0] !== '!';
+          }).map(function(element) {
+            return isNaN(element) ? element : parseFloat(element, 10);
+          })};
+
+        // $nin query
+        } else {
+          res[key] = {$nin: val.filter(function(element) {
+            return element[0] === '!';
+          }).map(function(element) {
+            element = element.substr(1);
+            return isNaN(element) ? element : parseFloat(element, 10);
+          })};
+        }
+      }
+
       continue;
     }
 
-    if (this.alias[key]) {
-      key = this.alias[key];
+    if (typeof val !== 'string') {
+      continue;
     }
 
     if (typeof this.custom[key] === 'function') {

test.js

@@ -287,22 +287,69 @@ describe('parse()', function() {
       });
     });
 
-    it('returns multiple querys', function() {
-      query = qs.parse({
-        foo: '',
-        bar: '!foo',
-        '%foo': 'bar',
-        'bix.bax': 'that',
-        'foo-bar': 'bar-foo'
+    describe('$in / $nin operator', function() {
+      it('returns in array query', function() {
+        var string = 'foo[]=10&foo[]=10.011&foo[]=bar';
+        var params = require('querystring').parse(string);
+
+        assert.deepEqual(qs.parse(params), {
+          foo: {
+            $in: [10, 10.011, 'bar']
+          }
+        });
       });
 
-      assert.deepEqual(query, {
-        foo: {
-          $exists: true
-        },
-        bar: {
-          $ne: 'foo'
-        },
+      it('returns in array without any not in array query', function() {
+        var string = 'foo[]=10&foo[]=!10.011&foo[]=!bar&foo[]=baz';
+        var params = require('querystring').parse(string);
+
+        assert.deepEqual(qs.parse(params), {
+          foo: {
+            $in: [10, 'baz']
+          }
+        });
+      });
+
+      it('returns not in array query', function() {
+        var string = 'foo[]=!10&foo[]=!10.011&foo[]=!bar';
+        var params = require('querystring').parse(string);
+
+        assert.deepEqual(qs.parse(params), {
+          foo: {
+            $nin: [10, 10.011, 'bar']
+          }
+        });
+      });
+
+      it('returns not in array without any in array query', function() {
+        var string = 'foo[]=!10&foo[]=10.011&foo[]=bar&foo[]=!baz';
+        var params = require('querystring').parse(string);
+
+        assert.deepEqual(qs.parse(params), {
+          foo: {
+            $nin: [10, 'baz']
+          }
+        });
+      });
+    });
+
+    it('returns multiple querys', function() {
+      var string = [
+        'foo=',
+        'bar=!',
+        'baz=!foo',
+        'bix=bez',
+        '%foo=bar',
+        'bix.bax=that',
+        'foo-bar=bar-foo'
+      ].join('&&');
+      var params = require('querystring').parse(string);
+
+      assert.deepEqual(qs.parse(params), {
+        foo: { $exists: true },
+        bar: { $exists: false },
+        baz: { $ne: 'foo' },
+        bix: 'bez',
         'bix.bax': 'that',
         'foo-bar': 'bar-foo'
       });