A factory for creating backbone objects for testing
JavaScript Ruby
Switch branches/tags
Nothing to show
Pull request Compare This branch is 17 commits ahead, 3 commits behind SupportBee:master.
Latest commit 11f481f Jul 19, 2012 Eddy Josafat Fixed typo error

README.mkd

Backbone Factory

Introduction

Backbone Factory is a small javascript library for creating Backbone.js objects for testing your code. It has no external dependency.

The API is heavily inspired by the awesome Factory Girl.

This is a fork. You may want to browse the original repo.

Installation

To use it, just download the file and include it in your testing setup.
Usage

Lets say you have two Backbone models, Post and User

var User = Backbone.Model.extend({

  name : null,
  email : null

})

var Post = Backbone.Model.extend({

  defaults: {
    title : 'Default Title'
  }

})

and one Collection, Users

var Users = Backbone.Collection.extend({
  model : User
})

Defining Factories

To define factories for them

var postFactory = BackboneFactory.define('post', Post)
var userFactory = BackboneFactory.define('user', User)
var usersFactory = BackboneFactory.define('users', Users)

Using Factories

To use these factories,

postObject = BackboneFactory.create('post')
userObject = BackboneFactory.create('user')
usersCollection = BackboneFactory.create('users')

This will create objects using the defaults you have in your class definitions.

Defining Sequences

var emailSequence = BackboneFactory.define_sequence('email', function (n) {
  return "person" + n + "@example.com"
})

Using Sequences

var email = BackboneFactory.next('email') // person1@example.com

Defining Factories with defaults

var userFactory = BackboneFactory.define('user', User, function(){
  return {
    name : 'Backbone User',
    email : BackboneFactory.next('person_email')
  }
})

If you don't need to invoke any function (like BackboneFactory.next), you can use a simple literal instead of a function as defaults. To define a default collection, just pass an array of literals to the definition:

var usersFactory = BackboneFactory.define('user', User, [{ name : 'Joe', email : 'joe@example.com' }])

It's possible to define default options too:

var usersFactory = BackboneFactory.define('user', User, [{ name : 'Joe', email : 'joe@example.com' }], { comparator : function (user) {
  return user.get("name")
}})

If you want to omit defaults and specify options, just pass a null or undefined parameter as:

var usersFactory = BackboneFactory.define('user', User, null, { comparator : function (user) {
  return user.get("name")
}})

Overriding defaults when creating objects

var userWithEmail = BackboneFactory.create('user', { email: 'overriden@example.com' }, { collection : users }})

Create lists (arrays) of models

var userList = BackboneFactory.createList("user", 30)  // generates an array of 30 User models.
BackboneFactory.create("users", userList) // creates a collection factory initialized with the list
BackboneFactory.define("users", Users, userList) // factory definition with default initialization with the list

You can omit the size; it will be 10 by default, but you can change this:

var userList = BackboneFactory.createList("user") // userList.length = 10
BackboneFactory.setDefaultListSize(20)
var biggerList = BackboneFactory.createList("user") // userList.length = 20

Contributing

  1. Open a ticket on GitHub, maybe someone else has the problem too
  2. Make a fork of my GitHub repository
  3. Make a spec driven change to the code base (we use jasmine)
  4. Make sure it works and all specs pass
  5. Update the README if needed to reflect your change / addition
  6. With all specs passing push your changes back to your fork
  7. Send me a pull request

License

(The MIT License)

Copyright (c) 2009, 2010, 2011

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.