dicetest 0.4.0

Framework for writing tests with randomly generated test data
Documentation 
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

use crate::dice::{CollectionBuilder, LengthRange};
use crate::prelude::*;

/// [`Vec`] builder for [`dice::collection`].
///
/// [`dice::collection`]: dice::collection()
pub struct VecBuilder;

impl<T> CollectionBuilder<T, Vec<T>> for VecBuilder {
    fn build(&self, elems: impl ExactSizeIterator<Item = T>) -> Vec<T> {
        let mut vec = Vec::with_capacity(elems.len());
        vec.extend(elems);
        vec
    }
}

/// Generates a [`Vec`] that contains elements of type `T`.
///
/// The range specifies the length of the [`Vec`].
///
/// # Panics
///
/// Panics if the range is empty.
///
/// # Examples
///
/// ```
/// use dicetest::prelude::*;
/// use dicetest::{Prng, Limit};
///
/// let mut prng = Prng::from_seed(0x5EED.into());
/// let limit = Limit::default();
/// let mut fate = Fate::new(&mut prng, limit);
///
/// let elem_die = dice::u8(..);
///
/// let vec = fate.with_limit(100.into()).roll(dice::vec(&elem_die, ..));
/// assert!(vec.len() <= 100);
///
/// let vec = fate.roll(dice::vec(&elem_die, ..=73));
/// assert!(vec.len() <= 73);
///
/// let vec = fate.roll(dice::vec(&elem_die, 17..));
/// assert!(vec.len() >= 17);
///
/// let vec = fate.roll(dice::vec(&elem_die, 42));
/// assert!(vec.len() == 42);
/// ```
pub fn vec<T>(elem_die: impl Die<T>, length_range: impl LengthRange) -> impl Die<Vec<T>> {
    dice::collection(VecBuilder, elem_die, length_range)
}

/// Similar to [`dice::vec`] but each element is generated using only a random part of
/// [`Limit`].
///
/// If you want to generate a [`Vec`] that contains other collections, then you should
/// consider using this generator for the outer [`Vec`]. That way the overall length is
/// bounded by [`Limit]` (and not the square of [`Limit`]).
///
/// [`Limit`]: crate::Limit
/// [`dice::vec`]: dice::vec()
///
/// # Panics
///
/// Panics if the range is empty.
///
/// # Examples
///
/// ```
/// use dicetest::prelude::*;
/// use dicetest::{Prng, Limit};
///
/// let mut prng = Prng::from_seed(0x5EED.into());
/// let limit = Limit::default();
/// let mut fate = Fate::new(&mut prng, limit);
///
/// let elem_die = dice::u8(..);
/// let vec_die = dice::vec(elem_die, ..);
/// let vec_of_vecs_die = dice::outer_vec(vec_die, ..);
///
/// let vec_of_vecs = fate.roll(vec_of_vecs_die);
/// assert!(vec_of_vecs.iter().flatten().count() <= 100);
/// ```
pub fn outer_vec<T>(elem_die: impl Die<T>, length_range: impl LengthRange) -> impl Die<Vec<T>> {
    dice::outer_collection(VecBuilder, elem_die, length_range)
}

#[cfg(test)]
mod tests {
    use crate::prelude::*;

    #[test]
    fn vec_calc_stats() {
        Dicetest::repeatedly()
            .passes(0)
            .stats_enabled(true)
            .run(|mut fate| {
                stat!(
                    "vec(dice::bool(), ..=3)",
                    "{:?}",
                    fate.roll(dice::vec(dice::bool(), ..=3)),
                );
            })
    }
}