ember-data-factory-guy 0.8.7 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3a176593875afbfb16b0b27f882eacb3d40d373
-  data.tar.gz: 9d15621eb85ee8fa3dcd1a26c84324accb08c71a
+  metadata.gz: b0f49b633dc4e0517c3f1ad408bdd1db344c57a3
+  data.tar.gz: e4eded2ac3ad0442f84e6baef55f3f15fe465126
 SHA512:
-  metadata.gz: 2ea89b1a73e315d4b25fa3d502bbbb52a76b0b57fdd616010f48f4406cb1c5458d5f1d6644a7d57fd226653b40fecb2e5cf812a4e9363500ecd0e5753a9f135b
-  data.tar.gz: 0bc86475042ac771c1771a37fbd70f3b89dcd0bdb88a800e9f581cf88bae009e2b69548be892f44d04c3a2a686049561d96a8f23442e609291858eb3e36a8e23
+  metadata.gz: 685ca7f54f663260a32f07803e616a774314917f17dd50fd8f95233b4712deaabb6dca324237ac1cd7a742fd3f4a64b1aa16d9d65ce1ca01d00097afca66bfaa
+  data.tar.gz: 41939f3df2b268972abfaa53f42c2eb7a6fcf73205631af9b9ea06b775d5d2dfd2d34c08da15965f893e12b315646e3016265c54f2f8f2e6e949383842e01b0c

data/Gruntfile.js

@@ -45,8 +45,8 @@ module.exports = function(grunt) {
       },
       test: {
         src: [
-          'tests/support/factories/*.js',
           'tests/support/models/*.js',
+          'tests/support/factories/*.js',
           'tests/support/libs/*.js'],
         dest: "tests/test_setup.js"
       }

data/README.md

@@ -2,24 +2,22 @@
 
 *NOTE*
   
-ember-data is changing the way they are doing relationships in 1.0.0-beta.10 and above 
-so, if you are using ember-data-1.0.0-beta.8 and earlier, then be sure to use version 0.6.4 
-of ember-data-factory-guy.  
+ember-data is changing the way they are doing relationships in 1.0.0-beta.10 and above
+so, if you are using ember-data-1.0.0-beta.8 and earlier, then be sure to use version 0.6.4
+of ember-data-factory-guy.
 
 - Versions:
   - 0.6.4   -> ember-data-1.0.0-beta.8 and under
   - 0.7.1.1 -> ember-data-1.0.0-beta.10
   - 0.8.6   -> ember-data-1.0.0-beta.11
-  - 0.8.7   -> ember-data-1.0.0-beta.12
+  - 0.9.0   -> ember-data-1.0.0-beta.12
 
-**For versions ( 0.7.1 -> 0.8.6 ), support for the fixture adapter is currently broken.**
+**Support for fixture adapter is currently kinda broken.**
 
-*Version 0.8.6 has many bug fixes and improvements that the earlier versions don't have, so
-hopefully you can switch to newer version of ember-data and therefore the best 
-ember-data-factory-guy version, but if not, send me bug report and I will try and go back 
-and fix the older version you are using.*  
+**Version 0.9.0 expects you to no longer use store.makeFixture explicitly in your tests
+but rather use the testHelper.make from FactoryGuyTestHelperMixin instead. If this is not the case,
+just add a FactoryGuy.setStore(store) somewhere in your code before you start making fixtures.**
 
-**Version 0.8.0 introduces amd and commonjs support**
 
 ## Using with Ember Cli
   - https://github.com/igorrKurr/ember-cli-factory-guy-example
@@ -41,7 +39,7 @@ gem 'ember-data-factory-guy', group: test
 or for particular version:
 
 ```ruby
-gem 'ember-data-factory-guy', '0.8.6', group: test
+gem 'ember-data-factory-guy', '0.9.0', group: test
 ```
 
 then:
