ember-data-factory-guy 0.2.1 → 0.3.0

data/tests/support/factories/project_factory.js

@@ -1,5 +1,17 @@
 FactoryGuy.define('project', {
   default: {
     title: 'Project'
+  },
+  project_with_user: {
+    // user model with default attributes
+    user: {}
+  },
+  project_with_dude: {
+    // user model with custom attributes
+    user: {name: 'Dude'}
+  },
+  project_with_admin: {
+    // for named association, use this FactoryGuy.association helper method
+    user: FactoryGuy.association('admin')
   }
 });

data/tests/support/models/hat.js

@@ -0,0 +1,8 @@
+Hat = DS.Model.extend({
+  type: DS.attr('string'),
+  user: DS.belongsTo('user')
+})
+
+BigHat = Hat.extend()
+SmallHat = Hat.extend()
+

data/tests/support/models/user.js

@@ -1,4 +1,5 @@
 User = DS.Model.extend({
   name:     DS.attr('string'),
-  projects: DS.hasMany('project')
+  projects: DS.hasMany('project'),
+  hats: DS.hasMany('hat', {polymorphic: true})
 })

data/tests/support/test_helper.js

@@ -9,6 +9,9 @@ TestHelper = Ember.Object.createWithMixins(FactoryGuyTestMixin,{
     var container = new Ember.Container();
     this.set('container', container);
 
+    container.register("model:hat", Hat);
+    container.register("model:small_hat", SmallHat);
+    container.register("model:big_hat", BigHat);
     container.register("model:user", User);
     container.register("model:project", Project);
     container.register("store:main", DS.Store.extend({adapter: adapter}));

data/tests/test_setup.js

@@ -1,6 +1,27 @@
+FactoryGuy.define('hat', {
+  default: {},
+  small_hat: {
+    type: 'small_hat'
+  },
+  big_hat: {
+    type: 'big_hat'
+  }
+})
 FactoryGuy.define('project', {
   default: {
     title: 'Project'
+  },
+  project_with_user: {
+    // user model with default attributes
+    user: {}
+  },
+  project_with_dude: {
+    // user model with custom attributes
+    user: {name: 'Dude'}
+  },
+  project_with_admin: {
+    // for named association, use this FactoryGuy.association helper method
+    user: FactoryGuy.association('admin')
   }
 });
 FactoryGuy.define('user', {
@@ -13,6 +34,15 @@ FactoryGuy.define('user', {
     name: 'Admin'
   }
 });
+Hat = DS.Model.extend({
+  type: DS.attr('string'),
+  user: DS.belongsTo('user')
+})
+
+BigHat = Hat.extend()
+SmallHat = Hat.extend()
+
+
 Project = DS.Model.extend({
   title: DS.attr('string'),
   user: DS.belongsTo('user')
@@ -20,7 +50,8 @@ Project = DS.Model.extend({
 
 User = DS.Model.extend({
   name:     DS.attr('string'),
-  projects: DS.hasMany('project')
+  projects: DS.hasMany('project'),
+  hats: DS.hasMany('hat', {polymorphic: true})
 })
 /**
  * Sinon.JS 1.6.0, 2013/02/18

data/vendor/assets/javascripts/ember_data_factory_guy.js

@@ -66,10 +66,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
@@ -175,8 +180,8 @@ FactoryGuy = {
 
    FactoryGuy.build('dude') or FactoryGuy.build('person')
 
-   @param model the model to define
-   @param config your model definition object
+   @param {String} model the model to define
+   @param {Object} config your model definition
    */
   define: function (model, config) {
     if (this.modelDefinitions[model]) {
@@ -215,29 +220,50 @@ FactoryGuy = {
   },
 
   /**
-    Given a name like 'person' or 'dude' determine what model this name
+   Used in model definitions to define a belongsTo association attribute.
+   For example:
+
+    ```
+     FactoryGuy.define('project', {
+       default: {
+         title: 'Project'
+       },
+       project_with_admin: {
+         // for named association, use this FactoryGuy.association helper method
+         user: FactoryGuy.association('admin')
+       }
+
+    ```
+
+   @param   {String} fixture name
+   @returns {Function} wrapper function that will build the association json
+   */
+  association: function (fixtureName, opts) {
+    return function () {
+      return FactoryGuy.build(fixtureName, opts);
+    }
+  },
+
+  /**
+    Given a fixture name like 'person' or 'dude' determine what model this name
     refers to. In this case it's 'person' for each one.
 
    @param {String} name a fixture name could be model name like 'person'
           or a named person in model definition like 'dude'
-   @returns {String} model name associated with fixture name
+   @returns {String} model name associated with fixture name or undefined if not found
    */
-  lookupModelForName: function (name) {
-    for (model in this.modelDefinitions) {
-      var definition = this.modelDefinitions[model];
-      if (definition.matchesName(name)) {
-        return definition.model;
-      }
-    }
+  lookupModelForFixtureName: function (name) {
+    var definition = this.lookupDefinitionForFixtureName(name);
+    if (definition) { return definition.model; }
   },
 
   /**
 
    @param {String} name a fixture name could be model name like 'person'
           or a named person in model definition like 'dude'
-   @returns {ModelDefinition} definition associated with model
+   @returns {ModelDefinition} ModelDefinition associated with model or undefined if not found
    */
-  lookupDefinitionForName: function (name) {
+  lookupDefinitionForFixtureName: function (name) {
     for (model in this.modelDefinitions) {
       var definition = this.modelDefinitions[model];
       if (definition.matchesName(name)) {
@@ -253,12 +279,12 @@ FactoryGuy = {
    FactoryGuy.build('user') for User model
    FactoryGuy.build('bob') for User model with bob attributes
 
-   @param {String} name fixture name
-   @param {Object} opts options that will override default fixture values
+   @param {String} name Fixture name
+   @param {Object} opts Options that will override default fixture values
    @returns {Object} json fixture
    */
   build: function (name, opts) {
-    var definition = this.lookupDefinitionForName(name);
+    var definition = this.lookupDefinitionForFixtureName(name);
     if (!definition) {
       throw new Error("Can't find that factory named [" + name + "]");
     }
@@ -277,7 +303,7 @@ FactoryGuy = {
    @returns {Array} list of fixtures
    */
   buildList: function (name, number, opts) {
-    var definition = this.lookupDefinitionForName(name);
+    var definition = this.lookupDefinitionForFixtureName(name);
     if (!definition) {
       throw new Error("Can't find that factory named [" + name + "]");
     }
@@ -291,7 +317,6 @@ FactoryGuy = {
    Reset the id sequence for the models back to zero.
   */
   resetModels: function (store) {
-    var typeMaps = store.typeMaps;
     for (model in this.modelDefinitions) {
       var definition = this.modelDefinitions[model];
       definition.reset();
@@ -303,11 +328,6 @@ FactoryGuy = {
         store.unloadAll(modelType);
       } catch (e) {
       }
-//    } else {
-//      for (model in typeMaps) {
-//        store.unloadAll(typeMaps[model].type);
-//      }
-//    }
     }
   },
 
@@ -333,7 +353,6 @@ FactoryGuy = {
   clear: function (opts) {
     if (!opts) {
       this.modelDefinitions = {};
-      return;
     }
   }
 }
@@ -355,19 +374,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;
     }
@@ -390,18 +415,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:
 
-   @param {String} modelType model type like App.User
+   ```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:
+
+   ```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) {
@@ -418,7 +457,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]) {
@@ -431,21 +474,56 @@ DS.Store.reopen({
   },
 
   /**
-   For the REST type models:
+   Before pushing the fixture to the store, do some preprocessing.
+
+   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
 
-   Set the belongsTo association with a hasMany association
+   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') {
@@ -458,31 +536,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;
         }
       }
@@ -558,7 +627,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);
           }
         })
@@ -639,7 +711,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),
@@ -655,7 +727,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;