mocker 0.1.5

A library for transforming text with uppercase and lowercase letters, resembling the Spongebob Mock Meme.
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

use crate::Mocker;

/// A built-in Mocker, which alternates between uppercase and lowercase.
pub struct AlternatingMocker {
    current: bool
}

impl AlternatingMocker {
    /// Creates a new AlternatingMocker. This by default starts with a lowercase letter, if you wanna control that, use `AlternatingMocker::new_from_bool()`.
    pub fn new() -> Self {
        Self {
            current: false
        }
    }
    /// Creates a new AlternatingMocker, and allows you to control the case of the starting letter with the parameter.
    ///
    /// ```
    /// let mocked = mock(&text, &mut AlternatingMocker::new_from_bool(true));
    /// ```
    pub fn new_from_bool(starting_case: bool) -> Self {
        Self {
            current: starting_case
        }
    }
}

impl Mocker for AlternatingMocker {
    /// Toggles the state of the current case and returns the old one.
    fn uppercase(&mut self) -> bool {
        self.current = !self.current;
        !self.current
    }
}

/// A built-in Mocker, which randomly makes characters uppercase or lowercase.
pub struct RandomMocker;

impl RandomMocker {
    /// Creates a new RandomMocker.
    pub fn new() -> Self {
        Self {}
    }
}

impl Mocker for RandomMocker {
    /// Returns a random boolean (which is also the case of the letter)
    fn uppercase(&mut self) -> bool {
        rand::random()
    }
}

/// A built-in Mocker, which takes in a closure that returns a boolean. Useful if you don't feel like implementing the Mocker trait yourself.
///
/// Example of a ClosureMocker which makes all the letters uppercase:
///
/// ```
/// let text = "hello, World!";
/// let mut mocker = ClosureMocker::new(|| {
///    true
/// });
/// assert_eq!("HELLO, WORLD!", mock(&text, &mut mocker));
/// ```
pub struct ClosureMocker<T: Fn() -> bool> {
    closure: T
}

impl<T: Fn() -> bool> ClosureMocker<T> {
    /// Creates a new ClosureMocker.
    /// The parameter must be a closure which returns a `bool`.
    /// The closure will be executed to determine whether the letter should be uppercase or not.
    pub fn new(closure: T) -> Self {
        Self {
            closure: closure
        }
    }
}

impl<T: Fn() -> bool> Mocker for ClosureMocker<T> {
    /// Executes the closure and returns the value.
    fn uppercase(&mut self) -> bool {
        (self.closure)()
    }
}