ape-mock v0.5.5

Ape

The Ape API is how I thought a data-mocker API should look like. I needed it to create similar chunks of raw data for projects and tests, and thought it could be a good idea to share it with the rest of the world. I believe that the API I proposed here makes it simple and easy to create complex template-based JSON objects.

Why Ape?

Because apes like to mimic (or "mock") real human behavior... ;) Also, API sounds like Ape-PI.

Usage

Use the Ape function to generate a new mock object. Ape receives a template object that is consisted of string keys and primitive or Ape operators as values:

import Ape, { name, age } from 'ape-mock';

const template = Ape({
  firstName: name().male(),
  lastName: name().lastName(),
  age: age().adult(),
});

// call the generate method to create a new object out of the template above
template.generate();

Ape

This is the template builder. It can receive an object or an array and returns a template object.

name

Generate random names. The name value can be mutated with the following methods:

If not specified, the gender will be random

name().female().middleName().abbrMiddleName().lastNameFirst()
// will generate a female name such as Cooper, Whitney E.

age

Generate a random age. Mutation methods:

If not specified, a random age between 0 and 120 will be generated

age().teenager()
// will generate an age between 14 and 20

text

Manipulate a supplied string.

text('We are the Borg. Your biological and technological distinctiveness will be added to our own. Resistance is futile.').maxLength(4)

loremIpsum

Generate a string extract from a lorem ipsum paragraph. Mutation methods:

loremIpsum().maxLength(5)
// result: Lorem ipsum dolor sit amet,

image

Generate a placeholder image (a link to a real image). Mutation methods:

If not specified, the default width and height are 420x320

image().width(100).height(50);

fromValues

Takes an array of values. The output will be a random value from the array.

fromValues(['Manager', 'Developer', 'IT', 'QA'])

color

Generate a color. Mutation methods:

color().setAlpha(0.5)
// rgb(r, g, b, a)

date

Generates a date. Mutation methods:

date().random().startYearsAgo(30)
// a date between 30 years ago and now

arrayOf

Generate an array of a specific value. The value can also be an Ape object (see example). Mutation methods:

Ape({
  blogPosts: arrayOf({
    title: loremIpsum().minLength(5).randomizeLength(10).randomizeOrder(),
    thumbnail: image(),
    publishDate: date().startYearsAgo(5).random()
  })
}.random(10, 3))

// an array of 3-10 blogPost items 

email

Generate an email address:

If no user was provided, a random one will be selected setEmail and setProvider do not validate the data they receive

email: email().gmail().male().useDot()
// will generate a random email like this: clarence.stanley@gmail.com