changelog_document 0.1.7

Feature-rich changelog format. Include a parser and serializer.
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

use crate::*;

// todo: use io::Write

#[derive(Debug, Clone, Default)]
pub struct Options {
    pub release_option: OptionsRelease,
}

#[derive(Debug, Clone)]
pub struct OptionsRelease {
    pub serialize_title: bool,
}

impl Default for OptionsRelease {
    fn default() -> Self {
        Self {
            serialize_title: true,
        }
    }
}

pub fn serialize_changelog(changelog: &ChangeLog, options: &Options) -> String {
    let mut s = String::new();

    let mut should_new_line = false;

    if let Some(header) = &changelog.header {
        s.push_str(header);
        s.push('\n');

        should_new_line = true;
    }

    if let Some(unreleased) = &changelog.unreleased {
        if should_new_line {
            s.push('\n');
        }
        should_new_line = true;

        serialize_release(&mut s, unreleased, &options.release_option);
    }

    for release in changelog.releases() {
        if should_new_line {
            s.push('\n');
        }
        should_new_line = true;
        serialize_release(&mut s, release, &options.release_option);
    }

    if !changelog.footer_links.links.is_empty() {
        s.push('\n');
    }

    for footer_link in &changelog.footer_links.links {
        s.push_str(&format!("[{}]: {}\n", footer_link.text, footer_link.link));
    }

    s
}

// todo: handle footer links
pub fn serialize_release(s: &mut String, release: &Release, options: &OptionsRelease) {
    let mut should_new_line = false;

    if options.serialize_title {
        let mut full_title = format!("## [{}]", release.title.version);

        if let Some(release_link) = &release.title.release_link {
            full_title.push_str(&format!("({})", release_link));
        }

        if let Some(title) = &release.title.title {
            full_title.push_str(&format!(" - {}", title));
        }

        full_title.push('\n');

        s.push_str(&full_title);

        should_new_line = true;
    }

    if let Some(header) = &release.header {
        if should_new_line {
            s.push('\n');
        }
        s.push_str(&format!("{}\n", header));
        should_new_line = true;
    }

    for (_, section) in &release.note_sections {
        if !section.notes.is_empty() {
            if should_new_line {
                s.push('\n');
            }
            should_new_line = true;

            s.push_str(&format!("### {}\n\n", section.title));

            for note in &section.notes {
                serialize_release_section_note(s, note);
            }
        }
    }

    if let Some(footer) = &release.footer {
        if should_new_line {
            s.push('\n');
        }
        s.push_str(&format!("{}\n", footer));
    }
}

pub fn serialize_release_section_note(s: &mut String, note: &ReleaseSectionNote) {
    let note_title = if let Some(scope) = &note.scope {
        format!("- {}: {}\n", scope, note.message)
    } else {
        format!("- {}\n", note.message)
    };

    s.push_str(&note_title);

    for context in &note.context {
        s.push_str(&format!("  {}\n", context));
    }
}

#[cfg(test)]
mod test {

    use crate::test::CHANGELOG1;

    use super::*;

    #[test]
    fn test() {
        let output = serialize_changelog(&CHANGELOG1, &Options::default());

        println!("{}", output);
    }

    #[test]
    fn test2() {
        let release_note = ReleaseSectionNote {
            scope: Some("data".into()),
            message: "the program".into(),
            context: vec!["- fix la base".into(), "49-3 hihi".into()],
        };

        let mut output = String::new();

        serialize_release_section_note(&mut output, &release_note);

        println!("{:?}", output);
    }
}