dataschema.js revision 2390f77db0b974f19412b6ee655c3983bfcaa812
140N/AYUI.add('dataschema-base', function(Y) {
140N/A
140N/A/**
140N/A * Provides the base DataSchema implementation, which can be extended to
140N/A * create DataSchemas for specific data formats, such XML, JSON, Text and
140N/A * Arrays
140N/A *
140N/A * @module dataschema
140N/A * @submodule dataschema-base
140N/A */
140N/A
140N/Avar LANG = Y.Lang,
140N/A/**
140N/A * Base class for the YUI DataSchema utility.
140N/A * @class DataSchema.Base
140N/A * @static
140N/A */
140N/A SchemaBase = {
140N/A /**
140N/A * Overridable method returns data as-is.
140N/A *
140N/A * @method apply
140N/A * @param schema {Object} Schema to apply.
140N/A * @param data {Object} Data.
140N/A * @return {Object} Schema-parsed data.
140N/A * @static
140N/A */
140N/A apply: function(schema, data) {
140N/A return data;
140N/A },
140N/A
140N/A /**
140N/A * Applies field parser, if defined
140N/A *
140N/A * @method parse
140N/A * @param value {Object} Original value.
140N/A * @param field {Object} Field.
140N/A * @return {Object} Type-converted value.
140N/A */
140N/A parse: function(value, field) {
140N/A if(field.parser) {
140N/A var parser = (LANG.isFunction(field.parser)) ?
140N/A field.parser : Y.Parsers[field.parser+''];
140N/A if(parser) {
140N/A value = parser.call(this, value);
140N/A }
140N/A else {
140N/A }
140N/A }
140N/A return value;
140N/A }
140N/A};
140N/A
140N/AY.namespace("DataSchema").Base = SchemaBase;
140N/AY.namespace("Parsers");
140N/A
140N/A
140N/A
140N/A}, '@VERSION@' ,{requires:['base']});
140N/A
140N/AYUI.add('dataschema-json', function(Y) {
140N/A
140N/A/**
* Provides a DataSchema implementation which can be used to work with JSON data
*
* @module dataschema
* @submodule dataschema-json
*/
/**
* JSON subclass for the YUI DataSchema utility.
* @class DataSchema.JSON
* @extends DataSchema.Base
* @static
*/
var LANG = Y.Lang,
SchemaJSON = {
/////////////////////////////////////////////////////////////////////////////
//
// DataSchema.JSON static methods
//
/////////////////////////////////////////////////////////////////////////////
/**
* Utility function converts JSON locator strings into walkable paths
*
* @method DataSchema.JSON.getPath
* @param locator {String} JSON value locator.
* @return {String[]} Walkable path to data value.
* @static
*/
getPath: function(locator) {
var path = null,
keys = [],
i = 0;
if (locator) {
// Strip the ["string keys"] and [1] array indexes
locator = locator.
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 {
}
}
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++) {
if(!LANG.isUndefined(data[path[i]])) {
data = data[path[i]];
}
else {
data = undefined;
break;
}
}
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.resultListLocator)) {
data_out = SchemaJSON._parseResults(schema, data_in, data_out);
}
// Parse meta data
if(!LANG.isUndefined(schema.metaFields)) {
data_out = SchemaJSON._parseMeta(schema.metaFields, data_in, data_out);
}
}
else {
data_out.error = new Error("JSON schema parse failure");
}
return data_out;
},
/**
* Schema-parsed list of results from full data
*
* @method _parseResults
* @param schema {Object} Schema to parse against.
* @param json_in {Object} JSON to parse.
* @param data_out {Object} In-progress parsed data to update.
* @return {Object} Parsed data object.
* @static
* @protected
*/
_parseResults: function(schema, json_in, data_out) {
var results = [],
path,
error;
if(schema.resultListLocator) {
path = SchemaJSON.getPath(schema.resultListLocator);
if(path) {
results = SchemaJSON.getLocationValue(path, json_in);
if (results === undefined) {
data_out.results = [];
error = new Error("JSON results retrieval failure");
}
else {
if(LANG.isArray(schema.resultFields) && LANG.isArray(results)) {
data_out = SchemaJSON._getFieldValues(schema.resultFields, results, data_out);
}
else {
data_out.results = [];
error = new Error("JSON Schema fields retrieval failure");
}
}
}
else {
error = new Error("JSON Schema results locator failure");
}
if (error) {
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 array_in {Array} Results to parse.
* @param data_out {Object} In-progress parsed data to update.
* @return {Object} Parsed data object.
* @static
* @protected
*/
_getFieldValues: function(fields, array_in, data_out) {
var results = [],
len = fields.length,
i, j,
field, key, path, parser,
simplePaths = [], complexPaths = [], fieldParsers = [],
result, record;
// 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 = SchemaJSON.getPath(key);
if (path) {
if (path.length === 1) {
simplePaths[simplePaths.length] = {key:key, path:path[0]};
} else {
complexPaths[complexPaths.length] = {key:key, path:path};
}
} else {
}
// Validate and store parsers for later
//TODO: use Y.DataSchema.parse?
parser = (LANG.isFunction(field.parser)) ? field.parser : Y.Parsers[field.parser+''];
if (parser) {
fieldParsers[fieldParsers.length] = {key:key, parser:parser};
}
}
// Traverse list of array_in, creating records of simple fields,
// complex fields, and applying parsers as necessary
for (i=array_in.length-1; i>=0; --i) {
record = {};
result = array_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] = Y.DataSchema.Base.parse(
(LANG.isUndefined(result[simplePaths[j].path]) ?
result[j] : result[simplePaths[j].path]), simplePaths[j]);
}
// Cycle through complexLocators
for (j=complexPaths.length - 1; j>=0; --j) {
record[complexPaths[j].key] = Y.DataSchema.Base.parse(
(SchemaJSON.getLocationValue(complexPaths[j].path, result)), complexPaths[j] );
}
// 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 metaFields {Object} Metafields definitions.
* @param json_in {Object} JSON to parse.
* @param data_out {Object} In-progress parsed data to update.
* @return {Object} Schema-parsed meta data.
* @static
* @protected
*/
_parseMeta: function(metaFields, json_in, data_out) {
if(LANG.isObject(metaFields)) {
var key, path;
for(key in metaFields) {
if (metaFields.hasOwnProperty(key)) {
path = SchemaJSON.getPath(metaFields[key]);
if (path && json_in) {
data_out.meta[key] = SchemaJSON.getLocationValue(path, json_in);
}
}
}
}
else {
data_out.error = new Error("JSON meta data retrieval failure");
}
return data_out;
}
};
Y.DataSchema.JSON = Y.mix(SchemaJSON, Y.DataSchema.Base);
}, '@VERSION@' ,{requires:['json', 'dataschema-base']});
YUI.add('dataschema-xml', function(Y) {
/**
* Provides a DataSchema implementation which can be used to work with XML data
*
* @module dataschema
* @submodule dataschema-xml
*/
var LANG = Y.Lang,
/**
* XML subclass for the YUI DataSchema utility.
* @class DataSchema.XML
* @extends DataSchema.Base
* @static
*/
SchemaXML = {
/////////////////////////////////////////////////////////////////////////////
//
// DataSchema.XML static methods
//
/////////////////////////////////////////////////////////////////////////////
/**
* Applies a given schema to given XML data.
*
* @method apply
* @param schema {Object} Schema to apply.
* @param data {XMLDoc} XML document.
* @return {Object} Schema-parsed data.
* @static
*/
apply: function(schema, data) {
var xmldoc = data,
data_out = {results:[],meta:{}};
if(xmldoc && xmldoc.nodeType && xmldoc.nodeType === 9 && schema) {
// Parse results data
data_out = SchemaXML._parseResults(schema, xmldoc, data_out);
// Parse meta data
data_out = SchemaXML._parseMeta(schema.metaFields, xmldoc, data_out);
}
else {
data_out.error = new Error("XML schema parse failure");
}
return data_out;
},
/**
* Get an XPath-specified value for a given field from an XML node or document.
*
* @method _getLocationValue
* @param field {String | Object} Field definition.
* @param context {Object} XML node or document to search within.
* @return {Object} Data value or null.
* @static
* @protected
*/
_getLocationValue: function(field, context) {
var locator = field.locator || field.key || field,
xmldoc = context.ownerDocument || context,
result, res, value = null;
try {
// Standards mode
if(!LANG.isUndefined(xmldoc.evaluate)) {
result = xmldoc.evaluate(locator, context, xmldoc.createNSResolver(!context.ownerDocument ? context.documentElement : context.ownerDocument.documentElement), 0, null);
while(res = result.iterateNext()) {
value = res.textContent;
}
}
// IE mode
else {
xmldoc.setProperty("SelectionLanguage", "XPath");
result = context.selectNodes(locator)[0];
value = result.value || result.text || null;
}
return Y.DataSchema.Base.parse(value, field);
}
catch(e) {
}
},
/**
* Parses results data according to schema
*
* @method _parseMeta
* @param xmldoc_in {Object} XML document parse.
* @param data_out {Object} In-progress schema-parsed data to update.
* @return {Object} Schema-parsed data.
* @static
* @protected
*/
_parseMeta: function(metaFields, xmldoc_in, data_out) {
if(LANG.isObject(metaFields)) {
var key,
xmldoc = xmldoc_in.ownerDocument || xmldoc_in;
for(key in metaFields) {
if (metaFields.hasOwnProperty(key)) {
data_out.meta[key] = SchemaXML._getLocationValue(metaFields[key], xmldoc);
}
}
}
return data_out;
},
/**
* Schema-parsed list of results from full data
*
* @method _parseResults
* @param schema {Object} Schema to parse against.
* @param xmldoc_in {Object} XML document parse.
* @param data_out {Object} In-progress schema-parsed data to update.
* @return {Object} Schema-parsed data.
* @static
* @protected
*/
_parseResults: function(schema, xmldoc_in, data_out) {
if(schema.resultListLocator && LANG.isArray(schema.resultFields)) {
var nodeList = xmldoc_in.getElementsByTagName(schema.resultListLocator),
fields = schema.resultFields,
results = [],
node, field, result, i, j;
if(nodeList.length) {
// Loop through each result node
for(i=nodeList.length-1; i>= 0; i--) {
result = {};
node = nodeList[i];
// Find each field value
for(j=fields.length-1; j>= 0; j--) {
field = fields[j];
result[field.key || field] = SchemaXML._getLocationValue(field, node);
}
results[i] = result;
}
data_out.results = results;
}
else {
data_out.error = new Error("XML schema result nodes retrieval failure");
}
}
return data_out;
}
};
Y.DataSchema.XML = Y.mix(SchemaXML, Y.DataSchema.Base);
}, '@VERSION@' ,{requires:['dataschema-base']});
YUI.add('dataschema-array', function(Y) {
/**
* The DataSchema utility provides a common configurable interface for widgets to
* apply a given schema to a variety of data.
*
* @module dataschema
*/
var LANG = Y.Lang,
/**
* Provides a DataSchema implementation which can be used to work with data stored in arrays
*
* @module dataschema
* @submodule dataschema-array
*/
/**
* Array subclass for the YUI DataSchema utility.
* @class DataSchema.Array
* @extends DataSchema.Base
* @static
*/
SchemaArray = {
/////////////////////////////////////////////////////////////////////////////
//
// DataSchema.Array static methods
//
/////////////////////////////////////////////////////////////////////////////
/**
* Applies a given schema to given Array data.
*
* @method apply
* @param schema {Object} Schema to apply.
* @param data {Object} Array data.
* @return {Object} Schema-parsed data.
* @static
*/
apply: function(schema, data) {
var data_in = data,
data_out = {results:[],meta:{}};
if(LANG.isArray(data_in)) {
if(LANG.isArray(schema.resultFields)) {
// Parse results data
data_out = SchemaArray._parseResults(schema.resultFields, data_in, data_out);
}
else {
data_out.results = data_in;
}
}
else {
data_out.error = new Error("Array schema parse failure");
}
return data_out;
},
/**
* Schema-parsed list of results from full data
*
* @method _parseResults
* @param fields {Array} Schema to parse against.
* @param array_in {Array} Array to parse.
* @param data_out {Object} In-progress parsed data to update.
* @return {Object} Parsed data object.
* @static
* @protected
*/
_parseResults: function(fields, array_in, data_out) {
var results = [],
result, item, type, field, key, value, i, j;
for(i=array_in.length-1; i>-1; i--) {
result = {};
item = array_in[i];
type = (LANG.isObject(item) && !LANG.isFunction(item)) ? 2 : (LANG.isArray(item)) ? 1 : (LANG.isString(item)) ? 0 : -1;
if(type > 0) {
for(j=fields.length-1; j>-1; j--) {
field = fields[j];
key = (!LANG.isUndefined(field.key)) ? field.key : field;
value = (!LANG.isUndefined(item[key])) ? item[key] : item[j];
result[key] = Y.DataSchema.Base.parse(value, field);
}
}
else if(type === 0) {
result = item;
}
else {
//TODO: null or {}?
result = null;
}
results[i] = result;
}
data_out.results = results;
return data_out;
}
};
Y.DataSchema.Array = Y.mix(SchemaArray, Y.DataSchema.Base);
}, '@VERSION@' ,{requires:['dataschema-base']});
YUI.add('dataschema-text', function(Y) {
/**
* Provides a DataSchema implementation which can be used to work with Text data
*
* @module dataschema
* @submodule dataschema-text
*/
/**
* Text subclass for the YUI DataSchema utility.
* @class DataSchema.Text
* @extends DataSchema.Base
* @static
*/
var LANG = Y.Lang,
SchemaText = {
/////////////////////////////////////////////////////////////////////////////
//
// DataSchema.Text static methods
//
/////////////////////////////////////////////////////////////////////////////
/**
* Applies a given schema to given delimited text data.
*
* @method apply
* @param schema {Object} Schema to apply.
* @param data {Object} Text data.
* @return {Object} Schema-parsed data.
* @static
*/
apply: function(schema, data) {
var data_in = data,
data_out = {results:[],meta:{}};
if(LANG.isString(data_in) && LANG.isString(schema.resultDelimiter)) {
// Parse results data
data_out = SchemaText._parseResults(schema, data_in, data_out);
}
else {
data_out.error = new Error("Text schema parse failure");
}
return data_out;
},
/**
* Schema-parsed list of results from full data
*
* @method _parseResults
* @param schema {Array} Schema to parse against.
* @param text_in {String} Text to parse.
* @param data_out {Object} In-progress parsed data to update.
* @return {Object} Parsed data object.
* @static
* @protected
*/
_parseResults: function(schema, text_in, data_out) {
var resultDelim = schema.resultDelimiter,
results = [],
results_in, fields_in, result, item, fields, field, key, value, i, j,
// Delete final delimiter at end of string if there
tmpLength = text_in.length-resultDelim.length;
if(text_in.substr(tmpLength) == resultDelim) {
text_in = text_in.substr(0, tmpLength);
}
// Split into results
results_in = text_in.split(schema.resultDelimiter);
for(i=results_in.length-1; i>-1; i--) {
result = {};
item = results_in[i];
if(LANG.isString(schema.fieldDelimiter)) {
fields_in = item.split(schema.fieldDelimiter);
if(LANG.isArray(schema.resultFields)) {
fields = schema.resultFields;
for(j=fields.length-1; j>-1; j--) {
field = fields[j];
key = (!LANG.isUndefined(field.key)) ? field.key : field;
value = (!LANG.isUndefined(fields_in[key])) ? fields_in[key] : fields_in[j];
result[key] = Y.DataSchema.Base.parse(value, field);
}
}
}
else {
result = item;
}
results[i] = result;
}
data_out.results = results;
return data_out;
}
};
Y.DataSchema.Text = Y.mix(SchemaText, Y.DataSchema.Base);
}, '@VERSION@' ,{requires:['dataschema-base']});
YUI.add('dataschema', function(Y){}, '@VERSION@' ,{use:['dataschema-base','dataschema-json','dataschema-xml','dataschema-array','dataschema-text']});