linkorb/haigha

Alice fixtures for database tables

v2.6.0 2018-07-27 16:06 UTC

README

687474703a2f2f332e62702e626c6f6773706f742e636f6d2f2d395f4a74336764663666552f542d32385f5255706f46492f41414141414141414342672f786741784b2d3266674c592f73313630302f4d61726368486172652e6a7067

Alice is an awesome database fixtures library. It works with Doctrine out-of-the-box, but if you don't use the Doctrine ORM, you'll need custom persisters...

This is where Haigha comes in:

Haigha lets you use Alice directly with database tables!

Features

  • Supports all standard Alice functionality (ranges, optional data, references, inheritence, etc)
  • Supports Faker data providers
  • Supports any PDO connection
  • No need to write classes, directly persist from yml to your sql database

Example fixture file

Haigha uses Alice to load fixture files, so the format is identical (Details). The only thing to keep in mind is that you use tablenames instead of classnames. Prefix your tablenames with table.. For example, if your tablename is called user, you use it like this:

table.group:
  group_random_users:
    id: 1 # This is important for version ~2.0
    name: Random users

table.user:
  random_user{0..9}:
    group_id: @group_random_users
    username: <userName()>
    firstname: <firstName()>
    lastname: <lastName()>
    password: <password()>
    email: <email()>

How to use Haigha in your application

Simply add the following to your require or require-dev section in your composer.json and run composer update:

"require": {
  "linkorb/haigha": "^2.0"
}

You can now use Haigha in your applications, or use the included command-line tool to load fixtures into your database:

Command-line usage

The haigha command-line tool knows one sub-command: fixtures:load.

The first argument is the filename of your fixture definition (yaml).

The second argument is the (optional) database url. If no database url is specified, haigha used your PDO environment variable instead.

Database URL

A full URL containing username, password, hostname and dbname. For example:

./vendor/bin/haigha fixtures:load examples/random_users.yml mysql://username:password@hostname/dbname

Just a dbname

In this case linkorb/database-manager is used for loading database connection details (server, username, password, etc) from .conf files (read project readme for more details).

In a nutshell - you must have a database_name.conf file at /share/config/database/ as described at database-manager's documentation.

./vendor/bin/haigha fixtures:load examples/random_users.yml dbname

Library usage:

You can use Haigha in your own application like this:

// Instantiate a new Alice loader
$loader = new Nelmio\Alice\Fixtures\Loader();

// Add the Haigha instantiator
$instantiator = new Haigha\TableRecordInstantiator();
$loader->addInstantiator($instantiator);

// Load (Haigha) objects from a Alice yml file
$objects = $loader->load('examples/random_users.yml');

// Instantiate the Haigha PDO persister, and pass a PDO connection
$persister = new PdoPersister($pdo);

// Persist the Haigha objects on the PDO connection
$persister->persist($objects);

Test

Customize phpunit.xml:

cp phpunit.xml.dist phpunit.xml

Run:

vendor/bin/phpunit

License

MIT (see LICENSE.md)

Brought to you by the LinkORB Engineering team

687474703a2f2f7777772e6c696e6b6f72622e636f6d2f642f6d6574612f74696572312f696d616765732f6c696e6b6f7262656e67696e656572696e672d6c6f676f2e706e67
Check out our other projects at linkorb.com/engineering.

Btw, we're hiring!