Merge pull request freewil#4 from freewil/async

add custom asyncronous validator support

Author: freewil

.travis.yml

@@ -1,5 +1,4 @@
 language: node_js
 node_js:
-  - 0.4
-  - 0.6
-  - 0.8
+  - "0.8"
+  - "0.10"

README.md

@@ -320,7 +320,7 @@ Use "%s" in the message to have the field name or label printed in the message:
         
         field("sport", "favorite sport").custom(function(value, source) {
           if (!source.country) {
-            throw new error('unable to validate %s');
+            throw new Error('unable to validate %s');
           }
           
           switch (source.country) {
@@ -338,6 +338,15 @@ Use "%s" in the message to have the field name or label printed in the message:
           }
           
         });
+        
+        Asynchronous custom validator (3 argument function signature)
+        
+        form.field('username').custom(function(value, source, callback) {
+          username.check(value, function(err) {
+            if (err) return callback(new Error('Invalid %s'));
+            callback(null);
+          });
+        });
 
 
 ### http.ServerRequest.prototype.form

lib/field.js

@@ -4,6 +4,7 @@ var validator = require("validator")
   , externalFilter = new validator.Filter()
   , externalValidator = new validator.Validator()
   , object = require("object-additions").object
+  , async = require("async")
   , utils = require("./utils");
 
 function Field(property, label) {
@@ -24,7 +25,7 @@ function Field(property, label) {
     return this;
   };
 
-  this.run = function (source, form, options) {
+  this.run = function (source, form, options, cb) {
     var self = this
       , errors = []
       , value = utils.getProp(property, form) || utils.getProp(property, source);
@@ -38,36 +39,62 @@ function Field(property, label) {
       });
     }
 
-    function runStack(foo) {
+    function runStack(foo, cb) {
 
-      stack.forEach(function (proc) {
-        var result = proc(foo, source); // Pass source for "equals" proc.
-        if (result.valid) return;
+      async.eachSeries(stack, function(proc, cb) {
+        
+        if (proc.length == 3) {
+          // run the async validator/filter
+          return proc(foo, source, function(err, result) {
+            if (err) {
+              errors.push(err.message.replace("%s", fieldLabel));
+              return cb(null);
+            }
+            
+            // filters return values
+            if (result != null) {
+              foo = result
+            }
+            
+            cb(null);
+            
+          });
+        }
+        
+        // run the sync validator/filter
+        var result = proc(foo, source);
+        if (result.valid) return cb(null);
         if (result.error) {
           // If this field is not required and it doesn't have a value, ignore error.
-          if (!utils.hasValue(value) && !self.__required) return;
+          if (!utils.hasValue(value) && !self.__required) return cb(null);
 
-          return errors.push(result.error.replace("%s", fieldLabel));
+          errors.push(result.error.replace("%s", fieldLabel));
+          return cb(null);
         }
         foo = result;
+        cb(null);
+        
+      }, function(err) {
+        cb(null, foo);
       });
-      
-      return foo;  
     }
 
     if (isArray) {
       if (!utils.hasValue(value)) value = [];
       if (!Array.isArray(value)) value = [value];
-      value = value.map(runStack);
+      async.mapSeries(value, runStack, function(err, value) {
+        utils.setProp(property, form, value);
+        cb(null, errors);
+      });
+      
 
     } else {
       if (Array.isArray(value)) value = value[0];
-      value = runStack(value);
+      runStack(value, function(err, value) {
+        utils.setProp(property, form, value);
+        cb(null, errors);
+      });
     }
-    
-    utils.setProp(property, form, value);
-    
-    if (errors.length) return errors;
   };
 }
 
@@ -92,7 +119,25 @@ Field.prototype.arrLength = function (from, to) {
 // HYBRID METHODS
 
 Field.prototype.custom = function(func, message) {
+  
+  // custom function is async
+  if (func.length == 3) {
+    return this.add(function(value, source, cb) {
+      func(value, source, function(err, result) {
+        if (err) return cb(new Error(message || err.message || "%s is invalid"));
+        
+        // functions that return values are filters
+        if (result != null) return cb(null, result);
+        
+        // value passed validator
+        cb(null, null);
+      });
+    });
+  }
+  
+  // custom function is sync
   return this.add(function (value, source) {
+    
     try {
       var result = func(value, source);
     } catch (e) {
@@ -101,7 +146,9 @@ Field.prototype.custom = function(func, message) {
     // Functions that return values are filters.
     if (result != null) return result;
 
+    // value passed validator
     return { valid: true };
+    
   });
 };
 

lib/form.js

@@ -4,7 +4,8 @@
  * MIT Licensed
  */
 
-var utils = require("./utils")
+var async = require("async")
+  , utils = require("./utils")
   , Field = require("./field");
 
 function form() {
@@ -82,25 +83,32 @@ function form() {
       }
     });
 
-    routines.forEach(function (routine) {
-      var result = routine.run(mergedSource, req.form, options);
-      
-      if (!Array.isArray(result) || !result.length) return;
+    //routines.forEach(function (routine) {
+    async.each(routines, function(routine, cb) {
+      routine.run(mergedSource, req.form, options, function(err, result) {
+        
+        // return early if no errors
+        if (!Array.isArray(result) || !result.length) return cb(null);
 
-      var errors = req.form.errors = req.form.errors || []
-        , name = routine.name;
+        var errors = req.form.errors = req.form.errors || []
+          , name = routine.name;
 
-      map[name] = map[name] || [];
+        map[name] = map[name] || [];
 
-      result.forEach(function (error) {
-        errors.push(error);
-        map[name].push(error);
+        result.forEach(function (error) {
+          errors.push(error);
+          map[name].push(error);
+        });
+        
+        cb(null);
+        
       });
+    }, function(err) {
+      
+      if (options.flashErrors) req.form.flashErrors();
+      if (next) next();
+      
     });
-    
-    if (options.flashErrors) req.form.flashErrors();
-    
-    if (next) next();
   }
 }
 

package.json

@@ -21,24 +21,26 @@
   ],
   "dependencies": {
     "validator": "0.4.x",
-    "object-additions": ">= 0.5.0"
+    "object-additions": ">= 0.5.0",
+    "async": "~0.2.9"
   },
   "peerDependencies": {
     "express": "3.x"
   },
   "devDependencies": {
-    "expresso": "~0.9.2",
-    "express": "3.x"
+    "mocha": "~1.13.0",
+    "express": "3.x",
+    "request": "~2.27.0"
   },
   "main": "index",
   "bugs": {
     "url": "http://github.com/freewil/express-form/issues"
   },
   "scripts": {
-    "test": "expresso"
+    "test": "mocha"
   },
   "engines": {
-    "node": ">=0.4.0"
+    "node": ">=0.8.0"
   },
   "licenses": [
     {

test/express.test.js

@@ -4,6 +4,7 @@ var assert = require("assert"),
     validate = form.validate,
     express = require("express"),
     http = require("http"),
+    request = require("request"),
     app = express();
 
 http.createServer(app).listen(3000);
@@ -16,13 +17,12 @@ app.close = function() {
   process.exit(0);
 };
 
-
 app.configure(function() {
   app.use(express.bodyParser());
 });
 
 module.exports = {
-  'express : middleware : valid-form': function() {
+  'express : middleware : valid-form': function(done) {
     app.post(
       '/user',
       form(
@@ -38,23 +38,24 @@ module.exports = {
         assert.strictEqual(req.form.errors.length, 0);
         res.send(JSON.stringify(req.form));
       }
-    );    
-
-    assert.response(app,
-      {
-        url: '/user',
-        method: 'POST',
-        body: JSON.stringify({
-          username: "   dandean   \n\n\t",
-          password: " 12345 "
-        }),
-        headers: { 'Content-Type': 'application/json' }
-      },
-      { status: 200 }
     );
+    
+    request.post({
+      url: 'http://localhost:3000/user',
+      method: 'POST',
+      body: JSON.stringify({
+        username: "   dandean   \n\n\t",
+        password: " 12345 "
+      }),
+      headers: { 'Content-Type': 'application/json' }
+    }, function(err, res, body) {
+      assert.ifError(err);
+      assert.strictEqual(res.statusCode, 200);
+      done();
+    });
   },
 
-  'express : middleware : merged-data': function() {
+  'express : middleware : merged-data': function(done) {
     app.post(
       '/user/:id',
       form(
@@ -75,21 +76,22 @@ module.exports = {
 
         res.send(JSON.stringify(req.form));
       }
-    );    
-
-    assert.response(app,
-      {
-        url: '/user/5?stuff=things&id=overridden',
-        method: 'POST',
-        body: JSON.stringify({
-          id: "overridden by url param",
-          stuff: "overridden by query param",
-          rad: "cool"
-        }),
-        headers: { 'Content-Type': 'application/json' }
-      },
-      { status: 200 }
     );
+    
+    request({
+      url: 'http://localhost:3000/user/5?stuff=things&id=overridden',
+      method: 'POST',
+      body: JSON.stringify({
+        id: "overridden by url param",
+        stuff: "overridden by query param",
+        rad: "cool"
+      }),
+      headers: { 'Content-Type': 'application/json' }
+    }, function(err, res, body) {
+      assert.ifError(err);
+      assert.strictEqual(res.statusCode, 200);
+      done();
+    });
   }
 
 

test/mocha.opts

@@ -0,0 +1 @@
+--ui exports