@@ -76,7 +74,7 @@ or for particular version:
   "dependencies": {
     "foo-dependency": "latest",
     "other-foo-dependency": "latest",
-    "ember-data-factory-guy": "0.8.6"
+    "ember-data-factory-guy": "0.9.0"
   }
 ```
 
@@ -218,28 +216,34 @@ the store is looking up the correct model type name
 
 
 ### Using Factories
+ - FactorGuy.setStore
+   - pass in the store instance to FactoryGuy before making fixtures.
  - FactoryGuy.build
    - Builds json  
- - store.makeFixture
+ - FactoryGuy.make
    - Loads model instance into the store  
  - Can override default attributes by passing in a hash
  - Can add attributes with traits ( see traits section )  
  
 ```javascript
-  
+  // First set the store on FactoryGuy. You don't have to do this step manually if you use
+  // FactoryGuyTestHelperMixin since this is done for you in the setup method.
+  var store = this.get('container').lookup('store:main');
+  FactoryGuy.setStore(store);
+
   // returns json   
   var json = FactoryGuy.build('user'); 
   json // => {id: 1, name: 'Dude', style: 'normal'}
 
   // returns a User instance that is loaded into your application's store   
-  var user = store.makeFixture('user');
-  user.toJSON() // => {id: 2, name: 'Dude', style: 'normal'}
+  var user = FactoryGuy.make('user');
+  user.toJSON({includeId: true}) // => {id: 2, name: 'Dude', style: 'normal'}
 
   var json = FactoryGuy.build('admin'); 
   json // => {id: 3, name: 'Admin', style: 'super'}
 
-  var user = store.makeFixture('admin');
-  user.toJSON() // => {id: 4, name: 'Admin', style: 'super'}
+  var user = FactoryGuy.make('admin');
+  user.toJSON({includeId: true}) // => {id: 4, name: 'Admin', style: 'super'}
   
 ```
 
@@ -281,7 +285,7 @@ You can override the default attributes by passing in a hash
   var json = FactoryGuy.build('user'); 
   json.name // => 'User1'
 
-  var user = store.makeFixture('user');
+  var user = FactoryGuy.make('user');
   user.get('name') // => 'User2'
 
 ```
@@ -299,7 +303,7 @@ You can override the default attributes by passing in a hash
   var json = FactoryGuy.build('special_project'); 
   json.title // => 'Project #1'
 
-  var project = store.makeFixture('special_project');
+  var project = FactoryGuy.make('special_project');
   project.get('title') // => 'Project #2'
 
 ```
@@ -324,7 +328,7 @@ You can override the default attributes by passing in a hash
   json.name // => 'User1'
   json.style // => 'funny User1'
   
-  var user = store.makeFixture('funny_user');
+  var user = FactoryGuy.make('funny_user');
   user.get('name') // => 'User2'
   user.get('style') // => 'funny User2'
 
@@ -353,7 +357,7 @@ You can override the default attributes by passing in a hash
   json.name // => 'Big Guy'
   json.style // => 'Friendly'
 
-  var user = store.makeFixture('user', 'big', 'friendly');
+  var user = FactoryGuy.make('user', 'big', 'friendly');
   user.get('name') // => 'Big Guy'
   user.get('style') // => 'Friendly'
 
@@ -364,7 +368,7 @@ attributes will override any trait attributes or default attributes
     
 ```javascript
 
-  var user = store.makeFixture('user', 'big', 'friendly', {name: 'Dave'});
+  var user = FactoryGuy.make('user', 'big', 'friendly', {name: 'Dave'});
   user.get('name') // => 'Dave'
   user.get('style') // => 'Friendly'
 
@@ -391,7 +395,7 @@ attributes will override any trait attributes or default attributes
       // create user model with default attributes
       user: {}
     },
-    project_with_dude: {
+    project_with_bob: {
       // create user model with custom attributes
       user: {name: 'Bob'}
     },
@@ -404,10 +408,10 @@ attributes will override any trait attributes or default attributes
   var json = FactoryGuy.build('project_with_user'); 
   json.user // => {id:1, name: 'Dude', style: 'normal'}
 
-  var json = FactoryGuy.build('project_with_dude'); 
-  json.user // => {id:1, name: 'Dude', style: 'normal'}
+  var json = FactoryGuy.build('project_with_bob');
+  json.user // => {id:1, name: 'Bob', style: 'normal'}
 
-  var project = store.makeFixture('project_with_admin');
+  var project = FactoryGuy.make('project_with_admin');
   project.get('user.name') // => 'Admin'
   project.get('user.style') // => 'super'
 
@@ -424,8 +428,8 @@ attributes will override any trait attributes or default attributes
     }
   });
   
