Add reason key

schema-inspector · Nov 10, 2016 · f0ccc55 · f0ccc55
1 parent 6972426
commit f0ccc55
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 38 deletions.
diff --git a/lib/schema-inspector.js b/lib/schema-inspector.js
@@ -206,7 +206,7 @@
  return;
  }
  if (typeof candidate === 'undefined') {
- this.report('is missing and not optional');
+ this.report('is missing and not optional', null, 'optional');
  }
  },
  type: function (schema, candidate) {
@@ -220,7 +220,7 @@
  });
  if (!typeIsValid) {
  types = types.map(function (t) {return typeof t === 'function' ? 'and instance of ' + t.name : t; });
- this.report('must be ' + types.join(' or ') + ', but is ' + _realType(candidate));
+ this.report('must be ' + types.join(' or ') + ', but is ' + _realType(candidate), null, 'type');
  }
  },
  uniqueness: function (schema, candidate) {
@@ -236,7 +236,7 @@
  var indexes = getIndexes(candidate, candidate[i]);
  if (indexes.length > 1) {
  reported.push(candidate[i]);
- this.report('has value [' + candidate[i] + '] more than once at indexes [' + indexes.join(', ') + ']');
+ this.report('has value [' + candidate[i] + '] more than once at indexes [' + indexes.join(', ') + ']', null, 'uniqueness');
  }
  }
  },
@@ -261,12 +261,12 @@
  }
  });
  if (!matches) {
- self.report('must match [' + regexs.join(' or ') + '], but is equal to "' + candidate + '"');
+ self.report('must match [' + regexs.join(' or ') + '], but is equal to "' + candidate + '"', null, 'pattern');
  }
  },
  validDate: function (schema, candidate) {
  if (String(schema.validDate) === 'true' && candidate instanceof Date && isNaN(candidate.getTime())) {
- this.report('must be a valid date');
+ this.report('must be a valid date', null, 'validDate');
  }
  },
  minLength: function (schema, candidate) {
@@ -278,7 +278,7 @@
  return;
  }
  if (candidate.length < minLength) {
- this.report('must be longer than ' + minLength + ' elements, but it has ' + candidate.length);
+ this.report('must be longer than ' + minLength + ' elements, but it has ' + candidate.length, null, 'minLength');
  }
  },
  maxLength: function (schema, candidate) {
@@ -290,7 +290,7 @@
  return;
  }
  if (candidate.length > maxLength) {
- this.report('must be shorter than ' + maxLength + ' elements, but it has ' + candidate.length);
+ this.report('must be shorter than ' + maxLength + ' elements, but it has ' + candidate.length, null, 'maxLength');
  }
  },
  exactLength: function (schema, candidate) {
@@ -302,7 +302,7 @@
  return;
  }
  if (candidate.length !== exactLength) {
- this.report('must have exactly ' + exactLength + ' elements, but it have ' + candidate.length);
+ this.report('must have exactly ' + exactLength + ' elements, but it have ' + candidate.length, null, 'exactLength');
  }
  },
  lt: function (schema, candidate) {
@@ -311,7 +311,7 @@
  return;
  }
  if (candidate >= limit) {
- this.report('must be less than ' + limit + ', but is equal to "' + candidate + '"');
+ this.report('must be less than ' + limit + ', but is equal to "' + candidate + '"', null, 'lt');
  }
  },
  lte: function (schema, candidate) {
@@ -320,7 +320,7 @@
  return;
  }
  if (candidate > limit) {
- this.report('must be less than or equal to ' + limit + ', but is equal to "' + candidate + '"');
+ this.report('must be less than or equal to ' + limit + ', but is equal to "' + candidate + '"', null, 'lte');
  }
  },
  gt: function (schema, candidate) {
@@ -329,7 +329,7 @@
  return;
  }
  if (candidate <= limit) {
- this.report('must be greater than ' + limit + ', but is equal to "' + candidate + '"');
+ this.report('must be greater than ' + limit + ', but is equal to "' + candidate + '"', null, 'gt');
  }
  },
  gte: function (schema, candidate) {
@@ -338,7 +338,7 @@
  return;
  }
  if (candidate < limit) {
- this.report('must be greater than or equal to ' + limit + ', but is equal to "' + candidate + '"');
+ this.report('must be greater than or equal to ' + limit + ', but is equal to "' + candidate + '"', null, 'gte');
  }
  },
  eq: function (schema, candidate) {
@@ -357,11 +357,11 @@
  }
  this.report('must be equal to [' + limit.map(function (l) {
  return '"' + l + '"';
- }).join(' or ') + '], but is equal to "' + candidate + '"');
+ }).join(' or ') + '], but is equal to "' + candidate + '"', null, 'eq');
  }
  else {
  if (candidate !== limit) {
- this.report('must be equal to "' + limit + '", but is equal to "' + candidate + '"');
+ this.report('must be equal to "' + limit + '", but is equal to "' + candidate + '"', null, 'eq');
  }
  }
  },
