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

tiny-fixtures

v0.3.0

Published

Simple database fixtures

Downloads

2,909

Readme

Tiny Fixtures tiny-fixtures npm monthly downloads current version Commitizen friendly

Installation

Run npm i -D tiny-fixtures to save to your dev dependencies.

Compatibility

Currently, only tested against Postgres flavoured SQL assuming a node-postgres connection pool.

Usage

Initialise a fixture manager by providing it with a connection pool. TinyFixtures will return an object with a createFixtures function.

import { tinyFixtures } from 'tiny-fixtures';
import { pool } from './db/connection';
import { getUsers } from '/db/users';

const { createFixtures } = tinyFixtures(pool)

describe('my test cases', () => {
    const [setupUserFixtures, teardownUserFixtures] = createFixtures('users', [
        {
            email: '[email protected]',
            username: 'tinyAnt'
        }, {
            email: '[email protected]',
            username: 'antTiny',
        }
    ]);
    beforeEach(async () => {
        await setupUserFixtures();
    });
    afterEach(async () => {
        await teardownUserFixtures();
    });
    it('should have two users in the database', async () => {
        expect((await getUsers()).length).to.equal(2);
    });
})

createFixtures takes

  • a table name
  • an array of objects

Each object in the array is a row to insert. The setup function uses each row object's keys as column names.

In the example above, tiny-fixtures will insert into columns email and username.

createFixtures returns two functions:

  • setupFixtures,
  • teardownFixtures

Call these functions in your before each and after each hook respectively. Tiny fixtures will then ensure you have clean data for each test. Additionally, it will preserve existing data in the database, improving the local development experience.

To create fixtures across foreign keys use the third value returned by createFixtures to populate the next table, being sure to correctly order your setup and teardown steps.

import { tinyFixtures } from 'tiny-fixtures';
import { pool } from './db/connection';
import { getUsers } from '/db/users';

const { createFixtures } = tinyFixtures(pool);

describe('my test cases', () => {
  const [setupUserFixtures, teardownUserFixtures, users] = createFixtures('users', [
    {
      email: '[email protected]',
      username: 'tinyAnt'
    }, {
      email: '[email protected]',
      username: 'antTiny',
    }
  ]);
  const [setupUserMessageFixtures, teardownUserMessageFixtures] = createFixtures(
    'user_messages',
    [{
        user_id: users[0].getRefByKey('id'),
        message: 'Foobar did the bar foo good',
      },
      {
        user_id: users[0].getRefByKey('id'),
        message: 'I am a meat popsicle', 
    }]
  )
  beforeEach(async () => {
    await setupUserFixtures();
    await setupUserMessageFixtures();
  });
  afterEach(async () => {
    await teardownUserMessageFixtures();
    await teardownUserFixtures();
  });
  it('should have a user with two messages, and one with none', async () => {
    const users = await getUsers();
    expect(users.length).to.equal(2);
    expect(users[0].messages.length).to.equal(2);
    expect(users[1].messages.length).to.equal(0);
  });
})

Pay attention to the ordering -- following these simple patterns is what keeps tiny-fixtures tiny!

Explaining user_id: users[0].getRefByKey('id')

Because the fixture hasn't been inserted into the database yet, tiny-fixtures doesn't have any serial/sequence values in the row array returned as the 3rd return value. getRefByKey takes the column name of the primary key for the parent object in the foreign key, allowing the value to be resolved when the setup step occurs.

Tiny-fixtures resolves the value at setup by inspecting the row objects you provided for functions. When it finds one, it looks up the result for that column in the original object, and populates its value before continuing the insert.

Tiny-fixtures is then able to create and destroy fixtures across foreign keys for each test run.

Docs

Full documentation located at https://www.tiny-fixtures.com/modules.html

Changelog

See CHANGELOG.md