Prefer function to method as type identifier.

Closes #47.

Author: tmpfs

EXAMPLE.md

@@ -251,7 +251,7 @@ schema.validate(source, function(err, res) {
 // validate a field length
 var Schema = require('async-validate')
   , descriptor = {
-      func: {type: 'method', required: true, len: 1}
+      func: {type: 'function', required: true, len: 1}
     }
   , source = {func: function noop(){}}
   , schema;
@@ -276,7 +276,7 @@ schema.validate(source, function(err, res) {
 // validate a field has a maximum length
 var Schema = require('async-validate')
   , descriptor = {
-      func: {type: 'method', required: true, max: 1}
+      func: {type: 'function', required: true, max: 1}
     }
   , source = {func: function noop(foo, bar){}}
   , schema;
@@ -427,7 +427,7 @@ schema.validate(source, function(err, res) {
 // validate a field has a minimum length
 var Schema = require('async-validate')
   , descriptor = {
-      func: {type: 'method', required: true, min: 1}
+      func: {type: 'function', required: true, min: 1}
     }
   , source = {func: function noop(){}}
   , schema;
@@ -584,7 +584,7 @@ schema.validate(source, function(err, res) {
 // validate a field has a length within a range
 var Schema = require('async-validate')
   , descriptor = {
-      func: {type: 'method', required: true, min: 1, max: 2}
+      func: {type: 'function', required: true, min: 1, max: 2}
     }
   , source = {func: function noop(foo, bar, qux){}}
   , schema;
@@ -701,7 +701,7 @@ schema.validate(source, opts, function(err, res) {
 ```
 
 ```
-[ { [Error: email: could not resolve dns for domain 1442394138490.com] field: 'email' } ]
+[ { [Error: email: could not resolve dns for domain 1442468604548.com] field: 'email' } ]
 ```
 
 #### type
@@ -761,4 +761,5 @@ Generated by [mdp(1)](https://github.com/freeformsystems/mdp).
 [mdp]: https://github.com/freeformsystems/mdp
 [browserify]: http://browserify.org/
 [jshint]: http://jshint.com/
+[jscs]: http://jscs.info/
 [zephyr]: https://github.com/socialally/zephyr

README.md

@@ -312,7 +312,7 @@ Recognised type values are:
 * `string`: Must be of type `string`.
 * `number`: Must be of type `number`.
 * `boolean`: Must be of type `boolean`.
-* `method`: Must be of type `function`.
+* `function`: Must be of type `function`.
 * `null`: Must strictly equal `null`.
 * `regexp`: Must be an instance of `RegExp` or a valid string regexp.
 * `integer`: Must be of type `number` and an integer.

doc/example/len.js

@@ -1,7 +1,7 @@
 // validate a field length
 var Schema = require('../..')
   , descriptor = {
-      func: {type: 'method', required: true, len: 1}
+      func: {type: 'function', required: true, len: 1}
     }
   , source = {func: function noop(){}}
   , schema;

doc/example/max.js

@@ -1,7 +1,7 @@
 // validate a field has a maximum length
 var Schema = require('../..')
   , descriptor = {
-      func: {type: 'method', required: true, max: 1}
+      func: {type: 'function', required: true, max: 1}
     }
   , source = {func: function noop(foo, bar){}}
   , schema;

doc/example/min.js

@@ -1,7 +1,7 @@
 // validate a field has a minimum length
 var Schema = require('../..')
   , descriptor = {
-      func: {type: 'method', required: true, min: 1}
+      func: {type: 'function', required: true, min: 1}
     }
   , source = {func: function noop(){}}
   , schema;

doc/example/range.js

@@ -1,7 +1,7 @@
 // validate a field has a length within a range
 var Schema = require('../..')
   , descriptor = {
-      func: {type: 'method', required: true, min: 1, max: 2}
+      func: {type: 'function', required: true, min: 1, max: 2}
     }
   , source = {func: function noop(foo, bar, qux){}}
   , schema;

doc/readme/guide.md

@@ -196,7 +196,7 @@ Recognised type values are:
 * `string`: Must be of type `string`.
 * `number`: Must be of type `number`.
 * `boolean`: Must be of type `boolean`.
-* `method`: Must be of type `function`.
+* `function`: Must be of type `function`.
 * `null`: Must strictly equal `null`.
 * `regexp`: Must be an instance of `RegExp` or a valid string regexp.
 * `integer`: Must be of type `number` and an integer.

messages.js

@@ -14,7 +14,7 @@ var messages = {
   types: {
     string: '%s is not a %s',
     null: '%s is not %s',
-    method: '%s is not a %s',
+    function: '%s is not a %s',
     instance: '%s is not an instance of %s',
     array: '%s is not an %s',
     object: '%s is not an %s',

plugin/all.js

@@ -6,7 +6,7 @@ rule.plugin([
   require('./enum'),
   require('./float'),
   require('./integer'),
-  require('./method'),
+  require('./function'),
   require('./null'),
   require('./number'),
   require('./object'),

plugin/method.js renamed to plugin/function.js

@@ -5,7 +5,7 @@ module.exports = function() {
    *
    *  @param cb The callback function.
    */
-  this.main.method = function method(cb) {
+  this.main.function = function method(cb) {
     if(this.validates()) {
       this.required();
       this.type();

plugin/util/type.js

@@ -77,7 +77,7 @@ module.exports = function() {
         this.type();
       }
 
-      invalid = (this.errors.length - length) === types.length;
+      invalid = (this.errors.length - length) === list.length;
       // remove raised errors
       this.errors = this.errors.slice(0, length);
 
@@ -87,7 +87,7 @@ module.exports = function() {
           this.reasons.type,
           this.messages.types.multiple,
           this.field,
-          types.map(function(type) {
+          list.map(function(type) {
             if(typeof(type) === 'function') {
               return type.name || 'function (anonymous)';
             }

test/spec/method.js

@@ -4,21 +4,21 @@ var expect = require('chai').expect
 describe('async-validate:', function() {
 
   var descriptor = {
-    mock: {type: 'method'},
+    mock: {type: 'function'},
   }
 
   it('should error on value that is not a function', function(done) {
     var schema = new Schema(descriptor);
     schema.validate({mock: 80}, function(err, res) {
       expect(res.errors.length).to.eql(1);
-      expect(res.errors[0].message).to.eql('mock is not a method');
+      expect(res.errors[0].message).to.eql('mock is not a function');
       done();
     });
   });
 
   it('should error on invalid arity (len: 1)', function(done) {
     var descriptor = {
-      mock: {type: 'method', len: 1},
+      mock: {type: 'function', len: 1},
     }
     var schema = new Schema(descriptor);
     schema.validate({mock: function(){}}, function(err, res) {
@@ -32,7 +32,7 @@ describe('async-validate:', function() {
 
   it('should error on invalid arity (min: 1)', function(done) {
     var descriptor = {
-      mock: {type: 'method', min: 1},
+      mock: {type: 'function', min: 1},
     }
     var schema = new Schema(descriptor);
     schema.validate({mock: function(){}}, function(err, res) {
@@ -45,7 +45,7 @@ describe('async-validate:', function() {
 
   it('should error on invalid arity (max: 0)', function(done) {
     var descriptor = {
-      mock: {type: 'method', max: 0},
+      mock: {type: 'function', max: 0},
     }
     var schema = new Schema(descriptor);
     schema.validate({mock: function(foo){}}, function(err, res) {
@@ -58,7 +58,7 @@ describe('async-validate:', function() {
 
   it('should error on invalid arity (min: 0, max: 1)', function(done) {
     var descriptor = {
-      mock: {type: 'method', min: 0, max: 1},
+      mock: {type: 'function', min: 0, max: 1},
     }
     var schema = new Schema(descriptor);
     schema.validate({mock: function(foo, bar){}}, function(err, res) {
@@ -69,7 +69,6 @@ describe('async-validate:', function() {
     });
   });
 
-
   it('should validate function type', function(done) {
     var schema = new Schema(descriptor);
     schema.validate({mock: function(){}}, function(err, res) {

test/spec/source.js

@@ -160,22 +160,22 @@ describe("async-validate:", function() {
     });
   });
 
-  it("should error on source as method type", function(done) {
-    var descriptor = {type: 'method'}
+  it("should error on source as function type", function(done) {
+    var descriptor = {type: 'function'}
       , validator = new schema(descriptor)
       , source = 'foo';
 
     validator.validate(source, function(err, res) {
       expect(err).to.eql(null);
       expect(res.errors.length).to.eql(1);
       expect(res.errors[0].message).to.eql(
-        'source is not a method');
+        'source is not a function');
       done();
     });
   });
 
-  it("should validate on source as method type", function(done) {
-    var descriptor = {type: 'method'}
+  it("should validate on source as function type", function(done) {
+    var descriptor = {type: 'function'}
       , validator = new schema(descriptor)
       , source = function noop(){};
 

test/spec/undef.js

@@ -123,9 +123,9 @@ describe('async-validate:', function() {
     });
   });
 
-  it('should allow undefined method field if not required', function(done) {
+  it('should allow undefined function field if not required', function(done) {
     var descriptor = {
-      mock: {type: 'method', required: false}
+      mock: {type: 'function', required: false}
     }
     var schema = new Schema(descriptor);
     var source = {mock: undefined};