-  var user = store.makeFixture('project', 'with_user');
-  project.get('user').toJSON() // => {id:1, name: 'Dude', style: 'normal'}
+  var user = FactoryGuy.make('project', 'with_user');
+  project.get('user').toJSON({includeId: true}) // => {id:1, name: 'Dude', style: 'normal'}
   
 ```
 
@@ -433,10 +437,10 @@ attributes will override any trait attributes or default attributes
 ##### Setup belongsTo associations manually
 
 ```javascript
-  var user = store.makeFixture('user');
-  var project = store.makeFixture('project', {user: user});
+  var user = FactoryGuy.make('user');
+  var project = FactoryGuy.make('project', {user: user});
     
-  project.get('user').toJSON() // => {id:1, name: 'Dude', style: 'normal'}
+  project.get('user').toJSON({includeId: true}) // => {id:1, name: 'Dude', style: 'normal'}
 ```
 
 *Note that though you are setting the 'user' belongsTo association on a project,
@@ -456,7 +460,7 @@ the reverse user hasMany 'projects' association is being setup for you on the us
     user_with_projects: { FactoryGuy.hasMany('project', 2) }
   });
   
-  var user = store.makeFixture('user_with_projects');
+  var user = FactoryGuy.make('user_with_projects');
   user.get('projects.length') // => 2
   
 ```
@@ -473,7 +477,7 @@ the reverse user hasMany 'projects' association is being setup for you on the us
     }
   });
   
-  var user = store.makeFixture('user', 'with_projects');
+  var user = FactoryGuy.make('user', 'with_projects');
   user.get('projects.length') // => 2
   
 ```
@@ -481,14 +485,14 @@ the reverse user hasMany 'projects' association is being setup for you on the us
 ##### Setup hasMany associations manually
 
 ```javascript
-  var project1 = store.makeFixture('project');
-  var project2 = store.makeFixture('project');
-  var user = store.makeFixture('user', {projects: [project1,project2]});
+  var project1 = FactoryGuy.make('project');
+  var project2 = FactoryGuy.make('project');
+  var user = FactoryGuy.make('user', {projects: [project1,project2]});
   user.get('projects.length') // => 2
   
   // or  
   var projects = store.makeList('project', 2);
-  var user = store.makeFixture('user', {projects: projects});
+  var user = FactoryGuy.make('user', {projects: projects});
   user.get('projects.length') // => 2
   
 ```
@@ -525,8 +529,8 @@ the reverse 'user' belongsTo association is being setup for you on the project
 ```javascript
   var users = store.makeList('user', 2) 
   users.get('length') // => 2 
-  users[0].toJSON() // => {id: 3, name: 'User3', style: 'normal'}
-  users[1].toJSON() // => {id: 4, name: 'User4', style: 'normal'}
+  users[0].toJSON({includeId: true}) // => {id: 3, name: 'User3', style: 'normal'}
+  users[1].toJSON({includeId: true}) // => {id: 4, name: 'User4', style: 'normal'}
 
 ```
 
@@ -550,21 +554,23 @@ TestHelper = Ember.Object.createWithMixins(FactoryGuyTestMixin);
 
 // Then in your tests you can use it like so:
 
-var testHelper, store;
+var testHelper, store, make;
 
 module('User Model', {
   setup: function() {
     testHelper = TestHelper.setup(App);
     store = testHelper.getStore();
+    // You could at this point, make fixtures with testHelper.make,
+    // but to be even more concise try this shortcut method to your tests
+    make = testHelper.make.bind(testHelper)
+    // or if your running in phantomjs and it does not support bind method try this:
+    // make = function() {return testHelper.make.apply(testHelper,arguments)}
   },
   teardown: function() {
     Em.run(function() { testHelper.teardown(); });
   }
 });
 
-// You could at this point, make fixtures with testHelper.make('user'), but
-// to be even more concise in tests you could add this method to your tests
-var make = function(name, opts) { return testHelper.make(name, opts); }
 
 // assuming your default adapter is ActiveModelAdapter or RESTAdapter
 test("make a user using your applications default adapter", function() {
@@ -685,12 +691,19 @@ match and or returns options.
 
 
 ##### handleUpdate
+  - handleUpdate(model)
+  - handleUpdate(modelType, id)
 
 *success case is the default*
 
 ```javascript
