Add support for custom properties in types, closes #32 and closes #36

Author: drudge

.travis.yml

@@ -10,3 +10,4 @@ node_js:
   - "iojs"
 services:
   - mongodb
+  - elasticsearch

index.js

@@ -5,29 +5,39 @@
  * MIT Licensed
  */
 
+var defaults = require('defaults');
+
 function timestampsPlugin(schema, options) {
     var updatedAt = 'updatedAt';
     var createdAt = 'createdAt';
-    var updatedAtType = Date;
-    var createdAtType = Date;
-    
+    var updatedAtOpts = Date;
+    var createdAtOpts = Date;
+    var dataObj = {};
+
     if (typeof options === 'object') {
-	if (typeof options.updatedAt === 'string') {
-	    updatedAt = options.updatedAt;
-	} else if (typeof options.updatedAt === 'object') {
-	    updatedAt = options.updatedAt.name || updatedAt;
-	    updatedAtType = options.updatedAt.type || updatedAtType;
-	}
-	if (typeof options.createdAt === 'string') {
-	    createdAt = options.createdAt;
-	} else if (typeof options.createdAt === 'object') {
-	    createdAt = options.createdAt.name || createdAt;
-	    createdAtType = options.createdAt.type || createdAtType;
-	}
+        if (typeof options.updatedAt === 'string') {
+           updatedAt = options.updatedAt;
+        } else if (typeof options.updatedAt === 'object') {
+            updatedAtOpts = defaults(options.updatedAt, {
+                name: updatedAt,
+                type: Date
+            });
+            updatedAt = updatedAtOpts.name;
+        }
+
+        if (typeof options.createdAt === 'string') {
+            createdAt = options.createdAt;
+        } else if (typeof options.createdAt === 'object') {
+            createdAtOpts = defaults(options.createdAt, {
+                name: createdAt,
+                type: Date
+            });
+            createdAt = createdAtOpts.name;
+        }
     }
 
-    var dataObj = {};
-    dataObj[updatedAt] = updatedAtType;
+    dataObj[updatedAt] = updatedAtOpts;
+
     if (schema.path(createdAt)) {
 	schema.add(dataObj);
 	schema.virtual(createdAt)
@@ -43,9 +53,9 @@ function timestampsPlugin(schema, options) {
 	    }
 	    next();
 	});
-	
+
     } else {
-	dataObj[createdAt] = createdAtType;
+	dataObj[createdAt] = createdAtOpts;
 	schema.add(dataObj);
 	schema.pre('save', function (next) {
 	    if (!this[createdAt]) {
@@ -56,7 +66,7 @@ function timestampsPlugin(schema, options) {
 	    next();
 	});
     }
-    
+
     schema.pre('findOneAndUpdate', function (next) {
 	if (this.op === 'findOneAndUpdate') {
 	    this._update = this._update || {};

package.json

@@ -1,7 +1,7 @@
 {
   "name": "mongoose-timestamp",
   "description": "Mongoose plugin that adds createdAt and updatedAt auto-assigned date properties",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "author": "Nicholas Penree <[email protected]>",
   "keywords": [
     "mongodb",
@@ -16,15 +16,20 @@
     "url": "git://github.com/drudge/mongoose-timestamp"
   },
   "devDependencies": {
-    "mongoose": "~4.0.1",
-    "should": "~3.2.0",
-    "mocha": "~1.18.2"
+    "mocha": "~2.5.3",
+    "mongoosastic": "^4.0.2",
+    "mongoose": "~4.5.3",
+    "request": "^2.72.0",
+    "should": "~9.0.2"
   },
   "scripts": {
     "test": "mocha -u bdd -R spec -c ./test/*test.js"
   },
   "license": "MIT",
   "engine": {
     "node": ">= 0.6"
+  },
+  "dependencies": {
+    "defaults": "^1.0.3"
   }
 }

test/custom_names_types_options_test.js

@@ -0,0 +1,75 @@
+
+/**
+ * @list dependencies
+ **/
+
+var mocha = require('mocha');
+var should = require('should');
+var mongoose = require('mongoose');
+var Schema = mongoose.Schema;
+var timestamps = require('../');
+var request = require('request');
+var mongoosastic = require('mongoosastic');
+
+mongoose = mongoose.createConnection('mongodb://localhost/mongoose_timestamps')
+mongoose.on('error', function (err) {
+        console.error('MongoDB error: ' + err.message);
+        console.error('Make sure a mongoDB server is running and accessible by this application')
+});
+
+var opts = {
+	createdAt: {
+		name: 'customNameCreatedAt',
+		type: String,
+		index: true
+	},
+	updatedAt: {
+		name: 'customNameUpdatedAt',
+		type: String,
+		es_indexed: true
+	}
+};
+
+var CustomizedTypeOptionsTimeCopSchema = new Schema({
+	email: String
+});
+
+CustomizedTypeOptionsTimeCopSchema.plugin(timestamps, opts);
+CustomizedTypeOptionsTimeCopSchema.plugin(mongoosastic);
+
+var CustomizedTypeOptionsTimeCop = mongoose.model('CustomizedTypeOptionsTimeCop', CustomizedTypeOptionsTimeCopSchema);
+
+describe('timestamps custom names and types with options', function() {
+	it('should create an index when passed in the createdAt options', function(done) {
+		CustomizedTypeOptionsTimeCop.collection.getIndexes(function(err, res) {
+			var idx = res[opts.createdAt.name + '_1'];
+			idx.should.be.an.Array().with.length(1);
+			var comp = idx[0];
+			comp.should.be.an.Array().with.length(2);
+			comp[0].should.equal(opts.createdAt.name);
+			done();
+		});
+	});
+
+	it('should create an elastic search index when passed es_indexed = true', function(done) {
+		var customCop = new CustomizedTypeOptionsTimeCop({email: '[email protected]'});
+		customCop.save(function (err) {
+			request({
+				url: 'http://127.0.0.1:9200/customizedtypeoptionstimecops',
+				json: true
+			}, function(err, res, body) {
+				if (err) return done(err);
+				body.should.have.a.property('customizedtypeoptionstimecops');
+				body.customizedtypeoptionstimecops.should.have.a.property('mappings');
+				body.customizedtypeoptionstimecops.mappings.should.have.a.property('customizedtypeoptionstimecop');
+				body.customizedtypeoptionstimecops.mappings.customizedtypeoptionstimecop.should.have.a.property('properties');
+				body.customizedtypeoptionstimecops.mappings.customizedtypeoptionstimecop.properties.should.have.a.property(opts.updatedAt.name);
+				done();
+			});
+		});
+	});
+
+	after(function() {
+		mongoose.close();
+	});
+});

test/sub_document_test.js

@@ -9,6 +9,8 @@ var mongoose = require('mongoose');
 var Schema = mongoose.Schema;
 var timestamps = require('../');
 
+mongoose.Promise = global.Promise || mongoose.Promise;
+
 mongoose = mongoose.createConnection('mongodb://localhost/mongoose_timestamps')
 mongoose.on('error', function (err) {
         console.error('MongoDB error: ' + err.message);
@@ -43,7 +45,7 @@ describe('sub document timestamps', function() {
       done();
     });
   });
-  
+
   it('should not have updatedAt change if parent was updated but not sub document', function(done) {
     TimeCopWithSubDocs.findOne({email: '[email protected]'}, function (err, found) {
       found.email = '[email protected]';