1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105

//! [![github]](https://github.com/TaKO8Ki/beaver)
//!
//! [github]: https://img.shields.io/badge/github-8da0cb?labelColor=555555&logo=github
//!
//! This crate is a library for setting up Rust objects inspired by [factory_bot](https://github.com/thoughtbot/factory_bot).
//!
//! ## Dependencies
//! ```toml
//! [dependencies]
//! beaver = "1"
//! serde = { version = "1.0", features = ["derive"] }
//! ```
//! If you want to use [chrono](https://!docs.rs/chrono/) for your struct fields, `Cargo.toml` would look like this.
//! ```toml
//! [dependencies]
//! beaver = "1"
//! serde = { version = "1.0", features = ["derive"] }
//! # you need `serde` feature.
//! chrono = { version = "0.4", features = ["serde"] }
//! ```
//!
//! ## Examples
//! ### Define a factory
//! ```rust
//! use serde::{Deserialize, Serialize};
//!
//! // Your struct needs both of `Serialize` and `Deserialize`.
//! #[derive(Serialize, Deserialize)]
//! struct Post {
//!     id: u16,
//!     title: String,
//!     approved: bool,
//! }
//!
//! beaver::define! {
//!     PostFactory (Post) {
//!         // n is a sequence number.
//!         id -> |n| n,
//!         title -> |n| format!("{}", n),
//!         approved -> |_| false,
//!     }
//! }
//! ```
//!
//! If you want to use factories outside modules, you need to make factories public.
//! For more information, please see this [example](https://github.com/TaKO8Ki/beaver/blob/master/examples/public_factory.rs).
//!
//! You can use the following functions in factory definition.
//! - [sequence](factory/fn.sequence.html): If you want to use a sequence number, you can use this function.
//! - [sequence_a](factory/fn.sequence_a.html): If you want to use a sequence letter, you can use this function.
//!
//! ### Build structs
//! ```
//! use serde::{Deserialize, Serialize};
//!
//! #[derive(Serialize, Deserialize, Debug)]
//! struct Post {
//!     id: u16,
//!     title: String,
//!     approved: bool,
//! }
//!
//! beaver::define! {
//!     PostFactory (Post) {
//!         id -> |n| n,
//!         title -> |n| format!("{}", n),
//!         approved -> |_| false,
//!     }
//! }
//!
//! impl Post {
//!     pub fn something(self) -> String {
//!         self.title
//!     }
//! }
//!
//! #[cfg(test)]
//! mod tests {
//!     #[test]
//!     fn test_something() {
//!         use crate::factory::PostFactory;
//!
//!         let post_factory = PostFactory::new();
//!         let post1 = post_factory.build(|_| {});
//!         let post2 = post_factory.build(|_| {});
//!         // override attributes of a factory
//!         let post3 = post_factory.build(|post| {
//!             post.id = 1024;
//!             post.title = "foo bar".to_string()
//!         });
//!
//!         assert_eq!(post1.something(), "post-1");
//!         assert_eq!(post2.something(), "post-2");
//!         assert_eq!(post3.something(), "foo bar");
//!     }
//! }
//! ```
//!

mod factory;
mod macros;
mod variable;

pub use factory::Factory;
pub use factory::{new, sequence, sequence_a};