-  var profile = store.makeFixture('profile');
-  testHelper.handleUpdate('profile', profile.id);
+  var profile = FactoryGuy.make('profile');
+
+  // Simplest way is to pass in the model that will be updated ( if you have it available )
+  testHelper.handleUpdate(profile);
+
+  // If the model is not available, pass in the modelType and the id ( if you know it )
+  testHelper.handleUpdate('profile', 1);
 
   profile.set('description', 'good value');
   profile.save() //=> will succeed
@@ -699,9 +712,12 @@ match and or returns options.
 *mocking a failed update*
 
 ```javascript
-  var profile = store.makeFixture('profile');
+  var profile = FactoryGuy.make('profile');
+
   // set the succeed flag to 'false'
   testHelper.handleUpdate('profile', profile.id, false);
+  // or
+  testHelper.handleUpdate(profile, false);
 
   profile.set('description', 'bad value');
   profile.save() //=> will fail
@@ -714,7 +730,7 @@ match and or returns options.
 *success case is the default*
 
 ```javascript
-  var profile = store.makeFixture('profile');
+  var profile = FactoryGuy.make('profile');
   testHelper.handleDelete('profile', profile.id);
 
   profile.destroyRecord() // => will succeed
@@ -723,7 +739,7 @@ match and or returns options.
 *mocking a failed delete*
 
 ```javascript
-  var profile = store.makeFixture('profile');
+  var profile = FactoryGuy.make('profile');
   // set the succeed flag to 'false'
   testHelper.handleDelete('profile', profile.id, false);
 
@@ -746,12 +762,12 @@ ViewTestHelper = Ember.Object.createWithMixins(FactoryGuyTestMixin,{
   }
 }
 
-var viewHelper;
+var viewHelper, user;
 
 module('User View', {
   setup: function() {
     viewHelper = ViewTestHelper.setup(App); // set up helper
-    var user = viewHelper.make('user'); // create a user in the store
+    user = viewHelper.make('user'); // create a user in the store
     visit('/users/'+user.id); // visit the users route
   },
   teardown: function() {
@@ -766,10 +782,9 @@ test("Creates new project", function() {
     click('.add-div div:contains(New Project)')
     fillIn('.add-project input', newProjectName)
 
-    // Remember, you only need to pass in attributes of the model you expect
-    // to create in your application. You do not need to include belongsTo records,
-    // as in this case the 'user' belongsTo association
-    viewHelper.handleCreate('project', {name: newProjectName})
+    // Remember, this is for handling an exact match, if you did not care about
+    // matching attributes, you could just do: viewHelper.handleCreate('project')
+    viewHelper.handleCreate('project', {match:{name: newProjectName, user:user}})
 
     /**
      Let's say that clicking this '.add-project .link', triggers action in the view to
@@ -796,9 +811,9 @@ test("Creates new project", function() {
 ### Using DS.Fixture adapter
 
 - Not recommended
-- store.makeFixture ... creates model in the store and returns json
+- FactoryGuy.make ... creates model in the store and returns json
 
-Technically when you call store.makeFixture with a store using the DS.FixtureAdapter,
+Technically when you call FactoryGuy.make with a store using the DS.FixtureAdapter,
 the fixture is actually added to the models FIXTURE array. It just seems to be added
 to the store because when you call store.find to get that record, the adapter looks
 in that FIXTURE array to find it and then puts it in the store.
@@ -806,26 +821,26 @@ in that FIXTURE array to find it and then puts it in the store.
 ```javascript
 
 
