feat: Add option.validateRoot to enable validate the root object (#41)

Author: paranoidjk

README.md

@@ -32,6 +32,7 @@ $ npm install parameter --save
 
 - `constructor([options])` - new Class `Parameter` instance
   - `options.translate` - translate function
+  - `options.validateRoot` - config whether to validate the passed in value must be a object.
 - `validate(rule, value)` - validate the `value` conforms to `rule`. return an array of errors if break rule.
 - `addRule(type, check)` - add custom rules.
    - `type` - rule type, required and must be string type.
@@ -47,7 +48,8 @@ var parameter = new Parameter({
     var args = Array.prototype.slice.call(arguments);
     // Assume there have I18n.t method for convert language.
     return I18n.t.apply(I18n, args);
-  }
+  },
+  validateRoot: true, // restrict the being validate value must be a object
 });
 
 var data = {

index.js

@@ -29,6 +29,10 @@ class Parameter {
     if (typeof opts.translate === 'function') {
       this.translate = opts.translate;
     }
+
+    if (opts.validateRoot) {
+      this.validateRoot = true;
+    }
   }
 
   t() {
@@ -52,6 +56,14 @@ class Parameter {
       throw new TypeError('need object type rule');
     }
 
+    if (this.validateRoot && (typeof obj !== 'object' || !obj)) {
+      return [{
+        message: 'the validated value should be a object',
+        code: this.t('invalid'),
+        field: undefined,
+      }];
+    }
+
     var self = this;
 
     var errors = [];

test/index.test.js

@@ -17,6 +17,10 @@ var util = require('util');
 var Parameter = require('..');
 var parameter = new Parameter();
 
+var parameterWithRootValidate = new Parameter({
+  validateRoot: true,
+});
+
 describe('parameter', function () {
   describe('required', function () {
     it('should required work fine', function () {
@@ -47,6 +51,18 @@ describe('parameter', function () {
   });
 
   describe('validate', function () {
+    it('should throw error when received a non object', function () {
+        var value = null;
+        var rule = {int: {type: 'int1', required: false}};
+        let err;
+        try {
+          parameter.validate(rule, undefined)
+        } catch (e) {
+          err = e;
+        }
+      should(err.message).equal("Cannot read property 'hasOwnProperty' of undefined");
+    });
+
     it('should invalid type throw', function () {
       (function () {
         var value = {int: 1.1};
@@ -662,3 +678,12 @@ describe('parameter', function () {
     });
   });
 });
+
+
+describe('validate with option.validateRoot', function () {
+  it('should not pass when received a invalid value', function () {
+    var value = null;
+    var rule = { int: { type: 'int1', required: false } };
+    parameterWithRootValidate.validate(rule, value)[0].message.should.equal('the validated value should be a object');;
+  });
+});