Merge pull request #5 from jacobwg/update-for-mongoose-3.6

Update for Mongoose 3.6

Author: Samuel Reed

.gitignore

@@ -0,0 +1,16 @@
+coverage
+lib-cov
+*.seed
+*.log
+*.csv
+*.dat
+*.out
+*.pid
+*.gz
+
+pids
+logs
+results
+
+npm-debug.log
+node_modules

README.md

@@ -47,7 +47,8 @@ UserSchema.plugin(filter, {
   },
   // 'nofilter' is a built-in filter that does no processing, be careful with this
   defaultFilterRole: 'nofilter',
-  sanitize: true // Escape HTML in strings
+  sanitize: true, // Escape HTML in strings
+  compat: true // Enable compatibility for Mongoose versions prior to 3.6 (default false)
 });
 ```
 
@@ -84,6 +85,7 @@ User.findById(req.params.id, function(err, user){
                                  Useful for protected attributes like fb.accessToken.
 - `defaultFilterRole` (String)(default: 'nofilter'):   Profile to use when one is not given, or the given profile does not exist.
 - `sanitize` (Boolean)(default: false):           True to automatically escape HTML in strings.
+- `compat` (Boolean)(default: false):             True to enable compatibility with Mongoose versions prior to 3.6
 
 ### Statics
 

lib/denormalize.js

@@ -11,7 +11,7 @@
 *
 * Example Usage:
 *
-* var denormalize = require('mongoose-denormalize-plugin');
+* var denormalize = require('mongoose-filter-denormalize').denormalize;
 * var ObjectId = mongoose.Schema.ObjectId;
 * var UserSchema = new Mongoose.schema({
 *   name            :   String,
@@ -38,7 +38,7 @@
 */
 
 var mongoose    = require('mongoose'),
-    _           = require('underscore');
+    _           = require('lodash');
 
 module.exports = function denormalize(schema, options) {
     if(!options) options = {};
@@ -128,4 +128,4 @@ module.exports = function denormalize(schema, options) {
         });
         return ret;
     }
-};
+};

lib/filter.js

@@ -35,7 +35,7 @@
 * ----- Environment: -----
 * -----              -----
 *
-* var filter = require('mongoose-filter-plugin');
+* var filter = require('mongoose-filter-denormalize').filter;
 * var ObjectId = mongoose.Schema.ObjectId;
 * var UserSchema = new Mongoose.schema({
 *   name            :   String,
@@ -89,21 +89,24 @@
 */
 
 var mongoose    = require('mongoose'),
-    _           = require('underscore'),
+    _           = require('lodash'),
     sanitizer   = require('sanitizer');
 
 module.exports = function filter(schema, options) {
 
     var defaults = {
         sanitize: false, // escapes HTML
-        defaultFilterRole : 'nofilter'
+        defaultFilterRole : 'nofilter',
+        compat: false
     };
 
     options = _.extend(defaults, options);
 
     schema.statics.getReadFilterKeys = function(filterRole){
         var filters = this._getFilterKeys("readFilter", filterRole);
-        return filters ? filters.concat('_id') : filters; // Always send _id property
+        filters = filters ? filters.concat('_id') : filters; // Always send _id property
+        if (options.compat) return filters;
+        else return filters.join(' ');
     };
 
     schema.statics.getWriteFilterKeys = function(filterRole){
@@ -246,4 +249,4 @@ module.exports = function filter(schema, options) {
         return obj;
     }
 
-};
+};

package.json

@@ -1,13 +1,14 @@
-{ "name": "mongoose-filter-denormalize",
+{
+  "name": "mongoose-filter-denormalize",
   "version": "0.2.0",
   "description": "Simple collection filtering and denormalization.",
   "author": "Samuel Reed <[email protected]",
   "main": "index",
   "tags": "mongoose filter plugin",
-  "repository" : "git://github.com/STRML/mongoose-filter-denormalize",
-  "dependencies"    : {
-        "mongoose"        : "~3.0",
-        "sanitizer"       : "~0.0.15",
-        "underscore"      : "~1.3.1"
+  "repository": "git://github.com/STRML/mongoose-filter-denormalize",
+  "dependencies": {
+    "lodash": "~2.2.0",
+    "mongoose": "~3.6.0",
+    "sanitizer": "~0.1.0"
   }
 }