Add distinct method to the list of supported methods #149

Author: dsanel

README.md

@@ -244,7 +244,7 @@ We have the option to override all standard methods or only specific methods. Ov
 | aggregate()                | aggregateDeleted                   | aggregateWithDeleted                   |
 | findById()                 | Please use findOne                 | Please use findOneWithDeleted          |
 | findByIdAndUpdate()        | Please use findOneAndUpdateDeleted | Please use findOneAndUpdateWithDeleted |
-
+| distinct()                 | distinctDeleted                    | distinctWithDeleted                    |
 
 ### Examples how to override one or multiple methods
 

index.js

@@ -121,7 +121,7 @@ module.exports = function (schema, options) {
 
     if (options.overrideMethods) {
         var overrideItems = options.overrideMethods;
-        var overridableMethods = ['count', 'countDocuments', 'find', 'findOne', 'findOneAndUpdate', 'update', 'updateOne', 'updateMany', 'aggregate'];
+        var overridableMethods = ['count', 'countDocuments', 'find', 'findOne', 'findOneAndUpdate', 'update', 'updateOne', 'updateMany', 'aggregate', 'distinct'];
         var finalList = [];
 
         if ((typeof overrideItems === 'string' || overrideItems instanceof String) && overrideItems === 'all') {
@@ -159,7 +159,7 @@ module.exports = function (schema, options) {
         }
 
         finalList.forEach(function(method) {
-            if (['count', 'countDocuments', 'find', 'findOne'].indexOf(method) > -1) {
+            if (['count', 'countDocuments', 'find', 'findOne', 'distinct'].indexOf(method) > -1) {
                 var modelMethodName = method;
 
                 schema.statics[method] = function () {

test/index.js

@@ -831,6 +831,15 @@ describe("check not overridden static methods", function () {
             should.not.exist(err);
         }
     });
+
+    it("distinct() -> should return 3 documents", async function () {
+        try {
+            const doc = await TestModel.distinct('name');
+            doc.should.have.members(['Obi-Wan Kenobi', 'Darth Vader', 'Luke Skywalker']);
+        } catch (err) {
+            should.not.exist(err);
+        }
+    });
 });
 
 describe("check overridden static methods: { overrideMethods: 'all' }", function () {
@@ -1166,6 +1175,33 @@ describe("check overridden static methods: { overrideMethods: 'all' }", function
             should.not.exist(err);
         }
     });
+
+    it("distinct() -> should return 1 documents", async function () {
+        try {
+            const doc = await TestModel.distinct('name');
+            doc.should.have.members(['Darth Vader']);
+        } catch (err) {
+            should.not.exist(err);
+        }
+    });
+
+    it("distinctDeleted() -> should return 2 documents", async function () {
+        try {
+            const doc = await TestModel.distinctDeleted('name');
+            doc.should.have.members(['Obi-Wan Kenobi', 'Luke Skywalker']);
+        } catch (err) {
+            should.not.exist(err);
+        }
+    });
+
+    it("distinctWithDeleted() -> should return 3 documents", async function () {
+        try {
+            const doc = await TestModel.distinctWithDeleted('name');
+            doc.should.have.members(['Obi-Wan Kenobi', 'Darth Vader', 'Luke Skywalker']);
+        } catch (err) {
+            should.not.exist(err);
+        }
+    });
 });
 
 describe("check the existence of override static methods: { overrideMethods: true }", function () {
@@ -1270,9 +1306,9 @@ describe("check the existence of override static methods: { overrideMethods: tru
     });
 });
 
-describe("check the existence of override static methods: { overrideMethods: ['testError', 'count', 'countDocuments', 'find', 'findOne', 'findOneAndUpdate', 'update', 'updateOne', 'updateMany'] }", function () {
+describe("check the existence of override static methods: { overrideMethods: ['testError', 'count', 'countDocuments', 'find', 'findOne', 'findOneAndUpdate', 'update', 'updateOne', 'updateMany', 'distinct'] }", function () {
     var TestSchema = new Schema({name: String}, {collection: 'mongoose_delete_test'});
-    TestSchema.plugin(mongoose_delete, {overrideMethods: ['testError', 'count', 'countDocuments', 'find', 'findOne', 'findOneAndUpdate', 'update', 'updateOne', 'updateMany']});
+    TestSchema.plugin(mongoose_delete, {overrideMethods: ['testError', 'count', 'countDocuments', 'find', 'findOne', 'findOneAndUpdate', 'update', 'updateOne', 'updateMany', 'distinct']});
     var TestModel = mongoose.model('Test7', TestSchema);
 
     it("testError() -> method should not exist", function () {
@@ -1374,6 +1410,18 @@ describe("check the existence of override static methods: { overrideMethods: ['t
     it("updateManyWithDeleted() -> method should exist", function () {
         expect(TestModel.updateManyWithDeleted).to.exist;
     });
+
+    it("distinct() => method should exist", function () {
+        expect(TestModel.distinct).to.exist;
+    });
+
+    it("distinctDeleted() => method should exist", function () {
+        expect(TestModel.distinctDeleted).to.exist;
+    });
+
+    it("distinctWithDeleted() => method should exist", function () {
+        expect(TestModel.distinctWithDeleted).to.exist;
+    });
 });
 
 describe("check the existence of override static methods: { overrideMethods: ['count', 'countDocuments', 'find'] }", function () {