# Factori [![Build Status](https://travis-ci.org/mjkillough/factori.svg?branch=master)](https://travis-ci.org/mjkillough/factori) [![Crates.io](https://img.shields.io/crates/v/factori.svg)](https://crates.io/crates/factori) [![Docs.rs](https://docs.rs/factori/badge.svg)](https://docs.rs/factori/)

A testing factory library for Rust, inspired by
[FactoryBot](https://github.com/thoughtbot/factory_bot). 🤖 🦀

Factori makes it easy to instantiate your test objects/fixtures in tests while
providing an ergonomic syntax for defining how they are instantiated.

Factori works on stable Rust >=1.30.

## Documentation

See [API documentation](https://docs.rs/factori/latest/factori/).

## Example

Factori provides two macros: `factori!`, which defines a factory for a type,
and `create!` which instantiates it:

```rust
#[macro_use]
extern crate factori;

pub struct Vehicle {
    number_wheels: u8,
    electric: bool,
}

factori!(Vehicle, {
    default {
        number_wheels = 4,
        electric = false,
    }

    mixin bike {
        number_wheels = 2,
    }
});

fn main() {
    let default = create!(Vehicle);
    assert_eq!(default.number_wheels, 4);
    assert_eq!(default.electric, false);

    // Its type is Vehicle, nothing fancy:
    let vehicle: Vehicle = default;

    let three_wheels = create!(Vehicle, number_wheels: 3);
    assert_eq!(three_wheels.number_wheels, 3);

    let electric_bike = create!(Vehicle, :bike, electric: true);
    assert_eq!(electric_bike.number_wheels, 2);
    assert_eq!(electric_bike.electric, true);
}
```

More examples are available in the
[`tests/`](https://github.com/mjkillough/factori/tree/master/tests) directory.

## Testing

Run:

```sh
cargo test
```

## License

MIT