backbone-relational-rails 0.8.5 → 0.8.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a358ff7e2c4cabae8dbddc3fbe53df8a87ff168c
+  data.tar.gz: 1c0de4ed22b1e62f19050ddb1811ae417e026adf
+SHA512:
+  metadata.gz: 14f7c8b8e3385e59d57cc4de3c5a114559bfaa6af8d79de6e5e3004a4cd78a645e55d1539a582818cf0c570d91e4024090aa9ccaaef9f248641cf8f8a37cf46e
+  data.tar.gz: f18037d420056d0e8be90af1b8a5dbcdeea84fe49905ed24f8174caa85665938ba0986cae98cc46a410c5477a2b7836ca4ce702de06a9a313d1efe53749424eb

data/README.md

@@ -1,7 +1,7 @@
 # backbone-relational-rails
 
 backbone-relational-rails wraps the [Backbone-relational](https://github.com/PaulUithol/Backbone-relational) library in a rails engine for simple
-use with the asset pipeline provided by rails 3.1. The gem includes the development (non-minified)
+use with the asset pipeline first provided by rails 3.1. The gem includes the development (non-minified)
 source for ease of exploration. The asset pipeline will minify in production.
 
 Backbone-relational provides one-to-one, one-to-many and many-to-one relations between models for [Backbone](http://backbonejs.org/).
@@ -18,7 +18,7 @@ Add the following directive to your Javascript manifest file (application.js):
 
 ## Versioning
 
-backbone-relational-rails 0.8.5 == Backbone-relational 0.8.5
+backbone-relational-rails 0.8.6 == Backbone-relational 0.8.6
 
 Every attempt is made to mirror the currently shipping Backbone-relational version number wherever possible.
 The major, minor, and patch version numbers will always represent the Backbone-relational version. Should a gem

data/lib/backbone-relational-rails/version.rb

@@ -1,7 +1,7 @@
 module Backbone
   module Relational
     module Rails
-      VERSION = "0.8.5"
+      VERSION = "0.8.6"
     end
   end
 end

data/vendor/assets/javascripts/backbone-relational.js

@@ -1,6 +1,6 @@
 /* vim: set tabstop=4 softtabstop=4 shiftwidth=4 noexpandtab: */
 /**
- * Backbone-relational.js 0.8.5
+ * Backbone-relational.js 0.8.6
  * (c) 2011-2013 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.
@@ -17,7 +17,8 @@
 	if ( typeof window === 'undefined' ) {
 		_ = require( 'underscore' );
 		Backbone = require( 'backbone' );
-		exports = module.exports = Backbone;
+		exports = Backbone;
+		typeof module === 'undefined' || ( module.exports = exports );
 	}
 	else {
 		_ = window._;
@@ -86,9 +87,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()();
 			}
 		},
 
@@ -298,7 +311,9 @@
 				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 );
@@ -407,6 +422,7 @@
 				var modelColl = model.collection;
 				coll.add( model );
 				this.listenTo( model, 'destroy', this.unregister, this );
+				this.listenTo( model, 'relational:unregister', this.unregister, this );
 				model.collection = modelColl;
 			}
 		},
@@ -446,10 +462,10 @@
 		 * Remove a 'model' from the store.
 		 * @param {Backbone.RelationalModel} model
 		 */
-		unregister: function( model ) {
-			this.stopListening( model, 'destroy', this.unregister );
+		unregister: function( model, collection, options ) {
+			this.stopListening( model );
 			var coll = this.getCollection( model );
-			coll && coll.remove( model );
+			coll && coll.remove( model, options );
 		},
 
 		/**
@@ -496,7 +512,12 @@
 		this.keyDestination = this.options.keyDestination || this.keySource || this.key;
 
 		this.model = this.options.model || this.instance.constructor;
+
 		this.relatedModel = this.options.relatedModel;
+
+		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 );
 		}
@@ -528,7 +549,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
@@ -829,6 +850,9 @@
 			
 			// 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 );
 			}
@@ -1064,6 +1088,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,
@@ -1128,7 +1153,9 @@
 					// Determine if the `change` event is still valid, now that all relations are populated
 					var changed = true;
 					if ( eventName === 'change' ) {
-						changed = dit.hasChanged();
+						// `hasChanged` may have gotten reset by nested calls to `set`.
+						changed = dit.hasChanged() || dit._attributeChangeFired;
+						dit._attributeChangeFired = false;
 					}
 					else {
 						var attr = eventName.slice( 7 ),
@@ -1137,7 +1164,7 @@
 						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,
+							// 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 );
 
@@ -1152,6 +1179,9 @@
 								delete dit.changed[ attr ];
 							}
 						}
+						else if ( changed ) {
+							dit._attributeChangeFired = true;
+						}
 					}
 
 					changed && Backbone.Model.prototype.trigger.apply( dit, args );
@@ -1172,7 +1202,7 @@
 			this.acquire(); // Setting up relations often also involve calls to 'set', and we only want to enter this function once
 			this._relations = {};
 
-			_.each( this.relations || [], function( rel ) {
+			_.each( _.result( this, 'relations' ) || [], function( rel ) {
 				Backbone.Relational.store.initializeRelation( this, rel, options );
 			}, this );
 
@@ -1188,11 +1218,16 @@
 		updateRelations: function( options ) {
 			if ( this._isInitialized && !this.isLocked() ) {
 				_.each( this._relations, function( rel ) {
-					// Update from data in `rel.keySource` if set, or `rel.key` otherwise
+					// Update from data in `rel.keySource` if data got set in there, 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 || {} );
 					}
+
+					// Explicitly clear 'keySource', to prevent a leaky abstraction if 'keySource' differs from 'key'.
+					if ( rel.keySource !== rel.key ) {
+						delete rel.instance.attributes[ rel.keySource ];
+					}
 				}, this );
 			}
 		},
@@ -1244,7 +1279,7 @@
 			var setUrl,
 				requests = [],
 				rel = this.getRelation( key ),
-				idsToFetch = rel && ( rel.keyIds || ( ( rel.keyId || rel.keyId === 0 ) ? [ rel.keyId ] : [] ) );
+				idsToFetch = 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 ) {
@@ -1329,11 +1364,19 @@
 			// 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 );
+				if ( _.isNull(model) || _.isUndefined( model ) ) {
+					// Return undefined if the path cannot be expanded
+					return undefined;
+				}
+				else if ( model instanceof Backbone.Model ) {
+					return Backbone.Model.prototype.get.call( model, split );
+				}
+				else if ( model instanceof Backbone.Collection ) {
+					return Backbone.Collection.prototype.at.call( model, split )
+				}
+				else {
+					throw new Error( 'Attribute must be an instanceof Backbone.Model or Backbone.Collection. Is: ' + model + ', currentSplit: ' + split );
 				}
-
-				return Backbone.Model.prototype.get.call( model, split );
 			}, this );
 
 			if ( originalResult !== undefined && result !== undefined ) {
@@ -1389,30 +1432,6 @@
 			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;
-		},
-
 		clone: function() {
 			var attributes = _.clone( this.attributes );
 			if ( !_.isUndefined( attributes[ this.idAttribute ] ) ) {
@@ -1569,57 +1588,92 @@
 		 * @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 );
-
-				// 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.
+			// 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();
+				});
+			}
+		},
+		
+		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 = _.select( this._superModel.prototype.relations || [], function( superRel ) {
 						return !_.any( this.prototype.relations || [], function( rel ) {
 							return superRel.relatedModel === rel.relatedModel && superRel.key === rel.key;
 						}, this );
 					}, this );
-
+	
 					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;
 			}
 		},
 
@@ -1638,7 +1692,7 @@
 		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 ) ) : attributes;
 
 			// Try to find an instance of 'this' model type in the store
 			var model = Backbone.Relational.store.find( this, parsedAttributes );
@@ -1647,8 +1701,9 @@
 			// 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 );
 				}
@@ -1658,6 +1713,22 @@
 			}
 
 			return model;
+		},
+
+		/**
+		 * Find an instance of `this` type in 'Backbone.Relational.store'.
+		 * - If `attributes` is a string or a number, `find` 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`.
+		 * @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 );
 		}
 	});
 	_.extend( Backbone.RelationalModel.prototype, Backbone.Semaphore );
@@ -1765,14 +1836,14 @@
 			return remove.apply( this, arguments );
 		}
 
-		models = _.isArray( models ) ? models.slice() : [ models ];
+		models = _.isArray( models ) ? models.slice( 0 ) : [ 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 );
 
@@ -1827,7 +1898,7 @@
 			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;
 			

metadata

@@ -1,30 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: backbone-relational-rails
 version: !ruby/object:Gem::Version
-  version: 0.8.5
-  prerelease: 
+  version: 0.8.6
 platform: ruby
 authors:
 - Peter Marsh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-11 00:00:00.000000000 Z
+date: 2013-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
 description: Backbone-relational provides one-to-one, one-to-many and many-to-one
@@ -35,41 +32,34 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/backbone-relational-rails.rb
 - lib/backbone-relational-rails/version.rb
+- lib/backbone-relational-rails.rb
 - vendor/assets/javascripts/backbone-relational.js
 - LICENSE
 - README.md
 homepage: http://github.com/petedmarsh/backbone-relational-rails
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 - vendor
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3926763858083606606
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3926763858083606606
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Backbone-relational packaged for Rails
 test_files: []