datasource/js/datasource-jsonparser.js

	datasource-jsonparser.js revision 3ab1d84918e2599d8b7cae1fd6632c311c808774
/**
 * Extends DataSource with schema-based JSON parsing functionality.
 *
 * @module datasource
 * @submodule datasource-dataparser
 */

/**
 * Adds parsability to the YUI DataSource utility.
 * @class DataSourceJSONParser
 * @extends Plugin
 */
var DataSourceJSONParser = function() {
    DataSourceJSONParser.superclass.constructor.apply(this, arguments);
};

Y.mix(DataSourceJSONParser, {
    /**
     * The namespace for the plugin. This will be the property on the host which
     * references the plugin instance.
     *
     * @property NS
     * @type String
     * @static
     * @final
     * @value "parser"
     */
    NS: "parser",

    /**
     * Class name.
     *
     * @property NAME
     * @type String
     * @static
     * @final
     * @value "DataSourceJSONParser"
     */
    NAME: "DataSourceJSONParser",

    /////////////////////////////////////////////////////////////////////////////
    //
    // DataSourceCache Attributes
    //
    /////////////////////////////////////////////////////////////////////////////

    ATTRS: {
        parser: {
            readOnly: true,
            value: Y.DataParser.JSON,
            useRef: true
        },
        schema: {
            //value: {}
        }
    }
});

Y.extend(DataSourceJSONParser, Y.Plugin, {
    /**
    * Internal init() handler.
    *
    * @method initializer
    * @param config {Object} Config object.
    * @private
    */
    initializer: function(config) {
        this.doBefore("_defDataFn", this._beforeDefDataFn);
    },

    /**
     * Parses raw data into a normalized response.
     *
     * @method _beforeDefDataFn
     * <dl>
     * <dt>tId (Number)</dt> <dd>Unique transaction ID.</dd>
     * <dt>request (Object)</dt> <dd>The request.</dd>
     * <dt>callback (Object)</dt> <dd>The callback object with the following properties:
     *     <dl>
     *         <dt>success (Function)</dt> <dd>Success handler.</dd>
     *         <dt>failure (Function)</dt> <dd>Failure handler.</dd>
     *         <dt>scope (Object)</dt> <dd>Execution context.</dd>
     *     </dl>
     * </dd>
     * <dt>data (Object)</dt> <dd>Raw data.</dd>
     * </dl>
     * @protected
     */
    _beforeDefDataFn: function(e) {
        // TODO: Remove temporary workaround for bug #2527838
        e._yuifacade = false;

        var response = (this.get("parser").parse(this.get("schema"), e.data));
        if(!response) {
            response = {
                meta: {},
                results: e.data
            };
        }
        this._owner.fire("response", Y.mix({response:response}, e));
        return new Y.Do.Halt("DataSourceJSONParser plugin halted _defDataFn");
    }
});

Y.namespace('plugin');
Y.plugin.DataSourceJSONParser = DataSourceJSONParser;