-store.makeFixture('user'); // user.FIXTURES = [{id: 1, name: 'User1', style: 'normal'}]
-store.makeFixture('user', {name: 'bob'}); //  user.FIXTURES = [{id: 2, name: 'bob', style: 'normal'}]
-store.makeFixture('admin'); //  user.FIXTURES = [{id: 3, name: 'Admin', style: 'super'}]
-store.makeFixture('admin', {name: 'Fred'}); //  user.FIXTURES = [{id: 4, name: 'Fred', style: 'super'}]
+FactoryGuy.make('user'); // user.FIXTURES = [{id: 1, name: 'User1', style: 'normal'}]
+FactoryGuy.make('user', {name: 'bob'}); //  user.FIXTURES = [{id: 2, name: 'bob', style: 'normal'}]
+FactoryGuy.make('admin'); //  user.FIXTURES = [{id: 3, name: 'Admin', style: 'super'}]
+FactoryGuy.make('admin', {name: 'Fred'}); //  user.FIXTURES = [{id: 4, name: 'Fred', style: 'super'}]
 
 
 // Use store.find to get the model instance ( Remember this is the Fixture adapter, if
 // you use the ActiveModelAdapter or RESTAdapter the record is returned so you don't
 // have to then go and find it )
-var userJson = store.makeFixture('user');
+var userJson = FactoryGuy.make('user');
 store.find('user', userJson.id).then(function(user) {
-   user.toJSON() ( pretty much equals ) userJson;
+   user.toJSON({includeId: true}) ( pretty much equals ) userJson;
 });
 
 // and to setup associations ...
-var projectJson = store.makeFixture('project');
-var userJson = store.makeFixture('user', {projects: [projectJson.id]});
+var projectJson = FactoryGuy.make('project');
+var userJson = FactoryGuy.make('user', {projects: [projectJson.id]});
 // OR
-var userJson = store.makeFixture('user');
-var projectJson = store.makeFixture('project', {user: userJson.id});
+var userJson = FactoryGuy.make('user');
+var projectJson = FactoryGuy.make('project', {user: userJson.id});
 
 // will give you the same result, but with fixture adapter all associations
 // are treated as async ( by factory_guy_has_many.js fix ), so it's
