fixted

    3.0.2 • Public • Published

    Simple DB Fixtures for Sails.js with Associations Support

    Fixted is a fork of Barrels, by Ruslan Bredikhin, updated to support Sails v1.

    npm (fixted) GitHub package.json version (branch) David

    Installation

    npm i --save-dev fixted

    Usage

    Drop your fixtures in test/fixtures as JSON files (or CommonJS modules) named after your models.

    Once your Sails.js server is running:

    const Fixted = require('fixted');
    const fixted = new Fixted();
    const fixtures = fixted.data;
    
    fixted.populate(function(err) {
        // do things
    });

    Pass to the constructor the path to the folder containing your fixtures (defaults to ./test/fixtures).

    Populate'ing the test database involves three steps:

    • Removing any existing data from the collection corresponding to the fixture
    • Loading the fixture data into the test database
    • Automatically applying associations (can be disabled by passing false as the last parameter to populate)

    Populate also accepts an array of names of collections to populate as the first (optional) argument, for example:

    fixted.populate(['products'], function(err) {
        // Only products will be populated
    });

    Automatic association

    Use the number of position (starting from one) of an entry in the JSON fixture as a reference to associate models (see https://github.com/neonexus/fixted/blob/master/test/fixtures/products.json for example). This feature can be disabled by passing false as the last parameter to populate.

    Required associations

    If you have any associations described as required: true, they will be added automatically, no matter if the last parameter to populate is false or not. However, you have to load your fixtures gradually (by passing an array of collection names as the first parameter) in such an order that collections corresponding to the required associations get populated first.

    Let's say, for example, you are implementing a Passport.js-based authentication, and every Passport has User as a required association. You'd write something like this:

    fixted.populate(['user', 'passport'], function(err) {
        if (err) {
            return done(err); // Higher level callback
        }
    
        // Do your thing...
        done();
    });

    Dependencies

    License

    The MIT License

    Install

    npm i fixted

    DownloadsWeekly Downloads

    212

    Version

    3.0.2

    License

    MIT

    Unpacked Size

    26.2 kB

    Total Files

    18

    Last publish

    Collaborators

    • neonexus