@@ -376,14 +376,14 @@
  if (_typeIs.array(limit)) {
  for (var i = 0; i < limit.length; i++) {
  if (candidate === limit[i]) {
- this.report('must not be equal to "' + limit[i] + '"');
+ this.report('must not be equal to "' + limit[i] + '"', null, 'ne');
  return;
  }
  }
  }
  else {
  if (candidate === limit) {
- this.report('must not be equal to "' + limit + '"');
+ this.report('must not be equal to "' + limit + '"', null, 'ne');
  }
  }
  },
@@ -398,7 +398,7 @@
  if (!valid) {
  this.report('must have at least key ' + _keys.map(function (i) {
  return '"' + i + '"';
- }).join(' or '));
+ }).join(' or '), null, 'someKeys');
  }
  },
  strict: function (schema, candidate) {
@@ -414,7 +414,7 @@
  if (intruder.length > 0) {
  var msg = 'should not contains ' + (intruder.length > 1 ? 'properties' : 'property') +
  ' [' + intruder.map(function (i) { return '"' + i + '"'; }).join(', ') + ']';
- self.report(msg);
+ self.report(msg, null, 'strict');
  }
  }
  },
@@ -581,9 +581,10 @@
  this._customFields = Object.keys(this._custom);
  this.origin = null;
 
- this.report = function (message, code) {
+ this.report = function (message, code, reason) {
  var newErr = {
  code: code || this.userCode || null,
+ reason: reason || 'unkown',
  message: this.userError || message || 'is invalid',
  property: this.userAlias ? (this.userAlias + ' (' + this._dumpStack() + ')') : this._dumpStack()
  };

diff --git a/misc/node-test.js b/misc/node-test.js
@@ -1,24 +1,24 @@
 var inspector = require('../');
 
-// var schema = {
-//  type: 'object',
-//  properties: {
-//  lorem: { type: 'string', eq: 'ipsum' },
-//  dolor: {
-//  type: 'array',
-//  items: { type: 'number' }
-//  }
-//  }
-// };
+var schema = {
+ type: 'object',
+ properties: {
+ lorem: { type: 'string', eq: 'ipsum' },
+ dolor: {
+ type: 'array',
+ items: { type: 'number' }
+ }
+ }
+};
 
-// var candidate = {
-//  lorem: 'not_ipsum',
-//  dolor: [ 12, 34, 'ERROR', 45, 'INVALID' ]
-// };
-// var result = inspector.validate(schema, candidate, function (err, result) {
-//  console.log(result.format());
-// });
+var candidate = {
+ lorem: 'not_ipsum',
+ dolor: [ 12, 34, 'ERROR', 45, 'INVALID' ]
+};
+var result = inspector.validate(schema, candidate, function (err, result) {
+ console.log(result);
+});
 
 // var schema = { type: 'object', properties: { lol: { someKeys: ['pouet'] } } };
 // var subject = { lol: null };
-// inspector.validate(schema, subject);
+// inspector.validate(schema, subject);
diff --git a/misc/vd_test2.js b/misc/vd_test2.js
@@ -0,0 +1,26 @@
+if (typeof require === 'function') {
+ var SchemaInspector = require('../');
+}
+
+SchemaInspector.Validation.extend({
+ unique: function (schema, candidate, callback) {
+ console.log(this.origin._connection);
+ callback();
+ }
+});
+
+var schema = {
+ type: 'array',
+ items: {
+ type: 'number', $unique: true
+ }
+};
+
+var obj = [ 0, 5, 10, 15, 17, 20];
+
+// -----------------------------------------------------------------------------
+obj._connection = 'test';
+SchemaInspector.validate(schema, obj, function (err, r) {
+ console.log(r);
+ console.log(r.format());
+});
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
  "name": "schema-inspector",
  "description": "Schema-Inspector is a powerful tool to sanitize and validate JS objects.",
- "version": "1.6.6",
+ "version": "1.6.7",
  "main": "index.js",
  "author": {
  "name": "Sebastien Chopin",