Major refactoring, including support for mongoose 4.x (#13)

major refactoring including several fixes and more tests

* Update package.json
* fixes against latest mongoose.
* This drops `Model.Query` api because it seems to be internally used by mongoose. Use `Model.query` instead.
* split module to smaller parts
* add parseQuery tests
* add more promise supports (flat)
* several fixes popups during parseQuery tests, e.g. date parsing
* moving to ES6 age.. - require node.js 6.x .
* update documentation

Author: jupe

README.md

@@ -5,14 +5,21 @@ mongoose-query [![Build Status](https://travis-ci.org/jupe/mongoose-query.png?br
 
 [![NPM](https://nodei.co/npm-dl/mongoose-query.png)](https://nodei.co/npm/mongoose-query/)
 
-mongoose query creator. Alternative for mongoose-api-query but without schema understanding.
-This very simple library can be used for example expressjs+mongoose applications to help 
-construct mongoose query model directly from url parameters.
+This library is usefull example with `expressjs` + `mongoose` applications to help construct mongoose query model directly from url parameters. Example:
 
-## History
+```
+http://localhost/model?q={"group":"users"}&f=name&sk=1&l=5&p=name
+```
+Converted to:
+```
+model.find({group: "users"}).select("name").skip(1).limit(5).populate('name')
+```
+
+## Changes log
 
 |versio|Changes|
 |------|-------|
+|0.3.0|Big refactoring, see more from release note.. e.g. mongoose 4.x support|
 |0.2.1|added oid support, fixed aggregate and support mongoose => 3.8.1
 |0.2.0|replace underscore with lodash, possible to return promise when no callback in use|
 |0.1.7|typo on mapReduce case, !empty keyword added|
@@ -42,32 +49,37 @@ module.exports = function query(req, res) {
 }
 ```
 
-## Query string example
+## doc
 
 ```
-http://localhost/query.json?q={"group":"users"}&f=name&sk=1&l=5&p=name
-
-Converted to:
-
-model.find({group: "users"}).select("name").skip(1).limit(5).populate('name')
+var QueryPlugin = require(mongoose-query);
+schema.plugin( QueryPlugin(, <options>) )
 ```
+optional `options`:
+* `logger`: custom logger, e.g. winston logger, default: "dummy logger"
+* `allowEval`: <boolean> Allow to use eval or not, default: true
 
-**note:** Seems that sorting with limit doesn't work with mongodb 2.4.x without related indexes. Mongodb 2.6.x seems to work.
+Model static methods:
 
+`model.query( <query>(, <callback>) )`
 
-## doc
+`model.leanQuery(<query>(, <callback>) )`: gives plain objects ([lean](http://mongoosejs.com/docs/api.html#query_Query-lean))
+
+**Note:** without `<callback>` you get Promise.
 
+**URL API:**
 ```
-http://www.myserver.com/query?[q=<query>][&t=<type>][&f=<fields>][&s=<order>][&sk=<skip>][&l=<limit>][&p=<populate>][&fl=<boolean>][&map=<mapFunction>][&reduce=<reduceFunction>]
+http://www.myserver.com/query?[q=<query>][&t=<type>][&f=<fields>][&s=<order>][&sk=<skip>]
+[&l=<limit>][&p=<populate>][&fl=<boolean>][&map=<mapFunction>][&reduce=<reduceFunction>]
 
 q=<query>                   restrict results by the specified JSON query
                             regex e.g. q='{"field":{"$regex":"/mygrep/", "$options":"i"}}'
 t=<type>                    find|findOne|count|aggregate|distinct|aggregate|mapReduce
-f=<set of fields>           specify the set of fields to include or exclude in each document 
+f=<set of fields>           specify the set of fields to include or exclude in each document
                             (1 - include; 0 - exclude)
-s=<sort order>              specify the order in which to sort each specified field 
+s=<sort order>              specify the order in which to sort each specified field
                             (1- ascending; -1 - descending), JSON
-sk=<num results to skip>    specify the number of results to skip in the result set; 
+sk=<num results to skip>    specify the number of results to skip in the result set;
                             useful for paging
 l=<limit>                   specify the limit for the number of results (default is 1000)
 p=<populate>                specify the fields for populate, also more complex json object is supported.
@@ -83,23 +95,23 @@ Special values:
 "oid:<string>"              string is converted to ObjectId
 { $regex: /<string>/,       regex match with optional regex options
  ($options: "") }        
-  
+
 Alternative search conditions:
 "key={in}a,b"               At least one of these is in array
 "key={nin}a,b"              Any of these values is not in array
 "key={all}a,b"              All of these contains in array
-"key={empty}-"              Field is empty or not exists
-"key={!empty}-"             Field exists and is not empty
+"key={empty}"               Field is empty or not exists
+"key={!empty}"              Field exists and is not empty
 "key={mod}a,b"              Docs where key mod a is b
 "key={gt}a"                 Docs key is greater than a
 "key={lt}a"                 Docs key is lower than a
 "key=a|b|c"                 Docs where type of key is Array and contains at least one of given value
+```
 
-Results:
-
-fl=false 
+Results with `fl=false`:
+```
 [
- { 
+ {
  	nest: {
  		ed: {
  			data: 'value',
@@ -108,14 +120,12 @@ fl=false
   	}
 }
 ]
+```
 
-fl=true
+Results with `fl=true`:
+```
 [
  {'nest.ed.data': 'value',
   'nest.ed.data2':'value'},
 ]
 ```
-
-
-
-