6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai /**
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai * Adds pluginhost constructor configuration and static configuration support
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai * @submodule pluginhost-config
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai */
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai
1e467ec3dfebabf9895552c6e7e85d4660a18969Satyen Desai var PluginHost = Y.Plugin.Host,
1e467ec3dfebabf9895552c6e7e85d4660a18969Satyen Desai L = Y.Lang;
1e467ec3dfebabf9895552c6e7e85d4660a18969Satyen Desai
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai /**
1e467ec3dfebabf9895552c6e7e85d4660a18969Satyen Desai * A protected initialization method, used by the host class to initialize
1e467ec3dfebabf9895552c6e7e85d4660a18969Satyen Desai * plugin configurations passed the constructor, through the config object.
1e467ec3dfebabf9895552c6e7e85d4660a18969Satyen Desai *
1e467ec3dfebabf9895552c6e7e85d4660a18969Satyen Desai * Host objects should invoke this method at the appropriate time in their
1e467ec3dfebabf9895552c6e7e85d4660a18969Satyen Desai * construction lifecycle.
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai *
1e467ec3dfebabf9895552c6e7e85d4660a18969Satyen Desai * @method _initConfigPlugins
1e467ec3dfebabf9895552c6e7e85d4660a18969Satyen Desai * @param {Object} config The configuration object passed to the constructor
1e467ec3dfebabf9895552c6e7e85d4660a18969Satyen Desai * @protected
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai * @for Plugin.Host
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai */
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai PluginHost.prototype._initConfigPlugins = function(config) {
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai // Class Configuration
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai var classes = (this._getClasses) ? this._getClasses() : [this.constructor],
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai plug = [],
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai unplug = {},
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai constructor, i, classPlug, classUnplug, pluginClassName;
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai // TODO: Room for optimization. Can we apply statically/unplug in same pass?
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai for (i = classes.length - 1; i >= 0; i--) {
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai constructor = classes[i];
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai classUnplug = constructor._UNPLUG;
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai if (classUnplug) {
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai // subclasses over-write
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai Y.mix(unplug, classUnplug, true);
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai }
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai classPlug = constructor._PLUG;
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai if (classPlug) {
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai // subclasses over-write
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai Y.mix(plug, classPlug, true);
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai }
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai }
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai for (pluginClassName in plug) {
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai if (plug.hasOwnProperty(pluginClassName)) {
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai if (!unplug[pluginClassName]) {
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai this.plug(plug[pluginClassName]);
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai }
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai }
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai }
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai // User Configuration
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai if (config && config.plugins) {
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai this.plug(config.plugins);
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai }
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai };
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai /**
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai * Registers plugins to be instantiated at the class level (plugins
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai * which should be plugged into every instance of the class by default).
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai *
10d8bafc5c24f3a4285cf6060a1935ba5cfc4b85Luke Smith * @method plug
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai * @static
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai *
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai * @param {Function} hostClass The host class on which to register the plugins
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai * @param {Function | Array} plugin Either the plugin class, an array of plugin classes or an array of objects (with fn and cfg properties defined)
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai * @param {Object} config (Optional) If plugin is the plugin class, the configuration for the plugin
10d8bafc5c24f3a4285cf6060a1935ba5cfc4b85Luke Smith * @for Plugin.Host
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai */
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai PluginHost.plug = function(hostClass, plugin, config) {
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai // Cannot plug into Base, since Plugins derive from Base [ will cause infinite recurrsion ]
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai var p, i, l, name;
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai if (hostClass !== Y.Base) {
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai hostClass._PLUG = hostClass._PLUG || {};
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai if (!L.isArray(plugin)) {
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai if (config) {
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai plugin = {fn:plugin, cfg:config};
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai }
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai plugin = [plugin];
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai }
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai for (i = 0, l = plugin.length; i < l;i++) {
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai p = plugin[i];
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai name = p.NAME || p.fn.NAME;
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai hostClass._PLUG[name] = p;
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai }
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai }
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai };
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai /**
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai * Unregisters any class level plugins which have been registered by the host class, or any
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai * other class in the hierarchy.
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai *
10d8bafc5c24f3a4285cf6060a1935ba5cfc4b85Luke Smith * @method unplug
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai * @static
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai *
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai * @param {Function} hostClass The host class from which to unregister the plugins
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai * @param {Function | Array} plugin The plugin class, or an array of plugin classes
10d8bafc5c24f3a4285cf6060a1935ba5cfc4b85Luke Smith * @for Plugin.Host
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai */
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai PluginHost.unplug = function(hostClass, plugin) {
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai var p, i, l, name;
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai if (hostClass !== Y.Base) {
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai hostClass._UNPLUG = hostClass._UNPLUG || {};
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai if (!L.isArray(plugin)) {
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai plugin = [plugin];
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai }
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai for (i = 0, l = plugin.length; i < l; i++) {
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai p = plugin[i];
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai name = p.NAME;
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai if (!hostClass._PLUG[name]) {
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai hostClass._UNPLUG[name] = p;
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai } else {
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai delete hostClass._PLUG[name];
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai }
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai }
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai }
6c96442b6a372e466ea59417a4e147d4fbd4a006Satyen Desai };