lib_dice 0.1.2

A library for parsing dice rolls
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

//! A library for parcing dice rolls using nom.
//!
//! ## Usage
//! ```
//! extern crate lib_dice;

//! fn main() {
//! 	let roll_1 = lib_dice::roll(1, 8, 0); // 1d8 + 0
//! 	let roll_2 = lib_dice::roll_from_str("2d6 + 7");
//! }
//! ```

extern crate rand;
use rand::Rng;

#[macro_use]
extern crate nom;
use nom::IResult;

use std::str::{from_utf8_unchecked, FromStr};

mod error;
use error::DiceFormatError;

fn buf_to_i32(buf: &[u8]) -> i32 {
    // unsafe is safe because nom guarantees utf8 string with only digits
    FromStr::from_str(unsafe { from_utf8_unchecked(buf) }).unwrap()
}

named!(
    parse_dice<(usize, u8, i32)>,
    do_parse!(
        count: call!(nom::digit) >>
        tag!("d") >>
        dice: call!(nom::digit) >>
        opt!(complete!(tag!(" + "))) >>
        bonus: opt!(complete!(call!(nom::digit))) >>
        ((buf_to_i32(count) as usize, buf_to_i32(dice) as u8, buf_to_i32(bonus.unwrap_or(b"0"))))
    )
);

/// Simulate a random dice roll using the rand crate.
///
/// ## Example
/// ```
/// extern crate lib_dice;
/// use lib_dice::roll;
/// let roll_1 = roll(1, 8, 0); // 1d8 + 0
/// let roll_2 = roll(2, 6, 7); // 2d6 + 7
/// ```
pub fn roll(count: usize, dice: u8, bonus: i32) -> i32 {
    let mut rng = rand::thread_rng();
    (0..count)
        .map(|_| rng.gen_range(0, dice as i32))
        .fold(0i32, |total, value| total + value)
        + bonus
        + count as i32
}

/// Parse a dice roll from a sting in one of the following formats
///
/// ## Example
/// ```
/// extern crate lib_dice;
/// use lib_dice::roll_from_str;
/// let roll_1 = roll_from_str("1d8").unwrap();  // roll a single 8 sided dice
/// let roll_2 = roll_from_str("2d6 + 7").unwrap();  // roll 2 6 sided dice with a +7 bonus
/// ```
///
/// ## Error
///
/// A lib_dice::DiceFormatError will be thrown if the dice string is malformed or empty.
pub fn roll_from_str(cmd: &str) -> Result<i32, DiceFormatError> {
    return match parse_dice(cmd.as_bytes()) {
        IResult::Done(_, dice) => Ok(roll(dice.0, dice.1, dice.2)),
        _ => Err(DiceFormatError::new(cmd)),
    };
}

#[test]
fn test_parse_dice() {
    // Valid dice strings
    assert_eq!(nom::IResult::Done(&[][..], (1, 8, 0)), parse_dice(b"1d8"));
    assert_eq!(
        nom::IResult::Done(&[][..], (1, 8, 0)),
        parse_dice(b"1d8 + 0")
    );
    assert_eq!(
        nom::IResult::Done(&[][..], (3, 4, 2)),
        parse_dice(b"3d4 + 2")
    );

    // Malformed Dice Strings
    assert_eq!(
        nom::IResult::Done(&[][..], (1, 8, 0)),
        parse_dice(b"1d8 + ")
    );
    assert_eq!(
        nom::IResult::Done(&b"+"[..], (1, 8, 0)),
        parse_dice(b"1d8+")
    );
}

#[test]
fn test_roll() {
    // Roll one dice
    for _ in 0..1000 {
        let r = roll(1, 6, 0);
        assert!(r >= 1);
        assert!(r <= 6);
    }

    // Roll two dice
    for _ in 0..1000 {
        let r = roll(2, 6, 0);
        assert!(r >= 1);
        assert!(r <= 12);
    }

    // Roll with bonus
    for _ in 0..1000 {
        let r = roll(1, 6, 6);
        assert!(r >= 6);
        assert!(r <= 12);
    }
}