uwu-rs 1.0.0

uwuifying library
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

use crate::Uwu;

/// A builder for the `Uwu` instance.
///
/// Quick start:
/// ```
/// uwu_rs::UwuBuilder::new()
///     .lowercase()
///     .expressions()
///     .w_replace()
///     .stutter(4)
///     .emojis(1)
///     .build();
/// ```
#[derive(Copy, Clone, Default, Debug, Eq, PartialEq)]
pub struct UwuBuilder {
    /// Enables the lowercase feature, e.g. 'Hello' becomes 'hello'. Beware that the other features
    /// may misbehave if this feature is disabled.
    pub lowercase: bool,
    /// Enables expression replacement, e.g. 'what' becomes 'nani'.
    pub expressions: bool,
    /// Enables replacement of 'l' and 'r' with 'w', e.g. 'lovely' becomes 'wovewy'.
    pub w_replace: bool,
    /// Enables stutter, e.g. 'hello' becomes 'h-hello'.
    pub stutter: bool,
    /// Specifies how frequent the stutter is. A value of 1 will add stutter to every word, whereas
    /// a value of 2 will add stutter every 2 words on average.
    pub stutter_chance: u8,
    /// Enables adding emojis after punctuation, e.g. 'goodbye.' becomes 'goodbye. OwO'.
    pub emojis: bool,
    /// Specifies how frequently emojis are added. A value of 1 will add emojis after every
    /// punctuation, whereas a value of 2 will add emojis every 2 punctuation marks on average.
    pub emojis_chance: u8,
}

impl UwuBuilder {
    /// Create a new instance of a builder for the `Uwu` instance.
    pub fn new() -> Self {
        Self::default()
    }

    /// Enables the lowercase feature, e.g. 'Hello' becomes 'hello'.
    pub fn lowercase(&mut self) -> &mut Self {
        self.lowercase = true;
        self
    }

    /// Enables expression replacement, e.g. 'what' becomes 'nani'.
    pub fn expressions(&mut self) -> &mut Self {
        self.expressions = true;
        self
    }

    /// Enables replacement of 'l' and 'r' with 'w', e.g. 'lovely' becomes 'wovewy'.
    pub fn w_replace(&mut self) -> &mut Self {
        self.w_replace = true;
        self
    }

    /// Enables stutter, e.g. 'hello' becomes 'h-hello'.
    pub fn stutter(&mut self, chance: u8) -> &mut Self {
        self.stutter = true;
        self.stutter_chance = chance;
        self
    }

    /// Enables adding emojis after punctuation, e.g. 'goodbye.' becomes 'goodbye. OwO'.
    pub fn emojis(&mut self, chance: u8) -> &mut Self {
        self.emojis = true;
        self.emojis_chance = chance;
        self
    }

    /// Builds a new `Uwu` instance from the arguments set in this builder.
    pub fn build(&self) -> Uwu {
        Uwu::from(self)
    }
}

impl From<&UwuBuilder> for Uwu {
    fn from(builder: &UwuBuilder) -> Self {
        Self {
            lowercase: builder.lowercase,
            expressions: builder.expressions,
            w_replace: builder.w_replace,
            stutter: builder.stutter,
            stutter_chance: builder.stutter_chance,
            emojis: builder.emojis,
            emojis_chance: builder.emojis_chance,
        }
    }
}

impl From<UwuBuilder> for Uwu {
    fn from(builder: UwuBuilder) -> Self {
        Self::from(&builder)
    }
}

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

    #[test]
    fn assert_builder() {
        let builder_ver = Uwu::builder()
            .lowercase()
            .expressions()
            .w_replace()
            .stutter(4)
            .emojis(1)
            .build();

        let manual_ver = Uwu {
            lowercase: true,
            expressions: true,
            w_replace: true,
            stutter: true,
            stutter_chance: 4,
            emojis: true,
            emojis_chance: 1,
        };

        assert_eq!(builder_ver, manual_ver);
    }
}