autocomplete-sources-debug.js revision c0486d6f93858a5de5737e65f736d40e4b0feed5
/**
Mixes support for JSONP and YQL result sources into AutoCompleteBase.
@module autocomplete
@submodule autocomplete-sources
**/
var ACBase = Y.AutoCompleteBase,
_SOURCE_SUCCESS = '_sourceSuccess',
MAX_RESULTS = 'maxResults',
REQUEST_TEMPLATE = 'requestTemplate',
RESULT_LIST_LOCATOR = 'resultListLocator';
// Add prototype properties and methods to AutoCompleteBase.
/**
Regular expression used to determine whether a String source is a YQL query.
@property _YQL_SOURCE_REGEX
@type RegExp
@protected
@for AutoCompleteBase
**/
/**
Runs before AutoCompleteBase's `_createObjectSource()` method and augments
it to support additional object-based source types.
@method _beforeCreateObjectSource
@param {String} source
@protected
@for AutoCompleteBase
**/
_beforeCreateObjectSource: function (source) {
// If the object is a <select> node, use the options as the result
// source.
return this._createSelectSource(source);
}
// If the object is a JSONPRequest instance, try to use it as a JSONP
// source.
return this._createJSONPSource(source);
}
// Fall back to a basic object source.
return this._createObjectSource(source);
},
/**
Creates a DataSource-like object that uses `Y.io` as a source. See the
`source` attribute for more details.
@method _createIOSource
@param {String} source URL.
@return {Object} DataSource-like object.
@protected
@for AutoCompleteBase
**/
_createIOSource: function (source) {
that = this,
// Private internal _sendRequest method that will be assigned to
// ioSource.sendRequest once io-base and json-parse are available.
function _sendRequest(request) {
// Return immediately on a cached response.
return;
}
// Cancel any outstanding requests.
}
on: {
var data;
try {
} catch (ex) {
}
if (data) {
}
}
}
});
}
// Keep track of the most recent request in case there are multiple
// requests while we're waiting for the IO module to load. Only the
// most recent request will be sent.
if (loading) { return; }
loading = true;
// Lazy-load the io-base and json-parse modules if necessary,
// then overwrite the sendRequest method to bypass this check in
// the future.
});
};
return ioSource;
},
/**
Creates a DataSource-like object that uses the specified JSONPRequest
instance as a source. See the `source` attribute for more details.
@method _createJSONPSource
@param {JSONPRequest|String} source URL string or JSONPRequest instance.
@return {Object} DataSource-like object.
@protected
@for AutoCompleteBase
**/
_createJSONPSource: function (source) {
that = this,
function _sendRequest(request) {
return;
}
// Hack alert: JSONPRequest currently doesn't support
// per-request callbacks, so we're reaching into the protected
// _config object to make it happen.
//
// This limitation is mentioned in the following JSONP
// enhancement ticket:
//
};
}
// Keep track of the most recent request in case there are multiple
// requests while we're waiting for the JSONP module to load. Only
// the most recent request will be sent.
if (loading) { return; }
loading = true;
// Lazy-load the JSONP module if necessary, then overwrite the
// sendRequest method to bypass this check in the future.
Y.use('jsonp', function () {
// Turn the source into a JSONPRequest instance if it isn't
// one already.
if (!(source instanceof Y.JSONPRequest)) {
});
}
});
};
return jsonpSource;
},
/**
Creates a DataSource-like object that uses the specified `<select>` node as
a source.
@method _createSelectSource
@param {Node} source YUI Node instance wrapping a `<select>` node.
@return {Object} DataSource-like object.
@protected
@for AutoCompleteBase
**/
_createSelectSource: function (source) {
var that = this;
return {
type: 'select',
sendRequest: function (request) {
var options = [];
});
});
}
};
},
/**
Creates a DataSource-like object that calls the specified URL or executes
the specified YQL query for results. If the string starts with "select ",
"use ", or "set " (case-insensitive), it's assumed to be a YQL query;
otherwise, it's assumed to be a URL (which may be absolute or relative).
URLs containing a "{callback}" placeholder are assumed to be JSONP URLs; all
others will use XHR. See the `source` attribute for more details.
@method _createStringSource
@param {String} source URL or YQL query.
@return {Object} DataSource-like object.
@protected
@for AutoCompleteBase
**/
_createStringSource: function (source) {
// Looks like a YQL query.
return this._createYQLSource(source);
// Contains a {callback} param and isn't a YQL query, so it must be
// JSONP.
return this._createJSONPSource(source);
} else {
// Not a YQL query or JSONP, so we'll assume it's an XHR URL.
return this._createIOSource(source);
}
},
/**
Creates a DataSource-like object that uses the specified YQL query string to
create a YQL-based source. See the `source` attribute for details. If no
`resultListLocator` is defined, this method will set a best-guess locator
that might work for many typical YQL queries.
@method _createYQLSource
@param {String} source YQL query.
@return {Object} DataSource-like object.
@protected
@for AutoCompleteBase
**/
_createYQLSource: function (source) {
var that = this,
}
function _sendRequest(request) {
});
return;
}
};
// Only create a new YQLRequest instance if this is the
// first request. For subsequent requests, we'll reuse the
// original instance.
if (yqlRequest) {
if (env) {
}
} else {
allowCache: false // temp workaround until JSONP has per-URL callback proxies
}
yqlRequest.send();
}
// Keep track of the most recent request in case there are multiple
// requests while we're waiting for the YQL module to load. Only the
// most recent request will be sent.
if (!loading) {
// Lazy-load the YQL module if necessary, then overwrite the
// sendRequest method to bypass this check in the future.
loading = true;
Y.use('yql', function () {
});
}
};
return yqlSource;
},
/**
Default resultListLocator used when a string-based YQL source is set and the
implementer hasn't already specified one.
@method _defaultYQLLocator
@param {Object} response YQL response object.
@return {Array}
@protected
@for AutoCompleteBase
**/
_defaultYQLLocator: function (response) {
// If there's only a single value on YQL's results object, that
// value almost certainly contains the array of results we want. If
// there are 0 or 2+ values, then the values themselves are most
// likely the results we want.
}
} else {
results = [];
}
return results;
},
/**
Returns a formatted XHR URL based on the specified base _url_, _query_, and
the current _requestTemplate_ if any.
@method _getXHRUrl
@param {String} url Base URL.
@param {Object} request Request object containing `query` and `request`
properties.
@return {String} Formatted URL.
@protected
@for AutoCompleteBase
**/
// Append the request template to the URL.
}
});
},
/**
URL formatter passed to `JSONPRequest` instances.
@method _jsonpFormatter
@param {String} url
@param {String} proxy
@param {String} query
@return {String} Formatted URL
@protected
@for AutoCompleteBase
**/
if (requestTemplate) {
}
});
}
});
// Add attributes to AutoCompleteBase.
/**
YQL environment file URL to load when the `source` is set to a YQL query.
Set this to `null` to use the default Open Data Tables environment file
@attribute yqlEnv
@type String
@default null
@for AutoCompleteBase
**/
yqlEnv: {
value: null
},
/**
URL protocol to use when the `source` is set to a YQL query.
@attribute yqlProtocol
@type String
@default 'http'
@for AutoCompleteBase
**/
yqlProtocol: {
value: 'http'
}
});
// Tell AutoCompleteBase about the new source types it can now support.
io : '_createIOSource',
jsonp : '_createJSONPSource',
select: '_createSelectSource',
string: '_createStringSource',
yql : '_createYQLSource'
}, true);
}, '@VERSION@' ,{requires:['autocomplete-base'], optional:['io-base', 'json-parse', 'jsonp', 'yql']});