zamm_yang 0.0.3

A basic, experimental code generator
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

#[cfg(test)]
const CODE_WIDTH: usize = 30;
/// How many characters per line each autogenerated document should have.
#[cfg(not(test))]
const CODE_WIDTH: usize = 80;

/// Break up a one line documentation string into a multi-line docstring.
pub fn into_docstring(documentation: &str, indent_size: usize) -> String {
    let indent = " ".repeat(indent_size);
    // subtract 4 more from CODE_WIDTH to account for "/// " at the beginning of each line
    let lines = textwrap::fill(documentation, CODE_WIDTH - indent_size - 4);
    let mut comment = String::new();
    for line in lines.split("\n") {
        comment.push_str(format!("{}/// {}\n", indent, line.trim_end()).as_str());
    }
    comment.trim_end().to_string()
}

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

    #[test]
    fn test_short_docstring() {
        assert_eq!(
            into_docstring("A short description.", 0),
            "/// A short description."
        );
    }

    #[test]
    fn test_short_docstring_indent() {
        assert_eq!(
            into_docstring("A short description.", 4),
            "    /// A short description."
        );
    }

    #[test]
    fn test_short_docstring_trim() {
        assert_eq!(
            into_docstring("A short description.\t", 4),
            "    /// A short description."
        );
    }

    #[test]
    fn test_long_docstring() {
        assert_eq!(
            into_docstring(
                "A really long description. I mean, there's just so much to \
            document. Who has time for it all?",
                0
            ),
            r#"/// A really long description.
/// I mean, there's just so
/// much to document. Who has
/// time for it all?"#
        );
    }

    #[test]
    fn test_long_docstring_indent() {
        assert_eq!(
            into_docstring(
                "A really long description. I mean, there's just so much to \
            document. Who has time for it all?",
                4
            ),
            r#"    /// A really long
    /// description. I mean,
    /// there's just so much
    /// to document. Who has
    /// time for it all?"#
        );
    }

    #[test]
    fn test_long_docstring_indent_more() {
        assert_eq!(
            into_docstring(
                "A really long description. I mean, there's just so much to \
            document. Who has time for it all?",
                8
            ),
            r#"        /// A really long
        /// description. I
        /// mean, there's just
        /// so much to
        /// document. Who has
        /// time for it all?"#
        );
    }
}