# Unionized

Unionized is a factory library for setting up JavaScript objects as test data. Compare to the [factory_girl](https://github.com/thoughtbot/factory_girl) Ruby gem by [thoughtbot](https://thoughtbot.com/open-source).

[![NPM
version](https://img.shields.io/npm/v/unionized.svg)](https://www.npmjs.com/package/unionized)
[![NPM
license](https://img.shields.io/npm/l/express.svg)](https://github.com/goodeggs/unionized/blob/master/LICENSE)
[![Dependency status](https://img.shields.io/david/goodeggs/unionized.svg)](https://david-dm.org/goodeggs/unionized)
[![Build Status](https://img.shields.io/travis/goodeggs/unionized.svg)](https://travis-ci.org/goodeggs/unionized)

# Links

- [Installation instructions](https://github.com/goodeggs/unionized/blob/master/docs/installation.md)
- [API Documentation](https://github.com/goodeggs/unionized/blob/master/docs/api.md)

# Examples

**Define** a factory:

```javascript
var humanFactory = unionized.factory({
  name: {
    first: unionized.enum(['Azrael', 'Bastiaan', 'Laurentiu', 'Gerolf']),
    last: 'Smithy'
  },
  birthdate: function() { return new Date() }
})
```

Use that factory to **create instances**:

```javascript
var human = humanFactory.create()
/*
 { name: { first: 'Gerolf', last: 'Smithy' }
   birthdate: Sun May 17 2015 16:52:25 GMT-0700 (PDT) }
*/
```

You can **override the defaults** if you like, using **dot notation**:

```javascript
var chen = humanFactory.create({ 'name.first': 'Chen' })
/*
 { name: { first: 'Chen', last: 'Smithy' }
   birthdate: Sun May 17 2015 16:58:19 GMT-0700 (PDT) }
*/
```

You might want factories that are **composed out of other factories**:

```javascript
var organizationFactory = unionized.factory({
  name: 'Board Game Club',
  members: unionized.array(humanFactory, 4)
})
organizationFactory.create()
/*
 { name: 'Board Game Club',
   members: [
     { name: { first: 'Bastiaan', last: 'Smithy' },
       birthdate: Sun May 17 2015 17:09:52 GMT-0700 (PDT) },
     { name: { first: 'Azrael', last: 'Smithy' },
       birthdate: Sun May 17 2015 17:09:52 GMT-0700 (PDT) }
     { name: { first: 'Gerolf', last: 'Smithy' },
       birthdate: Sun May 17 2015 17:09:52 GMT-0700 (PDT) }
     { name: { first: 'Bastiaan', last: 'Smithy' },
       birthdate: Sun May 17 2015 17:09:52 GMT-0700 (PDT) }
   ] }
*/
```

You might want to **pass arguments into your factory definitions**:

```javascript
var humanFactoryWithAge = humanFactory.factory (age) => {
  birthDate: moment().subtract(age, 'years').toDate()
};

var legalDriver = humanFactoryWithAge.create({}, 16);
/*
   { name: { first: 'Azrael', last: 'Smithy' }
     birthdate: Sun May 17 2000 15:00:02 GMT-0700 (PDT) }
*/
```

More features you may be interested in:

- [Factory inheritance](https://github.com/goodeggs/unionized/blob/master/docs/api.md#example)
- [Auto-generating factories from schemas (currently supported: JSON-schema and mongoose)](https://github.com/goodeggs/unionized/blob/master/docs/api.md#factorymongoosefactory)
- [Asynchronous factories](https://github.com/goodeggs/unionized/blob/master/docs/api.md#example-2)

# License

[The MIT License (MIT)](https://github.com/goodeggs/unionized/blob/master/LICENSE)