lib/yuilib/3.13.0/datasource-textschema/datasource-textschema.js

   1 /*
   2 YUI 3.13.0 (build 508226d)
   3 Copyright 2013 Yahoo! Inc. All rights reserved.
   4 Licensed under the BSD License.
   5 http://yuilibrary.com/license/
   6 */
   7
   8 YUI.add('datasource-textschema', function (Y, NAME) {
   9
  10 /**
  11  * Extends DataSource with schema-parsing on text data.
  12  *
  13  * @module datasource
  14  * @submodule datasource-textschema
  15  */
  16
  17 /**
  18  * Adds schema-parsing to the DataSource Utility.
  19  * @class DataSourceTextSchema
  20  * @extends Plugin.Base
  21  */
  22 var DataSourceTextSchema = function() {
  23     DataSourceTextSchema.superclass.constructor.apply(this, arguments);
  24 };
  25
  26 Y.mix(DataSourceTextSchema, {
  27     /**
  28      * The namespace for the plugin. This will be the property on the host which
  29      * references the plugin instance.
  30      *
  31      * @property NS
  32      * @type String
  33      * @static
  34      * @final
  35      * @value "schema"
  36      */
  37     NS: "schema",
  38
  39     /**
  40      * Class name.
  41      *
  42      * @property NAME
  43      * @type String
  44      * @static
  45      * @final
  46      * @value "dataSourceTextSchema"
  47      */
  48     NAME: "dataSourceTextSchema",
  49
  50     /////////////////////////////////////////////////////////////////////////////
  51     //
  52     // DataSourceTextSchema Attributes
  53     //
  54     /////////////////////////////////////////////////////////////////////////////
  55
  56     ATTRS: {
  57         schema: {
  58             //value: {}
  59         }
  60     }
  61 });
  62
  63 Y.extend(DataSourceTextSchema, Y.Plugin.Base, {
  64     /**
  65     * Internal init() handler.
  66     *
  67     * @method initializer
  68     * @param config {Object} Config object.
  69     * @private
  70     */
  71     initializer: function(config) {
  72         this.doBefore("_defDataFn", this._beforeDefDataFn);
  73     },
  74
  75     /**
  76      * Parses raw data into a normalized response.
  77      *
  78      * @method _beforeDefDataFn
  79      * @param tId {Number} Unique transaction ID.
  80      * @param request {Object} The request.
  81      * @param callback {Object} The callback object with the following properties:
  82      *     <dl>
  83      *         <dt>success (Function)</dt> <dd>Success handler.</dd>
  84      *         <dt>failure (Function)</dt> <dd>Failure handler.</dd>
  85      *     </dl>
  86      * @param data {Object} Raw data.
  87      * @protected
  88      */
  89     _beforeDefDataFn: function(e) {
  90         var schema = this.get('schema'),
  91             payload = e.details[0],
  92             // TODO: Do I need to sniff for DS.IO + isString(responseText)?
  93             data = e.data.responseText || e.data;
  94
  95         payload.response = Y.DataSchema.Text.apply.call(this, schema, data) || {
  96             meta: {},
  97             results: data
  98         };
  99
 100         this.get("host").fire("response", payload);
 101
 102         return new Y.Do.Halt("DataSourceTextSchema plugin halted _defDataFn");
 103     }
 104 });
 105
 106 Y.namespace('Plugin').DataSourceTextSchema = DataSourceTextSchema;
 107
 108
 109 }, '3.13.0', {"requires": ["datasource-local", "plugin", "dataschema-text"]});