Merge pull request #4 from angelxmoreno/development

v1.0.0 is ready

Author: angelxmoreno

.gitignore

@@ -25,3 +25,4 @@ build/Release
 # Dependency directory
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
+test/database.sqlite

README.md

@@ -60,9 +60,9 @@ errors: ...
 
 #### sequelize.validateIsUnique(`table field`, `optional error message`)
 
-When using `sequelize.validateIsUnique()` the first parameter must the the field to do the check on. Notice that `isUnique: sequelize.validateIsUnique('email')` is going to check for the `email` field on the table with the value of `User.email`. Based on the previous example, the query it performed was something like this ( depending on your database):
-```sql
-SELECT count(*) AS `count` FROM `users` AS `User` WHERE `User`.`email` = 'bob2@jones.com');
+When using `sequelize.validateIsUnique()` the first parameter must the the field to do the check on. For example, `isUnique: sequelize.validateIsUnique('email')`. In order for the validation to pass for an existing instance, the primary keys for that instance will be used to exclude values for that instance. Based on the previous example, the query it performed was something like this ( depending on your database):
+```
+SELECT count(*) AS `count` FROM `users` AS `User` WHERE `User`.`email` = 'jdoe@example.com' AND `User `.`id`  IS NOT NULL;
 ```
 
 The second parameter allows you to define a custom error message. The default error message is: `'{{field}} must be unique'`. Using our previous example we could do something like this: 
@@ -84,11 +84,14 @@ var User = sequelize.define('User', {
 ## Branch Strategy
 The master branch will be the stable branch. Please submit your PRs against the development branch. Once tests are created for v1.0.0 I will be moving development to master.
 
-## Issues
-If you discover a bug, please create a ticket on Github. https://github.com/angelxmoreno/sequelize-isunique-validator/issues
+## Testing
+```
+npm test
+```
 
-### Kown Issues
-There aren't any tests! I will be writing tests after further testing, oh and after I finish learning how to test, obviously :stuck_out_tongue_winking_eye:
+## Issues
+If you discover a bug, please create a ticket on Github. 
+[https://github.com/angelxmoreno/sequelize-isunique-validator/issues](https://github.com/angelxmoreno/sequelize-isunique-validator/issues)
 
 ## Contribution
 Pull requests are always welcomed. This is my first module contributed to the NodeJS ecosystem. I'm sure there are a few things that could be improved. Please point them out, provide feedback and suggestions. I am all ears!

lib/index.js

@@ -0,0 +1,28 @@
+/* global module */
+
+'use strict';
+var validateIsUnique = function (col, msg) {
+    var conditions = {where: {}};
+    msg = (!msg) ? col + ' must be unique' : msg;
+    return function (value, next) {
+        var self = this;
+        this.Model.describe().then(function (schema) {
+            conditions.where[col] = value;
+            Object.keys(schema).filter(function (field) {
+                return schema[field].primaryKey;
+            }).forEach(function (pk) {
+                conditions.where[pk] = {$ne: self[pk]};
+            });
+        }).then(function () {
+            return self.Model.count(conditions).then(function (found) {
+                return (found !== 0) ? next(msg) : next();
+            });
+        }).catch(next);
+    };
+};
+
+module.exports = function (Sequelize) {
+    Sequelize = !Sequelize ? require('sequelize') : Sequelize;
+    Sequelize.prototype.validateIsUnique = validateIsUnique;
+    return Sequelize;
+};

package.json

@@ -0,0 +1,34 @@
+{
+    "name": "sequelize-isunique-validator",
+    "version": "1.0.0",
+    "description": "A Sequelize plugin to add isUnique validation to models",
+    "main": "./lib/",
+    "scripts": {
+        "test": "mocha"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/angelxmoreno/sequelize-isunique-validator.git"
+    },
+    "keywords": [
+        "Sequelize",
+        "validation",
+        "models"
+    ],
+    "author": {
+        "name": "Agel S. Moreno",
+        "email": "angelxmoreno@gmail.com",
+        "url": "https://angelxmoreno.github.io/"
+    },
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/angelxmoreno/sequelize-isunique-validator/issues"
+    },
+    "homepage": "https://github.com/angelxmoreno/sequelize-isunique-validator#readme",
+    "dependencies": {
+        "sqlite3": "^3.1.0"
+    },
+    "peerDependencies": {
+        "sequelize": "2.0.0 - 3.x.x"
+    }
+}

test/isuniqueValidatorSpec.js

@@ -0,0 +1,107 @@
+/* global require */
+
+var expect = require('chai').expect;
+var Sequelize = require('sequelize');
+require('../lib')(Sequelize);
+var db = new Sequelize('database', 'username', 'password', {
+    dialect: 'sqlite',
+    storage: './test/database.sqlite',
+    logging: false
+});
+var UserModel;
+var isuniqueUsernameMsg = 'Please choose a different username';
+var dataset = {
+    user1: {
+        name: 'John Doe',
+        email: 'jdoe@example.com',
+        username: 'jdoe'
+    },
+    user2: {
+        name: 'Jane Doe',
+        email: 'jdoe@example.com',
+        username: 'jdoe1'
+    },
+    user3: {
+        name: 'Jack Does',
+        email: 'jackdoes@example.com',
+        username: 'jdoe'
+    }
+};
+var initModel = function (done) {
+    UserModel = db.define('UserModel', {
+        name: Sequelize.STRING,
+        email: {
+            type: Sequelize.STRING,
+            validate: {
+                isUnique: db.validateIsUnique('email')
+            }
+        },
+        username: {
+            type: Sequelize.STRING,
+            validate: {
+                isUnique: db.validateIsUnique('username', isuniqueUsernameMsg)
+            }
+        }
+    });
+
+    UserModel.sync({force: true}).then(function () {
+        done();
+    }).catch(done);
+};
+
+describe('Is Unique Validator', function () {
+    before('Creating db instance', function (done) {
+        return initModel(done);
+    });
+
+    describe('#init()', function () {
+        it('should add the `validateIsUnique` function to the sequelize object', function () {
+            expect(db.validateIsUnique).to.be.a('function');
+        });
+    });
+
+    describe('usage', function () {
+        it('should work ok when no duplicate fields are found', function (done) {
+            UserModel.create(dataset.user1).then(function (user) {
+                expect(user.name).to.equal(dataset.user1.name);
+                expect(user.email).to.equal(dataset.user1.email);
+                expect(user.username).to.equal(dataset.user1.username);
+                done();
+            }).catch(done);
+        });
+
+        it('should use the default error message when no message string is given', function (done) {
+            UserModel.create(dataset.user2).then(function (user) {
+                expect(user).to.be.null;
+            }).catch(function (err) {
+                expect(err.message).to.equal('Validation error: email must be unique');
+            }).finally(function () {
+                done();
+            });
+        });
+
+        it('should use the provided error message when a message string is given', function (done) {
+            UserModel.create(dataset.user3).then(function (user) {
+                expect(user).to.be.null;
+            }).catch(function (err) {
+                expect(err.message).to.equal('Validation error: ' + isuniqueUsernameMsg);
+            }).finally(function () {
+                done();
+            });
+        });
+        
+        it('should allow an instance to be saved when it is the only row holding the unique value', function (done) {
+            UserModel.findOne({
+                where: {
+                    email: dataset.user1.email
+                }
+            }).then(function (user) {
+                user.name += ' II';
+                user.validate().then(function(err){
+                    expect(err).to.be.a('undefined');
+                    done();
+                });
+            }).catch(done);
+        });
+    });
+});