[added] meta() and describe()

Author: jquense

README.md

@@ -228,6 +228,16 @@ Creates a deep copy of the schema. Clone is used internally to return a new sche
 
 Overrides the key name which is used in error messages.
 
+#### `mixed.meta(Object metadata)`
+
+Adds to a metadata object, useful for storing data with a schema, that doesn't belong
+the cast object itself.
+
+#### `mixed.describe() => Object description`
+
+Collects schema details (like meta, labels, and active tests) into a serializable 
+description object.
+
 #### `mixed.concat(Schema schema)`
 
 Creates a new instance of the schema by combining two schemas. Only schemas of the same type can be concatenated.

src/mixed.js

@@ -12,6 +12,7 @@ var Promise = require('promise/lib/es6-extensions')
 
 let notEmpty = value => !isAbsent(value);
 
+
 function runValidations(validations, endEarly, value, path) {
   return endEarly
     ? Promise.all(validations)
@@ -56,12 +57,21 @@ SchemaType.prototype = {
     return cloneDeep(this);
   },
 
-  label: function(label){
+  label(label) {
     var next = this.clone();
     next._label = label;
     return next;
   },
 
+  meta(obj) {
+    if (arguments.length === 0)
+      return this._meta;
+
+    var next = this.clone();
+    next._meta = Object.assign(next._meta || {}, { ...obj })
+    return next;
+  },
+
   withMutation(fn) {
     this._mutate = true
     let result = fn(this)
@@ -149,8 +159,10 @@ SchemaType.prototype = {
 
     if (schema._typeError)
       initialTests.push(schema._typeError(validationParams));
+
     if (schema._whitelistError)
       initialTests.push(schema._whitelistError(validationParams));
+
     if (schema._blacklistError)
       initialTests.push(schema._blacklistError(validationParams));
 
@@ -186,6 +198,10 @@ SchemaType.prototype = {
       }), cb)
     },
 
+  getDefault({ context, parent }) {
+    return this._resolve(context, parent).default()
+  },
+
   default(def) {
     if (arguments.length === 0) {
       var dflt = _.has(this, '_default') ? this._default : this._defaultDefault
@@ -369,6 +385,17 @@ SchemaType.prototype = {
   _option(key, overrides){
     return _.has(overrides, key)
       ? overrides[key] : this._options[key]
+  },
+
+  describe() {
+    let next = this.clone();
+
+    return {
+      type: next._type,
+      meta: next._meta,
+      label: next._label,
+      tests: next.tests.map((fn) => fn.TEST_NAME, {})
+    }
   }
 }
 

test/mixed.js

@@ -484,4 +484,28 @@ describe( 'Mixed Types ', function(){
       ])
   })
 
+  it('should add meta() data', () => {
+    string()
+      .meta({ input: 'foo' })
+      .meta({ foo: 'bar' })
+      .meta().should.eql({
+        input: 'foo',
+        foo: 'bar'
+      })
+  })
+
+  it('should describe', () => {
+    string().max(2)
+      .meta({ input: 'foo' })
+      .label('str!')
+      .describe().should.eql({
+        type: 'string',
+        label: 'str!',
+        tests: ['max'],
+        meta: {
+          input: 'foo'
+        }
+      })
+  })
+
 })