Merge pull request #54 from dsanel/ver-0-5-0

Ver 0.5.0

Author: dsanel

.travis.yml

@@ -1,7 +1,6 @@
 language: node_js
-node_js:
- - 0.12
+node_js: [10, 9, 8, 7, 6, 5, 4]
 services:
  - mongodb
 script: "npm run-script test-travis"
-after_script: "npm install coveralls@2.11.6 && cat ./coverage/lcov.info | coveralls"
+after_script: "npm install coveralls@3.0.2 && cat ./coverage/lcov.info | coveralls"

CHANGELOG.md

@@ -1,3 +1,14 @@
+## [v0.5.0]
+> December 10, 2018
+
+- Add support to mongoose 5.x (@joelmukuthu, @gforge)
+- Add `deleteById` static method #16
+- Add `countDocuments` method with related override methods (only for v5 Mongoose) #45
+- Upgrade all `devDependencies` to latest versions
+- Setup `.travis.yml` to test plugin on Node: 10, 9, 8, 7, 6, 5, 4
+- Setup `.travis.yml` to use `coveralls@3.0.2`
+- Add additional tests
+
 ## [v0.4.0]
 > July 10, 2016
 

README.md

@@ -8,12 +8,13 @@ mongoose-delete is simple and lightweight plugin that enables soft deletion of d
 
 ## Features
  - [Add __delete()__ method on document (do not override standard __remove()__ method)](#simple-usage)
+ - [Add __deleteById()__ static method](#simple-usage)
  - [Add __deleted__ (true-false) key on document](#simple-usage)
  - [Add __deletedAt__ key to store time of deletion](#save-time-of-deletion)
  - [Add __deletedBy__ key to record who deleted document](#who-has-deleted-the-data)
  - Restore deleted documents using __restore__ method
  - [Bulk delete and restore](#bulk-delete-and-restore)
- - [Option to override static methods](#examples-how-to-override-one-or-multiple-methods) (__count, find, findOne, findOneAndUpdate, update__)
+ - [Option to override static methods](#examples-how-to-override-one-or-multiple-methods) (__count, countDocuments, find, findOne, findOneAndUpdate, update__)
  - [For overridden methods we have two additional methods](#method-overridden): __methodDeleted__ and __methodWithDeleted__
  - [Disable model validation on delete](#disable-model-validation-on-delete)
  - [Option to create index on delete fields](#create-index-on-fields) (__deleted__, __deletedAt__, __deletedBy__)
@@ -55,6 +56,14 @@ fluffy.save(function () {
  });
 
 });
+
+var examplePetId = mongoose.Types.ObjectId("53da93b16b4a6670076b16bf");
+
+// INFO: Example usage of deleteById static method
+Pet.deleteById(examplePetId, function (err, petDocument) {
+ // mongodb: { deleted: true, name: 'Fluffy', _id: '53da93b1...' }
+});
+
 ```
 
 
@@ -187,7 +196,7 @@ PetSchema.plugin(mongoose_delete, { overrideMethods: true });
 // Overide only specific methods
 PetSchema.plugin(mongoose_delete, { overrideMethods: ['count', 'find', 'findOne', 'findOneAndUpdate', 'update'] });
 // or
-PetSchema.plugin(mongoose_delete, { overrideMethods: ['count', 'find'] });
+PetSchema.plugin(mongoose_delete, { overrideMethods: ['count', 'countDocuments', 'find'] });
 // or (unrecognized method names will be ignored)
 PetSchema.plugin(mongoose_delete, { overrideMethods: ['count', 'find', 'errorXyz'] });
 

index.js

@@ -101,7 +101,7 @@ module.exports = function (schema, options) {
 
  if (options.overrideMethods) {
  var overrideItems = options.overrideMethods;
- var overridableMethods = ['count', 'find', 'findOne', 'findOneAndUpdate', 'update'];
+ var overridableMethods = ['count', 'countDocuments', 'find', 'findOne', 'findOneAndUpdate', 'update'];
  var finalList = [];
 
  if ((typeof overrideItems === 'string' || overrideItems instanceof String) && overrideItems === 'all') {
@@ -121,15 +121,23 @@ module.exports = function (schema, options) {
  }
 
  finalList.forEach(function(method) {
- if (method === 'count' || method === 'find' || method === 'findOne') {
+ if (['count', 'countDocuments', 'find', 'findOne'].indexOf(method) > -1) {
+ var modelMethodName = method;
+
+ // countDocuments do not exist in Mongoose v4
+ /* istanbul ignore next */
+ if (method === 'countDocuments' && typeof Model.countDocuments !== 'function') {
+ modelMethodName = 'count';
+ }
+
  schema.statics[method] = function () {
- return Model[method].apply(this, arguments).where('deleted').ne(true);
+ return Model[modelMethodName].apply(this, arguments).where('deleted').ne(true);
  };
  schema.statics[method + 'Deleted'] = function () {
- return Model[method].apply(this, arguments).where('deleted').ne(false);
+ return Model[modelMethodName].apply(this, arguments).where('deleted').ne(false);
  };
  schema.statics[method + 'WithDeleted'] = function () {
- return Model[method].apply(this, arguments);
+ return Model[modelMethodName].apply(this, arguments);
  };
  } else {
  schema.statics[method] = function () {
@@ -208,6 +216,19 @@ module.exports = function (schema, options) {
  }
  };
 
+ schema.statics.deleteById = function (id, deletedBy, callback) {
+ if (arguments.length === 0 || typeof id === 'function') {
+ var msg = 'First argument is mandatory and must not be a function.';
+ throw new TypeError(msg);
+ }
+
+ var conditions = {
+ _id: id
+ };
+
+ return this.delete(conditions, deletedBy, callback);
+ };
+
  schema.methods.restore = function (callback) {
  this.deleted = false;
  this.deletedAt = undefined;