@@ -833,7 +848,7 @@ var projectJson = store.makeFixture('project', {user: userJson.id});
 // in view specs though, this clunk is dealt with for you. But remember,
 // you DON'T have to use the Fixture adapter.
 store.find('user', 1).then(function(user) {
-  user.toJSON() (pretty much equals) userJson;
+  user.toJSON({includeId: true}) (pretty much equals) userJson;
   user.get('projects').then(function(projects) {
     projects.length == 1;
   });

data/bower.json

@@ -1,6 +1,6 @@
 {
   "name": "ember-data-factory-guy",
-  "version": "0.8.7",
+  "version": "0.9.0",
   "authors": [
     "Daniel Sudol <dansudol@yahoo.com>",
     "Opak Alex <opak.alexandr@gmail.com>"

data/dist/amd/factory-guy.js

@@ -95,9 +95,19 @@ var ModelDefinition = function (model, config) {
         // 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
+        // If it's an object and it's a model association attribute, build the json
         // for the association and replace the attribute with that json
-        fixture[attribute] = FactoryGuy.build(attribute, fixture[attribute]);
+        if (FactoryGuy.getStore()) {
+          if (FactoryGuy.isAttributeRelationship(this.model, attribute)) {
+            fixture[attribute] = FactoryGuy.build(attribute, fixture[attribute]);
+          }
+        } else {
+          // For legacy reasons, if the store is not set in FactoryGuy, keep
+          // this code the way it is ( though it will cause failures when the object is actually
+          // a custom attribute and not a relationship ), while users start setting the store
+          // in FactoryGuy, or using testHelper.make instead of store.makeFixture
+          fixture[attribute] = FactoryGuy.build(attribute, fixture[attribute]);
+        }
       }
     }
     // set the id, unless it was already set in opts
@@ -218,6 +228,44 @@ var FactoryGuy = {
       this.modelDefinitions[model] = new ModelDefinition(model, config);
     }
   },
+  /**
+   Setting the store so FactoryGuy can do some model introspection.
+   */
+   setStore: function(store) {
+    Ember.assert("FactoryGuy#setStore needs a valid store instance.You passed in ["+store+"]",store instanceof DS.Store)
+    this.store = store;
+  },
+  getStore: function() {
+    return this.store;
+  },
+  /**
+   Checks a model's attribute to determine if it's a relationship.
+
+   @param {String} typeName  model type name like 'user' for User model class
+   @param {String} attribute  attribute you want to check
+   @returns {Boolean} true if the attribute is a relationship, false if not
+   */
+  isAttributeRelationship: function(typeName, attribute) {
+    if (!this.store) {
+      console.log("FactoryGuy does not have the application's store. Use FactoryGuy.setStore(store) before making any fixtures")
+      // The legacy value was true.
+      return true;
+    }
+    var model = this.store.modelFor(typeName);
+    return !!model.typeForRelationship(attribute);
+  },
+  /**
+   Make new fixture and save to store. Proxy to store#makeFixture method
+
+   @param {String} name  fixture name
+   @param {String} trait  optional trait names ( one or more )
+   @param {Object} opts  optional fixture options that will override default fixture values
+   @returns {Object|DS.Model} json or record depending on the adapter type
+   */
+  make: function() {
+    Ember.assert("FactoryGuy does not have the application's store. Use FactoryGuy.setStore(store) before making any fixtures", this.store);
+    return this.store.makeFixture.apply(this.store,arguments);
+  },
   /**
    Used in model definitions to declare use of a sequence. For example:
 
@@ -741,6 +789,7 @@ var FactoryGuyTestMixin = Em.Mixin.create({
   // Pass in the app root, which typically is App.
   setup: function (app) {
     this.set('container', app.__container__);
+    FactoryGuy.setStore(this.getStore());
     return this;
   },
   useFixtureAdapter: function (app) {
@@ -768,8 +817,7 @@ var FactoryGuyTestMixin = Em.Mixin.create({
     return this.getStore().find(type, id);
   },
   /**
-   Proxy to store's makeFixture method
-
+   Make new fixture and save to store. Proxy to store#makeFixture method
    */
   make: function () {
     var store = this.getStore();
@@ -778,12 +826,6 @@ var FactoryGuyTestMixin = Em.Mixin.create({
   getStore: function () {
     return this.get('container').lookup('store:main');
   },
-  pushPayload: function (type, hash) {
-    return this.getStore().pushPayload(type, hash);
-  },
-  pushRecord: function (type, hash) {
-    return this.getStore().push(type, hash);
-  },
   /**
    Using mockjax to stub an http request.
 
@@ -860,7 +902,10 @@ var FactoryGuyTestMixin = Em.Mixin.create({
     so you don't need to include them in the returns hash as well.
 
      2) If you don't use match options for exact match, there will be no id returned to the model.
-
+        The reason being, that this method purposely returns an empty hash response with a 'don't match'
+        style handleCreate, because if the responseJson returns a non empty data hash ( with even only
+        the id), this essentially empty hash of attributes will override ( and nullify ) all the attributes
+        that set when you created the record.
      3) If you match on a belongsTo association, you don't have to include that in the
     returns hash.
 
@@ -913,8 +958,25 @@ var FactoryGuyTestMixin = Em.Mixin.create({
    @param {Boolean} succeed  optional flag to indicate if the request
       should succeed ( default is true )
    */
-  handleUpdate: function (type, id, succeed) {
-    succeed = succeed === undefined ? true : succeed;
+  handleUpdate: function () {
+    var args = Array.prototype.slice.call(arguments)
+    Ember.assert("To handleUpdate pass in a model instance or a type and an id", args.length>0)
+    var succeed = true;
+    if (typeof args[args.length-1] == 'boolean') {
+      args.pop()
+      succeed = false;
+    }
+    Ember.assert("To handleUpdate pass in a model instance or a type and an id",args.length>0)
+    var type, id;
+    if (args[0] instanceof DS.Model) {
+      var model = args[0];
+      type = model.constructor.typeKey;
+      id = model.id;
+    } else if (typeof args[0] == "string" && typeof parseInt(args[1]) == "number") {
+      type = args[0];
+      id = args[1];
+    }
+    Ember.assert("To handleUpdate pass in a model instance or a type and an id",type && id)
     this.stubEndpointForHttpRequest(this.buildURL(type, id), {}, {
       type: 'PUT',
       status: succeed ? 200 : 500