diff -r 25731d245eda -r 487ca37bb0c7 web/res/js/backbone-relational.js --- a/web/res/js/backbone-relational.js Wed Dec 11 10:17:08 2019 +0100 +++ b/web/res/js/backbone-relational.js Wed Dec 11 11:02:15 2019 +0100 @@ -1,29 +1,65 @@ /* vim: set tabstop=4 softtabstop=4 shiftwidth=4 noexpandtab: */ /** - * Backbone-relational.js 0.8.5 - * (c) 2011-2013 Paul Uithol and contributors (https://github.com/PaulUithol/Backbone-relational/graphs/contributors) - * + * Backbone-relational.js 0.10.0 + * (c) 2011-2014 Paul Uithol and contributors (https://github.com/PaulUithol/Backbone-relational/graphs/contributors) + * * Backbone-relational may be freely distributed under the MIT license; see the accompanying LICENSE.txt. * For details and documentation: https://github.com/PaulUithol/Backbone-relational. * Depends on Backbone (and thus on Underscore as well): https://github.com/documentcloud/backbone. - */ -( function( undefined ) { - "use strict"; + * + * Example: + * + Zoo = Backbone.RelationalModel.extend({ + relations: [ { + type: Backbone.HasMany, + key: 'animals', + relatedModel: 'Animal', + reverseRelation: { + key: 'livesIn', + includeInJSON: 'id' + // 'relatedModel' is automatically set to 'Zoo'; the 'relationType' to 'HasOne'. + } + } ], + + toString: function() { + return this.get( 'name' ); + } + }); + + Animal = Backbone.RelationalModel.extend({ + toString: function() { + return this.get( 'species' ); + } + }); - /** - * CommonJS shim - **/ - var _, Backbone, exports; - if ( typeof window === 'undefined' ) { - _ = require( 'underscore' ); - Backbone = require( 'backbone' ); - exports = module.exports = Backbone; + // Creating the zoo will give it a collection with one animal in it: the monkey. + // The animal created after that has a relation `livesIn` that points to the zoo it's currently associated with. + // If you instantiate (or fetch) the zebra later, it will automatically be added. + + var zoo = new Zoo({ + name: 'Artis', + animals: [ { id: 'monkey-1', species: 'Chimp' }, 'lion-1', 'zebra-1' ] + }); + + var lion = new Animal( { id: 'lion-1', species: 'Lion' } ), + monkey = zoo.get( 'animals' ).first(), + sameZoo = lion.get( 'livesIn' ); + */ +( function( root, factory ) { + // Set up Backbone-relational for the environment. Start with AMD. + if ( typeof define === 'function' && define.amd ) { + define( [ 'exports', 'backbone', 'underscore' ], factory ); } + // Next for Node.js or CommonJS. + else if ( typeof exports !== 'undefined' ) { + factory( exports, require( 'backbone' ), require( 'underscore' ) ); + } + // Finally, as a browser global. Use `root` here as it references `window`. else { - _ = window._; - Backbone = window.Backbone; - exports = window; + factory( root, root.Backbone, root._ ); } +}( this, function( exports, Backbone, _ ) { + "use strict"; Backbone.Relational = { showWarnings: true @@ -86,9 +122,21 @@ } }, + // Some of the queued events may trigger other blocking events. By + // copying the queue here it allows queued events to process closer to + // the natural order. + // + // queue events [ 'A', 'B', 'C' ] + // A handler of 'B' triggers 'D' and 'E' + // By copying `this._queue` this executes: + // [ 'A', 'B', 'D', 'E', 'C' ] + // The same order the would have executed if they didn't have to be + // delayed and queued. process: function() { - while ( this._queue && this._queue.length ) { - this._queue.shift()(); + var queue = this._queue; + this._queue = []; + while ( queue && queue.length ) { + queue.shift()(); } }, @@ -134,7 +182,7 @@ 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` + var rel = 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 ); @@ -179,7 +227,7 @@ */ setupSuperModel: function( modelType ) { _.find( this._subModels, function( subModelDef ) { - return _.find( subModelDef.subModels || [], function( subModelTypeName, typeValue ) { + return _.filter( subModelDef.subModels || [], function( subModelTypeName, typeValue ) { var subModelType = this.getObjectByName( subModelTypeName ); if ( modelType === subModelType ) { @@ -192,7 +240,7 @@ modelType._subModelTypeAttribute = subModelDef.superModelType.prototype.subModelTypeAttribute; return true; } - }, this ); + }, this ).length; }, this ); }, @@ -211,7 +259,7 @@ return val === rel[ key ]; }); }); - + if ( !exists && relation.model && relation.type ) { this._reverseRelations.push( relation ); this._addRelation( relation.model, relation ); @@ -278,7 +326,7 @@ return; } - new relation.type( model, relation ); + var rel = new relation.type( model, relation ); }, this ); }, @@ -292,18 +340,20 @@ if ( type instanceof Backbone.RelationalModel ) { type = type.constructor; } - + var rootModel = type; while ( rootModel._superModel ) { rootModel = rootModel._superModel; } - - var coll = _.findWhere( this._collections, { model: rootModel } ); - + + var coll = _.find( this._collections, function( item ) { + return item.model === rootModel; + }); + if ( !coll && create !== false ) { coll = this._createCollection( rootModel ); } - + return coll; }, @@ -331,20 +381,20 @@ _createCollection: function( type ) { var coll; - + // If 'type' is an instance, take its constructor if ( type instanceof Backbone.RelationalModel ) { type = type.constructor; } - + // Type should inherit from Backbone.RelationalModel. if ( type.prototype instanceof Backbone.RelationalModel ) { coll = new Backbone.Collection(); coll.model = type; - + this._collections.push( coll ); } - + return coll; }, @@ -380,9 +430,9 @@ * @param {String|Number|Object|Backbone.RelationalModel} item */ find: function( type, item ) { - var id = this.resolveIdForItem( type, item ); - var coll = this.getCollection( type ); - + var id = this.resolveIdForItem( type, item ), + coll = this.getCollection( type ); + // Because the found object could be of any of the type's superModel // types, only return it if it's actually of the type asked for. if ( coll ) { @@ -406,7 +456,6 @@ if ( coll ) { var modelColl = model.collection; coll.add( model ); - this.listenTo( model, 'destroy', this.unregister, this ); model.collection = modelColl; } }, @@ -435,6 +484,12 @@ */ update: function( model ) { var coll = this.getCollection( model ); + + // Register a model if it isn't yet (which happens if it was created without an id). + if ( !coll.contains( model ) ) { + this.register( model ); + } + // This triggers updating the lookup indices kept in a collection coll._onModelEvent( 'change:' + model.idAttribute, model, coll ); @@ -443,13 +498,47 @@ }, /** - * Remove a 'model' from the store. - * @param {Backbone.RelationalModel} model + * Unregister from the store: a specific model, a collection, or a model type. + * @param {Backbone.RelationalModel|Backbone.RelationalModel.constructor|Backbone.Collection} type */ - unregister: function( model ) { - this.stopListening( model, 'destroy', this.unregister ); - var coll = this.getCollection( model ); - coll && coll.remove( model ); + unregister: function( type ) { + var coll, + models; + + if ( type instanceof Backbone.Model ) { + coll = this.getCollection( type ); + models = [ type ]; + } + else if ( type instanceof Backbone.Collection ) { + coll = this.getCollection( type.model ); + models = _.clone( type.models ); + } + else { + coll = this.getCollection( type ); + models = _.clone( coll.models ); + } + + _.each( models, function( model ) { + this.stopListening( model ); + _.invoke( model.getRelations(), 'stopListening' ); + }, this ); + + + // If we've unregistered an entire store collection, reset the collection (which is much faster). + // Otherwise, remove each model one by one. + if ( _.contains( this._collections, type ) ) { + coll.reset( [] ); + } + else { + _.each( models, function( model ) { + if ( coll.get( model ) ) { + coll.remove( model ); + } + else { + coll.trigger( 'relational:remove', model, coll ); + } + }, this ); + } }, /** @@ -458,6 +547,12 @@ */ reset: function() { this.stopListening(); + + // Unregister each collection to remove event listeners + _.each( this._collections, function( coll ) { + this.unregister( coll ); + }, this ); + this._collections = []; this._subModels = []; this._modelScopes = [ exports ]; @@ -496,11 +591,23 @@ this.keyDestination = this.options.keyDestination || this.keySource || this.key; this.model = this.options.model || this.instance.constructor; + this.relatedModel = this.options.relatedModel; + + // No 'relatedModel' is interpreted as self-referential + if ( _.isUndefined( this.relatedModel ) ) { + this.relatedModel = this.model; + } + + // Otherwise, try to resolve the given value to an object + if ( _.isFunction( this.relatedModel ) && !( this.relatedModel.prototype instanceof Backbone.RelationalModel ) ) { + this.relatedModel = _.result( this, 'relatedModel' ); + } if ( _.isString( this.relatedModel ) ) { this.relatedModel = Backbone.Relational.store.getObjectByName( this.relatedModel ); } + if ( !this.checkPreconditions() ) { return; } @@ -519,7 +626,7 @@ if ( instance ) { var contentKey = this.keySource; - if ( contentKey !== this.key && typeof this.instance.get( this.key ) === 'object' ) { + if ( contentKey !== this.key && _.isObject( this.instance.get( this.key ) ) ) { contentKey = this.key; } @@ -528,7 +635,7 @@ // 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 } ); + delete this.instance.attributes[ this.keySource ]; } // Add this Relation to instance._relations @@ -537,13 +644,13 @@ this.initialize( opts ); if ( this.options.autoFetch ) { - this.instance.fetchRelated( this.key, _.isObject( this.options.autoFetch ) ? this.options.autoFetch : {} ); + this.instance.getAsync( this.key, _.isObject( this.options.autoFetch ) ? this.options.autoFetch : {} ); } // When 'relatedModel' are created or destroyed, check if it affects this relation. this.listenTo( this.instance, 'destroy', this.destroy ) .listenTo( this.relatedCollection, 'relational:add relational:change:id', this.tryAddRelated ) - .listenTo( this.relatedCollection, 'relational:remove', this.removeRelated ) + .listenTo( this.relatedCollection, 'relational:remove', this.removeRelated ); } }; // Fix inheritance :\ @@ -618,10 +725,7 @@ */ setRelated: function( related ) { this.related = related; - - this.instance.acquire(); this.instance.attributes[ this.key ] = related; - this.instance.release(); }, /** @@ -644,15 +748,22 @@ getReverseRelations: function( model ) { 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 ); - + var models = !_.isUndefined( model ) ? [ model ] : this.related && ( this.related.models || [ this.related ] ), + relations = null, + relation = null; + + for( var i = 0; i < ( models || [] ).length; i++ ) { + relations = models[ i ].getRelations() || []; + + for( var j = 0; j < relations.length; j++ ) { + relation = relations[ j ]; + + if ( this._isReverseRelation( relation ) ) { + reverseRelations.push( relation ); + } + } + } + return reverseRelations; }, @@ -669,7 +780,7 @@ else if ( this instanceof Backbone.HasMany ) { this.setRelated( this._prepareCollection() ); } - + _.each( this.getReverseRelations(), function( relation ) { relation.removeRelated( this.instance ); }, this ); @@ -712,7 +823,7 @@ } // Nullify `keyId` if we have a related model; in case it was already part of the relation - if ( this.related ) { + if ( related ) { this.keyId = null; } @@ -739,19 +850,19 @@ } this.acquire(); options = options ? _.clone( options ) : {}; - + // '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 + // 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; - + if ( changed ) { this.setKeyContents( attr ); var related = this.findRelated( options ); this.setRelated( related ); } - + // Notify old 'related' object of the terminated relation if ( oldRelated && this.related !== oldRelated ) { _.each( this.getReverseRelations( oldRelated ), function( relation ) { @@ -765,7 +876,7 @@ _.each( this.getReverseRelations(), function( relation ) { relation.addRelated( this.instance, options ); }, this ); - + // Fire the 'change:' event if 'related' was updated if ( !options.silent && this.related !== oldRelated ) { var dit = this; @@ -805,7 +916,7 @@ if ( !this.related ) { return; } - + if ( model === this.related ) { var oldRelated = this.related || null; this.setRelated( null ); @@ -826,9 +937,12 @@ initialize: function( opts ) { this.listenTo( this.instance, 'relational:change:' + this.key, this.onChange ); - + // Handle a custom 'collectionType' this.collectionType = this.options.collectionType; + if ( _.isFunction( this.collectionType ) && this.collectionType !== Backbone.Collection && !( this.collectionType.prototype instanceof Backbone.Collection ) ) { + this.collectionType = _.result( this, 'collectionType' ); + } if ( _.isString( this.collectionType ) ) { this.collectionType = Backbone.Relational.store.getObjectByName( this.collectionType ); } @@ -859,10 +973,10 @@ } collection.model = this.relatedModel; - + if ( this.options.collectionKey ) { var key = this.options.collectionKey === true ? this.options.reverseRelation.key : this.options.collectionKey; - + if ( collection[ key ] && collection[ key ] !== this.instance ) { if ( Backbone.Relational.showWarnings && typeof console !== 'undefined' ) { console.warn( 'Relation=%o; collectionKey=%s already exists on collection=%o', this, key, this.options.collectionKey ); @@ -876,7 +990,7 @@ this.listenTo( collection, 'relational:add', this.handleAddition ) .listenTo( collection, 'relational:remove', this.handleRemoval ) .listenTo( collection, 'relational:reset', this.handleReset ); - + return collection; }, @@ -901,14 +1015,15 @@ var toAdd = []; _.each( this.keyContents, function( attributes ) { + var model = null; + if ( attributes instanceof this.relatedModel ) { - var model = attributes; + 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 = ( _.isObject( attributes ) && options.parse && this.relatedModel.prototype.parse ) ? + this.relatedModel.prototype.parse( _.clone( attributes ), options ) : attributes; } model && toAdd.push( model ); @@ -921,9 +1036,9 @@ related = this._prepareCollection(); } - // By now, both `merge` and `parse` will already have been executed for models if they were specified. - // Disable them to prevent additional calls. - related.set( toAdd, _.defaults( { merge: false, parse: false }, options ) ); + // By now, `parse` will already have been executed just above for models if specified. + // Disable to prevent additional calls. + related.set( toAdd, _.defaults( { parse: false }, options ) ); } // Remove entries from `keyIds` that were already part of the relation (and are thus 'unchanged') @@ -980,12 +1095,12 @@ /** * 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; - + _.each( this.getReverseRelations( model ), function( relation ) { relation.addRelated( this.instance, options ); }, this ); @@ -1005,14 +1120,14 @@ //console.debug('handleRemoval called; args=%o', arguments); options = options ? _.clone( options ) : {}; this.changed = true; - + _.each( this.getReverseRelations( model ), function( relation ) { relation.removeRelated( this.instance, null, options ); }, this ); - + var dit = this; !options.silent && Backbone.Relational.eventQueue.add( function() { - dit.instance.trigger( 'remove:' + dit.key, model, dit.related, options ); + dit.instance.trigger( 'remove:' + dit.key, model, dit.related, options ); }); }, @@ -1064,6 +1179,7 @@ _isInitialized: false, _deferProcessing: false, _queue: null, + _attributeChangeFired: false, // Keeps track of `change` event firing under some conditions (like nested `set`s) subModelTypeAttribute: 'type', subModelTypes: null, @@ -1075,7 +1191,7 @@ // Example: event for "p.on( 'add:jobs' )" -> "p.get('jobs').add( { company: c.id, person: p.id } )". if ( options && options.collection ) { var dit = this, - collection = this.collection = options.collection; + collection = this.collection = options.collection; // Prevent `collection` from cascading down to nested models; they shouldn't go into this `if` clause. delete options.collection; @@ -1098,7 +1214,8 @@ } Backbone.Relational.store.processOrphanRelations(); - + Backbone.Relational.store.listenTo( this, 'relational:unregister', Backbone.Relational.store.unregister ); + this._queue = new Backbone.BlockingQueue(); this._queue.block(); Backbone.Relational.eventQueue.block(); @@ -1120,42 +1237,53 @@ 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 ( !Backbone.Relational.eventQueue.isBlocked() ) { + // If we're not in a more complicated nested scenario, fire the change event right away + Backbone.Model.prototype.trigger.apply( dit, args ); + } + else { + Backbone.Relational.eventQueue.add( function() { + // Determine if the `change` event is still valid, now that all relations are populated + var changed = true; + if ( eventName === 'change' ) { + // `hasChanged` may have gotten reset by nested calls to `set`. + changed = dit.hasChanged() || dit._attributeChangeFired; + dit._attributeChangeFired = false; + } + 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 ( 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 sets 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 ]; + // 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 ]; + } } - // 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 ]; + else if ( changed ) { + dit._attributeChangeFired = true; } } - } - changed && Backbone.Model.prototype.trigger.apply( dit, args ); - }); + changed && Backbone.Model.prototype.trigger.apply( dit, args ); + }); + } + } + else if ( eventName === 'destroy' ) { + Backbone.Model.prototype.trigger.apply( this, arguments ); + Backbone.Relational.store.unregister( this ); } else { Backbone.Model.prototype.trigger.apply( this, arguments ); @@ -1183,15 +1311,28 @@ /** * When new values are set, notify this model's relations (also if options.silent is set). - * (Relation.setRelated locks this model before calling 'set' on it to prevent loops) + * (called from `set`; Relation.setRelated locks this model before calling 'set' on it to prevent loops) + * @param {Object} [changedAttrs] + * @param {Object} [options] */ - updateRelations: function( options ) { + updateRelations: function( changedAttrs, options ) { if ( this._isInitialized && !this.isLocked() ) { _.each( this._relations, function( rel ) { - // Update from data in `rel.keySource` if set, or `rel.key` otherwise - var val = this.attributes[ rel.keySource ] || this.attributes[ rel.key ]; - if ( rel.related !== val ) { - this.trigger( 'relational:change:' + rel.key, this, val, options || {} ); + if ( !changedAttrs || ( rel.keySource in changedAttrs || rel.key in changedAttrs ) ) { + // Fetch data in `rel.keySource` if data got set in there, or `rel.key` otherwise + var value = this.attributes[ rel.keySource ] || this.attributes[ rel.key ], + attr = changedAttrs && ( changedAttrs[ rel.keySource ] || changedAttrs[ rel.key ] ); + + // Update a relation if its value differs from this model's attributes, or it's been explicitly nullified. + // Which can also happen before the originally intended related model has been found (`val` is null). + if ( rel.related !== value || ( value === null && attr === null ) ) { + this.trigger( 'relational:change:' + rel.key, this, value, options || {} ); + } + } + + // Explicitly clear 'keySource', to prevent a leaky abstraction if 'keySource' differs from 'key'. + if ( rel.keySource !== rel.key ) { + delete this.attributes[ rel.keySource ]; } }, this ); } @@ -1215,11 +1356,11 @@ /** * 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. + * @param {string} attr The relation key to look for. + * @return {Backbone.Relation} An instance of 'Backbone.Relation', if a relation was found for 'attr', or null. */ - getRelation: function( key ) { - return this._relations[ key ]; + getRelation: function( attr ) { + return this._relations[ attr ]; }, /** @@ -1230,82 +1371,119 @@ return _.values( 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). - * @return {jQuery.when[]} An array of request objects + * Get a list of ids that will be fetched on a call to `getAsync`. + * @param {string|Backbone.Relation} attr The relation key to fetch models for. + * @param [refresh=false] Add ids for models that are already in the relation, refreshing them? + * @return {Array} An array of ids that need to be fetched. */ - fetchRelated: function( key, options, refresh ) { - // Set default `options` for fetch - options = _.extend( { update: true, remove: false }, options ); - - var setUrl, - requests = [], - rel = this.getRelation( key ), - idsToFetch = rel && ( rel.keyIds || ( ( rel.keyId || rel.keyId === 0 ) ? [ rel.keyId ] : [] ) ); + getIdsToFetch: function( attr, refresh ) { + var rel = attr instanceof Backbone.Relation ? attr : this.getRelation( attr ), + ids = rel ? ( rel.keyIds && rel.keyIds.slice( 0 ) ) || ( ( rel.keyId || rel.keyId === 0 ) ? [ rel.keyId ] : [] ) : []; // On `refresh`, add the ids for current models in the relation to `idsToFetch` if ( refresh ) { - var models = rel.related instanceof Backbone.Collection ? rel.related.models : [ rel.related ]; + var models = rel.related && ( rel.related.models || [ rel.related ] ); _.each( models, function( model ) { if ( model.id || model.id === 0 ) { - idsToFetch.push( model.id ); + ids.push( model.id ); } }); } + return ids; + }, + + /** + * Get related objects. Returns a single promise, which can either resolve immediately (if the related model[s]) + * are already present locally, or after fetching the contents of the requested attribute. + * @param {string} attr The relation key to fetch models for. + * @param {Object} [options] Options for 'Backbone.Model.fetch' and 'Backbone.sync'. + * @param {Boolean} [options.refresh=false] Fetch existing models from the server as well (in order to update them). + * @return {jQuery.Deferred} A jQuery promise object. When resolved, its `done` callback will be called with + * contents of `attr`. + */ + getAsync: function( attr, options ) { + // Set default `options` for fetch + options = _.extend( { add: true, remove: false, refresh: false }, options ); + + var dit = this, + requests = [], + rel = this.getRelation( attr ), + idsToFetch = rel && this.getIdsToFetch( rel, options.refresh ), + coll = rel.related instanceof Backbone.Collection ? rel.related : rel.relatedCollection; + if ( idsToFetch && idsToFetch.length ) { - // Find (or create) a model for each one that is to be fetched - var created = [], - models = _.map( idsToFetch, 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 ); + var models = [], + createdModels = [], + setUrl, + createModels = function() { + // Find (or create) a model for each one that is to be fetched + models = _.map( idsToFetch, function( id ) { + var model = rel.relatedModel.findModel( id ); + + if ( !model ) { + var attrs = {}; + attrs[ rel.relatedModel.prototype.idAttribute ] = id; + model = rel.relatedModel.findOrCreate( attrs, options ); + createdModels.push( model ); + } + + return model; + }, this ); + }; + + // Try if the 'collection' can provide a url to fetch a set of models in one request. + // This assumes that when 'Backbone.Collection.url' is a function, it can handle building of set urls. + // To make sure it can, test if the url we got by supplying a list of models to fetch is different from + // the one supplied for the default fetch action (without args to 'url'). + if ( coll instanceof Backbone.Collection && _.isFunction( coll.url ) ) { + var defaultUrl = coll.url(); + setUrl = coll.url( idsToFetch ); + + if ( setUrl === defaultUrl ) { + createModels(); + setUrl = coll.url( models ); + + if ( setUrl === defaultUrl ) { + setUrl = null; } - - 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 ) ) { - setUrl = rel.related.url( models ); + } } - // An assumption is that when 'Backbone.Collection.url' is a function, it can handle building of set urls. - // To make sure it can, test if the url we got by supplying a list of models to fetch is different from - // the one supplied for the default fetch action (without args to 'url'). - if ( setUrl && setUrl !== rel.related.url() ) { + if ( setUrl ) { + // Do a single request to fetch all models var opts = _.defaults( { error: function() { - var args = arguments; - _.each( created, function( model ) { + _.each( createdModels, function( model ) { model.trigger( 'destroy', model, model.collection, options ); - options.error && options.error.apply( model, args ); }); + + options.error && options.error.apply( models, arguments ); }, url: setUrl }, options ); - requests = [ rel.related.fetch( opts ) ]; + requests = [ coll.fetch( opts ) ]; } else { + // Make a request per model to fetch + if ( !models.length ) { + createModels(); + } + requests = _.map( models, function( model ) { var opts = _.defaults( { error: function() { - if ( _.contains( created, model ) ) { + if ( _.contains( createdModels, model ) ) { model.trigger( 'destroy', model, model.collection, options ); - options.error && options.error.apply( model, arguments ); } + options.error && options.error.apply( models, arguments ); } }, options @@ -1314,40 +1492,25 @@ }, this ); } } - - return requests; + + return this.deferArray(requests).then( + function() { + return Backbone.Model.prototype.get.call( dit, attr ); + } + ); }, - - 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; + + deferArray: function(deferArray) { + return Backbone.$.when.apply(null, deferArray); }, set: function( key, value, options ) { Backbone.Relational.eventQueue.block(); // Duplicate backbone's behavior to allow separate key/value parameters, instead of a single 'attributes' object - var attributes; + var attributes, + result; + if ( _.isObject( key ) || key == null ) { attributes = key; options = value; @@ -1364,12 +1527,17 @@ // Check if we're not setting a duplicate id before actually calling `set`. Backbone.Relational.store.checkId( this, newId ); - var result = Backbone.Model.prototype.set.apply( this, arguments ); + result = Backbone.Model.prototype.set.apply( this, arguments ); // Ideal place to set up relations, if this is the first time we're here for this model if ( !this._isInitialized && !this.isLocked() ) { this.constructor.initializeModelHierarchy(); - Backbone.Relational.store.register( this ); + + // Only register models that have an id. A model will be registered when/if it gets an id later on. + if ( newId || newId === 0 ) { + Backbone.Relational.store.register( this ); + } + this.initializeRelations( options ); } // The store should know about an `id` update asap @@ -1378,37 +1546,13 @@ } if ( attributes ) { - this.updateRelations( options ); + this.updateRelations( attributes, options ); } } finally { // Try to run the global queue holding external events Backbone.Relational.eventQueue.unblock(); } - - return result; - }, - - unset: function( attribute, options ) { - Backbone.Relational.eventQueue.block(); - - var result = Backbone.Model.prototype.unset.apply( this, arguments ); - this.updateRelations( options ); - - // Try to run the global queue holding external events - Backbone.Relational.eventQueue.unblock(); - - return result; - }, - - clear: function( options ) { - Backbone.Relational.eventQueue.block(); - - var result = Backbone.Model.prototype.clear.apply( this, arguments ); - this.updateRelations( options ); - - // Try to run the global queue holding external events - Backbone.Relational.eventQueue.unblock(); return result; }, @@ -1465,8 +1609,12 @@ if ( rel instanceof Backbone.HasMany ) { value = value.concat( rel.keyIds ); } - else if ( rel instanceof Backbone.HasOne ) { + else if ( rel instanceof Backbone.HasOne ) { value = value || rel.keyId; + + if ( !value && !_.isObject( rel.keyContents ) ) { + value = rel.keyContents || null; + } } } } @@ -1492,6 +1640,13 @@ delete json[ rel.key ]; } + // In case of `wait: true`, Backbone will simply push whatever's passed into `save` into attributes. + // We'll want to get this information into the JSON, even if it doesn't conform to our normal + // expectations of what's contained in it (no model/collection for a relation, etc). + if ( value === null && options && options.wait ) { + value = related; + } + if ( includeInJSON ) { json[ rel.keyDestination ] = value; } @@ -1500,7 +1655,7 @@ delete json[ rel.key ]; } }); - + this.release(); return json; } @@ -1512,8 +1667,8 @@ * @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. + // We don't want to share a relations array with a parent, as this will cause problems with reverse + // relations. Since `relations` may also be a property or function, only use slice if we have an array. this.prototype.relations = ( this.prototype.relations || [] ).slice( 0 ); this._subModels = {}; @@ -1533,7 +1688,7 @@ if ( !rel.model ) { rel.model = this; } - + if ( rel.reverseRelation && rel.model === this ) { var preInitialize = true; if ( _.isString( rel.relatedModel ) ) { @@ -1558,7 +1713,7 @@ } } }, this ); - + return this; }, @@ -1569,39 +1724,82 @@ * @return {Backbone.Model} */ build: function( attributes, options ) { - var model = this; - // 'build' is a possible entrypoint; it's possible no model hierarchy has been determined yet. this.initializeModelHierarchy(); // Determine what type of (sub)model should be built if applicable. - // Lookup the proper subModelType in 'this._subModels'. - if ( this._subModels && this.prototype.subModelTypeAttribute in attributes ) { - var subModelTypeAttribute = attributes[ this.prototype.subModelTypeAttribute ]; - var subModelType = this._subModels[ subModelTypeAttribute ]; + var model = this._findSubModelType( this, attributes ) || this; + + return new model( attributes, options ); + }, + + /** + * Determines what type of (sub)model should be built if applicable. + * Looks up the proper subModelType in 'this._subModels', recursing into + * types until a match is found. Returns the applicable 'Backbone.Model' + * or null if no match is found. + * @param {Backbone.Model} type + * @param {Object} attributes + * @return {Backbone.Model} + */ + _findSubModelType: function( type, attributes ) { + if ( type._subModels && type.prototype.subModelTypeAttribute in attributes ) { + var subModelTypeAttribute = attributes[ type.prototype.subModelTypeAttribute ]; + var subModelType = type._subModels[ subModelTypeAttribute ]; if ( subModelType ) { - model = subModelType; + return subModelType; + } + else { + // Recurse into subModelTypes to find a match + for ( subModelTypeAttribute in type._subModels ) { + subModelType = this._findSubModelType( type._subModels[ subModelTypeAttribute ], attributes ); + if ( subModelType ) { + return subModelType; + } + } } } - - return new model( attributes, options ); + + return null; }, /** * */ 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 ) ) { - Backbone.Relational.store.setupSuperModel( this ); + // Inherit any relations that have been defined in the parent model. + this.inheritRelations(); + + // If we came here through 'build' for a model that has 'subModelTypes' then try to initialize the ones that + // haven't been resolved yet. + if ( this.prototype.subModelTypes ) { + var resolvedSubModels = _.keys( this._subModels ); + var unresolvedSubModels = _.omit( this.prototype.subModelTypes, resolvedSubModels ); + _.each( unresolvedSubModels, function( subModelTypeName ) { + var subModelType = Backbone.Relational.store.getObjectByName( subModelTypeName ); + subModelType && subModelType.initializeModelHierarchy(); + }); + } + }, - // If a superModel has been found, copy relations from the _superModel if they haven't been - // inherited automatically (due to a redefinition of 'relations'). - // Otherwise, make sure we don't get here again for this type by making '_superModel' false so we fail - // the isUndefined/isNull check next time. - if ( this._superModel && this._superModel.prototype.relations ) { - // Find relations that exist on the `_superModel`, but not yet on this model. - var inheritedRelations = _.select( this._superModel.prototype.relations || [], function( superRel ) { + inheritRelations: function() { + // Bail out if we've been here before. + if ( !_.isUndefined( this._superModel ) && !_.isNull( this._superModel ) ) { + return; + } + // Try to initialize the _superModel. + Backbone.Relational.store.setupSuperModel( this ); + + // If a superModel has been found, copy relations from the _superModel if they haven't been inherited automatically + // (due to a redefinition of 'relations'). + if ( this._superModel ) { + // The _superModel needs a chance to initialize its own inherited relations before we attempt to inherit relations + // from the _superModel. You don't want to call 'initializeModelHierarchy' because that could cause sub-models of + // this class to inherit their relations before this class has had chance to inherit it's relations. + this._superModel.inheritRelations(); + if ( this._superModel.prototype.relations ) { + // Find relations that exist on the '_superModel', but not yet on this model. + var inheritedRelations = _.filter( this._superModel.prototype.relations || [], function( superRel ) { return !_.any( this.prototype.relations || [], function( rel ) { return superRel.relatedModel === rel.relatedModel && superRel.key === rel.key; }, this ); @@ -1609,25 +1807,19 @@ this.prototype.relations = inheritedRelations.concat( this.prototype.relations ); } - else { - this._superModel = false; - } } - - // 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 ) { - var subModelType = Backbone.Relational.store.getObjectByName( subModelTypeName ); - subModelType && subModelType.initializeModelHierarchy(); - }); + // Otherwise, make sure we don't get here again for this type by making '_superModel' false so we fail the + // isUndefined/isNull check next time. + else { + this._superModel = false; } }, /** * 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`. - * Otherwise, a new model is created with `attributes` (unless `options.create` is explicitly set to `false`). + * A new model is created if no matching model is found, `attributes` is an object, and `options.create` is true. + * - If `attributes` is a string or a number, `findOrCreate` will 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.merge` is `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] @@ -1638,26 +1830,54 @@ findOrCreate: function( attributes, options ) { options || ( options = {} ); var parsedAttributes = ( _.isObject( attributes ) && options.parse && this.prototype.parse ) ? - this.prototype.parse( attributes ) : attributes; + this.prototype.parse( _.clone( attributes ), options ) : attributes; - // Try to find an instance of 'this' model type in the store - var model = Backbone.Relational.store.find( this, parsedAttributes ); + // If specified, use a custom `find` function to match up existing models to the given attributes. + // Otherwise, try to find an instance of 'this' model type in the store + var model = this.findModel( parsedAttributes ); // 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 ( _.isObject( attributes ) ) { if ( model && options.merge !== false ) { - // Make sure `options.collection` doesn't cascade to nested models + // Make sure `options.collection` and `options.url` doesn't cascade to nested models delete options.collection; + delete options.url; model.set( parsedAttributes, options ); } else if ( !model && options.create !== false ) { - model = this.build( attributes, options ); + model = this.build( parsedAttributes, _.defaults( { parse: false }, options ) ); } } return model; + }, + + /** + * Find an instance of `this` type in 'Backbone.Relational.store'. + * - If `attributes` is a string or a number, `find` will 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.merge` is `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.merge=true] + * @param {Boolean} [options.parse=false] + * @return {Backbone.RelationalModel} + */ + find: function( attributes, options ) { + options || ( options = {} ); + options.create = false; + return this.findOrCreate( attributes, options ); + }, + + /** + * A hook to override the matching when updating (or creating) a model. + * The default implementation is to look up the model by id in the store. + * @param {Object} attributes + * @returns {Backbone.RelationalModel} + */ + findModel: function( attributes ) { + return Backbone.Relational.store.find( this, attributes ); } }); _.extend( Backbone.RelationalModel.prototype, Backbone.Semaphore ); @@ -1669,9 +1889,9 @@ * (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 ) { + Backbone.Collection.prototype._prepareModel = function( attrs, options ) { var model; - + if ( attrs instanceof Backbone.Model ) { if ( !attrs.collection ) { attrs.collection = this; @@ -1679,22 +1899,22 @@ model = attrs; } else { - options || ( options = {} ); + options = options ? _.clone( options ) : {}; options.collection = this; - + if ( typeof this.model.findOrCreate !== 'undefined' ) { model = this.model.findOrCreate( attrs, options ); } else { model = new this.model( attrs, options ); } - - if ( model && model.isNew() && !model._validate( attrs, options ) ) { + + if ( model && model.validationError ) { this.trigger( 'invalid', this, attrs, options ); model = false; } } - + return model; }; @@ -1707,84 +1927,80 @@ Backbone.Collection.prototype.set = function( models, options ) { // Short-circuit if this Collection doesn't hold RelationalModels if ( !( this.model.prototype instanceof Backbone.RelationalModel ) ) { - return set.apply( this, arguments ); + return set.call( this, models, options ); } if ( options && options.parse ) { models = this.parse( models, options ); } - if ( !_.isArray( models ) ) { - models = models ? [ models ] : []; - } + var singular = !_.isArray( models ), + newModels = [], + toAdd = [], + model = null; - var newModels = [], - toAdd = []; + models = singular ? ( models ? [ models ] : [] ) : _.clone( models ); //console.debug( 'calling add on coll=%o; model=%o, options=%o', this, models, options ); - _.each( models, function( model ) { + for ( var i = 0; i < models.length; i++ ) { + model = models[i]; 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 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 ) { + else if ( model.id !== null && model.id !== undefined ) { this._byId[ model.id ] = model; } } - }, this ); + } // Add 'models' in a single batch, so the original add will only be called once (and thus 'sort', etc). // If `parse` was specified, the collection and contained models have been parsed now. - set.call( this, toAdd, _.defaults( { parse: false }, options ) ); + toAdd = singular ? ( toAdd.length ? toAdd[ 0 ] : null ) : toAdd; + var result = set.call( this, toAdd, _.defaults( { merge: false, parse: false }, options ) ); - _.each( newModels, function( model ) { + for ( i = 0; i < newModels.length; i++ ) { + model = newModels[i]; // 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 ); - - return this; + } + + return result; }; /** - * Override 'Backbone.Collection.remove' to trigger 'relational:remove'. + * Override 'Backbone.Collection._removeModels' to trigger 'relational:remove'. */ - var remove = Backbone.Collection.prototype.__remove = Backbone.Collection.prototype.remove; - Backbone.Collection.prototype.remove = function( models, options ) { + var _removeModels = Backbone.Collection.prototype.___removeModels = Backbone.Collection.prototype._removeModels; + Backbone.Collection.prototype._removeModels = function( models, options ) { // Short-circuit if this Collection doesn't hold RelationalModels if ( !( this.model.prototype instanceof Backbone.RelationalModel ) ) { - return remove.apply( this, arguments ); + return _removeModels.call( this, models, options ); } - 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 = this.get( model ) || ( model && this.get( model.cid ) ); model && toRemove.push( model ); }, this ); - if ( toRemove.length ) { - remove.call( this, toRemove, options ); + var result = _removeModels.call( this, toRemove, options ); - _.each( toRemove, function( model ) { - this.trigger('relational:remove', model, this, options); - }, this ); - } - - return this; + _.each( toRemove, function( model ) { + this.trigger( 'relational:remove', model, this, options ); + }, this ); + + return result; }; /** @@ -1793,13 +2009,13 @@ var reset = Backbone.Collection.prototype.__reset = Backbone.Collection.prototype.reset; Backbone.Collection.prototype.reset = function( models, options ) { options = _.extend( { merge: true }, options ); - reset.call( this, models, options ); + var result = reset.call( this, models, options ); if ( this.model.prototype instanceof Backbone.RelationalModel ) { this.trigger( 'relational:reset', this, options ); } - return this; + return result; }; /** @@ -1807,13 +2023,13 @@ */ var sort = Backbone.Collection.prototype.__sort = Backbone.Collection.prototype.sort; Backbone.Collection.prototype.sort = function( options ) { - sort.call( this, options ); + var result = sort.call( this, options ); if ( this.model.prototype instanceof Backbone.RelationalModel ) { this.trigger( 'relational:reset', this, options ); } - return this; + return result; }; /** @@ -1827,17 +2043,17 @@ return trigger.apply( this, arguments ); } - if ( eventName === 'add' || eventName === 'remove' || eventName === 'reset' ) { + if ( eventName === 'add' || eventName === 'remove' || eventName === 'reset' || eventName === 'sort' ) { 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 ] ); } - + Backbone.Relational.eventQueue.add( function() { trigger.apply( dit, args ); }); @@ -1845,16 +2061,16 @@ else { trigger.apply( this, arguments ); } - + return this; }; // Override .extend() to automatically call .setup() Backbone.RelationalModel.extend = function( protoProps, classProps ) { - var child = Backbone.Model.extend.apply( this, arguments ); - + var child = Backbone.Model.extend.call( this, protoProps, classProps ); + child.setup( this ); return child; }; -})(); +}));