mockd 0.5.3

Fake data generator library with 130+ functions
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
142
143

//!
//! Provides 4 functions to return currency data.
//!
//! # Examples
//!
//! ```rust
//! use mockd::currency;
//!
//!     let data = currency::compact(); // currency::Info
//!     let data = currency::short(); // short: SRD
//!     let data = currency::long(); // long: Burundi Franc
//!     let data = currency::price(1 as f64, 123 as f64); // price: 53.7
//! ```
//!
//! # Feature
//!
//! Requires the "currency" feature.
//!

use crate::misc;
use math::round;

pub(crate) mod data;

/// Contains both the short and long name for a currency
/// # Example
///
/// ```rust
/// let compact = mockd::currency::compact();
///
/// println!("Currency: {:#?}", compact);
/// ```
///
/// # Feature
///
/// Requires the "currency" feature.
///
#[derive(Debug)]
pub struct Info {
    short: String,
    long: String,
}

/// Generate a random currency description based on info struct.
///
/// # Example
///
/// ```rust
/// let compact = mockd::currency::compact();
///
/// println!("Currency: {:#?}", compact);
/// ```
///
/// # Feature
///
/// Requires the "currency" feature.
///
pub fn compact() -> Info {
    let index = misc::random_data_index(data::SHORT);
    Info {
        short: data::SHORT[index].to_string(),
        long: data::LONG[index].to_string(),
    }
}

/// Generate a random short currency code.
///
/// # Example
///
/// ```rust
/// let short = mockd::currency::short();
///
/// println!("Currency code: {}", short);
/// ```
///
/// # Feature
///
/// Requires the "currency" feature.
///
pub fn short() -> String {
    misc::random_data(data::SHORT).to_string()
}

/// Generate a random long currency name.
///
/// # Example
///
/// ```rust
/// let name = mockd::currency::long();
///
/// println!("Currency name: {}", name);
/// ```
///
/// # Feature
///
/// Requires the "currency" feature.
///
pub fn long() -> String {
    misc::random_data(data::LONG).to_string()
}

/// Generate a random currency price within a range.
///
/// Given a range provide a currency price to two places of decimal.
///
/// # Example
///
/// ```rust
/// let price = mockd::currency::price(10.0,39.5);
///
/// println!("Currency price: {}", price);
/// ```
///
/// # Feature
///
/// Requires the "currency" feature.
///
pub fn price(min: f64, max: f64) -> f64 {
    round::floor(misc::random::<f64>(min, max), 2)
}

#[cfg(test)]
mod tests {
    use crate::currency;
    use crate::testify::exec_mes;

    #[test]
    fn short() {
        exec_mes("currency::short", currency::short);
    }

    #[test]
    fn long() {
        exec_mes("currency::long", currency::long);
    }

    #[test]
    fn price() {
        exec_mes("currency::short", || {
            format!("{}", currency::price(1.0_f64, 123.0_f64))
        });
    }
}