Factory-castrado NPM

factory-castrado

Factory Castrado is a library for Node.js which provides factories for objects creation. It is designed for use with Backbone-style models which use new Model(attributes) for initialization and model.create(function(err, model){...}) for saving.

It is highly inspired by:

factory_girl - ruby
factory-lady - node.js
factory-boy - node.js

Installation

Node.js:

npm install factory-castrado

Usage

Defining factories

Coffeescript:

Factory	= require 'factory-castrado'
Model	= require('backbone').Model

counter = 1

# Define with (name, model, attributes)
Factory.define 'user', Model, 
	email: (cb) -> cb("user#{counter++}@test.com")
	name: "Test name"
	password: 'abc123'

# With associations, using (name, options):
Factory.define 'post',
	model: Model
	attributes:
		title: "Test title"
		content: "Test content"
	associations:
		user:
			factory: 'user'	# Defaults to association name (user here)
			key: 'user_id'	# Defaults to name + _id

Using factories

Coffeescript:

Factory.build 'user', (user) ->
	# user is an unsaved user model

Factory.build 'user', name:"New", (user) ->
	# user is an unsaved user model with name "New"

Factory.build 'post', (post) ->
	# post is an unsaved post model
	# post.user is a saved associated user model
	# post has new attribute 'user_id' with the user's id

Factory.create 'user', (user) -> 
	# User is SAVED model

Associations

Coffeescript:

Factory.define 'post',
	model: Model
	associations:
		user:
			# Defaults to association name (user here)
			factory: 'user'	
			
			# Defaults to name + _id
			key: 'user_id'	
			
			# Gets foreign key from associated model
			# Default getter, just grabs id
			getter: (assocObj) -> return assocObj.id  
			
			# Sets foreign key on factory's built model
			# Default setter (pseudocode - uses 'key' from above if setter not overridden)
			setter: (obj, val) -> obj.set {{key}}, val
			
			 # Conveniently provides default setters/getters
			type: 'id' # Currently supported: "id", "ids[]"
			# Using type: "ids[]" provides a default setter than inserts id into object's array of ids