chai-js-factories

chai-js-factories adds support of js-factories to Chai. In essence, it's a wrapper around the js-factories library and makes it available within the Chai namespace.

Installation

chai-js-factories is designed to work in most JavaScript environments, including Node and the browser.

Node

Run npm install {--save-dev} chai-js-factories; then, to use:

1var chai = require('chai');
2var chaiJsFactories = require('chai-js-factories');
3chai.use(chaiJsFactories);

AMD

Include chai and js-factories per their respective readmes directions, then include chai-js-factories as a normal AMD module.

Note that unlike the other methods, you will need to explicitly initialize chai-js-factories with the chai-js-factories library:

1require(['chai', 'js-factories', 'chai-js-factories'], function(chai, Factory, chaiJsFactories) {
2  chai.use(function(chai, utils) {
3    chaiJsFactories(Factory, chai, utils);
4  });
5});

<script> tag

Include chai-js-factories.js after including chai andjs-factories:

1<script src="chai.js" encoding="utf-8"></script>
2<script src="js-factories.js" encoding="utf-8"></script>
3<script src="chai-js-factories.js" encoding="utf-8"></script>

Karma

If you're using Karma, check out the accompanying karma-chai-js-factories plugin.

Usage

Access to the js-factory library located on the chai.factory object:

1chai.factory.define('testFactory', function (args) {
2  return new Example(_.extend({foo: 'bar'}, args));
3});
4
5console.log(chai.factory.create('testFactory'));
6console.log(chai.factory.create('testFactory', {wom: 'bat'}));
7console.log(chai.factory.create('testFactory', {foo: 'wombat'}));

This works as expected, overriding the default arguments when they are provided at creation time. For more documentation about factories, take a look at the js-factories documentation.