npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

datamother

v2.2.5

Published

DataMother.js - A data management and injection system for easier unit testing

Downloads

106

Readme

DataMother

DataMother is a test data construction library to make creating and using test data fast, easy and predictable. By centralizing data in factories with declared dependencies, your tests will always use the correct data format which will make tests more reliable. When real-world data contracts change, simply change your data files and then use your tests to identify where things went wrong!

DataMother makes writing tests fast and making correct tests easier.

API

This is the basic API, examples are listed below.

  • dataMother.register -- name:string, factory:function => undefined

    • Register registers a mother object with DataMother for data creation later. Register requires a key and an object and returns undefined.
  • dataMother.buildData -- name:string, options:[object] => *

    • Build returns a new instance of test data as well as nested instances of depency objects.
  • dataMother.buildDataArray -- name:string, length:variant<undefined, leftBoundedInt<1>>, options:[object] => array<*>

    • BuildDataArray returns a new array of data containing a number of data elements equal to the length passed in. When no length is provided, the length will be 1.

Examples

  • A sample motherfile in Node might look like the following:
'use strict';

function nestedTestData (simpleNestedTestDataArray, simpleTestData) {
    return {
        ownProperty: 'something',
        dependencyData: simpleNestedTestDataArray,
        simpleTestData: simpleTestData
    };
}

nestedTestData['@dependencies'] = ['simpleNestedTestData', 'simpleTestData'];

module.exports = nestedTestData;
  • Likewise, in the client a motherfile might look like this:
(function () {
    'use strict';

    function nestedTestData (simpleNestedTestDataArray, simpleTestData) {
        return {
            ownProperty: 'something',
            dependencyData: simpleNestedTestDataArray,
            simpleTestData: simpleTestData
        };
    }

    nestedTestData['@dependencies'] = ['simpleNestedTestData', 'simpleTestData'];

    dataMother.register('nestedTestData', nestedTestData);
})()
  • Capturing data from DataMother is as easy as the following:
const simpleData = dataMother.buildData('simpleTestData');
const simpleData = dataMother.buildDataArray('simpleTestData', 5);
  • Properties can be data factories so data can be dynamically generated per test
'use strict';

function testDataWithPropertyFactory () {
    return {
        property1: 'foo',
        property2: function (index) {
            // index always starts at 0
            return 'bar' + index;
        }
    };
}

module.exports = testDataWithPropertyFactory;
  • Data can be constructed with data properties via the options object
const options = {
    optionsData: {
        testDataWithPropertyFactory: {
            value: 'testValue'
        }
    }
}

// Constructing a single data value
motherContainer.buildData('testDataWithPropertyFactory', options);

// Constructing an array of data
motherContainer.buildDataArray('testDataWithPropertyFactory', 3, options);