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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

use std::marker::PhantomData;

use crate::prelude::*;
use crate::{Limit, Prng};

/// The value generated by [`dice::fn_builder`].
///
/// [`dice::fn_builder`]: dice::fn_builder()
pub struct FnBuilder<I, O, IC, OD> {
    input_codie: IC,
    output_die: OD,
    prng: Prng,
    limit: Limit,
    _i: PhantomData<I>,
    _o: PhantomData<O>,
}

impl<I, O, IC, OD> FnBuilder<I, O, IC, OD>
where
    IC: Codie<I>,
    OD: DieOnce<O>,
{
    pub fn build_fn_once(mut self) -> impl FnOnce(I) -> O {
        move |input| {
            let output_die = self.output_die;
            let randomness = self.input_codie.coroll(input);
            let prng = &mut self.prng;
            prng.reseed(randomness);
            let limit = self.limit;
            let fate = Fate::new(prng, limit);
            output_die.roll_once(fate)
        }
    }
}

impl<I, O, IC, OD> FnBuilder<I, O, IC, OD>
where
    IC: Codie<I>,
    OD: Die<O>,
{
    pub fn build_fn(self) -> impl Fn(I) -> O {
        move |input| {
            let output_die = &self.output_die;
            let randomness = self.input_codie.coroll(input);
            let prng = &mut self.prng.clone();
            prng.reseed(randomness);
            let limit = self.limit;
            let fate = Fate::new(prng, limit);
            output_die.roll(fate)
        }
    }

    pub fn build_fn_mut(mut self) -> impl FnMut(I) -> O {
        move |input| {
            let output_die = &self.output_die;
            let randomness = self.input_codie.coroll(input);
            let prng = &mut self.prng;
            prng.reseed(randomness);
            let limit = self.limit;
            let fate = Fate::new(prng, limit);
            output_die.roll(fate)
        }
    }
}

/// Generates a function builder.
///
/// The builder can be converted into an implementation of [`FnOnce`], [`FnMut`] or [`Fn`].
///
/// # Examples
///
/// This example generates a [`FnOnce`]:
/// ```
/// 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 f = fate.roll(dice::fn_builder(
///     codice::from_default_hasher(),
///     dice::u8(..),
/// )).build_fn_once();
///
/// let x = f(42);
/// ```
///
/// This example generates a [`FnMut`]:
/// ```
/// 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 mut f = fate.roll(dice::fn_builder(
///     codice::from_default_hasher(),
///     dice::u8(..),
/// )).build_fn_mut();
///
/// let x = f(42);
/// let y = f(42);
/// ```
///
/// This example generates a [`Fn`]:
/// ```
/// 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 f = fate.roll(dice::fn_builder(
///     codice::from_default_hasher(),
///     dice::u8(..),
/// )).build_fn();
///
/// let x = f(42);
/// let y = f(42);
/// assert_eq!(x, y);
/// ```
pub fn fn_builder<I, O, IC, OD>(
    input_codie: IC,
    output_die: OD,
) -> impl DieOnce<FnBuilder<I, O, IC, OD>>
where
    IC: Codie<I>,
    OD: DieOnce<O>,
{
    dice::from_fn_once(|mut fate| FnBuilder {
        input_codie,
        output_die,
        prng: fate.fork_prng(),
        limit: fate.limit(),
        _i: PhantomData,
        _o: PhantomData,
    })
}