now supports hasOne associations

bradrobertson · bradrobertson · commit 33bf32754868 · 2012-02-05T22:16:48.000-05:00
still TODO, auto parsing when fetching a model
diff --git a/spec/rails_model.spec.js b/spec/rails_model.spec.js
@@ -20,10 +20,10 @@ describe("RailsModel", function() {
     expect(book.attributes).toBeDefined();
   });
 
-  describe("hasMany associations", function() {
+  describe("Associations Using Nested Attributes", function() {
     
     beforeEach(function() {
-      Book = Backbone.RailsModel.extend(hasManyNested);
+      Book = Backbone.RailsModel.extend(nestedAssociations);
     });
 
     describe("Empty model", function() {
@@ -35,34 +35,29 @@ describe("RailsModel", function() {
         expect(book.pages instanceof Collections.Pages).toBeTruthy();
         expect(book.customerReviews instanceof Collections.CustomerReviews).toBeTruthy();
       });
+      
+      it("should have models set", function(){
+        expect(book.author instanceof Models.Author).toBeTruthy();
+        expect(book.publishingHouse instanceof Models.PublishingHouse).toBeTruthy();
+      });
 
       describe("serialization", function() {
-        it("should not contain the books and reviews collections", function() {
+        it("should not contain the collections", function() {
           expect(book.toJSON().pages_attributes).toBeUndefined();
           expect(book.toJSON().customer_reviews_attributes).toBeUndefined();
         });
         
-        describe("asNestedAttributes: false", function(){
-          beforeEach(function(){
-            Book = Backbone.RailsModel.extend(hasManyNotNested);
-            book = new Book();
-          });
-          
-          it("should not contain the books and reviews collection", function() {
-            expect(book.toJSON().pages).toBeUndefined();
-            expect(book.toJSON().customer_reviews).toBeUndefined();
-          });
+        it("should not contain the models", function() {
+          expect(book.toJSON().author_attributes).toBeUndefined();
+          expect(book.toJSON().publishing_house_attributes).toBeUndefined();
         });
       });
 
     });
 
     describe("Populated model", function() {
       beforeEach(function() {
-        book = new Book({
-          pages: [{one:1}, {two:2}],
-          customer_reviews: [{one:'great'},{two:'mediocre'},{three:'soso'}]
-        });
+        book = new Book(sampleBook);
       });
 
       it("should have a populated each collection", function() {
@@ -75,11 +70,21 @@ describe("RailsModel", function() {
         expect(book.customerReviews.at(1).get('two')).toEqual('mediocre');
         expect(book.customerReviews.at(2).get('three')).toEqual('soso');
       });
+      
+      it("should have populated each model", function(){
+        expect(book.author.get('name')).toEqual('John Doe');
+        expect(book.publishingHouse.get('name')).toEqual('Books co.');
+      });
 
-      it("should not have the collection set as attributes", function(){
+      it("should not have the passed in collection names set as attributes", function(){
         expect(book.get('pages')).toBeUndefined();
         expect(book.get('customer_reviews')).toBeUndefined();
       });
+      
+      it("should not have the passed in model names set as attributes", function(){
+        expect(book.get('author')).toBeUndefined();
+        expect(book.get('publishing_house')).toBeUndefined();
+      });
 
       describe("serialization", function() {
         it("should have both collection's attributes", function() {
@@ -89,34 +94,81 @@ describe("RailsModel", function() {
           expect(book.toJSON().customer_reviews_attributes).toBeDefined();
           expect(book.toJSON().customer_reviews_attributes[0].one).toEqual('great');
         });
+        
+        it("should have model attributes set", function(){
+          expect(book.toJSON().author_attributes).toBeDefined();
+          expect(book.toJSON().author_attributes.name).toEqual('John Doe');
+          
+          expect(book.toJSON().publishing_house_attributes).toBeDefined();
+          expect(book.toJSON().publishing_house_attributes.name).toEqual('Books co.');
+        });
 
         it("should not have pages or customer_reviews", function() {
           expect(book.toJSON().pages).toBeUndefined();
           expect(book.toJSON().customer_reviews).toBeUndefined();
         });
+        
+        it("should not have author or publishing_house", function() {
+          expect(book.toJSON().author).toBeUndefined();
+          expect(book.toJSON().publishing_house).toBeUndefined();
+        });
+      });
+    });
+  });
+  
+  describe("Associations Without Using Nested Attributes", function() {
+    
+    beforeEach(function() {
+      Book = Backbone.RailsModel.extend(nonNestedAssociations);
+    });
 
-        describe("asNestedAttributes: false", function() {
-          beforeEach(function() {
-            Book = Backbone.RailsModel.extend(hasManyNotNested);
-
-            book = new Book({
-              pages: [{one:1}, {two:2}],
-              customer_reviews: [{one:'great'},{two:'mediocre'},{three:'soso'}]
-            });
-          });
-
-          it("should have pages", function(){
-            expect(book.toJSON().pages).toBeDefined();
-            expect(book.toJSON().pages[0].one).toEqual(1);
-            
-            expect(book.toJSON().customer_reviews).toBeDefined();
-            expect(book.toJSON().customer_reviews[0].one).toEqual('great');
-          });
-
-          it("should not have pages_attributes", function() {
-            expect(book.toJSON().pages_attributes).toBeUndefined();
-            expect(book.toJSON().customer_reviews_attributes).toBeUndefined();
-          });
+    describe("serialization", function(){
+      
+      describe("empty model", function(){
+        beforeEach(function(){
+          book = new Book();
+        });
+
+        it("should not include collections", function() {
+          expect(book.toJSON().pages).toBeUndefined();
+          expect(book.toJSON().customer_reviews).toBeUndefined();
+        });
+        
+        it("should not include models", function() {
+          expect(book.toJSON().author).toBeUndefined();
+          expect(book.toJSON().publishing_house).toBeUndefined();
+        });
+      });
+      
+      describe("populated model", function() {
+        beforeEach(function() {
+          book = new Book(sampleBook);
+        });
+
+        it("should include collections", function(){
+          expect(book.toJSON().pages).toBeDefined();
+          expect(book.toJSON().pages[0].one).toEqual(1);
+          
+          expect(book.toJSON().customer_reviews).toBeDefined();
+          expect(book.toJSON().customer_reviews[0].one).toEqual('great');
+        });
+        
+        it("should include models", function(){
+          expect(book.toJSON().author).toBeDefined();
+          expect(book.toJSON().author.name).toEqual('John Doe');
+          
+          expect(book.toJSON().publishing_house).toBeDefined();
+          expect(book.toJSON().publishing_house.name).toEqual('Books co.');
+        });
+
+        it("should not have _attributes collections", function() {
+          expect(book.toJSON().pages_attributes).toBeUndefined();
+          expect(book.toJSON().customer_reviews_attributes).toBeUndefined();
+        });
+        
+        it("should not have _attributes models", function() {
+          expect(book.toJSON().author_attributes).toBeUndefined();
+          expect(book.toJSON().publishing_house_attributes).toBeUndefined();
         });
       });
     });
diff --git a/spec/spec_helper.js b/spec/spec_helper.js
@@ -1,11 +1,13 @@
 var Models = {},
     Collections = {},
-    hasManyNested,
-    hasOneNested,
-    hasOneAndManyNested,
-    hasManyNotNested,
-    hasOneNotNested,
-    hasOneAndManyNotNested;
+    nestedAssociations,
+    nonNestedAssociations,
+    sampleBook = {
+      pages: [{one:1}, {two:2}],
+      customer_reviews: [{one:'great'},{two:'mediocre'},{three:'soso'}],
+      author: {name:'John Doe', phone: '123-456-7890'},
+      publishing_house: {name: 'Books co.', phone: '012-345-6789'}
+    };
 
 beforeEach(function(){
   Models.Author = Backbone.Model.extend();
@@ -14,18 +16,15 @@ beforeEach(function(){
   Collections.Pages = Backbone.RailsNestedAttributesCollection.extend();
   Collections.CustomerReviews = Backbone.RailsNestedAttributesCollection.extend();
   
-  hasManyNested = {
+  nestedAssociations = {
     hasMany: {
       pages: {
         collection: Collections.Pages
       },
       customerReviews: {
         collection: Collections.CustomerReviews
       }
-    }
-  };
-
-  hasOneNested = {
+    },
     hasOne: {
       author: {
         model: Models.Author
@@ -36,9 +35,7 @@ beforeEach(function(){
     }
   };
 
-  hasOneAndManyNested = _.extend(hasManyNested, hasOneNested);
-  
-  hasManyNotNested = {
+  nonNestedAssociations = {
     hasMany: {
       pages: {
         collection: Collections.Pages,
@@ -48,10 +45,7 @@ beforeEach(function(){
         collection: Collections.CustomerReviews,
         asNestedAttributes: false
       }
-    }
-  };
-
-  hasOneNotNested = {
+    },
     hasOne: {
       author: {
         model: Models.Author,
@@ -64,5 +58,4 @@ beforeEach(function(){
     }
   };
 
-  hasOneAndManyNotNested = _.extend(hasManyNotNested, hasOneNotNested);
 });
diff --git a/src/rails_model.js b/src/rails_model.js
@@ -31,6 +31,11 @@
 */
 (function(){
   
+  /**
+  *
+  *   Some String utility functions to work with camelCase and underscore strings
+  *
+  */
   var 
       /**
       *
@@ -66,7 +71,24 @@
           replace(/([a-z\d])([A-Z]+)/g, '$1_$2').
           replace(/\-|\s+/g, '_').toLowerCase();
       };
-
+    
+    var 
+      /**
+      *   @private
+      *   @binding {Backbone.RailsModel}
+      *   @param {String} type The type of association (collection|model)
+      *   @param {Object} properties The properties for this particular association (ie. which model/collection to uset etc...)
+      *   @param {String} association The name of the association to set
+      *
+      *   Creates the associated model and populates it with data
+      *   Note this is not set on attributes, but directly on the model itself
+      *
+      */
+      createAssociation = function(type, properties, association){
+        var railsAssociation = underscored(association);
+        this[association] = new properties[type](this.get( railsAssociation ));
+        this.unset(railsAssociation, {silent: true});
+      };
 
   Backbone.RailsModel = Backbone.Model.extend({
 
@@ -92,9 +114,11 @@
       Backbone.Model.prototype.constructor.apply(this, arguments);
 
       _.each(this.hasMany, function(properties, association){
-        var railsAssociation = underscored(association);
-        self[association] = new properties.collection(self.get( railsAssociation ));
-        self.unset(railsAssociation, {silent: true});
+        createAssociation.call(self, 'collection', properties, association);
+      });
+      
+      _.each(this.hasOne, function(properties, association){
+        createAssociation.call(self, 'model', properties, association);
       });
     },
 
@@ -110,10 +134,11 @@
       var self = this,
           attrs = _.clone(this.attributes);
 
-      _.each(this.hasMany, function(properties, association){
-        var associationKey = underscored(association) + (properties.asNestedAttributes === false ? "" : "_attributes");
+      _.each(_.extend({}, this.hasOne, this.hasMany), function(properties, association){
 
-        if ( self[association].length ){
+        // checking for either: length (if collection), or populated attributes (if model)
+        if ( self[association].length || !_.isEmpty(self[association].attributes)){
+          var associationKey = underscored(association) + (properties.asNestedAttributes === false ? "" : "_attributes");
           attrs[associationKey] = self[association].toJSON();
         }
       });
