ember-data-factory-guy 0.2.1 → 0.3.0

data/src/factory_guy_test_mixin.js

@@ -69,7 +69,7 @@ FactoryGuyTestMixin = Em.Mixin.create({
     @param {Object} opts fixture options
    */
   handleCreate: function (name, opts) {
-    var model = FactoryGuy.lookupModelForName(name);
+    var model = FactoryGuy.lookupModelForFixtureName(name);
     this.stubEndpointForHttpRequest(
       "/" + Em.String.pluralize(model),
       this.buildAjaxCreateResponse(name, opts),
@@ -85,7 +85,7 @@ FactoryGuyTestMixin = Em.Mixin.create({
 ¬  */
   buildAjaxCreateResponse: function (name, opts) {
     var fixture = FactoryGuy.build(name, opts);
-    var model = FactoryGuy.lookupModelForName(name);
+    var model = FactoryGuy.lookupModelForFixtureName(name);
     var hash = {};
     hash[model] = fixture;
     return hash;

data/src/model_definition.js

@@ -50,10 +50,15 @@ ModelDefinition = function (model, config) {
     var modelAttributes = namedModels[name] || {};
     // merge default, modelAttributes and opts to get the rough fixture
     var fixture = $.extend({}, defaultAttributes, modelAttributes, opts);
-    // convert attributes that are functions to strings
+    // deal with attributes that are functions or objects
     for (attribute in fixture) {
-      if (typeof fixture[attribute] == 'function') {
+      if (Ember.typeOf(fixture[attribute]) == 'function') {
+        // function might be a sequence of a named association
         fixture[attribute] = fixture[attribute].call(this, fixture);
+      } else if (Ember.typeOf(fixture[attribute]) == 'object') {
+        // if it's an object it's for a model association, so build the json
+        // for the association and replace the attribute with that json
+        fixture[attribute] = FactoryGuy.build(attribute, fixture[attribute])
       }
     }
     // set the id, unless it was already set in opts

data/src/store.js

@@ -16,19 +16,25 @@ DS.Store.reopen({
    @returns {Object|DS.Model} json or record depending on the adapter type
    */
   makeFixture: function (name, options) {
-    var modelName = FactoryGuy.lookupModelForName(name);
+    var modelName = FactoryGuy.lookupModelForFixtureName(name);
     var fixture = FactoryGuy.build(name, options);
     var modelType = this.modelFor(modelName);
 
     if (this.usingFixtureAdapter()) {
-      this.setBelongsToFixturesAdapter(modelType, modelName, fixture);
+      this.setAssociationsForFixtureAdapter(modelType, modelName, fixture);
       return FactoryGuy.pushFixture(modelType, fixture);
     } else {
-      var self = this;
+      var store = this;
       var model;
       Em.run(function () {
-        model = self.push(modelName, fixture);
-        self.setBelongsToRESTAdapter(modelType, modelName, model);
+        store.findEmbeddedBelongsToAssociationsForRESTAdapter(modelType, fixture);
+        if (fixture.type) {
+          // assuming its polymorphic if there is a type attribute
+          // is this too bold an assumption?
+          modelName = fixture.type
+        }
+        model = store.push(modelName, fixture);
+        store.setAssociationsForRESTAdapter(modelType, modelName, model);
       });
       return model;
     }
@@ -51,18 +57,32 @@ DS.Store.reopen({
   },
 
   /**
-   Set the belongsTo association for FixtureAdapter,
-   with models that have a hasMany association.
+   Set the hasMany and belongsTo associations for FixtureAdapter.
 
-   For example if a user hasMany projects, then set the user.id
-   on each project that the user hasMany of, so that the project
-   now has the belongsTo user association setup.
+   For example, assuming a user hasMany projects, if you make a project,
+   then a user with that project in the users list of project, then this method
+   will go back and set the user.id on each project that the user hasMany of,
+   so that the project now has the belongsTo user association setup.
+   As in this scenario:
+
+   ```js
+   var projectJson = store.makeFixture('project');
+   var userJson = store.makeFixture('user', {projects: [projectJson.id]});
+   ```
+
+   Or if you make a project with a user, then set this project in
+   the users list of 'projects' it hasMany of. As in this scenario:
 
-   @param {String} modelType model type like App.User
+   ```js
+   var userJson = store.makeFixture('user');
+   var projectJson = store.makeFixture('project', {user: userJson.id});
+   ```
+
+   @param {DS.Model} modelType model type like User
    @param {String} modelName model name like 'user'
-   @param {Object} parentFixture parent to assign as belongTo
+   @param {Object} fixture to check for needed association assignments
    */
-  setBelongsToFixturesAdapter: function(modelType, modelName, fixture) {
+  setAssociationsForFixtureAdapter: function(modelType, modelName, fixture) {
     var self = this;
     var adapter = this.adapterFor('application');
     Ember.get(modelType, 'relationshipsByName').forEach(function (name, relationship) {
@@ -79,7 +99,11 @@ DS.Store.reopen({
       if (relationship.kind == 'belongsTo') {
         var belongsToRecord = fixture[relationship.key];
         if (belongsToRecord) {
-          var hasManyName = self.findHasManyRelationshipName2(relationship.type, relationship.parentType);
+          if (typeof belongsToRecord == 'object') {
+            FactoryGuy.pushFixture(relationship.type, belongsToRecord);
+            fixture[relationship.key] = belongsToRecord.id;
+          }
+          var hasManyName = self.findHasManyRelationshipName(relationship.type, relationship.parentType);
           var belongsToFixtures = adapter.fixturesForType(relationship.type);
           var belongsTofixture = adapter.findFixtureById(belongsToFixtures, fixture[relationship.key]);
           if (!belongsTofixture[hasManyName]) {
@@ -92,21 +116,56 @@ DS.Store.reopen({
   },
 
   /**
-   For the REST type models:
+   Before pushing the fixture to the store, do some preprocessing.
 
-   Set the belongsTo association with a hasMany association
+   If its a belongs to association, and the fixture has an object there,
+    then push that model to the store and set the id of that new model
+    as the attribute value in the fixture
+
+   If it's a hasMany association, and its polymorphic, then convert the
+    attribute value to a polymorphic style
+
+   @param modelType
+   @param fixture
+   */
+  findEmbeddedBelongsToAssociationsForRESTAdapter: function (modelType, fixture) {
+    var store = this;
+    Ember.get(modelType, 'relationshipsByName').forEach(function (name, relationship) {
+      if (relationship.kind == 'belongsTo') {
+        var belongsToRecord = fixture[relationship.key];
+        if (typeof belongsToRecord == 'object') {
+          belongsToRecord = store.push(relationship.type, belongsToRecord);
+          fixture[relationship.key] = belongsToRecord;
+        }
+      }
+    })
+  },
 
-   Set this model in the parent hasMany array this model belongsTo
+  /**
+   For the REST type models:
 
    For example if a user hasMany projects, then set the user
    on each project that the user hasMany of, so that the project
-   now has the belongsTo user association setup
+   now has the belongsTo user association setup. As in this scenario:
+
+   ```js
+   var project = store.makeFixture('project');
+   var user = store.makeFixture('user', {projects: [project]});
+   ```
+
+   Or if you make a user, then a project with that user, then set the project
+   in the users list of 'projects' it hasMany of. As in this scenario:
+
+   ```js
+   var user = store.makeFixture('user');
+   var project = store.makeFixture('project', {user: user});
+   ```
 
    @param {DS.Model} modelType model type like 'User'
    @param {String} modelName model name like 'user'
-   @param {DS.Model} model
+   @param {DS.Model} model model to check for needed association assignments
    */
-  setBelongsToRESTAdapter: function (modelType, modelName, model) {
+  setAssociationsForRESTAdapter: function (modelType, modelName, model) {
     var self = this;
     Ember.get(modelType, 'relationshipsByName').forEach(function (name, relationship) {
       if (relationship.kind == 'hasMany') {
@@ -119,31 +178,22 @@ DS.Store.reopen({
       if (relationship.kind == 'belongsTo') {
         var belongsToRecord = model.get(name);
         if (belongsToRecord) {
-          var hasManyName = self.findHasManyRelationshipName(belongsToRecord, model)
+          var hasManyName = self.findHasManyRelationshipName(
+            belongsToRecord.constructor,
+            model.constructor
+          )
           belongsToRecord.get(hasManyName).addObject(model);
         }
       }
     })
   },
 
-  findHasManyRelationshipName2: function (belongToModel, childModel) {
-    var relationshipName;
-    Ember.get(belongToModel, 'relationshipsByName').forEach(
-      function (name, relationship) {
-        if (relationship.kind == 'hasMany' &&
-          relationship.type == childModel) {
-          relationshipName = relationship.key;
-        }
-      }
-    )
-    return relationshipName;
-  },
-  findHasManyRelationshipName: function (belongToModel, childModel) {
+  findHasManyRelationshipName: function (belongToModelType, childModelType) {
     var relationshipName;
-    Ember.get(belongToModel.constructor, 'relationshipsByName').forEach(
+    Ember.get(belongToModelType, 'relationshipsByName').forEach(
       function (name, relationship) {
         if (relationship.kind == 'hasMany' &&
-          relationship.type == childModel.constructor) {
+          relationship.type == childModelType) {
           relationshipName = relationship.key;
         }
       }
@@ -219,7 +269,10 @@ DS.FixtureAdapter.reopen({
         relationShips.belongsTo.forEach(function (relationship) {
           var belongsToRecord = record.get(relationship);
           if (belongsToRecord) {
-            var hasManyName = store.findHasManyRelationshipName(belongsToRecord, record);
+            var hasManyName = store.findHasManyRelationshipName(
+              belongsToRecord.constructor,
+              record.constructor
+            );
             belongsToRecord.get(hasManyName).addObject(record);
           }
         })

data/tests/active_model_adapter_factory_test.js

@@ -13,7 +13,7 @@ module('FactoryGuy with ActiveModelAdapter', {
 
 test("#resetModels clears the store of models, and resets the model definition", function() {
   var project = store.makeFixture('project');
-  var user = store.makeFixture('user', {projects: [project.id]});
+  var user = store.makeFixture('user', {projects: [project]});
 
   for (model in FactoryGuy.modelDefinitions) {
     var definition = FactoryGuy.modelDefinitions[model];
@@ -62,19 +62,29 @@ asyncTest("creates record in the store", function() {
 test("supports hasMany associations", function() {
   var p1 = store.makeFixture('project');
   var p2 = store.makeFixture('project');
-  var user = store.makeFixture('user', {projects: [p1.id, p2.id]})
+  var user = store.makeFixture('user', {projects: [p1, p2]})
 
   equal(user.get('projects.length'), 2);
 });
 
+test("supports hasMany polymorphic associations", function() {
+  var sh = store.makeFixture('big_hat');
+  var bh = store.makeFixture('small_hat');
+  var user = store.makeFixture('user', {hats: [sh, bh]})
+  equal(user.get('hats.length'), 2);
+  ok(user.get('hats.firstObject') instanceof BigHat)
+  ok(user.get('hats.lastObject') instanceof SmallHat)
+});
+
 
 test("when hasMany associations assigned, belongTo parent is assigned", function() {
   var p1 = store.makeFixture('project');
-  var user = store.makeFixture('user', {projects: [p1.id]})
+  var user = store.makeFixture('user', {projects: [p1]})
 
   deepEqual(p1.get('user').toJSON(), user.toJSON());
 });
 
+
 test("when belongTo parent is assigned, parent adds to hasMany records", function() {
   var user = store.makeFixture('user');
   var project = store.makeFixture('project', {user: user});
@@ -83,6 +93,19 @@ test("when belongTo parent is assigned, parent adds to hasMany records", functio
 });
 
 
+test("belongsTo associations defined as attributes in fixture", function() {
+  var project = store.makeFixture('project_with_user');
+  equal(project.get('user') instanceof User, true)
+  deepEqual(project.get('user').toJSON(),{name: 'User1'})
+
+  var project = store.makeFixture('project_with_dude');
+  deepEqual(project.get('user').toJSON(),{name: 'Dude'})
+
+  var project = store.makeFixture('project_with_admin');
+  deepEqual(project.get('user').toJSON(),{name: 'Admin'})
+})
+
+
 module('DS.Store#makeList with ActiveModelAdapter', {
   setup: function() {
     testHelper = TestHelper.setup(DS.ActiveModelAdapter);

data/tests/factory_guy_test.js

@@ -65,10 +65,10 @@ test("Referring to other attributes in attribute definition", function() {
       type: 'normal'
     },
     funny_person: {
-      type: function(fixture) { return 'funny ' + fixture.name }
+      type: function(f) { return 'funny ' + f.name }
     },
     missing_person: {
-      type: function(fixture) { return 'level ' + fixture.brain_size }
+      type: function(f) { return 'level ' + f.brain_size }
     }
   });
 
@@ -80,6 +80,18 @@ test("Referring to other attributes in attribute definition", function() {
 });
 
 
+test("Using associations in attribute definition", function() {
+  var json = FactoryGuy.build('project_with_user');
+  deepEqual(json, {id: 1, title: 'Project', user: {id: 1, name: 'User1'}}, 'creates default user for "user" belongsTo attribute');
+
+  var json = FactoryGuy.build('project_with_dude');
+  deepEqual(json, {id: 2, title: 'Project', user: {id: 2, name: 'Dude'}}, 'creates user with optional attributes for "user" belongsTo attribute');
+
+  var json = FactoryGuy.build('project_with_admin');
+  deepEqual(json, {id: 3, title: 'Project', user: {id: 3, name: 'Admin'}}, 'creates named user for "user" belongsTo attribute');
+});
+
+
 test("#build creates default json for model", function() {
   var json = FactoryGuy.build('user');
   deepEqual(json, {id: 1, name: 'User1'});
@@ -118,4 +130,18 @@ test("#buildList creates list of fixtures", function() {
   var userList = FactoryGuy.buildList('user', 2);
   deepEqual(userList[0], {id: 1, name: 'User1'});
   deepEqual(userList[1], {id: 2, name: 'User1'});
+});
+
+
+test("#lookupDefinitionForFixtureName", function() {
+  equal(!!FactoryGuy.lookupDefinitionForFixtureName('person'), true, 'finds definition if its the same as model name');
+  equal(!!FactoryGuy.lookupDefinitionForFixtureName('funny_person'), true, 'finds definition if its a named fixture');
+  equal(!!FactoryGuy.lookupDefinitionForFixtureName('fake'), false, "return nothing if can't find definition");
+});
+
+
+test("#lookupModelForFixtureName", function() {
+  equal(FactoryGuy.lookupModelForFixtureName('person'), 'person', "finds model if its the same as model name");
+  equal(FactoryGuy.lookupModelForFixtureName('funny_person'), 'person', "finds model if it's definition has this named fixture");
+  equal(FactoryGuy.lookupModelForFixtureName('fake'), undefined, "return nothing if can't find definition");
 });

data/tests/fixture_adapter_factory_test.js

@@ -106,6 +106,29 @@ asyncTest("#makeFixture adds record to hasMany association array for which it be
   })
 })
 
+asyncTest("#makeFixture handles default belongsTo associations in fixture", function() {
+  var projectWithUser = store.makeFixture('project_with_user');
+  equal(User.FIXTURES.length, 1);
+
+  store.find('user', 1).then( function(user) {
+    user.get('projects').then( function(projects) {
+      equal(projects.get('length'), 1, "adds hasMany records");
+      equal(projects.get('firstObject.user.id'), 1, "sets belongsTo record");
+      start();
+    })
+  })
+  // TODO.. have to make belongsTo async for fixture adapter
+  // to get this to work
+//  store.find('project', projectWithUser.id).then( function(project) {
+//    console.log('a',project+'', project.id)
+//    console.log('b',project.get('user')+'', project.get('user').toJSON())
+//    project.get('user').then( function(user) {
+//      console.log('c',user.toJSON())
+//    })
+//    start();
+//  })
+})
+
 
 asyncTest("#createRecord adds belongsTo association to records it hasMany of", function() {
   var user = store.makeFixture('user');

data/tests/rest_adapter_factory_test.js

@@ -13,7 +13,7 @@ module('FactoryGuy with DS.RESTAdapter', {
 
 test("#resetModels clears the store of models, and resets the model definition", function() {
   var project = store.makeFixture('project');
-  var user = store.makeFixture('user', {projects: [project.id]});
+  var user = store.makeFixture('user', {projects: [project]});
 
   for (model in FactoryGuy.modelDefinitions) {
     var definition = FactoryGuy.modelDefinitions[model];
@@ -61,19 +61,30 @@ asyncTest("creates records in the store", function() {
 test("supports hasMany associations", function() {
   var p1 = store.makeFixture('project');
   var p2 = store.makeFixture('project');
-  var user = store.makeFixture('user', {projects: [p1.id, p2.id]})
+  var user = store.makeFixture('user', {projects: [p1, p2]})
 
   equal(user.get('projects.length'), 2);
 });
 
 
+test("supports hasMany polymorphic associations", function() {
+  var sh = store.makeFixture('big_hat');
+  var bh = store.makeFixture('small_hat');
+  var user = store.makeFixture('user', {hats: [sh, bh]})
+  equal(user.get('hats.length'), 2);
+  ok(user.get('hats.firstObject') instanceof BigHat)
+  ok(user.get('hats.lastObject') instanceof SmallHat)
+});
+
+
 test("when hasMany associations assigned, belongTo parent is assigned", function() {
   var p1 = store.makeFixture('project');
-  var user = store.makeFixture('user', {projects: [p1.id]})
+  var user = store.makeFixture('user', {projects: [p1]})
 
   deepEqual(p1.get('user').toJSON(), user.toJSON());
 });
 
+
 test("when belongTo parent is assigned, parent adds to hasMany records", function() {
   var user = store.makeFixture('user');
   var project = store.makeFixture('project', {user: user});
@@ -82,7 +93,19 @@ test("when belongTo parent is assigned, parent adds to hasMany records", functio
 });
 
 
-module('DS.Store#makeList with ActiveModelAdapter', {
+test("belongsTo associations defined as attributes in fixture", function() {
+  var project = store.makeFixture('project_with_user');
+  equal(project.get('user') instanceof User, true)
+  deepEqual(project.get('user').toJSON(),{name: 'User1'})
+
+  var project = store.makeFixture('project_with_dude');
+  deepEqual(project.get('user').toJSON(),{name: 'Dude'})
+
+  var project = store.makeFixture('project_with_admin');
+  deepEqual(project.get('user').toJSON(),{name: 'Admin'})
+})
+
+module('DS.Store#makeList with DS.RESTAdapter', {
   setup: function() {
     testHelper = TestHelper.setup(DS.RESTAdapter);
     store = testHelper.getStore();

data/tests/store_test.js

@@ -1,6 +1,6 @@
 var container;
 
-module('DS.Store#usingFixtureAdapter', {
+module('DS.Store', {
   setup: function() {
     container = new Ember.Container();
   },

data/tests/support/factories/hat_factory.js

@@ -0,0 +1,9 @@
+FactoryGuy.define('hat', {
+  default: {},
+  small_hat: {
+    type: 'small_hat'
+  },
+  big_hat: {
+    type: 'big_hat'
+  }
+})