diff --git a/static/scripts/libs/backbone/backbone-relational.js b/static/scripts/libs/backbone/backbone-relational.js index 4f2910b845d..62b48eee968 100644 --- a/static/scripts/libs/backbone/backbone-relational.js +++ b/static/scripts/libs/backbone/backbone-relational.js @@ -1,15 +1,14 @@ -/* vim: set tabstop=4 softtabstop=4 shiftwidth=4 noexpandtab: */ /** - * Backbone-relational.js 0.8.0 - * (c) 2011-2013 Paul Uithol and contributors (https://github.com/PaulUithol/Backbone-relational/graphs/contributors) + * Backbone-relational.js 0.5.0 + * (c) 2011 Paul Uithol * - * Backbone-relational may be freely distributed under the MIT license; see the accompanying LICENSE.txt. + * Backbone-relational may be freely distributed under the MIT license. * For details and documentation: https://github.com/PaulUithol/Backbone-relational. - * Depends on Backbone (and thus on Underscore as well): https://github.com/documentcloud/backbone. + * Depends on Backbone: https://github.com/documentcloud/backbone. */ ( function( undefined ) { "use strict"; - + /** * CommonJS shim **/ @@ -35,7 +34,7 @@ Backbone.Semaphore = { _permitsAvailable: null, _permitsUsed: 0, - + acquire: function() { if ( this._permitsAvailable && this._permitsUsed >= this._permitsAvailable ) { throw new Error( 'Max permits acquired' ); @@ -44,7 +43,7 @@ this._permitsUsed++; } }, - + release: function() { if ( this._permitsUsed === 0 ) { throw new Error( 'All permits released' ); @@ -53,11 +52,11 @@ this._permitsUsed--; } }, - + isLocked: function() { return this._permitsUsed > 0; }, - + setAvailablePermits: function( amount ) { if ( this._permitsUsed > amount ) { throw new Error( 'Available permits cannot be less than used permits' ); @@ -65,7 +64,7 @@ this._permitsAvailable = amount; } }; - + /** * A BlockingQueue that accumulates items while blocked (via 'block'), * and processes them when unblocked (via 'unblock'). @@ -76,7 +75,7 @@ }; _.extend( Backbone.BlockingQueue.prototype, Backbone.Semaphore, { _queue: null, - + add: function( func ) { if ( this.isBlocked() ) { this._queue.push( func ); @@ -85,34 +84,34 @@ func(); } }, - + process: function() { while ( this._queue && this._queue.length ) { this._queue.shift()(); } }, - + block: function() { this.acquire(); }, - + unblock: function() { this.release(); if ( !this.isBlocked() ) { this.process(); } }, - + isBlocked: function() { return this.isLocked(); } }); /** - * Global event queue. Accumulates external events ('add:', 'remove:' and 'change:') + * Global event queue. Accumulates external events ('add:', 'remove:' and 'update:') * until the top-level object is fully initialized (see 'Backbone.RelationalModel'). */ Backbone.Relational.eventQueue = new Backbone.BlockingQueue(); - + /** * Backbone.Store keeps track of all created (and destruction of) Backbone.RelationalModel. * Handles lookup for relations. @@ -120,31 +119,10 @@ Backbone.Store = function() { this._collections = []; this._reverseRelations = []; - this._orphanRelations = []; this._subModels = []; this._modelScopes = [ exports ]; }; _.extend( Backbone.Store.prototype, Backbone.Events, { - /** - * Create a new `Relation`. - * @param {Backbone.RelationalModel} [model] - * @param {Object} relation - * @param {Object} [options] - */ - initializeRelation: function( model, relation, options ) { - var type = !_.isString( relation.type ) ? relation.type : Backbone[ relation.type ] || this.getObjectByName( relation.type ); - if ( type && type.prototype instanceof Backbone.Relation ) { - new type( model, relation, options ); // Also pushes the new Relation into `model._relations` - } - else { - Backbone.Relational.showWarnings && typeof console !== 'undefined' && console.warn( 'Relation=%o; missing or invalid relation type!', relation ); - } - }, - - /** - * Add a scope for `getObjectByName` to look for model types by name. - * @param {Object} scope - */ addModelScope: function( scope ) { this._modelScopes.push( scope ); }, @@ -171,7 +149,7 @@ */ setupSuperModel: function( modelType ) { _.find( this._subModels, function( subModelDef ) { - return _.find( subModelDef.subModels || [], function( subModelTypeName, typeValue ) { + return _.find( subModelDef.subModels, function( subModelTypeName, typeValue ) { var subModelType = this.getObjectByName( subModelTypeName ); if ( modelType === subModelType ) { @@ -187,7 +165,7 @@ }, this ); }, this ); }, - + /** * Add a reverse relation. Is added to the 'relations' property on model's prototype, and to * existing instances of 'model' in the store as well. @@ -199,108 +177,74 @@ */ addReverseRelation: function( relation ) { var exists = _.any( this._reverseRelations, function( rel ) { - return _.all( relation || [], function( val, key ) { - return val === rel[ key ]; + return _.all( relation, function( val, key ) { + return val === rel[ key ]; + }); }); - }); if ( !exists && relation.model && relation.type ) { this._reverseRelations.push( relation ); - this._addRelation( relation.model, relation ); + + var addRelation = function( model, relation ) { + if ( !model.prototype.relations ) { + model.prototype.relations = []; + } + model.prototype.relations.push( relation ); + + _.each( model._subModels, function( subModel ) { + addRelation( subModel, relation ); + }, this ); + }; + + addRelation( relation.model, relation ); + this.retroFitRelation( relation ); } }, - - /** - * Deposit a `relation` for which the `relatedModel` can't be resolved at the moment. - * - * @param {Object} relation - */ - addOrphanRelation: function( relation ) { - var exists = _.any( this._orphanRelations, function( rel ) { - return _.all( relation || [], function( val, key ) { - return val === rel[ key ]; - }); - }); - - if ( !exists && relation.model && relation.type ) { - this._orphanRelations.push( relation ); - } - }, - - /** - * Try to initialize any `_orphanRelation`s - */ - processOrphanRelations: function() { - // Make sure to operate on a copy since we're removing while iterating - _.each( this._orphanRelations.slice( 0 ), function( rel ) { - var relatedModel = Backbone.Relational.store.getObjectByName( rel.relatedModel ); - if ( relatedModel ) { - this.initializeRelation( null, rel ); - this._orphanRelations = _.without( this._orphanRelations, rel ); - } - }, this ); - }, - - /** - * - * @param {Backbone.RelationalModel.constructor} type - * @param {Object} relation - * @private - */ - _addRelation: function( type, relation ) { - if ( !type.prototype.relations ) { - type.prototype.relations = []; - } - type.prototype.relations.push( relation ); - - _.each( type._subModels || [], function( subModel ) { - this._addRelation( subModel, relation ); - }, this ); - }, - + /** * Add a 'relation' to all existing instances of 'relation.model' in the store * @param {Object} relation */ retroFitRelation: function( relation ) { - var coll = this.getCollection( relation.model, false ); - coll && coll.each( function( model ) { + var coll = this.getCollection( relation.model ); + coll.each( function( model ) { if ( !( model instanceof relation.model ) ) { return; } new relation.type( model, relation ); - }, this ); + }, this); }, - + /** * Find the Store's collection for a certain type of model. - * @param {Backbone.RelationalModel} type - * @param {Boolean} [create=true] Should a collection be created if none is found? + * @param {Backbone.RelationalModel} model * @return {Backbone.Collection} A collection if found (or applicable for 'model'), or null */ - getCollection: function( type, create ) { - if ( type instanceof Backbone.RelationalModel ) { - type = type.constructor; + getCollection: function( model ) { + if ( model instanceof Backbone.RelationalModel ) { + model = model.constructor; } - var rootModel = type; + var rootModel = model; while ( rootModel._superModel ) { rootModel = rootModel._superModel; } - var coll = _.findWhere( this._collections, { model: rootModel } ); + var coll = _.detect( this._collections, function( c ) { + return c.model === rootModel; + }); - if ( !coll && create !== false ) { - coll = this._createCollection( rootModel ); + if ( !coll ) { + coll = this._createCollection( model ); } return coll; }, - + /** - * Find a model type on one of the modelScopes by name. Names are split on dots. + * Find a type on the global object by name. Splits name on dots. * @param {String} name * @return {Object} */ @@ -309,8 +253,8 @@ type = null; _.find( this._modelScopes, function( scope ) { - type = _.reduce( parts || [], function( memo, val ) { - return memo ? memo[ val ] : undefined; + type = _.reduce( parts, function( memo, val ) { + return memo[ val ]; }, scope ); if ( type && type !== scope ) { @@ -320,7 +264,7 @@ return type; }, - + _createCollection: function( type ) { var coll; @@ -344,12 +288,11 @@ * Find the attribute that is to be used as the `id` on a given object * @param type * @param {String|Number|Object|Backbone.RelationalModel} item - * @return {String|Number} */ resolveIdForItem: function( type, item ) { var id = _.isString( item ) || _.isNumber( item ) ? item : null; - if ( id === null ) { + if ( id == null ) { if ( item instanceof Backbone.RelationalModel ) { id = item.id; } @@ -358,11 +301,6 @@ } } - // Make all falsy values `null` (except for 0, which could be an id.. see '/issues/179') - if ( !id && id !== 0 ) { - id = null; - } - return id; }, @@ -387,67 +325,45 @@ return null; }, - + /** - * Add a 'model' to its appropriate collection. Retain the original contents of 'model.collection'. + * Add a 'model' to it's appropriate collection. Retain the original contents of 'model.collection'. * @param {Backbone.RelationalModel} model */ register: function( model ) { + var modelColl = model.collection; var coll = this.getCollection( model ); - - if ( coll ) { - if ( coll.get( model ) ) { - if ( Backbone.Relational.showWarnings && typeof console !== 'undefined' ) { - console.warn( 'Duplicate id! Old RelationalModel=%o, new RelationalModel=%o', coll.get( model ), model ); - } - throw new Error( "Cannot instantiate more than one Backbone.RelationalModel with the same id per type!" ); - } - - var modelColl = model.collection; - coll.add( model ); - this.listenTo( model, 'destroy', this.unregister, this ); - model.collection = modelColl; - } + coll && coll.add( model ); + model.bind( 'destroy', this.unregister, this ); + model.collection = modelColl; }, - + /** - * Explicitly update a model's id in its store collection + * Explicitly update a model's id in it's store collection * @param {Backbone.RelationalModel} model - */ + */ update: function( model ) { var coll = this.getCollection( model ); coll._onModelEvent( 'change:' + model.idAttribute, model, coll ); }, - + /** * Remove a 'model' from the store. * @param {Backbone.RelationalModel} model */ unregister: function( model ) { - this.stopListening( model, 'destroy', this.unregister ); + model.unbind( 'destroy', this.unregister ); var coll = this.getCollection( model ); coll && coll.remove( model ); - }, - - /** - * Reset the `store` to it's original state. The `reverseRelations` are kept though, since attempting to - * re-initialize these on models would lead to a large amount of warnings. - */ - reset: function() { - this.stopListening(); - this._collections = []; - this._subModels = []; - this._modelScopes = [ exports ]; } }); Backbone.Relational.store = new Backbone.Store(); - + /** * The main Relation class, from which 'HasOne' and 'HasMany' inherit. Internally, 'relational:' events * are used to regulate addition and removal of models from relations. * - * @param {Backbone.RelationalModel} [instance] Model that this relation is created for. If no model is supplied, - * Relation just tries to instantiate it's `reverseRelation` if specified, and bails out after that. + * @param {Backbone.RelationalModel} instance * @param {Object} options * @param {string} options.key * @param {Backbone.RelationalModel.constructor} options.relatedModel @@ -456,30 +372,41 @@ * @param {Object} [options.reverseRelation] Specify a bi-directional relation. If provided, Relation will reciprocate * the relation to the 'relatedModel'. Required and optional properties match 'options', except that it also needs * {Backbone.Relation|String} type ('HasOne' or 'HasMany'). - * @param {Object} opts */ - Backbone.Relation = function( instance, options, opts ) { + Backbone.Relation = function( instance, options ) { this.instance = instance; // Make sure 'options' is sane, and fill with defaults from subclasses and this object's prototype options = _.isObject( options ) ? options : {}; this.reverseRelation = _.defaults( options.reverseRelation || {}, this.options.reverseRelation ); - this.options = _.defaults( options, this.options, Backbone.Relation.prototype.options ); - this.reverseRelation.type = !_.isString( this.reverseRelation.type ) ? this.reverseRelation.type : Backbone[ this.reverseRelation.type ] || Backbone.Relational.store.getObjectByName( this.reverseRelation.type ); - + this.model = options.model || this.instance.constructor; + this.options = _.defaults( options, this.options, Backbone.Relation.prototype.options ); + this.key = this.options.key; this.keySource = this.options.keySource || this.key; this.keyDestination = this.options.keyDestination || this.keySource || this.key; - this.model = this.options.model || this.instance.constructor; + // 'exports' should be the global object where 'relatedModel' can be found on if given as a string. this.relatedModel = this.options.relatedModel; if ( _.isString( this.relatedModel ) ) { this.relatedModel = Backbone.Relational.store.getObjectByName( this.relatedModel ); } if ( !this.checkPreconditions() ) { - return; + return false; + } + + if ( instance ) { + this.keyContents = this.instance.get( this.keySource ); + + // Explicitly clear 'keySource', to prevent a leaky abstraction if 'keySource' differs from 'key'. + if ( this.key !== this.keySource ) { + this.instance.unset( this.keySource, { silent: true } ); + } + + // Add this Relation to instance._relations + this.instance._relations.push( this ); } // Add the reverse relation on 'relatedModel' to the store's reverseRelations @@ -488,39 +415,25 @@ isAutoRelation: true, model: this.relatedModel, relatedModel: this.model, - reverseRelation: this.options // current relation is the 'reverseRelation' for its own reverseRelation + reverseRelation: this.options // current relation is the 'reverseRelation' for it's own reverseRelation }, this.reverseRelation // Take further properties from this.reverseRelation (type, key, etc.) ) ); } + _.bindAll( this, '_modelRemovedFromCollection', '_relatedModelAdded', '_relatedModelRemoved' ); + if ( instance ) { - var contentKey = this.keySource; - if ( contentKey !== this.key && typeof this.instance.get( this.key ) === 'object' ) { - contentKey = this.key; - } + this.initialize(); - this.setKeyContents( this.instance.get( contentKey ) ); - this.relatedCollection = Backbone.Relational.store.getCollection( this.relatedModel ); - - // Explicitly clear 'keySource', to prevent a leaky abstraction if 'keySource' differs from 'key'. - if ( this.keySource !== this.key ) { - this.instance.unset( this.keySource, { silent: true } ); - } - - // Add this Relation to instance._relations - this.instance._relations[ this.key ] = this; - - this.initialize( opts ); - - if ( this.options.autoFetch ) { - this.instance.fetchRelated( this.key, _.isObject( this.options.autoFetch ) ? this.options.autoFetch : {} ); - } + // When a model in the store is destroyed, check if it is 'this.instance'. + Backbone.Relational.store.getCollection( this.instance ) + .bind( 'relational:remove', this._modelRemovedFromCollection ); // When 'relatedModel' are created or destroyed, check if it affects this relation. - this.listenTo( this.instance, 'destroy', this.destroy ) - .listenTo( this.relatedCollection, 'relational:add', this.tryAddRelated ) - .listenTo( this.relatedCollection, 'relational:remove', this.removeRelated ) + Backbone.Relational.store.getCollection( this.relatedModel ) + .bind( 'relational:add', this._relatedModelAdded ) + .bind( 'relational:remove', this._relatedModelRemoved ); } }; // Fix inheritance :\ @@ -530,19 +443,35 @@ options: { createModels: true, includeInJSON: true, - isAutoRelation: false, - autoFetch: false, - parse: false + isAutoRelation: false }, - + instance: null, key: null, keyContents: null, relatedModel: null, - relatedCollection: null, reverseRelation: null, related: null, - + + _relatedModelAdded: function( model, coll, options ) { + // Allow 'model' to set up it's relations, before calling 'tryAddRelated' + // (which can result in a call to 'addRelated' on a relation of 'model') + var dit = this; + model.queue( function() { + dit.tryAddRelated( model, options ); + }); + }, + + _relatedModelRemoved: function( model, coll, options ) { + this.removeRelated( model, options ); + }, + + _modelRemovedFromCollection: function( model ) { + if ( model === this.instance ) { + this.destroy(); + } + }, + /** * Check several pre-conditions. * @return {Boolean} True if pre-conditions are satisfied, false if they're not. @@ -555,33 +484,36 @@ warn = Backbone.Relational.showWarnings && typeof console !== 'undefined'; if ( !m || !k || !rm ) { - warn && console.warn( 'Relation=%o: missing model, key or relatedModel (%o, %o, %o).', this, m, k, rm ); + warn && console.warn( 'Relation=%o; no model, key or relatedModel (%o, %o, %o)', this, m, k, rm ); return false; } - // Check if the type in 'model' inherits from Backbone.RelationalModel + // Check if the type in 'relatedModel' inherits from Backbone.RelationalModel if ( !( m.prototype instanceof Backbone.RelationalModel ) ) { - warn && console.warn( 'Relation=%o: model does not inherit from Backbone.RelationalModel (%o).', this, i ); + warn && console.warn( 'Relation=%o; model does not inherit from Backbone.RelationalModel (%o)', this, i ); return false; } // Check if the type in 'relatedModel' inherits from Backbone.RelationalModel if ( !( rm.prototype instanceof Backbone.RelationalModel ) ) { - warn && console.warn( 'Relation=%o: relatedModel does not inherit from Backbone.RelationalModel (%o).', this, rm ); + warn && console.warn( 'Relation=%o; relatedModel does not inherit from Backbone.RelationalModel (%o)', this, rm ); return false; } // Check if this is not a HasMany, and the reverse relation is HasMany as well if ( this instanceof Backbone.HasMany && this.reverseRelation.type === Backbone.HasMany ) { - warn && console.warn( 'Relation=%o: relation is a HasMany, and the reverseRelation is HasMany as well.', this ); + warn && console.warn( 'Relation=%o; relation is a HasMany, and the reverseRelation is HasMany as well.', this ); return false; } - // Check if we're not attempting to create a relationship on a `key` that's already used. - if ( i && _.keys( i._relations ).length ) { - var existing = _.find( i._relations, function( rel ) { - return rel.key === k; - }, this ); - if ( existing ) { - warn && console.warn( 'Cannot create relation=%o on %o for model=%o: already taken by relation=%o.', - this, k, i, existing ); + // Check if we're not attempting to create a duplicate relationship + if ( i && i._relations.length ) { + var exists = _.any( i._relations, function( rel ) { + var hasReverseRelation = this.reverseRelation.key && rel.reverseRelation.key; + return rel.relatedModel === rm && rel.key === k && + ( !hasReverseRelation || this.reverseRelation.key === rel.reverseRelation.key ); + }, this ); + + if ( exists ) { + warn && console.warn( 'Relation=%o between instance=%o.%s and relatedModel=%o.%s already exists', + this, i, k, rm, this.reverseRelation.key ); return false; } } @@ -591,16 +523,17 @@ /** * Set the related model(s) for this relation - * @param {Backbone.Model|Backbone.Collection} related + * @param {Backbone.Mode|Backbone.Collection} related + * @param {Object} [options] */ - setRelated: function( related ) { + setRelated: function( related, options ) { this.related = related; this.instance.acquire(); - this.instance.attributes[ this.key ] = related; + this.instance.set( this.key, related, _.defaults( options || {}, { silent: true } ) ); this.instance.release(); }, - + /** * Determine if a relation (on a different RelationalModel) is the reverse * relation of the current one. @@ -608,10 +541,13 @@ * @return {Boolean} */ _isReverseRelation: function( relation ) { - return relation.instance instanceof this.relatedModel && this.reverseRelation.key === relation.key && - this.key === relation.reverseRelation.key; + if ( relation.instance instanceof this.relatedModel && this.reverseRelation.key === relation.key && + this.key === relation.reverseRelation.key ) { + return true; + } + return false; }, - + /** * Get the reverse relations (pointing back to 'this.key' on 'this.instance') for the currently related model(s). * @param {Backbone.RelationalModel} [model] Get the reverse relations for a specific model. @@ -622,87 +558,97 @@ var reverseRelations = []; // Iterate over 'model', 'this.related.models' (if this.related is a Backbone.Collection), or wrap 'this.related' in an array. var models = !_.isUndefined( model ) ? [ model ] : this.related && ( this.related.models || [ this.related ] ); - _.each( models || [], function( related ) { - _.each( related.getRelations() || [], function( relation ) { - if ( this._isReverseRelation( relation ) ) { - reverseRelations.push( relation ); - } - }, this ); - }, this ); + _.each( models , function( related ) { + _.each( related.getRelations(), function( relation ) { + if ( this._isReverseRelation( relation ) ) { + reverseRelations.push( relation ); + } + }, this ); + }, this ); return reverseRelations; }, + + /** + * Rename options.silent to options.silentChange, so events propagate properly. + * (for example in HasMany, from 'addRelated'->'handleAddition') + * @param {Object} [options] + * @return {Object} + */ + sanitizeOptions: function( options ) { + options = options ? _.clone( options ) : {}; + if ( options.silent ) { + options.silentChange = true; + delete options.silent; + } + return options; + }, /** - * When `this.instance` is destroyed, cleanup our relations. - * Get reverse relation, call removeRelated on each. + * Rename options.silentChange to options.silent, so events are silenced as intended in Backbone's + * original functions. + * @param {Object} [options] + * @return {Object} */ + unsanitizeOptions: function( options ) { + options = options ? _.clone( options ) : {}; + if ( options.silentChange ) { + options.silent = true; + delete options.silentChange; + } + return options; + }, + + // Cleanup. Get reverse relation, call removeRelated on each. destroy: function() { - this.stopListening(); - - if ( this instanceof Backbone.HasOne ) { - this.setRelated( null ); - } - else if ( this instanceof Backbone.HasMany ) { - this.setRelated( this._prepareCollection() ); - } + Backbone.Relational.store.getCollection( this.instance ) + .unbind( 'relational:remove', this._modelRemovedFromCollection ); + + Backbone.Relational.store.getCollection( this.relatedModel ) + .unbind( 'relational:add', this._relatedModelAdded ) + .unbind( 'relational:remove', this._relatedModelRemoved ); _.each( this.getReverseRelations(), function( relation ) { - relation.removeRelated( this.instance ); - }, this ); + relation.removeRelated( this.instance ); + }, this ); } }); - + Backbone.HasOne = Backbone.Relation.extend({ options: { reverseRelation: { type: 'HasMany' } }, + + initialize: function() { + _.bindAll( this, 'onChange' ); - initialize: function( opts ) { - this.listenTo( this.instance, 'relational:change:' + this.key, this.onChange ); + this.instance.bind( 'relational:change:' + this.key, this.onChange ); - var related = this.findRelated( opts ); - this.setRelated( related ); + var model = this.findRelated( { silent: true } ); + this.setRelated( model ); // Notify new 'related' object of the new relation. _.each( this.getReverseRelations(), function( relation ) { - relation.addRelated( this.instance, opts ); - }, this ); + relation.addRelated( this.instance ); + }, this ); }, - - /** - * Find related Models. - * @param {Object} [options] - * @return {Backbone.Model} - */ + findRelated: function( options ) { - var related = null; - - options = _.defaults( { parse: this.options.parse }, options ); - - if ( this.keyContents instanceof this.relatedModel ) { - related = this.keyContents; + var item = this.keyContents; + var model = null; + + if ( item instanceof this.relatedModel ) { + model = item; } - else if ( this.keyContents || this.keyContents === 0 ) { // since 0 can be a valid `id` as well - var opts = _.defaults( { create: this.options.createModels }, options ); - related = this.relatedModel.findOrCreate( this.keyContents, opts ); + else if ( item ) { + model = this.relatedModel.findOrCreate( item, { create: this.options.createModels } ); } - - return related; + + return model; }, - + /** - * Normalize and reduce `keyContents` to an `id`, for easier comparison - * @param {String|Number|Backbone.Model} keyContents - */ - setKeyContents: function( keyContents ) { - this.keyContents = keyContents; - this.keyId = Backbone.Relational.store.resolveIdForItem( this.relatedModel, this.keyContents ); - }, - - /** - * Event handler for `change:`. - * If the key is changed, notify old & new reverse relations and initialize the new relation. + * If the key is changed, notify old & new reverse relations and initialize the new relation */ onChange: function( model, attr, options ) { // Don't accept recursive calls to onChange (like onChange->findRelated->findOrCreate->initializeRelations->addRelated->onChange) @@ -710,70 +656,81 @@ return; } this.acquire(); - options = options ? _.clone( options ) : {}; + options = this.sanitizeOptions( options ); - // 'options.__related' is set by 'addRelated'/'removeRelated'. If it is set, the change + // 'options._related' is set by 'addRelated'/'removeRelated'. If it is set, the change // is the result of a call from a relation. If it's not, the change is the result of // a 'set' call on this.instance. - var changed = _.isUndefined( options.__related ), - oldRelated = changed ? this.related : options.__related; + var changed = _.isUndefined( options._related ); + var oldRelated = changed ? this.related : options._related; - if ( changed ) { - this.setKeyContents( attr ); - var related = this.findRelated( options ); - this.setRelated( related ); + if ( changed ) { + this.keyContents = attr; + + // Set new 'related' + if ( attr instanceof this.relatedModel ) { + this.related = attr; + } + else if ( attr ) { + var related = this.findRelated( options ); + this.setRelated( related ); + } + else { + this.setRelated( null ); + } } // Notify old 'related' object of the terminated relation if ( oldRelated && this.related !== oldRelated ) { _.each( this.getReverseRelations( oldRelated ), function( relation ) { - relation.removeRelated( this.instance, null, options ); - }, this ); + relation.removeRelated( this.instance, options ); + }, this ); } - + // Notify new 'related' object of the new relation. Note we do re-apply even if this.related is oldRelated; // that can be necessary for bi-directional relations if 'this.instance' was created after 'this.related'. // In that case, 'this.instance' will already know 'this.related', but the reverse might not exist yet. _.each( this.getReverseRelations(), function( relation ) { - relation.addRelated( this.instance, options ); - }, this ); + relation.addRelated( this.instance, options ); + }, this); - // Fire the 'change:' event if 'related' was updated - if ( !options.silent && this.related !== oldRelated ) { + // Fire the 'update:' event if 'related' was updated + if ( !options.silentChange && this.related !== oldRelated ) { var dit = this; - this.changed = true; Backbone.Relational.eventQueue.add( function() { - dit.instance.trigger( 'change:' + dit.key, dit.instance, dit.related, options, true ); - dit.changed = false; + dit.instance.trigger( 'update:' + dit.key, dit.instance, dit.related, options ); }); } this.release(); }, - + /** * If a new 'this.relatedModel' appears in the 'store', try to match it to the last set 'keyContents' */ - tryAddRelated: function( model, coll, options ) { - if ( ( this.keyId || this.keyId === 0 ) && model.id === this.keyId ) { // since 0 can be a valid `id` as well - this.addRelated( model, options ); - this.keyId = null; + tryAddRelated: function( model, options ) { + if ( this.related ) { + return; + } + options = this.sanitizeOptions( options ); + + var item = this.keyContents; + if ( item ) { + var id = Backbone.Relational.store.resolveIdForItem( this.relatedModel, item ); + if ( model.id === id ) { + this.addRelated( model, options ); + } } }, - + addRelated: function( model, options ) { - // Allow 'model' to set up its relations before proceeding. - // (which can result in a call to 'addRelated' from a relation of 'model') - var dit = this; - model.queue( function() { - if ( model !== dit.related ) { - var oldRelated = dit.related || null; - dit.setRelated( model ); - dit.onChange( dit.instance, model, _.defaults( { __related: oldRelated }, options ) ); - } - }); + if ( model !== this.related ) { + var oldRelated = this.related || null; + this.setRelated( model ); + this.onChange( this.instance, model, { _related: oldRelated } ); + } }, - - removeRelated: function( model, coll, options ) { + + removeRelated: function( model, options ) { if ( !this.related ) { return; } @@ -781,23 +738,24 @@ if ( model === this.related ) { var oldRelated = this.related || null; this.setRelated( null ); - this.onChange( this.instance, model, _.defaults( { __related: oldRelated }, options ) ); + this.onChange( this.instance, model, { _related: oldRelated } ); } } }); - + Backbone.HasMany = Backbone.Relation.extend({ collectionType: null, - + options: { reverseRelation: { type: 'HasOne' }, collectionType: Backbone.Collection, collectionKey: true, collectionOptions: {} }, - - initialize: function( opts ) { - this.listenTo( this.instance, 'relational:change:' + this.key, this.onChange ); + + initialize: function() { + _.bindAll( this, 'onChange', 'handleAddition', 'handleRemoval', 'handleReset' ); + this.instance.bind( 'relational:change:' + this.key, this.onChange ); // Handle a custom 'collectionType' this.collectionType = this.options.collectionType; @@ -805,29 +763,41 @@ this.collectionType = Backbone.Relational.store.getObjectByName( this.collectionType ); } if ( !this.collectionType.prototype instanceof Backbone.Collection ){ - throw new Error( '`collectionType` must inherit from Backbone.Collection' ); + throw new Error( 'collectionType must inherit from Backbone.Collection' ); } - var related = this.findRelated( opts ); - this.setRelated( related ); + // Handle cases where a model/relation is created with a collection passed straight into 'attributes' + if ( this.keyContents instanceof Backbone.Collection ) { + this.setRelated( this._prepareCollection( this.keyContents ) ); + } + else { + this.setRelated( this._prepareCollection() ); + } + + this.findRelated( { silent: true } ); + }, + + _getCollectionOptions: function() { + return _.isFunction( this.options.collectionOptions ) ? + this.options.collectionOptions( this.instance ) : + this.options.collectionOptions; }, /** * Bind events and setup collectionKeys for a collection that is to be used as the backing store for a HasMany. * If no 'collection' is supplied, a new collection will be created of the specified 'collectionType' option. * @param {Backbone.Collection} [collection] - * @return {Backbone.Collection} */ _prepareCollection: function( collection ) { if ( this.related ) { - this.stopListening( this.related ); + this.related + .unbind( 'relational:add', this.handleAddition ) + .unbind( 'relational:remove', this.handleRemoval ) + .unbind( 'relational:reset', this.handleReset ) } if ( !collection || !( collection instanceof Backbone.Collection ) ) { - var options = _.isFunction( this.options.collectionOptions ) ? - this.options.collectionOptions( this.instance ) : this.options.collectionOptions; - - collection = new this.collectionType( null, options ); + collection = new this.collectionType( [], this._getCollectionOptions() ); } collection.model = this.relatedModel; @@ -844,184 +814,191 @@ collection[ key ] = this.instance; } } - - this.listenTo( collection, 'relational:add', this.handleAddition ) - .listenTo( collection, 'relational:remove', this.handleRemoval ) - .listenTo( collection, 'relational:reset', this.handleReset ); + + collection + .bind( 'relational:add', this.handleAddition ) + .bind( 'relational:remove', this.handleRemoval ) + .bind( 'relational:reset', this.handleReset ); return collection; }, - - /** - * Find related Models. - * @param {Object} [options] - * @return {Backbone.Collection} - */ + findRelated: function( options ) { - var related = null; + if ( this.keyContents ) { + var models = []; - options = _.defaults( { parse: this.options.parse }, options ); - - // Replace 'this.related' by 'this.keyContents' if it is a Backbone.Collection - if ( this.keyContents instanceof Backbone.Collection ) { - this._prepareCollection( this.keyContents ); - related = this.keyContents; - } - // Otherwise, 'this.keyContents' should be an array of related object ids. - // Re-use the current 'this.related' if it is a Backbone.Collection; otherwise, create a new collection. - else { - var toAdd = []; - - _.each( this.keyContents, function( attributes ) { - if ( attributes instanceof this.relatedModel ) { - var model = attributes; - } - else { - // If `merge` is true, update models here, instead of during update. - model = this.relatedModel.findOrCreate( attributes, _.extend( { merge: true }, options, { create: this.options.createModels } ) ); - } - - model && toAdd.push( model ); - }, this ); - - if ( this.related instanceof Backbone.Collection ) { - related = this.related; + if ( this.keyContents instanceof Backbone.Collection ) { + models = this.keyContents.models; } else { - related = this._prepareCollection(); + // Handle cases the an API/user supplies just an Object/id instead of an Array + this.keyContents = _.isArray( this.keyContents ) ? this.keyContents : [ this.keyContents ]; + + // Try to find instances of the appropriate 'relatedModel' in the store + _.each( this.keyContents, function( item ) { + var model = null; + if ( item instanceof this.relatedModel ) { + model = item; + } + else { + model = this.relatedModel.findOrCreate( item, { create: this.options.createModels } ); + } + + if ( model && !this.related.getByCid( model ) && !this.related.get( model ) ) { + models.push( model ); + } + }, this ); } - related.update( toAdd, _.defaults( { merge: false, parse: false }, options ) ); - } - - return related; - }, - - /** - * Normalize and reduce `keyContents` to a list of `ids`, for easier comparison - * @param {String|Number|String[]|Number[]|Backbone.Collection} keyContents - */ - setKeyContents: function( keyContents ) { - this.keyContents = keyContents instanceof Backbone.Collection ? keyContents : null; - this.keyIds = []; - - if ( !this.keyContents && ( keyContents || keyContents === 0 ) ) { // since 0 can be a valid `id` as well - // Handle cases the an API/user supplies just an Object/id instead of an Array - this.keyContents = _.isArray( keyContents ) ? keyContents : [ keyContents ]; - - _.each( this.keyContents, function( item ) { - var itemId = Backbone.Relational.store.resolveIdForItem( this.relatedModel, item ); - if ( itemId || itemId === 0 ) { - this.keyIds.push( itemId ); - } - }, this ); + // Add all found 'models' in on go, so 'add' will only be called once (and thus 'sort', etc.) + if ( models.length ) { + options = this.unsanitizeOptions( options ); + this.related.add( models, options ); + } } }, - + /** - * Event handler for `change:`. - * If the contents of the key are changed, notify old & new reverse relations and initialize the new relation. + * If the key is changed, notify old & new reverse relations and initialize the new relation */ onChange: function( model, attr, options ) { - options = options ? _.clone( options ) : {}; - this.setKeyContents( attr ); - this.changed = false; + options = this.sanitizeOptions( options ); + this.keyContents = attr; + + // Notify old 'related' object of the terminated relation + _.each( this.getReverseRelations(), function( relation ) { + relation.removeRelated( this.instance, options ); + }, this ); + + // Replace 'this.related' by 'attr' if it is a Backbone.Collection + if ( attr instanceof Backbone.Collection ) { + this._prepareCollection( attr ); + this.related = attr; + } + // Otherwise, 'attr' should be an array of related object ids. + // Re-use the current 'this.related' if it is a Backbone.Collection, and remove any current entries. + // Otherwise, create a new collection. + else { + var coll; - var related = this.findRelated( options ); - this.setRelated( related ); + if ( this.related instanceof Backbone.Collection ) { + coll = this.related; + coll.remove( coll.models ); + } + else { + coll = this._prepareCollection(); + } - if ( !options.silent ) { - var dit = this; - Backbone.Relational.eventQueue.add( function() { - // The `changed` flag can be set in `handleAddition` or `handleRemoval` - if ( dit.changed ) { - dit.instance.trigger( 'change:' + dit.key, dit.instance, dit.related, options, true ); - dit.changed = false; - } - }); + this.setRelated( coll ); + this.findRelated( options ); + } + + // Notify new 'related' object of the new relation + _.each( this.getReverseRelations(), function( relation ) { + relation.addRelated( this.instance, options ); + }, this ); + + var dit = this; + Backbone.Relational.eventQueue.add( function() { + !options.silentChange && dit.instance.trigger( 'update:' + dit.key, dit.instance, dit.related, options ); + }); + }, + + tryAddRelated: function( model, options ) { + options = this.sanitizeOptions( options ); + if ( !this.related.getByCid( model ) && !this.related.get( model ) ) { + // Check if this new model was specified in 'this.keyContents' + var item = _.any( this.keyContents, function( item ) { + var id = Backbone.Relational.store.resolveIdForItem( this.relatedModel, item ); + return id && id === model.id; + }, this ); + + if ( item ) { + this.related.add( model, options ); + } } }, - + /** * When a model is added to a 'HasMany', trigger 'add' on 'this.instance' and notify reverse relations. * (should be 'HasOne', must set 'this.instance' as their related). - */ + */ handleAddition: function( model, coll, options ) { //console.debug('handleAddition called; args=%o', arguments); - options = options ? _.clone( options ) : {}; - this.changed = true; + // Make sure the model is in fact a valid model before continuing. + // (it can be invalid as a result of failing validation in Backbone.Collection._prepareModel) + if ( !( model instanceof Backbone.Model ) ) { + return; + } + + options = this.sanitizeOptions( options ); _.each( this.getReverseRelations( model ), function( relation ) { - relation.addRelated( this.instance, options ); - }, this ); + relation.addRelated( this.instance, options ); + }, this ); - // Only trigger 'add' once the newly added model is initialized (so, has its relations set up) + // Only trigger 'add' once the newly added model is initialized (so, has it's relations set up) var dit = this; - !options.silent && Backbone.Relational.eventQueue.add( function() { - dit.instance.trigger( 'add:' + dit.key, model, dit.related, options ); + Backbone.Relational.eventQueue.add( function() { + !options.silentChange && dit.instance.trigger( 'add:' + dit.key, model, dit.related, options ); }); }, - + /** * When a model is removed from a 'HasMany', trigger 'remove' on 'this.instance' and notify reverse relations. * (should be 'HasOne', which should be nullified) */ handleRemoval: function( model, coll, options ) { //console.debug('handleRemoval called; args=%o', arguments); - options = options ? _.clone( options ) : {}; - this.changed = true; + if ( !( model instanceof Backbone.Model ) ) { + return; + } + + options = this.sanitizeOptions( options ); _.each( this.getReverseRelations( model ), function( relation ) { - relation.removeRelated( this.instance, null, options ); - }, this ); + relation.removeRelated( this.instance, options ); + }, this ); var dit = this; - !options.silent && Backbone.Relational.eventQueue.add( function() { - dit.instance.trigger( 'remove:' + dit.key, model, dit.related, options ); + Backbone.Relational.eventQueue.add( function() { + !options.silentChange && dit.instance.trigger( 'remove:' + dit.key, model, dit.related, options ); }); }, handleReset: function( coll, options ) { + options = this.sanitizeOptions( options ); + var dit = this; - options = options ? _.clone( options ) : {}; - !options.silent && Backbone.Relational.eventQueue.add( function() { - dit.instance.trigger( 'reset:' + dit.key, dit.related, options ); + Backbone.Relational.eventQueue.add( function() { + !options.silentChange && dit.instance.trigger( 'reset:' + dit.key, dit.related, options ); }); }, - - tryAddRelated: function( model, coll, options ) { - var item = _.contains( this.keyIds, model.id ); - - if ( item ) { - this.addRelated( model, options ); - this.keyIds = _.without( this.keyIds, model.id ); - } - }, - + addRelated: function( model, options ) { - // Allow 'model' to set up its relations before proceeding. - // (which can result in a call to 'addRelated' from a relation of 'model') var dit = this; - model.queue( function() { - if ( dit.related && !dit.related.get( model ) ) { + options = this.unsanitizeOptions( options ); + model.queue( function() { // Queued to avoid errors for adding 'model' to the 'this.related' set twice + if ( dit.related && !dit.related.getByCid( model ) && !dit.related.get( model ) ) { dit.related.add( model, options ); } }); }, - - removeRelated: function( model, coll, options ) { - if ( this.related.get( model ) ) { + + removeRelated: function( model, options ) { + options = this.unsanitizeOptions( options ); + if ( this.related.getByCid( model ) || this.related.get( model ) ) { this.related.remove( model, options ); } } }); - + /** * A type of Backbone.Model that also maintains relations to other models and collections. * New events when compared to the original: * - 'add:' (model, related collection, options) * - 'remove:' (model, related collection, options) - * - 'change:' (model, related model or collection, options) + * - 'update:' (model, related model or collection, options) */ Backbone.RelationalModel = Backbone.Model.extend({ relations: null, // Relation descriptions on the prototype @@ -1029,98 +1006,56 @@ _isInitialized: false, _deferProcessing: false, _queue: null, - + subModelTypeAttribute: 'type', subModelTypes: null, - + constructor: function( attributes, options ) { // Nasty hack, for cases like 'model.get( ).add( item )'. - // Defer 'processQueue', so that when 'Relation.createModels' is used we trigger 'HasMany' - // collection events only after the model is really fully set up. - // Example: "p.get('jobs').add( { company: c, person: p } )". + // Defer 'processQueue', so that when 'Relation.createModels' is used we: + // a) Survive 'Backbone.Collection.add'; this takes care we won't error on "can't add model to a set twice" + // (by creating a model from properties, having the model add itself to the collection via one of + // it's relations, then trying to add it to the collection). + // b) Trigger 'HasMany' collection events only after the model is really fully set up. + // Example that triggers both a and b: "p.get('jobs').add( { company: c, person: p } )". + var dit = this; if ( options && options.collection ) { - var dit = this, - collection = this.collection = options.collection; - - // Prevent this option from cascading down to related models; they shouldn't go into this `if` clause. - delete options.collection; - this._deferProcessing = true; - + var processQueue = function( model ) { if ( model === dit ) { dit._deferProcessing = false; dit.processQueue(); - collection.off( 'relational:add', processQueue ); + options.collection.unbind( 'relational:add', processQueue ); } }; - collection.on( 'relational:add', processQueue ); - - // So we do process the queue eventually, regardless of whether this model actually gets added to 'options.collection'. + options.collection.bind( 'relational:add', processQueue ); + + // So we do process the queue eventually, regardless of whether this model really gets added to 'options.collection'. _.defer( function() { processQueue( dit ); }); } - - Backbone.Relational.store.processOrphanRelations(); this._queue = new Backbone.BlockingQueue(); this._queue.block(); Backbone.Relational.eventQueue.block(); - - try { - Backbone.Model.apply( this, arguments ); - } - finally { - // Try to run the global queue holding external events - Backbone.Relational.eventQueue.unblock(); - } + + Backbone.Model.apply( this, arguments ); + + // Try to run the global queue holding external events + Backbone.Relational.eventQueue.unblock(); }, - + /** * Override 'trigger' to queue 'change' and 'change:*' events */ trigger: function( eventName ) { - if ( eventName.length > 5 && eventName.indexOf( 'change' ) === 0 ) { - var dit = this, - args = arguments; - + if ( eventName.length > 5 && 'change' === eventName.substr( 0, 6 ) ) { + var dit = this, args = arguments; Backbone.Relational.eventQueue.add( function() { - if ( !dit._isInitialized ) { - return; - } - - // Determine if the `change` event is still valid, now that all relations are populated - var changed = true; - if ( eventName === 'change' ) { - changed = dit.hasChanged(); - } - else { - var attr = eventName.slice( 7 ), - rel = dit.getRelation( attr ); - - if ( rel ) { - // If `attr` is a relation, `change:attr` get triggered from `Relation.onChange`. - // These take precedence over `change:attr` events triggered by `Model.set`. - // The relation set a fourth attribute to `true`. If this attribute is present, - // continue triggering this event; otherwise, it's from `Model.set` and should be stopped. - changed = ( args[ 4 ] === true ); - - // If this event was triggered by a relation, set the right value in `this.changed` - // (a Collection or Model instead of raw data). - if ( changed ) { - dit.changed[ attr ] = args[ 2 ]; - } - // Otherwise, this event is from `Model.set`. If the relation doesn't report a change, - // remove attr from `dit.changed` so `hasChanged` doesn't take it into account. - else if ( !rel.changed ) { - delete dit.changed[ attr ]; - } - } - } - - changed && Backbone.Model.prototype.trigger.apply( dit, args ); - }); + Backbone.Model.prototype.trigger.apply( dit, args ); + }); } else { Backbone.Model.prototype.trigger.apply( this, arguments ); @@ -1128,18 +1063,24 @@ return this; }, - + /** * Initialize Relations present in this.relations; determine the type (HasOne/HasMany), then creates a new instance. * Invoked in the first call so 'set' (which is made from the Backbone.Model constructor). */ - initializeRelations: function( options ) { + initializeRelations: function() { this.acquire(); // Setting up relations often also involve calls to 'set', and we only want to enter this function once - this._relations = {}; + this._relations = []; - _.each( this.relations || [], function( rel ) { - Backbone.Relational.store.initializeRelation( this, rel, options ); - }, this ); + _.each( this.relations, function( rel ) { + var type = !_.isString( rel.type ) ? rel.type : Backbone[ rel.type ] || Backbone.Relational.store.getObjectByName( rel.type ); + if ( type && type.prototype instanceof Backbone.Relation ) { + new type( this, rel ); // Also pushes the new Relation into _relations + } + else { + Backbone.Relational.showWarnings && typeof console !== 'undefined' && console.warn( 'Relation=%o; missing or invalid type!', rel ); + } + }, this ); this._isInitialized = true; this.release(); @@ -1161,14 +1102,14 @@ }, this ); } }, - + /** * Either add to the queue (if we're not initialized yet), or execute right away. */ queue: function( func ) { this._queue.add( func ); }, - + /** * Process _queue */ @@ -1177,58 +1118,62 @@ this._queue.unblock(); } }, - + /** * Get a specific relation. * @param key {string} The relation key to look for. * @return {Backbone.Relation} An instance of 'Backbone.Relation', if a relation was found for 'key', or null. */ getRelation: function( key ) { - return this._relations[ key ]; + return _.detect( this._relations, function( rel ) { + if ( rel.key === key ) { + return true; + } + }, this ); }, - + /** * Get all of the created relations. * @return {Backbone.Relation[]} */ getRelations: function() { - return _.values( this._relations ); + return this._relations; }, - + /** * Retrieve related objects. * @param key {string} The relation key to fetch models for. - * @param [options] {Object} Options for 'Backbone.Model.fetch' and 'Backbone.sync'. - * @param [refresh=false] {boolean} Fetch existing models from the server as well (in order to update them). + * @param options {Object} Options for 'Backbone.Model.fetch' and 'Backbone.sync'. + * @param update {boolean} Whether to force a fetch from the server (updating existing models). * @return {jQuery.when[]} An array of request objects */ - fetchRelated: function( key, options, refresh ) { - // Set default `options` for fetch - options = _.extend( { update: true, remove: false }, options ); - + fetchRelated: function( key, options, update ) { + options || ( options = {} ); var setUrl, requests = [], rel = this.getRelation( key ), - keys = rel && ( rel.keyIds || [ rel.keyId ] ), - toFetch = keys && _.select( keys || [], function( id ) { - return ( id || id === 0 ) && ( refresh || !Backbone.Relational.store.find( rel.relatedModel, id ) ); + keyContents = rel && rel.keyContents, + toFetch = keyContents && _.select( _.isArray( keyContents ) ? keyContents : [ keyContents ], function( item ) { + var id = Backbone.Relational.store.resolveIdForItem( rel.relatedModel, item ); + return id && ( update || !Backbone.Relational.store.find( rel.relatedModel, id ) ); }, this ); if ( toFetch && toFetch.length ) { - // Find (or create) a model for each one that is to be fetched - var created = [], - models = _.map( toFetch, function( id ) { - var model = Backbone.Relational.store.find( rel.relatedModel, id ); - - if ( !model ) { - var attrs = {}; - attrs[ rel.relatedModel.prototype.idAttribute ] = id; - model = rel.relatedModel.findOrCreate( attrs, options ); - created.push( model ); - } + // Create a model for each entry in 'keyContents' that is to be fetched + var models = _.map( toFetch, function( item ) { + var model; - return model; - }, this ); + if ( _.isObject( item ) ) { + model = rel.relatedModel.build( item ); + } + else { + var attrs = {}; + attrs[ rel.relatedModel.prototype.idAttribute ] = item; + model = rel.relatedModel.build( attrs ); + } + + return model; + }, this ); // Try if the 'collection' can provide a url to fetch a set of models in one request. if ( rel.related instanceof Backbone.Collection && _.isFunction( rel.related.url ) ) { @@ -1243,14 +1188,15 @@ { error: function() { var args = arguments; - _.each( created, function( model ) { - model.trigger( 'destroy', model, model.collection, options ); - options.error && options.error.apply( model, args ); - }); + _.each( models, function( model ) { + model.trigger( 'destroy', model, model.collection, options ); + options.error && options.error.apply( model, args ); + }); }, url: setUrl }, - options + options, + { add: true } ); requests = [ rel.related.fetch( opts ) ]; @@ -1260,10 +1206,8 @@ var opts = _.defaults( { error: function() { - if ( _.contains( created, model ) ) { - model.trigger( 'destroy', model, model.collection, options ); - options.error && options.error.apply( model, arguments ); - } + model.trigger( 'destroy', model, model.collection, options ); + options.error && options.error.apply( model, arguments ); } }, options @@ -1275,32 +1219,7 @@ return requests; }, - - get: function( attr ) { - var originalResult = Backbone.Model.prototype.get.call( this, attr ); - - // Use `originalResult` get if dotNotation not enabled or not required because no dot is in `attr` - if ( !this.dotNotation || attr.indexOf( '.' ) === -1 ) { - return originalResult; - } - - // Go through all splits and return the final result - var splits = attr.split( '.' ); - var result = _.reduce(splits, function( model, split ) { - if ( !( model instanceof Backbone.Model ) ) { - throw new Error( 'Attribute must be an instanceof Backbone.Model. Is: ' + model + ', currentSplit: ' + split ); - } - - return Backbone.Model.prototype.get.call( model, split ); - }, this ); - - if ( originalResult !== undefined && result !== undefined ) { - throw new Error( "Ambiguous result for '" + attr + "'. direct result: " + originalResult + ", dotNotation: " + result ); - } - - return originalResult || result; - }, - + set: function( key, value, options ) { Backbone.Relational.eventQueue.block(); @@ -1318,31 +1237,28 @@ var result = Backbone.Model.prototype.set.apply( this, arguments ); // Ideal place to set up relations :) - try { - if ( !this._isInitialized && !this.isLocked() ) { - this.constructor.initializeModelHierarchy(); + if ( !this._isInitialized && !this.isLocked() ) { + this.constructor.initializeModelHierarchy(); - Backbone.Relational.store.register( this ); + Backbone.Relational.store.register( this ); - this.initializeRelations( options ); - } - // Update the 'idAttribute' in Backbone.store if; we don't want it to miss an 'id' update due to {silent:true} - else if ( attributes && this.idAttribute in attributes ) { - Backbone.Relational.store.update( this ); - } - - if ( attributes ) { - this.updateRelations( options ); - } + this.initializeRelations(); } - finally { - // Try to run the global queue holding external events - Backbone.Relational.eventQueue.unblock(); + // Update the 'idAttribute' in Backbone.store if; we don't want it to miss an 'id' update due to {silent:true} + else if ( attributes && this.idAttribute in attributes ) { + Backbone.Relational.store.update( this ); } + if ( attributes ) { + this.updateRelations( options ); + } + + // Try to run the global queue holding external events + Backbone.Relational.eventQueue.unblock(); + return result; }, - + unset: function( attribute, options ) { Backbone.Relational.eventQueue.block(); @@ -1354,7 +1270,7 @@ return result; }, - + clear: function( options ) { Backbone.Relational.eventQueue.block(); @@ -1366,6 +1282,17 @@ return result; }, + + /** + * Override 'change', so the change will only execute after 'set' has finised (relations are updated), + * and 'previousAttributes' will be available when the event is fired. + */ + change: function( options ) { + var dit = this, args = arguments; + Backbone.Relational.eventQueue.add( function() { + Backbone.Model.prototype.change.apply( dit, args ); + }); + }, clone: function() { var attributes = _.clone( this.attributes ); @@ -1374,92 +1301,87 @@ } _.each( this.getRelations(), function( rel ) { - delete attributes[ rel.key ]; - }); + delete attributes[ rel.key ]; + }); return new this.constructor( attributes ); }, - + /** * Convert relations to JSON, omits them when required */ - toJSON: function( options ) { + toJSON: function() { // If this Model has already been fully serialized in this branch once, return to avoid loops if ( this.isLocked() ) { return this.id; } this.acquire(); - var json = Backbone.Model.prototype.toJSON.call( this, options ); + var json = Backbone.Model.prototype.toJSON.call( this ); if ( this.constructor._superModel && !( this.constructor._subModelTypeAttribute in json ) ) { json[ this.constructor._subModelTypeAttribute ] = this.constructor._subModelTypeValue; } _.each( this._relations, function( rel ) { - var value = json[ rel.key ]; + var value = json[ rel.key ]; - if ( rel.options.includeInJSON === true) { - if ( value && _.isFunction( value.toJSON ) ) { - json[ rel.keyDestination ] = value.toJSON( options ); + if ( rel.options.includeInJSON === true) { + if ( value && _.isFunction( value.toJSON ) ) { + json[ rel.keyDestination ] = value.toJSON(); + } + else { + json[ rel.keyDestination ] = null; + } } - else { - json[ rel.keyDestination ] = null; + else if ( _.isString( rel.options.includeInJSON ) ) { + if ( value instanceof Backbone.Collection ) { + json[ rel.keyDestination ] = value.pluck( rel.options.includeInJSON ); + } + else if ( value instanceof Backbone.Model ) { + json[ rel.keyDestination ] = value.get( rel.options.includeInJSON ); + } + else { + json[ rel.keyDestination ] = null; + } } - } - else if ( _.isString( rel.options.includeInJSON ) ) { - if ( value instanceof Backbone.Collection ) { - json[ rel.keyDestination ] = value.pluck( rel.options.includeInJSON ); - } - else if ( value instanceof Backbone.Model ) { - json[ rel.keyDestination ] = value.get( rel.options.includeInJSON ); - } - else { - json[ rel.keyDestination ] = null; - } - } - else if ( _.isArray( rel.options.includeInJSON ) ) { - if ( value instanceof Backbone.Collection ) { - var valueSub = []; - value.each( function( model ) { - var curJson = {}; - _.each( rel.options.includeInJSON, function( key ) { - curJson[ key ] = model.get( key ); + else if ( _.isArray( rel.options.includeInJSON ) ) { + if ( value instanceof Backbone.Collection ) { + var valueSub = []; + value.each( function( model ) { + var curJson = {}; + _.each( rel.options.includeInJSON, function( key ) { + curJson[ key ] = model.get( key ); + }); + valueSub.push( curJson ); }); - valueSub.push( curJson ); - }); - json[ rel.keyDestination ] = valueSub; - } - else if ( value instanceof Backbone.Model ) { - var valueSub = {}; - _.each( rel.options.includeInJSON, function( key ) { - valueSub[ key ] = value.get( key ); - }); - json[ rel.keyDestination ] = valueSub; + json[ rel.keyDestination ] = valueSub; + } + else if ( value instanceof Backbone.Model ) { + var valueSub = {}; + _.each( rel.options.includeInJSON, function( key ) { + valueSub[ key ] = value.get( key ); + }); + json[ rel.keyDestination ] = valueSub; + } + else { + json[ rel.keyDestination ] = null; + } } else { - json[ rel.keyDestination ] = null; + delete json[ rel.key ]; } - } - else { - delete json[ rel.key ]; - } - if ( rel.keyDestination !== rel.key ) { - delete json[ rel.key ]; - } - }); + if ( rel.keyDestination !== rel.key ) { + delete json[ rel.key ]; + } + }); this.release(); return json; } }, { - /** - * - * @param superModel - * @returns {Backbone.RelationalModel.constructor} - */ setup: function( superModel ) { // We don't want to share a relations array with a parent, as this will cause problems with // reverse relations. @@ -1478,37 +1400,30 @@ } // Initialize all reverseRelations that belong to this new model. - _.each( this.prototype.relations || [], function( rel ) { - if ( !rel.model ) { - rel.model = this; - } - - if ( rel.reverseRelation && rel.model === this ) { - var preInitialize = true; - if ( _.isString( rel.relatedModel ) ) { - /** - * The related model might not be defined for two reasons - * 1. it is related to itself - * 2. it never gets defined, e.g. a typo - * 3. the model hasn't been defined yet, but will be later - * In neither of these cases do we need to pre-initialize reverse relations. - * However, for 3. (which is, to us, indistinguishable from 2.), we do need to attempt - * setting up this relation again later, in case the related model is defined later. - */ - var relatedModel = Backbone.Relational.store.getObjectByName( rel.relatedModel ); - preInitialize = relatedModel && ( relatedModel.prototype instanceof Backbone.RelationalModel ); + _.each( this.prototype.relations, function( rel ) { + if ( !rel.model ) { + rel.model = this; } - if ( preInitialize ) { - Backbone.Relational.store.initializeRelation( null, rel ); + if ( rel.reverseRelation && rel.model === this ) { + var preInitialize = true; + if ( _.isString( rel.relatedModel ) ) { + /** + * The related model might not be defined for two reasons + * 1. it never gets defined, e.g. a typo + * 2. it is related to itself + * In neither of these cases do we need to pre-initialize reverse relations. + */ + var relatedModel = Backbone.Relational.store.getObjectByName( rel.relatedModel ); + preInitialize = relatedModel && ( relatedModel.prototype instanceof Backbone.RelationalModel ); + } + + var type = !_.isString( rel.type ) ? rel.type : Backbone[ rel.type ] || Backbone.Relational.store.getObjectByName( rel.type ); + if ( preInitialize && type && type.prototype instanceof Backbone.Relation ) { + new type( null, rel ); + } } - else if ( _.isString( rel.relatedModel ) ) { - Backbone.Relational.store.addOrphanRelation( rel ); - } - } - }, this ); - - return this; + }, this ); }, /** @@ -1536,9 +1451,6 @@ return new model( attributes, options ); }, - /** - * - */ initializeModelHierarchy: function() { // If we're here for the first time, try to determine if this modelType has a 'superModel'. if ( _.isUndefined( this._superModel ) || _.isNull( this._superModel ) ) { @@ -1551,7 +1463,7 @@ if ( this._superModel ) { // if ( this._superModel.prototype.relations ) { - var supermodelRelationsExist = _.any( this.prototype.relations || [], function( rel ) { + var supermodelRelationsExist = _.any( this.prototype.relations, function( rel ) { return rel.model && rel.model !== this; }, this ); @@ -1567,7 +1479,7 @@ // If we came here through 'build' for a model that has 'subModelTypes', and not all of them have been resolved yet, try to resolve each. if ( this.prototype.subModelTypes && _.keys( this.prototype.subModelTypes ).length !== _.keys( this._subModels ).length ) { - _.each( this.prototype.subModelTypes || [], function( subModelTypeName ) { + _.each( this.prototype.subModelTypes, function( subModelTypeName ) { var subModelType = Backbone.Relational.store.getObjectByName( subModelTypeName ); subModelType && subModelType.initializeModelHierarchy(); }); @@ -1577,30 +1489,24 @@ /** * Find an instance of `this` type in 'Backbone.Relational.store'. * - If `attributes` is a string or a number, `findOrCreate` will just query the `store` and return a model if found. - * - If `attributes` is an object and is found in the store, the model will be updated with `attributes` unless `options.update` is `false`. + * - If `attributes` is an object, the model will be updated with `attributes` if found. * Otherwise, a new model is created with `attributes` (unless `options.create` is explicitly set to `false`). * @param {Object|String|Number} attributes Either a model's id, or the attributes used to create or update a model. * @param {Object} [options] * @param {Boolean} [options.create=true] - * @param {Boolean} [options.merge=true] - * @param {Boolean} [options.parse=false] * @return {Backbone.RelationalModel} */ findOrCreate: function( attributes, options ) { - options || ( options = {} ); - var parsedAttributes = ( _.isObject( attributes ) && options.parse && this.prototype.parse ) ? - this.prototype.parse( attributes ) : attributes; - // Try to find an instance of 'this' model type in the store - var model = Backbone.Relational.store.find( this, parsedAttributes ); + var model = Backbone.Relational.store.find( this, attributes ); - // If we found an instance, update it with the data in 'item' (unless 'options.merge' is false). - // If not, create an instance (unless 'options.create' is false). + // If we found an instance, update it with the data in 'item'; if not, create an instance + // (unless 'options.create' is false). if ( _.isObject( attributes ) ) { - if ( model && options.merge !== false ) { - model.set( parsedAttributes, options ); + if ( model ) { + model.set( attributes, options ); } - else if ( !model && options.create !== false ) { + else if ( !options || ( options && options.create !== false ) ) { model = this.build( attributes, options ); } } @@ -1609,123 +1515,103 @@ } }); _.extend( Backbone.RelationalModel.prototype, Backbone.Semaphore ); - + /** * Override Backbone.Collection._prepareModel, so objects will be built using the correct type * if the collection.model has subModels. - * Attempts to find a model for `attrs` in Backbone.store through `findOrCreate` - * (which sets the new properties on it if found), or instantiates a new model. */ Backbone.Collection.prototype.__prepareModel = Backbone.Collection.prototype._prepareModel; - Backbone.Collection.prototype._prepareModel = function ( attrs, options ) { - var model; - - if ( attrs instanceof Backbone.Model ) { - if ( !attrs.collection ) { - attrs.collection = this; - } - model = attrs; - } - else { - options || (options = {}); + Backbone.Collection.prototype._prepareModel = function ( model, options ) { + options || (options = {}); + if ( !( model instanceof Backbone.Model ) ) { + var attrs = model; options.collection = this; - if ( typeof this.model.findOrCreate !== 'undefined' ) { - model = this.model.findOrCreate( attrs, options ); + if ( typeof this.model.build !== 'undefined' ) { + model = this.model.build( attrs, options ); } else { model = new this.model( attrs, options ); } - if ( model && model.isNew() && !model._validate( attrs, options ) ) { - this.trigger( 'invalid', this, attrs, options ); + if ( !model._validate( model.attributes, options ) ) { model = false; } } + else if ( !model.collection ) { + model.collection = this; + } return model; - }; - - + } + /** - * Override Backbone.Collection.add, so we'll create objects from attributes where required, - * and update the existing models. Also, trigger 'relational:add'. + * Override Backbone.Collection.add, so objects fetched from the server multiple times will + * update the existing Model. Also, trigger 'relational:add'. */ var add = Backbone.Collection.prototype.__add = Backbone.Collection.prototype.add; Backbone.Collection.prototype.add = function( models, options ) { - // Short-circuit if this Collection doesn't hold RelationalModels - if ( !( this.model.prototype instanceof Backbone.RelationalModel ) ) { - return add.apply( this, arguments ); + options || (options = {}); + if ( !_.isArray( models ) ) { + models = [ models ]; } - models = _.isArray( models ) ? models.slice() : [ models ]; - // Set default options to the same values as `add` uses, so `findOrCreate` will also respect those. - options = _.extend( { merge: false }, options ); - - var newModels = [], - toAdd = []; + var modelsToAdd = []; //console.debug( 'calling add on coll=%o; model=%o, options=%o', this, models, options ); _.each( models, function( model ) { - if ( !( model instanceof Backbone.Model ) ) { - model = Backbone.Collection.prototype._prepareModel.call( this, model, options ); - } - - if ( model ) { - toAdd.push( model ); - - if ( !( this.get( model ) || this.get( model.cid ) ) ) { - newModels.push( model ); + if ( !( model instanceof Backbone.Model ) ) { + // Try to find 'model' in Backbone.store. If it already exists, set the new properties on it. + var existingModel = Backbone.Relational.store.find( this.model, model[ this.model.prototype.idAttribute ] ); + if ( existingModel ) { + existingModel.set( existingModel.parse ? existingModel.parse( model ) : model, options ); + model = existingModel; + } + else { + model = Backbone.Collection.prototype._prepareModel.call( this, model, options ); + } } - // If we arrive in `add` while performing a `set` (after a create, so the model gains an `id`), - // we may get here before `_onModelEvent` has had the chance to update `_byId`. - else if ( model.id != null ) { - this._byId[ model.id ] = model; + + if ( model instanceof Backbone.Model && !this.get( model ) && !this.getByCid( model ) ) { + modelsToAdd.push( model ); } - } - }, this ); + }, this ); + // Add 'models' in a single batch, so the original add will only be called once (and thus 'sort', etc). - add.call( this, toAdd, options ); + if ( modelsToAdd.length ) { + add.call( this, modelsToAdd, options ); - _.each( newModels, function( model ) { - // Fire a `relational:add` event for any model in `newModels` that has actually been added to the collection. - if ( this.get( model ) || this.get( model.cid ) ) { - this.trigger( 'relational:add', model, this, options ); - } - }, this ); + _.each( modelsToAdd, function( model ) { + this.trigger( 'relational:add', model, this, options ); + }, this ); + } return this; }; - + /** * Override 'Backbone.Collection.remove' to trigger 'relational:remove'. */ var remove = Backbone.Collection.prototype.__remove = Backbone.Collection.prototype.remove; Backbone.Collection.prototype.remove = function( models, options ) { - // Short-circuit if this Collection doesn't hold RelationalModels - if ( !( this.model.prototype instanceof Backbone.RelationalModel ) ) { - return remove.apply( this, arguments ); + options || (options = {}); + if ( !_.isArray( models ) ) { + models = [ models ]; + } + else { + models = models.slice( 0 ); } - - models = _.isArray( models ) ? models.slice() : [ models ]; - options || ( options = {} ); - - var toRemove = []; //console.debug('calling remove on coll=%o; models=%o, options=%o', this, models, options ); _.each( models, function( model ) { - model = this.get( model ) || this.get( model.cid ); - model && toRemove.push( model ); - }, this ); + model = this.getByCid( model ) || this.get( model ); - if ( toRemove.length ) { - remove.call( this, toRemove, options ); - - _.each( toRemove, function( model ) { - this.trigger('relational:remove', model, this, options); + if ( model instanceof Backbone.Model ) { + remove.call( this, model, options ); + this.trigger('relational:remove', model, this, options); + } }, this ); - } return this; }; @@ -1736,10 +1622,7 @@ var reset = Backbone.Collection.prototype.__reset = Backbone.Collection.prototype.reset; Backbone.Collection.prototype.reset = function( models, options ) { reset.call( this, models, options ); - - if ( this.model.prototype instanceof Backbone.RelationalModel ) { - this.trigger( 'relational:reset', this, options ); - } + this.trigger( 'relational:reset', this, options ); return this; }; @@ -1750,39 +1633,22 @@ var sort = Backbone.Collection.prototype.__sort = Backbone.Collection.prototype.sort; Backbone.Collection.prototype.sort = function( options ) { sort.call( this, options ); - - if ( this.model.prototype instanceof Backbone.RelationalModel ) { - this.trigger( 'relational:reset', this, options ); - } + this.trigger( 'relational:reset', this, options ); return this; }; - + /** * Override 'Backbone.Collection.trigger' so 'add', 'remove' and 'reset' events are queued until relations * are ready. */ var trigger = Backbone.Collection.prototype.__trigger = Backbone.Collection.prototype.trigger; Backbone.Collection.prototype.trigger = function( eventName ) { - // Short-circuit if this Collection doesn't hold RelationalModels - if ( !( this.model.prototype instanceof Backbone.RelationalModel ) ) { - return trigger.apply( this, arguments ); - } - if ( eventName === 'add' || eventName === 'remove' || eventName === 'reset' ) { - var dit = this, - args = arguments; - - if ( _.isObject( args[ 3 ] ) ) { - args = _.toArray( args ); - // the fourth argument is the option object. - // we need to clone it, as it could be modified while we wait on the eventQueue to be unblocked - args[ 3 ] = _.clone( args[ 3 ] ); - } - + var dit = this, args = arguments; Backbone.Relational.eventQueue.add( function() { - trigger.apply( dit, args ); - }); + trigger.apply( dit, args ); + }); } else { trigger.apply( this, arguments ); diff --git a/static/scripts/libs/backbone/backbone.js b/static/scripts/libs/backbone/backbone.js index 3512d42fb43..3373c952bfa 100644 --- a/static/scripts/libs/backbone/backbone.js +++ b/static/scripts/libs/backbone/backbone.js @@ -1,6 +1,6 @@ -// Backbone.js 1.0.0 +// Backbone.js 0.9.2 -// (c) 2010-2013 Jeremy Ashkenas, DocumentCloud Inc. +// (c) 2010-2012 Jeremy Ashkenas, DocumentCloud Inc. // Backbone may be freely distributed under the MIT license. // For all details and documentation: // http://backbonejs.org @@ -10,7 +10,7 @@ // Initial Setup // ------------- - // Save a reference to the global object (`window` in the browser, `exports` + // Save a reference to the global object (`window` in the browser, `global` // on the server). var root = this; @@ -18,14 +18,12 @@ // restored later on, if `noConflict` is used. var previousBackbone = root.Backbone; - // Create local references to array methods we'll want to use later. - var array = []; - var push = array.push; - var slice = array.slice; - var splice = array.splice; + // Create a local reference to slice/splice. + var slice = Array.prototype.slice; + var splice = Array.prototype.splice; // The top-level namespace. All public Backbone classes and modules will - // be attached to this. Exported for both the browser and the server. + // be attached to this. Exported for both CommonJS and the browser. var Backbone; if (typeof exports !== 'undefined') { Backbone = exports; @@ -34,15 +32,23 @@ } // Current version of the library. Keep in sync with `package.json`. - Backbone.VERSION = '1.0.0'; + Backbone.VERSION = '0.9.2'; // Require Underscore, if we're on the server, and it's not already present. var _ = root._; if (!_ && (typeof require !== 'undefined')) _ = require('underscore'); - // For Backbone's purposes, jQuery, Zepto, Ender, or My Library (kidding) owns - // the `$` variable. - Backbone.$ = root.jQuery || root.Zepto || root.ender || root.$; + // For Backbone's purposes, jQuery, Zepto, or Ender owns the `$` variable. + var $ = root.jQuery || root.Zepto || root.ender; + + // Set the JavaScript library that will be used for DOM manipulation and + // Ajax calls (a.k.a. the `$` variable). By default Backbone will use: jQuery, + // Zepto, or Ender; but the `setDomLibrary()` method lets you inject an + // alternate JavaScript library (or a mock library for testing your views + // outside of a browser). + Backbone.setDomLibrary = function(lib) { + $ = lib; + }; // Runs Backbone.js in *noConflict* mode, returning the `Backbone` variable // to its previous owner. Returns a reference to this Backbone object. @@ -63,12 +69,14 @@ Backbone.emulateJSON = false; // Backbone.Events - // --------------- + // ----------------- + + // Regular expression used to split event strings + var eventSplitter = /\s+/; // A module that can be mixed in to *any object* in order to provide it with - // custom events. You may bind with `on` or remove with `off` callback - // functions to an event; `trigger`-ing an event fires all callbacks in - // succession. + // custom events. You may bind with `on` or remove with `off` callback functions + // to an event; trigger`-ing an event fires all callbacks in succession. // // var object = {}; // _.extend(object, Backbone.Events); @@ -77,56 +85,58 @@ // var Events = Backbone.Events = { - // Bind an event to a `callback` function. Passing `"all"` will bind - // the callback to all events fired. - on: function(name, callback, context) { - if (!eventsApi(this, 'on', name, [callback, context]) || !callback) return this; - this._events || (this._events = {}); - var events = this._events[name] || (this._events[name] = []); - events.push({callback: callback, context: context, ctx: context || this}); + // Bind one or more space separated events, `events`, to a `callback` + // function. Passing `"all"` will bind the callback to all events fired. + on: function(events, callback, context) { + + var calls, event, node, tail, list; + if (!callback) return this; + events = events.split(eventSplitter); + calls = this._callbacks || (this._callbacks = {}); + + // Create an immutable callback list, allowing traversal during + // modification. The tail is an empty object that will always be used + // as the next node. + while (event = events.shift()) { + list = calls[event]; + node = list ? list.tail : {}; + node.next = tail = {}; + node.context = context; + node.callback = callback; + calls[event] = {tail: tail, next: list ? list.next : node}; + } + return this; }, - // Bind an event to only be triggered a single time. After the first time - // the callback is invoked, it will be removed. - once: function(name, callback, context) { - if (!eventsApi(this, 'once', name, [callback, context]) || !callback) return this; - var self = this; - var once = _.once(function() { - self.off(name, once); - callback.apply(this, arguments); - }); - once._callback = callback; - return this.on(name, once, context); - }, + // Remove one or many callbacks. If `context` is null, removes all callbacks + // with that function. If `callback` is null, removes all callbacks for the + // event. If `events` is null, removes all bound callbacks for all events. + off: function(events, callback, context) { + var event, calls, node, tail, cb, ctx; - // Remove one or many callbacks. If `context` is null, removes all - // callbacks with that function. If `callback` is null, removes all - // callbacks for the event. If `name` is null, removes all bound - // callbacks for all events. - off: function(name, callback, context) { - var retain, ev, events, names, i, l, j, k; - if (!this._events || !eventsApi(this, 'off', name, [callback, context])) return this; - if (!name && !callback && !context) { - this._events = {}; + // No events, or removing *all* events. + if (!(calls = this._callbacks)) return; + if (!(events || callback || context)) { + delete this._callbacks; return this; } - names = name ? [name] : _.keys(this._events); - for (i = 0, l = names.length; i < l; i++) { - name = names[i]; - if (events = this._events[name]) { - this._events[name] = retain = []; - if (callback || context) { - for (j = 0, k = events.length; j < k; j++) { - ev = events[j]; - if ((callback && callback !== ev.callback && callback !== ev.callback._callback) || - (context && context !== ev.context)) { - retain.push(ev); - } - } + // Loop through the listed events and contexts, splicing them out of the + // linked list of callbacks if appropriate. + events = events ? events.split(eventSplitter) : _.keys(calls); + while (event = events.shift()) { + node = calls[event]; + delete calls[event]; + if (!node || !(callback || context)) continue; + // Create a new list, omitting the indicated callbacks. + tail = node.tail; + while ((node = node.next) !== tail) { + cb = node.callback; + ctx = node.context; + if ((callback && cb !== callback) || (context && ctx !== context)) { + this.on(event, cb, ctx); } - if (!retain.length) delete this._events[name]; } } @@ -137,138 +147,81 @@ // passed the same arguments as `trigger` is, apart from the event name // (unless you're listening on `"all"`, which will cause your callback to // receive the true name of the event as the first argument). - trigger: function(name) { - if (!this._events) return this; - var args = slice.call(arguments, 1); - if (!eventsApi(this, 'trigger', name, args)) return this; - var events = this._events[name]; - var allEvents = this._events.all; - if (events) triggerEvents(events, args); - if (allEvents) triggerEvents(allEvents, arguments); - return this; - }, + trigger: function(events) { + var event, node, calls, tail, args, all, rest; + if (!(calls = this._callbacks)) return this; + all = calls.all; + events = events.split(eventSplitter); + rest = slice.call(arguments, 1); - // Tell this object to stop listening to either specific events ... or - // to every object it's currently listening to. - stopListening: function(obj, name, callback) { - var listeners = this._listeners; - if (!listeners) return this; - var deleteListener = !name && !callback; - if (typeof name === 'object') callback = this; - if (obj) (listeners = {})[obj._listenerId] = obj; - for (var id in listeners) { - listeners[id].off(name, callback, this); - if (deleteListener) delete this._listeners[id]; + // For each event, walk through the linked list of callbacks twice, + // first to trigger the event, then to trigger any `"all"` callbacks. + while (event = events.shift()) { + if (node = calls[event]) { + tail = node.tail; + while ((node = node.next) !== tail) { + node.callback.apply(node.context || this, rest); + } + } + if (node = all) { + tail = node.tail; + args = [event].concat(rest); + while ((node = node.next) !== tail) { + node.callback.apply(node.context || this, args); + } + } } + return this; } }; - // Regular expression used to split event strings. - var eventSplitter = /\s+/; - - // Implement fancy features of the Events API such as multiple event - // names `"change blur"` and jQuery-style event maps `{change: action}` - // in terms of the existing API. - var eventsApi = function(obj, action, name, rest) { - if (!name) return true; - - // Handle event maps. - if (typeof name === 'object') { - for (var key in name) { - obj[action].apply(obj, [key, name[key]].concat(rest)); - } - return false; - } - - // Handle space separated event names. - if (eventSplitter.test(name)) { - var names = name.split(eventSplitter); - for (var i = 0, l = names.length; i < l; i++) { - obj[action].apply(obj, [names[i]].concat(rest)); - } - return false; - } - - return true; - }; - - // A difficult-to-believe, but optimized internal dispatch function for - // triggering events. Tries to keep the usual cases speedy (most internal - // Backbone events have 3 arguments). - var triggerEvents = function(events, args) { - var ev, i = -1, l = events.length, a1 = args[0], a2 = args[1], a3 = args[2]; - switch (args.length) { - case 0: while (++i < l) (ev = events[i]).callback.call(ev.ctx); return; - case 1: while (++i < l) (ev = events[i]).callback.call(ev.ctx, a1); return; - case 2: while (++i < l) (ev = events[i]).callback.call(ev.ctx, a1, a2); return; - case 3: while (++i < l) (ev = events[i]).callback.call(ev.ctx, a1, a2, a3); return; - default: while (++i < l) (ev = events[i]).callback.apply(ev.ctx, args); - } - }; - - var listenMethods = {listenTo: 'on', listenToOnce: 'once'}; - - // Inversion-of-control versions of `on` and `once`. Tell *this* object to - // listen to an event in another object ... keeping track of what it's - // listening to. - _.each(listenMethods, function(implementation, method) { - Events[method] = function(obj, name, callback) { - var listeners = this._listeners || (this._listeners = {}); - var id = obj._listenerId || (obj._listenerId = _.uniqueId('l')); - listeners[id] = obj; - if (typeof name === 'object') callback = this; - obj[implementation](name, callback, this); - return this; - }; - }); - // Aliases for backwards compatibility. Events.bind = Events.on; Events.unbind = Events.off; - // Allow the `Backbone` object to serve as a global event bus, for folks who - // want global "pubsub" in a convenient place. - _.extend(Backbone, Events); - // Backbone.Model // -------------- - // Backbone **Models** are the basic data object in the framework -- - // frequently representing a row in a table in a database on your server. - // A discrete chunk of data and a bunch of useful, related methods for - // performing computations and transformations on that data. - - // Create a new model with the specified attributes. A client id (`cid`) + // Create a new model, with defined attributes. A client id (`cid`) // is automatically generated and assigned for you. var Model = Backbone.Model = function(attributes, options) { var defaults; - var attrs = attributes || {}; - options || (options = {}); - this.cid = _.uniqueId('c'); - this.attributes = {}; - _.extend(this, _.pick(options, modelOptions)); - if (options.parse) attrs = this.parse(attrs, options) || {}; - if (defaults = _.result(this, 'defaults')) { - attrs = _.defaults({}, attrs, defaults); + attributes || (attributes = {}); + if (options && options.parse) attributes = this.parse(attributes); + if (defaults = getValue(this, 'defaults')) { + attributes = _.extend({}, defaults, attributes); } - this.set(attrs, options); + if (options && options.collection) this.collection = options.collection; + this.attributes = {}; + this._escapedAttributes = {}; + this.cid = _.uniqueId('c'); this.changed = {}; + this._silent = {}; + this._pending = {}; + this.set(attributes, {silent: true}); + // Reset change tracking. + this.changed = {}; + this._silent = {}; + this._pending = {}; + this._previousAttributes = _.clone(this.attributes); this.initialize.apply(this, arguments); }; - // A list of options to be attached directly to the model, if provided. - var modelOptions = ['url', 'urlRoot', 'collection']; - // Attach all inheritable methods to the Model prototype. _.extend(Model.prototype, Events, { // A hash of attributes whose current and previous value differ. changed: null, - // The value returned during the last failed validation. - validationError: null, + // A hash of attributes that have silently changed since the last time + // `change` was called. Will become pending attributes on the next call. + _silent: null, + + // A hash of attributes that have changed since the last `'change'` event + // began. + _pending: null, // The default name for the JSON `id` attribute is `"id"`. MongoDB and // CouchDB users may want to set this to `"_id"`. @@ -283,12 +236,6 @@ return _.clone(this.attributes); }, - // Proxy `Backbone.sync` by default -- but override this if you need - // custom syncing semantics for *this* particular model. - sync: function() { - return Backbone.sync.apply(this, arguments); - }, - // Get the value of an attribute. get: function(attr) { return this.attributes[attr]; @@ -296,7 +243,10 @@ // Get the HTML-escaped value of an attribute. escape: function(attr) { - return _.escape(this.get(attr)); + var html; + if (html = this._escapedAttributes[attr]) return html; + var val = this.get(attr); + return this._escapedAttributes[attr] = _.escape(val == null ? '' : '' + val); }, // Returns `true` if the attribute contains a value that is not null @@ -305,195 +255,146 @@ return this.get(attr) != null; }, - // Set a hash of model attributes on the object, firing `"change"`. This is - // the core primitive operation of a model, updating the data and notifying - // anyone who needs to know about the change in state. The heart of the beast. - set: function(key, val, options) { - var attr, attrs, unset, changes, silent, changing, prev, current; - if (key == null) return this; + // Set a hash of model attributes on the object, firing `"change"` unless + // you choose to silence it. + set: function(key, value, options) { + var attrs, attr, val; // Handle both `"key", value` and `{key: value}` -style arguments. - if (typeof key === 'object') { + if (_.isObject(key) || key == null) { attrs = key; - options = val; + options = value; } else { - (attrs = {})[key] = val; + attrs = {}; + attrs[key] = value; } + // Extract attributes and options. options || (options = {}); + if (!attrs) return this; + if (attrs instanceof Model) attrs = attrs.attributes; + if (options.unset) for (attr in attrs) attrs[attr] = void 0; // Run validation. if (!this._validate(attrs, options)) return false; - // Extract attributes and options. - unset = options.unset; - silent = options.silent; - changes = []; - changing = this._changing; - this._changing = true; - - if (!changing) { - this._previousAttributes = _.clone(this.attributes); - this.changed = {}; - } - current = this.attributes, prev = this._previousAttributes; - // Check for changes of `id`. if (this.idAttribute in attrs) this.id = attrs[this.idAttribute]; - // For each `set` attribute, update or delete the current value. + var changes = options.changes = {}; + var now = this.attributes; + var escaped = this._escapedAttributes; + var prev = this._previousAttributes || {}; + + // For each `set` attribute... for (attr in attrs) { val = attrs[attr]; - if (!_.isEqual(current[attr], val)) changes.push(attr); - if (!_.isEqual(prev[attr], val)) { + + // If the new and current value differ, record the change. + if (!_.isEqual(now[attr], val) || (options.unset && _.has(now, attr))) { + delete escaped[attr]; + (options.silent ? this._silent : changes)[attr] = true; + } + + // Update or delete the current value. + options.unset ? delete now[attr] : now[attr] = val; + + // If the new and previous value differ, record the change. If not, + // then remove changes for this attribute. + if (!_.isEqual(prev[attr], val) || (_.has(now, attr) != _.has(prev, attr))) { this.changed[attr] = val; + if (!options.silent) this._pending[attr] = true; } else { delete this.changed[attr]; - } - unset ? delete current[attr] : current[attr] = val; - } - - // Trigger all relevant attribute changes. - if (!silent) { - if (changes.length) this._pending = true; - for (var i = 0, l = changes.length; i < l; i++) { - this.trigger('change:' + changes[i], this, current[changes[i]], options); + delete this._pending[attr]; } } - // You might be wondering why there's a `while` loop here. Changes can - // be recursively nested within `"change"` events. - if (changing) return this; - if (!silent) { - while (this._pending) { - this._pending = false; - this.trigger('change', this, options); - } - } - this._pending = false; - this._changing = false; + // Fire the `"change"` events. + if (!options.silent) this.change(options); return this; }, - // Remove an attribute from the model, firing `"change"`. `unset` is a noop - // if the attribute doesn't exist. + // Remove an attribute from the model, firing `"change"` unless you choose + // to silence it. `unset` is a noop if the attribute doesn't exist. unset: function(attr, options) { - return this.set(attr, void 0, _.extend({}, options, {unset: true})); + (options || (options = {})).unset = true; + return this.set(attr, null, options); }, - // Clear all attributes on the model, firing `"change"`. + // Clear all attributes on the model, firing `"change"` unless you choose + // to silence it. clear: function(options) { - var attrs = {}; - for (var key in this.attributes) attrs[key] = void 0; - return this.set(attrs, _.extend({}, options, {unset: true})); - }, - - // Determine if the model has changed since the last `"change"` event. - // If you specify an attribute name, determine if that attribute has changed. - hasChanged: function(attr) { - if (attr == null) return !_.isEmpty(this.changed); - return _.has(this.changed, attr); - }, - - // Return an object containing all the attributes that have changed, or - // false if there are no changed attributes. Useful for determining what - // parts of a view need to be updated and/or what attributes need to be - // persisted to the server. Unset attributes will be set to undefined. - // You can also pass an attributes object to diff against the model, - // determining if there *would be* a change. - changedAttributes: function(diff) { - if (!diff) return this.hasChanged() ? _.clone(this.changed) : false; - var val, changed = false; - var old = this._changing ? this._previousAttributes : this.attributes; - for (var attr in diff) { - if (_.isEqual(old[attr], (val = diff[attr]))) continue; - (changed || (changed = {}))[attr] = val; - } - return changed; - }, - - // Get the previous value of an attribute, recorded at the time the last - // `"change"` event was fired. - previous: function(attr) { - if (attr == null || !this._previousAttributes) return null; - return this._previousAttributes[attr]; - }, - - // Get all of the attributes of the model at the time of the previous - // `"change"` event. - previousAttributes: function() { - return _.clone(this._previousAttributes); + (options || (options = {})).unset = true; + return this.set(_.clone(this.attributes), options); }, // Fetch the model from the server. If the server's representation of the - // model differs from its current attributes, they will be overridden, + // model differs from its current attributes, they will be overriden, // triggering a `"change"` event. fetch: function(options) { options = options ? _.clone(options) : {}; - if (options.parse === void 0) options.parse = true; var model = this; var success = options.success; - options.success = function(resp) { - if (!model.set(model.parse(resp, options), options)) return false; - if (success) success(model, resp, options); - model.trigger('sync', model, resp, options); + options.success = function(resp, status, xhr) { + if (!model.set(model.parse(resp, xhr), options)) return false; + if (success) success(model, resp); }; - wrapError(this, options); - return this.sync('read', this, options); + options.error = Backbone.wrapError(options.error, model, options); + return (this.sync || Backbone.sync).call(this, 'read', this, options); }, // Set a hash of model attributes, and sync the model to the server. // If the server returns an attributes hash that differs, the model's // state will be `set` again. - save: function(key, val, options) { - var attrs, method, xhr, attributes = this.attributes; + save: function(key, value, options) { + var attrs, current; - // Handle both `"key", value` and `{key: value}` -style arguments. - if (key == null || typeof key === 'object') { + // Handle both `("key", value)` and `({key: value})` -style calls. + if (_.isObject(key) || key == null) { attrs = key; - options = val; + options = value; } else { - (attrs = {})[key] = val; + attrs = {}; + attrs[key] = value; + } + options = options ? _.clone(options) : {}; + + // If we're "wait"-ing to set changed attributes, validate early. + if (options.wait) { + if (!this._validate(attrs, options)) return false; + current = _.clone(this.attributes); } - // If we're not waiting and attributes exist, save acts as `set(attr).save(null, opts)`. - if (attrs && (!options || !options.wait) && !this.set(attrs, options)) return false; - - options = _.extend({validate: true}, options); - - // Do not persist invalid models. - if (!this._validate(attrs, options)) return false; - - // Set temporary attributes if `{wait: true}`. - if (attrs && options.wait) { - this.attributes = _.extend({}, attributes, attrs); + // Regular saves `set` attributes before persisting to the server. + var silentOptions = _.extend({}, options, {silent: true}); + if (attrs && !this.set(attrs, options.wait ? silentOptions : options)) { + return false; } // After a successful server-side save, the client is (optionally) // updated with the server-side state. - if (options.parse === void 0) options.parse = true; var model = this; var success = options.success; - options.success = function(resp) { - // Ensure attributes are restored during synchronous saves. - model.attributes = attributes; - var serverAttrs = model.parse(resp, options); - if (options.wait) serverAttrs = _.extend(attrs || {}, serverAttrs); - if (_.isObject(serverAttrs) && !model.set(serverAttrs, options)) { - return false; + options.success = function(resp, status, xhr) { + var serverAttrs = model.parse(resp, xhr); + if (options.wait) { + delete options.wait; + serverAttrs = _.extend(attrs || {}, serverAttrs); + } + if (!model.set(serverAttrs, options)) return false; + if (success) { + success(model, resp); + } else { + model.trigger('sync', model, resp, options); } - if (success) success(model, resp, options); - model.trigger('sync', model, resp, options); }; - wrapError(this, options); - - method = this.isNew() ? 'create' : (options.patch ? 'patch' : 'update'); - if (method === 'patch') options.attrs = attrs; - xhr = this.sync(method, this, options); - - // Restore attributes. - if (attrs && options.wait) this.attributes = attributes; + // Finish configuring and sending the Ajax request. + options.error = Backbone.wrapError(options.error, model, options); + var method = this.isNew() ? 'create' : 'update'; + var xhr = (this.sync || Backbone.sync).call(this, method, this, options); + if (options.wait) this.set(current, silentOptions); return xhr; }, @@ -505,24 +406,27 @@ var model = this; var success = options.success; - var destroy = function() { + var triggerDestroy = function() { model.trigger('destroy', model, model.collection, options); }; - options.success = function(resp) { - if (options.wait || model.isNew()) destroy(); - if (success) success(model, resp, options); - if (!model.isNew()) model.trigger('sync', model, resp, options); - }; - if (this.isNew()) { - options.success(); + triggerDestroy(); return false; } - wrapError(this, options); - var xhr = this.sync('delete', this, options); - if (!options.wait) destroy(); + options.success = function(resp) { + if (options.wait) triggerDestroy(); + if (success) { + success(model, resp); + } else { + model.trigger('sync', model, resp, options); + } + }; + + options.error = Backbone.wrapError(options.error, model, options); + var xhr = (this.sync || Backbone.sync).call(this, 'delete', this, options); + if (!options.wait) triggerDestroy(); return xhr; }, @@ -530,14 +434,14 @@ // using Backbone's restful methods, override this to change the endpoint // that will be called. url: function() { - var base = _.result(this, 'urlRoot') || _.result(this.collection, 'url') || urlError(); + var base = getValue(this, 'urlRoot') || getValue(this.collection, 'url') || urlError(); if (this.isNew()) return base; - return base + (base.charAt(base.length - 1) === '/' ? '' : '/') + encodeURIComponent(this.id); + return base + (base.charAt(base.length - 1) == '/' ? '' : '/') + encodeURIComponent(this.id); }, // **parse** converts a response into the hash of attributes to be `set` on // the model. The default implementation is just to pass the response along. - parse: function(resp, options) { + parse: function(resp, xhr) { return resp; }, @@ -551,63 +455,116 @@ return this.id == null; }, - // Check if the model is currently in a valid state. - isValid: function(options) { - return this._validate({}, _.extend(options || {}, { validate: true })); + // Call this method to manually fire a `"change"` event for this model and + // a `"change:attribute"` event for each changed attribute. + // Calling this will cause all objects observing the model to update. + change: function(options) { + options || (options = {}); + var changing = this._changing; + this._changing = true; + + // Silent changes become pending changes. + for (var attr in this._silent) this._pending[attr] = true; + + // Silent changes are triggered. + var changes = _.extend({}, options.changes, this._silent); + this._silent = {}; + for (var attr in changes) { + this.trigger('change:' + attr, this, this.get(attr), options); + } + if (changing) return this; + + // Continue firing `"change"` events while there are pending changes. + while (!_.isEmpty(this._pending)) { + this._pending = {}; + this.trigger('change', this, options); + // Pending and silent changes still remain. + for (var attr in this.changed) { + if (this._pending[attr] || this._silent[attr]) continue; + delete this.changed[attr]; + } + this._previousAttributes = _.clone(this.attributes); + } + + this._changing = false; + return this; + }, + + // Determine if the model has changed since the last `"change"` event. + // If you specify an attribute name, determine if that attribute has changed. + hasChanged: function(attr) { + if (!arguments.length) return !_.isEmpty(this.changed); + return _.has(this.changed, attr); + }, + + // Return an object containing all the attributes that have changed, or + // false if there are no changed attributes. Useful for determining what + // parts of a view need to be updated and/or what attributes need to be + // persisted to the server. Unset attributes will be set to undefined. + // You can also pass an attributes object to diff against the model, + // determining if there *would be* a change. + changedAttributes: function(diff) { + if (!diff) return this.hasChanged() ? _.clone(this.changed) : false; + var val, changed = false, old = this._previousAttributes; + for (var attr in diff) { + if (_.isEqual(old[attr], (val = diff[attr]))) continue; + (changed || (changed = {}))[attr] = val; + } + return changed; + }, + + // Get the previous value of an attribute, recorded at the time the last + // `"change"` event was fired. + previous: function(attr) { + if (!arguments.length || !this._previousAttributes) return null; + return this._previousAttributes[attr]; + }, + + // Get all of the attributes of the model at the time of the previous + // `"change"` event. + previousAttributes: function() { + return _.clone(this._previousAttributes); + }, + + // Check if the model is currently in a valid state. It's only possible to + // get into an *invalid* state if you're using silent changes. + isValid: function() { + return !this.validate(this.attributes); }, // Run validation against the next complete set of model attributes, - // returning `true` if all is well. Otherwise, fire an `"invalid"` event. + // returning `true` if all is well. If a specific `error` callback has + // been passed, call that instead of firing the general `"error"` event. _validate: function(attrs, options) { - if (!options.validate || !this.validate) return true; + if (options.silent || !this.validate) return true; attrs = _.extend({}, this.attributes, attrs); - var error = this.validationError = this.validate(attrs, options) || null; + var error = this.validate(attrs, options); if (!error) return true; - this.trigger('invalid', this, error, _.extend(options || {}, {validationError: error})); + if (options && options.error) { + options.error(this, error, options); + } else { + this.trigger('error', this, error, options); + } return false; } }); - // Underscore methods that we want to implement on the Model. - var modelMethods = ['keys', 'values', 'pairs', 'invert', 'pick', 'omit']; - - // Mix in each Underscore method as a proxy to `Model#attributes`. - _.each(modelMethods, function(method) { - Model.prototype[method] = function() { - var args = slice.call(arguments); - args.unshift(this.attributes); - return _[method].apply(_, args); - }; - }); - // Backbone.Collection // ------------------- - // If models tend to represent a single row of data, a Backbone Collection is - // more analagous to a table full of data ... or a small slice or page of that - // table, or a collection of rows that belong together for a particular reason - // -- all of the messages in this particular folder, all of the documents - // belonging to this particular author, and so on. Collections maintain - // indexes of their models, both in order, and for lookup by `id`. - - // Create a new **Collection**, perhaps to contain a specific type of `model`. - // If a `comparator` is specified, the Collection will maintain + // Provides a standard collection class for our sets of models, ordered + // or unordered. If a `comparator` is specified, the Collection will maintain // its models in sort order, as they're added and removed. var Collection = Backbone.Collection = function(models, options) { options || (options = {}); - if (options.url) this.url = options.url; if (options.model) this.model = options.model; - if (options.comparator !== void 0) this.comparator = options.comparator; + if (options.comparator) this.comparator = options.comparator; this._reset(); this.initialize.apply(this, arguments); - if (models) this.reset(models, _.extend({silent: true}, options)); + if (models) this.reset(models, {silent: true, parse: options.parse}); }; - // Default options for `Collection#set`. - var setOptions = {add: true, remove: true, merge: true}; - var addOptions = {add: true, merge: false, remove: false}; - // Define the Collection's inheritable methods. _.extend(Collection.prototype, Events, { @@ -625,26 +582,68 @@ return this.map(function(model){ return model.toJSON(options); }); }, - // Proxy `Backbone.sync` by default. - sync: function() { - return Backbone.sync.apply(this, arguments); - }, - - // Add a model, or list of models to the set. + // Add a model, or list of models to the set. Pass **silent** to avoid + // firing the `add` event for every new model. add: function(models, options) { - return this.set(models, _.defaults(options || {}, addOptions)); + var i, index, length, model, cid, id, cids = {}, ids = {}, dups = []; + options || (options = {}); + models = _.isArray(models) ? models.slice() : [models]; + + // Begin by turning bare objects into model references, and preventing + // invalid models or duplicate models from being added. + for (i = 0, length = models.length; i < length; i++) { + if (!(model = models[i] = this._prepareModel(models[i], options))) { + throw new Error("Can't add an invalid model to a collection"); + } + cid = model.cid; + id = model.id; + if (cids[cid] || this._byCid[cid] || ((id != null) && (ids[id] || this._byId[id]))) { + dups.push(i); + continue; + } + cids[cid] = ids[id] = model; + } + + // Remove duplicates. + i = dups.length; + while (i--) { + models.splice(dups[i], 1); + } + + // Listen to added models' events, and index models for lookup by + // `id` and by `cid`. + for (i = 0, length = models.length; i < length; i++) { + (model = models[i]).on('all', this._onModelEvent, this); + this._byCid[model.cid] = model; + if (model.id != null) this._byId[model.id] = model; + } + + // Insert models into the collection, re-sorting if needed, and triggering + // `add` events unless silenced. + this.length += length; + index = options.at != null ? options.at : this.models.length; + splice.apply(this.models, [index, 0].concat(models)); + if (this.comparator) this.sort({silent: true}); + if (options.silent) return this; + for (i = 0, length = this.models.length; i < length; i++) { + if (!cids[(model = this.models[i]).cid]) continue; + options.index = i; + model.trigger('add', model, this, options); + } + return this; }, - // Remove a model, or a list of models from the set. + // Remove a model, or a list of models from the set. Pass silent to avoid + // firing the `remove` event for every model removed. remove: function(models, options) { - models = _.isArray(models) ? models.slice() : [models]; - options || (options = {}); var i, l, index, model; + options || (options = {}); + models = _.isArray(models) ? models.slice() : [models]; for (i = 0, l = models.length; i < l; i++) { - model = this.get(models[i]); + model = this.getByCid(models[i]) || this.get(models[i]); if (!model) continue; delete this._byId[model.id]; - delete this._byId[model.cid]; + delete this._byCid[model.cid]; index = this.indexOf(model); this.models.splice(index, 1); this.length--; @@ -657,100 +656,10 @@ return this; }, - // Update a collection by `set`-ing a new list of models, adding new ones, - // removing models that are no longer present, and merging models that - // already exist in the collection, as necessary. Similar to **Model#set**, - // the core operation for updating the data contained by the collection. - set: function(models, options) { - options = _.defaults(options || {}, setOptions); - if (options.parse) models = this.parse(models, options); - if (!_.isArray(models)) models = models ? [models] : []; - var i, l, model, attrs, existing, sort; - var at = options.at; - var sortable = this.comparator && (at == null) && options.sort !== false; - var sortAttr = _.isString(this.comparator) ? this.comparator : null; - var toAdd = [], toRemove = [], modelMap = {}; - - // Turn bare objects into model references, and prevent invalid models - // from being added. - for (i = 0, l = models.length; i < l; i++) { - if (!(model = this._prepareModel(models[i], options))) continue; - - // If a duplicate is found, prevent it from being added and - // optionally merge it into the existing model. - if (existing = this.get(model)) { - if (options.remove) modelMap[existing.cid] = true; - if (options.merge) { - existing.set(model.attributes, options); - if (sortable && !sort && existing.hasChanged(sortAttr)) sort = true; - } - - // This is a new model, push it to the `toAdd` list. - } else if (options.add) { - toAdd.push(model); - - // Listen to added models' events, and index models for lookup by - // `id` and by `cid`. - model.on('all', this._onModelEvent, this); - this._byId[model.cid] = model; - if (model.id != null) this._byId[model.id] = model; - } - } - - // Remove nonexistent models if appropriate. - if (options.remove) { - for (i = 0, l = this.length; i < l; ++i) { - if (!modelMap[(model = this.models[i]).cid]) toRemove.push(model); - } - if (toRemove.length) this.remove(toRemove, options); - } - - // See if sorting is needed, update `length` and splice in new models. - if (toAdd.length) { - if (sortable) sort = true; - this.length += toAdd.length; - if (at != null) { - splice.apply(this.models, [at, 0].concat(toAdd)); - } else { - push.apply(this.models, toAdd); - } - } - - // Silently sort the collection if appropriate. - if (sort) this.sort({silent: true}); - - if (options.silent) return this; - - // Trigger `add` events. - for (i = 0, l = toAdd.length; i < l; i++) { - (model = toAdd[i]).trigger('add', model, this, options); - } - - // Trigger `sort` if the collection was sorted. - if (sort) this.trigger('sort', this, options); - return this; - }, - - // When you have more items than you want to add or remove individually, - // you can reset the entire set with a new list of models, without firing - // any granular `add` or `remove` events. Fires `reset` when finished. - // Useful for bulk operations and optimizations. - reset: function(models, options) { - options || (options = {}); - for (var i = 0, l = this.models.length; i < l; i++) { - this._removeReference(this.models[i]); - } - options.previousModels = this.models; - this._reset(); - this.add(models, _.extend({silent: true}, options)); - if (!options.silent) this.trigger('reset', this, options); - return this; - }, - // Add a model to the end of the collection. push: function(model, options) { model = this._prepareModel(model, options); - this.add(model, _.extend({at: this.length}, options)); + this.add(model, options); return model; }, @@ -775,15 +684,15 @@ return model; }, - // Slice out a sub-array of models from the collection. - slice: function(begin, end) { - return this.models.slice(begin, end); + // Get a model from the set by id. + get: function(id) { + if (id == null) return void 0; + return this._byId[id.id != null ? id.id : id]; }, - // Get a model from the set by id. - get: function(obj) { - if (obj == null) return void 0; - return this._byId[obj.id != null ? obj.id : obj.cid || obj]; + // Get a model from the set by client id. + getByCid: function(cid) { + return cid && this._byCid[cid.cid || cid]; }, // Get the model at the given index. @@ -791,11 +700,10 @@ return this.models[index]; }, - // Return models with matching attributes. Useful for simple cases of - // `filter`. - where: function(attrs, first) { - if (_.isEmpty(attrs)) return first ? void 0 : []; - return this[first ? 'find' : 'filter'](function(model) { + // Return models with matching attributes. Useful for simple cases of `filter`. + where: function(attrs) { + if (_.isEmpty(attrs)) return []; + return this.filter(function(model) { for (var key in attrs) { if (attrs[key] !== model.get(key)) return false; } @@ -803,75 +711,75 @@ }); }, - // Return the first model with matching attributes. Useful for simple cases - // of `find`. - findWhere: function(attrs) { - return this.where(attrs, true); - }, - // Force the collection to re-sort itself. You don't need to call this under // normal circumstances, as the set will maintain sort order as each item // is added. sort: function(options) { - if (!this.comparator) throw new Error('Cannot sort a set without a comparator'); options || (options = {}); - - // Run sort based on type of `comparator`. - if (_.isString(this.comparator) || this.comparator.length === 1) { - this.models = this.sortBy(this.comparator, this); + if (!this.comparator) throw new Error('Cannot sort a set without a comparator'); + var boundComparator = _.bind(this.comparator, this); + if (this.comparator.length == 1) { + this.models = this.sortBy(boundComparator); } else { - this.models.sort(_.bind(this.comparator, this)); + this.models.sort(boundComparator); } - - if (!options.silent) this.trigger('sort', this, options); + if (!options.silent) this.trigger('reset', this, options); return this; }, - // Figure out the smallest index at which a model should be inserted so as - // to maintain order. - sortedIndex: function(model, value, context) { - value || (value = this.comparator); - var iterator = _.isFunction(value) ? value : function(model) { - return model.get(value); - }; - return _.sortedIndex(this.models, model, iterator, context); - }, - // Pluck an attribute from each model in the collection. pluck: function(attr) { - return _.invoke(this.models, 'get', attr); + return _.map(this.models, function(model){ return model.get(attr); }); + }, + + // When you have more items than you want to add or remove individually, + // you can reset the entire set with a new list of models, without firing + // any `add` or `remove` events. Fires `reset` when finished. + reset: function(models, options) { + models || (models = []); + options || (options = {}); + for (var i = 0, l = this.models.length; i < l; i++) { + this._removeReference(this.models[i]); + } + this._reset(); + this.add(models, _.extend({silent: true}, options)); + if (!options.silent) this.trigger('reset', this, options); + return this; }, // Fetch the default set of models for this collection, resetting the - // collection when they arrive. If `reset: true` is passed, the response - // data will be passed through the `reset` method instead of `set`. + // collection when they arrive. If `add: true` is passed, appends the + // models to the collection instead of resetting. fetch: function(options) { options = options ? _.clone(options) : {}; - if (options.parse === void 0) options.parse = true; - var success = options.success; + if (options.parse === undefined) options.parse = true; var collection = this; - options.success = function(resp) { - var method = options.reset ? 'reset' : 'set'; - collection[method](resp, options); - if (success) success(collection, resp, options); - collection.trigger('sync', collection, resp, options); + var success = options.success; + options.success = function(resp, status, xhr) { + collection[options.add ? 'add' : 'reset'](collection.parse(resp, xhr), options); + if (success) success(collection, resp); }; - wrapError(this, options); - return this.sync('read', this, options); + options.error = Backbone.wrapError(options.error, collection, options); + return (this.sync || Backbone.sync).call(this, 'read', this, options); }, // Create a new instance of a model in this collection. Add the model to the // collection immediately, unless `wait: true` is passed, in which case we // wait for the server to agree. create: function(model, options) { + var coll = this; options = options ? _.clone(options) : {}; - if (!(model = this._prepareModel(model, options))) return false; - if (!options.wait) this.add(model, options); - var collection = this; + model = this._prepareModel(model, options); + if (!model) return false; + if (!options.wait) coll.add(model, options); var success = options.success; - options.success = function(resp) { - if (options.wait) collection.add(model, options); - if (success) success(model, resp, options); + options.success = function(nextModel, resp, xhr) { + if (options.wait) coll.add(nextModel, options); + if (success) { + success(nextModel, resp); + } else { + nextModel.trigger('sync', model, resp, options); + } }; model.save(null, options); return model; @@ -879,43 +787,44 @@ // **parse** converts a response into a list of models to be added to the // collection. The default implementation is just to pass it through. - parse: function(resp, options) { + parse: function(resp, xhr) { return resp; }, - // Create a new collection with an identical list of models as this one. - clone: function() { - return new this.constructor(this.models); + // Proxy to _'s chain. Can't be proxied the same way the rest of the + // underscore methods are proxied because it relies on the underscore + // constructor. + chain: function () { + return _(this.models).chain(); }, - // Private method to reset all internal state. Called when the collection - // is first initialized or reset. - _reset: function() { + // Reset all internal state. Called when the collection is reset. + _reset: function(options) { this.length = 0; this.models = []; this._byId = {}; + this._byCid = {}; }, - // Prepare a hash of attributes (or other model) to be added to this - // collection. - _prepareModel: function(attrs, options) { - if (attrs instanceof Model) { - if (!attrs.collection) attrs.collection = this; - return attrs; - } + // Prepare a model or hash of attributes to be added to this collection. + _prepareModel: function(model, options) { options || (options = {}); - options.collection = this; - var model = new this.model(attrs, options); - if (!model._validate(attrs, options)) { - this.trigger('invalid', this, attrs, options); - return false; + if (!(model instanceof Model)) { + var attrs = model; + options.collection = this; + model = new this.model(attrs, options); + if (!model._validate(model.attributes, options)) model = false; + } else if (!model.collection) { + model.collection = this; } return model; }, - // Internal method to sever a model's ties to a collection. + // Internal method to remove a model's ties to a collection. _removeReference: function(model) { - if (this === model.collection) delete model.collection; + if (this == model.collection) { + delete model.collection; + } model.off('all', this._onModelEvent, this); }, @@ -924,11 +833,13 @@ // events simply proxy through. "add" and "remove" events that originate // in other collections are ignored. _onModelEvent: function(event, model, collection, options) { - if ((event === 'add' || event === 'remove') && collection !== this) return; - if (event === 'destroy') this.remove(model, options); + if ((event == 'add' || event == 'remove') && collection != this) return; + if (event == 'destroy') { + this.remove(model, options); + } if (model && event === 'change:' + model.idAttribute) { delete this._byId[model.previous(model.idAttribute)]; - if (model.id != null) this._byId[model.id] = model; + this._byId[model.id] = model; } this.trigger.apply(this, arguments); } @@ -936,274 +847,21 @@ }); // Underscore methods that we want to implement on the Collection. - // 90% of the core usefulness of Backbone Collections is actually implemented - // right here: - var methods = ['forEach', 'each', 'map', 'collect', 'reduce', 'foldl', - 'inject', 'reduceRight', 'foldr', 'find', 'detect', 'filter', 'select', - 'reject', 'every', 'all', 'some', 'any', 'include', 'contains', 'invoke', - 'max', 'min', 'toArray', 'size', 'first', 'head', 'take', 'initial', 'rest', - 'tail', 'drop', 'last', 'without', 'indexOf', 'shuffle', 'lastIndexOf', - 'isEmpty', 'chain']; + var methods = ['forEach', 'each', 'map', 'reduce', 'reduceRight', 'find', + 'detect', 'filter', 'select', 'reject', 'every', 'all', 'some', 'any', + 'include', 'contains', 'invoke', 'max', 'min', 'sortBy', 'sortedIndex', + 'toArray', 'size', 'first', 'initial', 'rest', 'last', 'without', 'indexOf', + 'shuffle', 'lastIndexOf', 'isEmpty', 'groupBy']; // Mix in each Underscore method as a proxy to `Collection#models`. _.each(methods, function(method) { Collection.prototype[method] = function() { - var args = slice.call(arguments); - args.unshift(this.models); - return _[method].apply(_, args); + return _[method].apply(_, [this.models].concat(_.toArray(arguments))); }; }); - // Underscore methods that take a property name as an argument. - var attributeMethods = ['groupBy', 'countBy', 'sortBy']; - - // Use attributes instead of properties. - _.each(attributeMethods, function(method) { - Collection.prototype[method] = function(value, context) { - var iterator = _.isFunction(value) ? value : function(model) { - return model.get(value); - }; - return _[method](this.models, iterator, context); - }; - }); - - // Backbone.View - // ------------- - - // Backbone Views are almost more convention than they are actual code. A View - // is simply a JavaScript object that represents a logical chunk of UI in the - // DOM. This might be a single item, an entire list, a sidebar or panel, or - // even the surrounding frame which wraps your whole app. Defining a chunk of - // UI as a **View** allows you to define your DOM events declaratively, without - // having to worry about render order ... and makes it easy for the view to - // react to specific changes in the state of your models. - - // Creating a Backbone.View creates its initial element outside of the DOM, - // if an existing element is not provided... - var View = Backbone.View = function(options) { - this.cid = _.uniqueId('view'); - this._configure(options || {}); - this._ensureElement(); - this.initialize.apply(this, arguments); - this.delegateEvents(); - }; - - // Cached regex to split keys for `delegate`. - var delegateEventSplitter = /^(\S+)\s*(.*)$/; - - // List of view options to be merged as properties. - var viewOptions = ['model', 'collection', 'el', 'id', 'attributes', 'className', 'tagName', 'events']; - - // Set up all inheritable **Backbone.View** properties and methods. - _.extend(View.prototype, Events, { - - // The default `tagName` of a View's element is `"div"`. - tagName: 'div', - - // jQuery delegate for element lookup, scoped to DOM elements within the - // current view. This should be prefered to global lookups where possible. - $: function(selector) { - return this.$el.find(selector); - }, - - // Initialize is an empty function by default. Override it with your own - // initialization logic. - initialize: function(){}, - - // **render** is the core function that your view should override, in order - // to populate its element (`this.el`), with the appropriate HTML. The - // convention is for **render** to always return `this`. - render: function() { - return this; - }, - - // Remove this view by taking the element out of the DOM, and removing any - // applicable Backbone.Events listeners. - remove: function() { - this.$el.remove(); - this.stopListening(); - return this; - }, - - // Change the view's element (`this.el` property), including event - // re-delegation. - setElement: function(element, delegate) { - if (this.$el) this.undelegateEvents(); - this.$el = element instanceof Backbone.$ ? element : Backbone.$(element); - this.el = this.$el[0]; - if (delegate !== false) this.delegateEvents(); - return this; - }, - - // Set callbacks, where `this.events` is a hash of - // - // *{"event selector": "callback"}* - // - // { - // 'mousedown .title': 'edit', - // 'click .button': 'save' - // 'click .open': function(e) { ... } - // } - // - // pairs. Callbacks will be bound to the view, with `this` set properly. - // Uses event delegation for efficiency. - // Omitting the selector binds the event to `this.el`. - // This only works for delegate-able events: not `focus`, `blur`, and - // not `change`, `submit`, and `reset` in Internet Explorer. - delegateEvents: function(events) { - if (!(events || (events = _.result(this, 'events')))) return this; - this.undelegateEvents(); - for (var key in events) { - var method = events[key]; - if (!_.isFunction(method)) method = this[events[key]]; - if (!method) continue; - - var match = key.match(delegateEventSplitter); - var eventName = match[1], selector = match[2]; - method = _.bind(method, this); - eventName += '.delegateEvents' + this.cid; - if (selector === '') { - this.$el.on(eventName, method); - } else { - this.$el.on(eventName, selector, method); - } - } - return this; - }, - - // Clears all callbacks previously bound to the view with `delegateEvents`. - // You usually don't need to use this, but may wish to if you have multiple - // Backbone views attached to the same DOM element. - undelegateEvents: function() { - this.$el.off('.delegateEvents' + this.cid); - return this; - }, - - // Performs the initial configuration of a View with a set of options. - // Keys with special meaning *(e.g. model, collection, id, className)* are - // attached directly to the view. See `viewOptions` for an exhaustive - // list. - _configure: function(options) { - if (this.options) options = _.extend({}, _.result(this, 'options'), options); - _.extend(this, _.pick(options, viewOptions)); - this.options = options; - }, - - // Ensure that the View has a DOM element to render into. - // If `this.el` is a string, pass it through `$()`, take the first - // matching element, and re-assign it to `el`. Otherwise, create - // an element from the `id`, `className` and `tagName` properties. - _ensureElement: function() { - if (!this.el) { - var attrs = _.extend({}, _.result(this, 'attributes')); - if (this.id) attrs.id = _.result(this, 'id'); - if (this.className) attrs['class'] = _.result(this, 'className'); - var $el = Backbone.$('<' + _.result(this, 'tagName') + '>').attr(attrs); - this.setElement($el, false); - } else { - this.setElement(_.result(this, 'el'), false); - } - } - - }); - - // Backbone.sync - // ------------- - - // Override this function to change the manner in which Backbone persists - // models to the server. You will be passed the type of request, and the - // model in question. By default, makes a RESTful Ajax request - // to the model's `url()`. Some possible customizations could be: - // - // * Use `setTimeout` to batch rapid-fire updates into a single request. - // * Send up the models as XML instead of JSON. - // * Persist models via WebSockets instead of Ajax. - // - // Turn on `Backbone.emulateHTTP` in order to send `PUT` and `DELETE` requests - // as `POST`, with a `_method` parameter containing the true HTTP method, - // as well as all requests with the body as `application/x-www-form-urlencoded` - // instead of `application/json` with the model in a param named `model`. - // Useful when interfacing with server-side languages like **PHP** that make - // it difficult to read the body of `PUT` requests. - Backbone.sync = function(method, model, options) { - var type = methodMap[method]; - - // Default options, unless specified. - _.defaults(options || (options = {}), { - emulateHTTP: Backbone.emulateHTTP, - emulateJSON: Backbone.emulateJSON - }); - - // Default JSON-request options. - var params = {type: type, dataType: 'json'}; - - // Ensure that we have a URL. - if (!options.url) { - params.url = _.result(model, 'url') || urlError(); - } - - // Ensure that we have the appropriate request data. - if (options.data == null && model && (method === 'create' || method === 'update' || method === 'patch')) { - params.contentType = 'application/json'; - params.data = JSON.stringify(options.attrs || model.toJSON(options)); - } - - // For older servers, emulate JSON by encoding the request into an HTML-form. - if (options.emulateJSON) { - params.contentType = 'application/x-www-form-urlencoded'; - params.data = params.data ? {model: params.data} : {}; - } - - // For older servers, emulate HTTP by mimicking the HTTP method with `_method` - // And an `X-HTTP-Method-Override` header. - if (options.emulateHTTP && (type === 'PUT' || type === 'DELETE' || type === 'PATCH')) { - params.type = 'POST'; - if (options.emulateJSON) params.data._method = type; - var beforeSend = options.beforeSend; - options.beforeSend = function(xhr) { - xhr.setRequestHeader('X-HTTP-Method-Override', type); - if (beforeSend) return beforeSend.apply(this, arguments); - }; - } - - // Don't process data on a non-GET request. - if (params.type !== 'GET' && !options.emulateJSON) { - params.processData = false; - } - - // If we're sending a `PATCH` request, and we're in an old Internet Explorer - // that still has ActiveX enabled by default, override jQuery to use that - // for XHR instead. Remove this line when jQuery supports `PATCH` on IE8. - if (params.type === 'PATCH' && window.ActiveXObject && - !(window.external && window.external.msActiveXFilteringEnabled)) { - params.xhr = function() { - return new ActiveXObject("Microsoft.XMLHTTP"); - }; - } - - // Make the request, allowing the user to override any Ajax options. - var xhr = options.xhr = Backbone.ajax(_.extend(params, options)); - model.trigger('request', model, xhr, options); - return xhr; - }; - - // Map from CRUD to HTTP for our default `Backbone.sync` implementation. - var methodMap = { - 'create': 'POST', - 'update': 'PUT', - 'patch': 'PATCH', - 'delete': 'DELETE', - 'read': 'GET' - }; - - // Set the default implementation of `Backbone.ajax` to proxy through to `$`. - // Override this if you'd like to use a different library. - Backbone.ajax = function() { - return Backbone.$.ajax.apply(Backbone.$, arguments); - }; - // Backbone.Router - // --------------- + // ------------------- // Routers map faux-URLs to actions, and fire events when routes are // matched. Creating a new one sets its `routes` hash, if not set statically. @@ -1216,10 +874,9 @@ // Cached regular expressions for matching named param parts and splatted // parts of route strings. - var optionalParam = /\((.*?)\)/g; - var namedParam = /(\(\?)?:\w+/g; + var namedParam = /:\w+/g; var splatParam = /\*\w+/g; - var escapeRegExp = /[\-{}\[\]+?.,\\\^$|#\s]/g; + var escapeRegExp = /[-[\]{}()+?.,\\^$|#\s]/g; // Set up all inheritable **Backbone.Router** properties and methods. _.extend(Router.prototype, Events, { @@ -1235,27 +892,21 @@ // }); // route: function(route, name, callback) { + Backbone.history || (Backbone.history = new History); if (!_.isRegExp(route)) route = this._routeToRegExp(route); - if (_.isFunction(name)) { - callback = name; - name = ''; - } if (!callback) callback = this[name]; - var router = this; - Backbone.history.route(route, function(fragment) { - var args = router._extractParameters(route, fragment); - callback && callback.apply(router, args); - router.trigger.apply(router, ['route:' + name].concat(args)); - router.trigger('route', name, args); - Backbone.history.trigger('route', router, name, args); - }); + Backbone.history.route(route, _.bind(function(fragment) { + var args = this._extractParameters(route, fragment); + callback && callback.apply(this, args); + this.trigger.apply(this, ['route:' + name].concat(args)); + Backbone.history.trigger('route', this, name, args); + }, this)); return this; }, // Simple proxy to `Backbone.history` to save a fragment into the history. navigate: function(fragment, options) { Backbone.history.navigate(fragment, options); - return this; }, // Bind all defined routes to `Backbone.history`. We have to reverse the @@ -1263,10 +914,12 @@ // routes can be defined at the bottom of the route map. _bindRoutes: function() { if (!this.routes) return; - this.routes = _.result(this, 'routes'); - var route, routes = _.keys(this.routes); - while ((route = routes.pop()) != null) { - this.route(route, this.routes[route]); + var routes = []; + for (var route in this.routes) { + routes.unshift([route, this.routes[route]]); + } + for (var i = 0, l = routes.length; i < l; i++) { + this.route(routes[i][0], routes[i][1], this[routes[i][1]]); } }, @@ -1274,22 +927,15 @@ // against the current location hash. _routeToRegExp: function(route) { route = route.replace(escapeRegExp, '\\$&') - .replace(optionalParam, '(?:$1)?') - .replace(namedParam, function(match, optional){ - return optional ? match : '([^\/]+)'; - }) + .replace(namedParam, '([^\/]+)') .replace(splatParam, '(.*?)'); return new RegExp('^' + route + '$'); }, // Given a route, and a URL fragment that it matches, return the array of - // extracted decoded parameters. Empty or unmatched parameters will be - // treated as `null` to normalize cross-browser behavior. + // extracted parameters. _extractParameters: function(route, fragment) { - var params = route.exec(fragment).slice(1); - return _.map(params, function(param) { - return param ? decodeURIComponent(param) : null; - }); + return route.exec(fragment).slice(1); } }); @@ -1297,34 +943,19 @@ // Backbone.History // ---------------- - // Handles cross-browser history management, based on either - // [pushState](http://diveintohtml5.info/history.html) and real URLs, or - // [onhashchange](https://developer.mozilla.org/en-US/docs/DOM/window.onhashchange) - // and URL fragments. If the browser supports neither (old IE, natch), - // falls back to polling. + // Handles cross-browser history management, based on URL fragments. If the + // browser does not support `onhashchange`, falls back to polling. var History = Backbone.History = function() { this.handlers = []; _.bindAll(this, 'checkUrl'); - - // Ensure that `History` can be used outside of the browser. - if (typeof window !== 'undefined') { - this.location = window.location; - this.history = window.history; - } }; - // Cached regex for stripping a leading hash/slash and trailing space. - var routeStripper = /^[#\/]|\s+$/g; - - // Cached regex for stripping leading and trailing slashes. - var rootStripper = /^\/+|\/+$/g; + // Cached regex for cleaning leading hashes and slashes . + var routeStripper = /^[#\/]/; // Cached regex for detecting MSIE. var isExplorer = /msie [\w.]+/; - // Cached regex for removing a trailing slash. - var trailingSlash = /\/$/; - // Has the history handling already been started? History.started = false; @@ -1337,8 +968,9 @@ // Gets the true hash value. Cannot use location.hash directly due to bug // in Firefox where location.hash will always be decoded. - getHash: function(window) { - var match = (window || this).location.href.match(/#(.*)$/); + getHash: function(windowOverride) { + var loc = windowOverride ? windowOverride.location : window.location; + var match = loc.href.match(/#(.*)$/); return match ? match[1] : ''; }, @@ -1346,14 +978,15 @@ // the hash, or the override. getFragment: function(fragment, forcePushState) { if (fragment == null) { - if (this._hasPushState || !this._wantsHashChange || forcePushState) { - fragment = this.location.pathname; - var root = this.root.replace(trailingSlash, ''); - if (!fragment.indexOf(root)) fragment = fragment.substr(root.length); + if (this._hasPushState || forcePushState) { + fragment = window.location.pathname; + var search = window.location.search; + if (search) fragment += search; } else { fragment = this.getHash(); } } + if (!fragment.indexOf(this.options.root)) fragment = fragment.substr(this.options.root.length); return fragment.replace(routeStripper, ''); }, @@ -1366,28 +999,24 @@ // Figure out the initial configuration. Do we need an iframe? // Is pushState desired ... is it available? this.options = _.extend({}, {root: '/'}, this.options, options); - this.root = this.options.root; this._wantsHashChange = this.options.hashChange !== false; this._wantsPushState = !!this.options.pushState; - this._hasPushState = !!(this.options.pushState && this.history && this.history.pushState); + this._hasPushState = !!(this.options.pushState && window.history && window.history.pushState); var fragment = this.getFragment(); var docMode = document.documentMode; var oldIE = (isExplorer.exec(navigator.userAgent.toLowerCase()) && (!docMode || docMode <= 7)); - // Normalize root to always include a leading and trailing slash. - this.root = ('/' + this.root + '/').replace(rootStripper, '/'); - - if (oldIE && this._wantsHashChange) { - this.iframe = Backbone.$('