dataschema-debug.js revision 93913a258f1827d9ccbbd16bb36bb24948200043
/**
* The DataSchema utility provides a common configurable interface for widgets to
* apply a given schema to a variety of data.
*
* @module dataschema
*/
/**
* Base class for the YUI DataSchema utility.
* @class DataSchema.Base
* @static
*/
var DPBase = {
/**
* Returns string name.
*
* @method toString
* @return {String} String representation for this object.
*/
toString: function() {
return "DataSchema.Base";
},
/**
* Overridable method returns data as-is.
*
* @method apply
* @param schema {Object} Schema to apply.
* @param data {Object} Data.
* @return {Object} Schema-parsed data.
* @static
*/
return data;
}
};
/**
* The DataSchema utility provides a common configurable interface for widgets to
* apply a given schema to a variety of data.
*
* @module dataschema
*/
/**
* JSON subclass for the YUI DataSchema utility.
* @class DataSchema.JSON
* @extends DataSchema.Base
* @static
*/
DPJSON = {
/////////////////////////////////////////////////////////////////////////////
//
// DataSchema.JSON static methods
//
/////////////////////////////////////////////////////////////////////////////
/**
* Returns string name.
*
* @method toString
* @return {String} String representation for this object.
*/
toString: function() {
return "DataSchema.JSON";
},
/**
* Utility function converts JSON locator strings into walkable paths
*
* @method DataSchema.JSON.buildPath
* @param locator {String} JSON value locator.
* @return {String[]} Walkable path to data value.
* @static
*/
var path = null,
keys = [],
i = 0;
if (locator) {
// Strip the ["string keys"] and [1] array indexes
replace(/\[(['"])(.*?)\1\]/g,
function (x,$1,$2) {keys[i]=$2;return '.@'+(i++);}).
replace(/\[(\d+)\]/g,
function (x,$1) {keys[i]=parseInt($1,10)|0;return '.@'+(i++);}).
replace(/^\./,''); // remove leading dot
// Validate against problematic characters.
if (!/[^\w\.\$@]/.test(locator)) {
path = locator.split('.');
for (i=path.length-1; i >= 0; --i) {
if (path[i].charAt(0) === '@') {
path[i] = keys[parseInt(path[i].substr(1),10)];
}
}
}
else {
Y.log("Invalid locator: " + locator, "error", DPJSON.toString());
}
}
return path;
},
/**
* Utility function to walk a path and return the value located there.
*
* @method DataSchema.JSON.getLocationValue
* @param path {String[]} Locator path.
* @param data {String} Data to traverse.
* @return {Object} Data value at location.
* @static
*/
getLocationValue: function (path, data) {
var i = 0,
len = path.length;
for (;i<len;i++) {
data = data[path[i]];
}
return data;
},
/**
* Applies a given schema to given JSON data.
*
* @method apply
* @param schema {Object} Schema to apply.
* @param data {Object} JSON data.
* @return {Object} Schema-parsed data.
* @static
*/
apply: function(schema, data) {
var data_in = data,
data_out = {results:[],meta:{}};
// Convert incoming JSON strings
if(!LANG.isObject(data)) {
try {
data_in = Y.JSON.parse(data);
}
catch(e) {
data_out.error = e;
return data_out;
}
}
if(LANG.isObject(data_in) && schema) {
// Parse results data
if(!LANG.isUndefined(schema.resultsLocator)) {
data_out = DPJSON._parseResults(schema, data_in, data_out);
}
// Parse meta data
if(!LANG.isUndefined(schema.metaFields)) {
data_out = DPJSON._parseMeta(schema.metaFields, data_in, data_out);
}
}
else {
Y.log("JSON data could not be schema-parsed: " + Y.dump(data) + " " + Y.dump(data), "error", DPJSON.toString());
data_out.error = true;
}
return data_out;
},
/**
* Schema-parsed list of results from full data
*
* @method _parseResults
* @param schema {Object} Schema to parse against.
* @param data_in {Object} Data to parse.
* @param data_out {Object} In-progress parsed data to update.
* @return {Object} Parsed data object.
* @static
* @protected
*/
_parseResults: function(schema, data_in, data_out) {
var results = [],
path,
error;
if(schema.resultsLocator) {
path = DPJSON.buildPath(schema.resultsLocator);
if(path) {
results = DPJSON.getLocationValue(path, data_in);
if (results === undefined) {
data_out.results = [];
error = new Error(this.toString() + " Results retrieval failure");
}
if(LANG.isArray(schema.resultsFields) && LANG.isArray(results)) {
data_out = DPJSON._getFieldValues(schema.resultsFields, results, data_out);
}
else {
data_out.results = [];
data_out.error = new Error(this.toString() + " Fields retrieval failure");
}
}
else {
error = new Error(this.toString() + " Results locator failure");
}
if (error) {
Y.log("JSON data could not be parsed: " + Y.dump(data_in), "error", DPJSON.toString());
data_out.error = error;
}
}
return data_out;
},
/**
* Get field data values out of list of full results
*
* @method _getFieldValues
* @param fields {Array} Fields to find.
* @param data_in {Array} Results data to parse.
* @param data_out {Object} In-progress parsed data to update.
* @return {Object} Parsed data object.
* @static
* @protected
*/
_getFieldValues: function(fields, data_in, data_out) {
var results = [],
len = fields.length,
i, j,
field, key, path, parser,
simplePaths = [], complexPaths = [], fieldParsers = [],
result, record;
if(LANG.isArray(fields)) {
// First collect hashes of simple paths, complex paths, and parsers
for (i=0; i<len; i++) {
field = fields[i]; // A field can be a simple string or a hash
key = field.key || field; // Find the key
// Validate and store locators for later
path = DPJSON.buildPath(key);
if (path) {
if (path.length === 1) {
simplePaths[simplePaths.length] = {key:key, path:path[0]};
} else {
complexPaths[complexPaths.length] = {key:key, path:path};
}
} else {
Y.log("Invalid key syntax: " + key, "warn", DPJSON.toString());
}
// Validate and store parsers for later
//TODO: implement shortcuts
parser = (LANG.isFunction(field.parser)) ? field.parser : Y.DataSchema[field.parser+''];
if (parser) {
fieldParsers[fieldParsers.length] = {key:key, parser:parser};
}
}
// Traverse list of data_in, creating records of simple fields,
// complex fields, and applying parsers as necessary
for (i=data_in.length-1; i>=0; --i) {
record = {};
result = data_in[i];
if(result) {
// Cycle through simpleLocators
for (j=simplePaths.length-1; j>=0; --j) {
// Bug 1777850: The result might be an array instead of object
record[simplePaths[j].key] =
LANG.isUndefined(result[simplePaths[j].path]) ?
result[j] : result[simplePaths[j].path];
}
// Cycle through complexLocators
for (j=complexPaths.length - 1; j>=0; --j) {
record[complexPaths[j].key] = DPJSON.getLocationValue(complexPaths[j].path, result);
}
// Cycle through fieldParsers
for (j=fieldParsers.length-1; j>=0; --j) {
key = fieldParsers[j].key;
record[key] = fieldParsers[j].parser(record[key]);
// Safety net
if (LANG.isUndefined(record[key])) {
record[key] = null;
}
}
}
results[i] = record;
}
data_out.results = results;
}
return data_out;
},
/**
* Parses results data according to schema
*
* @method _parseMeta
* @param data_out {Object} Data to parse.
* @param data_in {Object} In-progress parsed data to update.
* @return {Object} Schema-parsed meta data.
* @static
* @protected
*/
_parseMeta: function(metaFields, data_in, data_out) {
if(LANG.isObject(metaFields)) {
var key, path;
for(key in metaFields) {
if (metaFields.hasOwnProperty(key)) {
path = DPJSON.buildPath(metaFields[key]);
if (path && data_in) {
data_out.meta[key] = DPJSON.getLocationValue(path, data_in);
}
}
}
}
else {
data_out.error = new Error(this.toString() + " Meta retrieval failure");
}
return data_out;
}
};
Y.DataSchema.JSON = Y.mix(DPJSON, Y.DataSchema.Base);