README

Fabrication

Construct real Objects with fake data

Fabrication allows you to build fabricators that produce real objects from your codebase using fake data. It provides several aids to ease the process of populating Objects.

Quick usage

var userFabricator = fabrication.fabricator(function() {
  return new User(
    this.sequence('User').next,
    this.generate.name(),
    this.generate.email()
  );
});

var fakeUser = userFabricator();
// fakeUser => { id: 1, name: 'Arthur Dent', email: 'guide@galaxy.net' }

API

The fabrication module and it's API has three parts:

fabricate
generate
sequence

fabricator(name, fn)

fabrication.fabricate(name, config, number)

fabricator.generate

fabricator.sequence

Generate

Fabrication facilitates in generating random data to populate Objects easilly. These generators are available through the generate module.

Fabrication uses grand to provide most of the generators.

var generate = require('fabrication').generate;

// fabrication generators
generate.version(sections)       // A random, semver compatible version consisting of 1 or more sections (optional)
generate.ObjectId()              // A time based ObjectId

// grand generators
generate.number(exclusiveMax)    // A random, positive number less than the exclusiveMax (optional)
generate.integer(exclusiveMax)   // A random, positive integer less than the exclusiveMax (optional)
generate.pick(array)             // A random item from the given array
generate.letter()                // A random letter [A-Za-z]
generate.wordChar()              // A random word character [A-Za-z0-9_]
generate.word(length)            // A random word from the system dictionary of the given length (optional)
generate.sentence(maxWords)      // A random sentence with the given number of words (optional)
generate.gender()                // Either "male" or "female"
generate.givenName(gender)       // A random given name for the given gender (optional)
generate.familyName()            // A random family name
generate.name(gender)            // A random full name of the given gender (optional)
generate.emailAddress()          // A random email address
generate.language(base)          // A random language and region for a given language (optional)
generate.timezone(continent)     // A random timezone on a continent (optional)
generate.uuid()                  // A random uuid (v4) using node-uuid and accepting the v4 parameters (optional)

All generators are available as separate functions but the generator module is a function itself that can be used to call generators:

var generate = require('fabrication').generate;

var name = generate('name');
// instead of generate.name()

var timezone = generate('timezone', 'Europe');
// instead of generate.timezone('Europe')

Sequnce API

License

The MIT License (MIT)

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.

Usage no npm install needed!