Skip to content

Instantly share code, notes, and snippets.

@pieterv
Last active December 14, 2015 00:49
Show Gist options
  • Save pieterv/5001516 to your computer and use it in GitHub Desktop.
Save pieterv/5001516 to your computer and use it in GitHub Desktop.
Wire.js plugin that can connect event handlers after an object is initialised, and disconnect them when an object is destroyed.
define( {
plugins: [
{ module: 'wire/backbone/events' }
],
model: {
create: {
module: 'model',
}
},
view: {
create: {
module: 'view',
},
connect: {
'model': {
'change' : 'onChange',
'change:value' : 'onValueChange'
}
}
}
} );
/**
* @license Copyright (c) 2010-2011 Brian Cavalier
* LICENSE: see the LICENSE.txt file. If file is missing, this file is subject
* to the MIT License at: http://www.opensource.org/licenses/mit-license.php.
*/
/*
File: events.js
wire plugin that can connect event handlers after an object is initialized,
and disconnect them when an object is destroyed.
*/
define( function() {
return {
wire$plugin: function eventsPlugin( ready, destroyed, options ) {
var event_handlers = [];
function connect( target, ref, options, wire ) {
// Connect to events
wire.resolveRef( ref ).then( function( resolved ) {
for ( var eventName in options ) {
bindEvent( resolved, eventName, options[ eventName ], target );
}
});
}
function bindEvent( backbone_obj, eventName, callback_name, context ) {
var callback;
// Make sure the object is bindable
// TODO: the bind check could be more robust
if ( !backbone_obj || typeof backbone_obj.on != 'function' ) return;
var args = arguments;
callback = function() {
if ( !context[ callback_name ] ) return;
context[ callback_name ].apply( context, arguments );
};
backbone_obj.on( eventName, callback );
event_handlers.push( function unbind() {
backbone_obj.off( eventName, callback );
} );
}
/*
Function: connectFacet
Setup connections for each specified in the connects param. Each key
in connects is a reference, and the corresponding value is an object
whose keys are event names, and whose values are methods of object to
invoke. For example:
connect: {
"refToOtherThing": {
"eventOrMethodOfOtherThing": "myOwnMethod"
}
}
Parameters:
factory - wiring factory
object - object being wired, will be the target of connected events
connects - specification of events to connect, see examples above.
*/
function connectFacet( wire, target, connects ) {
for ( var ref in connects ) {
connect( target, ref, connects[ ref ], wire );
}
}
destroyed.then( function onContextDestroy() {
for ( var i = event_handlers.length - 1; i >= 0; i-- ) {
if ( event_handlers[ i ] ) event_handlers[ i ]();
}
event_handlers = null;
} );
return {
facets: {
connect: {
configure: function( promise, facet, wire ) {
connectFacet( wire, facet.target, facet.options );
promise.resolve();
}
}
}
};
}
};
});
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment