Normalize describe(). For #1606. For #1867

Author: hueniverse

lib/common.js

@@ -43,7 +43,6 @@ exports.symbols = {
     arraySingle: Symbol('arraySingle'),
     castFrom: Symbol('castFrom'),
     deepDefault: Symbol('deepDefault'),
-    schema: Symbol('schema'),                   // Used by describe() to include a reference to the schema
     prefs: Symbol('prefs'),
     ref: Symbol('ref'),
     template: Symbol('template')

lib/index.js

@@ -101,7 +101,6 @@ internals.methods = {
 
     ValidationError: Errors.ValidationError,
     version: Pkg.version,
-    schema: Common.symbols.schema,
     cache: Cache.provider,
 
     assert: function (value, schema, ...args/* [message], [options]*/) {

lib/manifest.js

@@ -15,8 +15,7 @@ exports.describe = function (schema) {
 
     const description = {
         type: schema._type,
-        flags: {},
-        [Common.symbols.schema]: schema
+        flags: {}
     };
 
     // Flags
@@ -72,17 +71,29 @@ exports.describe = function (schema) {
         delete description.flags;
     }
 
+    // Preferences
+
     if (schema._preferences) {
         description.options = Hoek.clone(schema._preferences, { shallow: ['messages'] });
         if (description.options.messages) {
             description.options.messages = Messages.decompile(description.options.messages);
         }
     }
 
-    if (schema._baseType) {
-        description.base = schema._baseType.describe();
+    // Valids
+
+    const valids = schema._valids ? schema._valids.values() : [];
+    if (valids.length) {
+        description.valids = internals.values(valids);
     }
 
+    const invalids = schema._invalids ? schema._invalids.values() : [];
+    if (invalids.length) {
+        description.invalids = internals.values(invalids);
+    }
+
+    // Meta properties
+
     if (schema._inners.notes.length) {
         description.notes = schema._inners.notes.slice();
     }
@@ -99,30 +110,20 @@ exports.describe = function (schema) {
         description.examples = schema._inners.examples.slice();
     }
 
-    const valids = schema._valids ? schema._valids.values() : [];
-    if (valids.length) {
-        description.valids = valids.map((v) => {
-
-            return Common.isResolvable(v) ? v.describe() : v;
-        });
-    }
-
-    const invalids = schema._invalids ? schema._invalids.values() : [];
-    if (invalids.length) {
-        description.invalids = invalids.map((v) => {
-
-            return Common.isResolvable(v) ? v.describe() : v;
-        });
-    }
+    // Alterations
 
     if (schema._inners.alterations) {
         description.alterations = schema._inners.alterations.slice();
     }
 
+    // Externals
+
     if (schema._inners.externals) {
         description.externals = schema._inners.externals.slice();
     }
 
+    // Rules
+
     description.rules = [];
 
     for (const test of schema._tests) {
@@ -153,7 +154,7 @@ exports.describe = function (schema) {
             }
 
             if (arg !== undefined) {
-                item.arg = Common.isResolvable(arg) ? arg.describe() : arg;
+                item.arg = Common.isResolvable(arg) || Common.isSchema(arg) ? arg.describe() : arg;
             }
         }
 
@@ -183,5 +184,23 @@ exports.describe = function (schema) {
         delete description.rules;
     }
 
+    // Extension
+
+    if (schema._baseType) {
+        description.base = schema._baseType.describe();
+    }
+
     return description;
 };
+
+
+internals.values = function (values) {
+
+    const normalized = [];
+
+    for (const value of values) {
+        normalized.push(Common.isResolvable(value) ? value.describe() : (value && typeof value === 'object' ? { value } : value));
+    }
+
+    return normalized;
+};

lib/messages.js

@@ -85,7 +85,7 @@ exports.decompile = function (messages) {
         }
 
         if (Template.isTemplate(message)) {
-            target[code] = message.source;
+            target[code] = message.describe({ compact: true });
             continue;
         }
 
@@ -102,7 +102,7 @@ exports.decompile = function (messages) {
                 continue;
             }
 
-            target[language][code] = localized.source;
+            target[language][code] = localized.describe({ compact: true });
         }
     }
 

lib/template.js

@@ -25,7 +25,7 @@ const internals = {
 
 module.exports = exports = internals.Template = class {
 
-    constructor(source, options = {}) {
+    constructor(source, options) {
 
         Hoek.assert(typeof source === 'string', 'Template source must be a string');
         Hoek.assert(!source.includes('\u0000') && !source.includes('\u0001'), 'Template source cannot contain reserved control characters');
@@ -101,9 +101,20 @@ module.exports = exports = internals.Template = class {
         return internals.dateFormat[prefs.dateFormat].call(date);
     }
 
-    describe() {
+    describe(options = {}) {
 
-        return { template: this.source, options: this._settings };
+        if (!this._settings &&
+            options.compact) {
+
+            return this.source;
+        }
+
+        const desc = { template: this.source };
+        if (this._settings) {
+            desc.options = this._settings;
+        }
+
+        return desc;
     }
 
     isDynamic() {

lib/types/array.js

@@ -110,29 +110,18 @@ internals.Array = class extends Any {
 
         if (this._inners.ordereds.length) {
             description.orderedItems = [];
-
             for (let i = 0; i < this._inners.ordereds.length; ++i) {
                 description.orderedItems.push(this._inners.ordereds[i].describe());
             }
         }
 
         if (this._inners.items.length) {
             description.items = [];
-
             for (let i = 0; i < this._inners.items.length; ++i) {
                 description.items.push(this._inners.items[i].describe());
             }
         }
 
-        if (description.rules) {
-            for (let i = 0; i < description.rules.length; ++i) {
-                const rule = description.rules[i];
-                if (rule.name === 'has') {
-                    rule.arg = rule.arg.describe();
-                }
-            }
-        }
-
         return description;
     }
 

lib/types/object.js

@@ -319,7 +319,7 @@ internals.Object = class extends Any {
         if (description.rules) {
             for (const rule of description.rules) {
 
-                // Coverage off for future-proof descriptions, only object().assert() is use right now
+                // Coverage off for future-proof descriptions, only object().assert() is used right now
 
                 if (/* $lab:coverage:off$ */rule.arg &&
                     typeof rule.arg === 'object' &&