chordlib 0.15.0

Work with chord-and-lyrics songs: parse, transform, and render them to multiple formats
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

use super::{render_bars, render_line};
use crate::types::{ChordRepresentation, Line, Part, Section, SimpleChord};

fn is_chord_only_line(line: &Line) -> bool {
    line.parts
        .iter()
        .all(|part| part.languages.iter().all(|lang| lang.is_empty()))
}

pub fn render_section(
    section: &Section,
    key: &SimpleChord,
    representation: &ChordRepresentation,
    language: usize,
    bar_duration: u32,
    beats_per_bar: u32,
    compact_six_eight: bool,
) -> String {
    let mut content = String::new();
    let mut chord_only_line_buffer = Vec::new();

    for line in &section.lines {
        if is_chord_only_line(line) {
            chord_only_line_buffer.push(line);
        } else {
            if !chord_only_line_buffer.is_empty() {
                content.push_str(&render_bars::render_bars(
                    &chord_only_line_buffer,
                    key,
                    representation,
                    bar_duration,
                    beats_per_bar,
                    compact_six_eight,
                ));
                chord_only_line_buffer.clear();
            }
            content.push_str(&render_line::render_line(
                line,
                key,
                representation,
                language,
            ));
        }
    }

    if !chord_only_line_buffer.is_empty() {
        content.push_str(&render_bars::render_bars(
            &chord_only_line_buffer,
            key,
            representation,
            bar_duration,
            beats_per_bar,
            compact_six_eight,
        ));
    }

    // Add a separate repeat line at the end of the section if needed.
    if section.repeat_count > 1 {
        let repeat_text = if section.repeat_count == 2 {
            "(repeat)".to_string()
        } else {
            format!("(repeat {}x)", section.repeat_count)
        };

        // Ensure the languages vector has an entry for the requested language index.
        let mut languages = vec![String::new(); language.saturating_add(1)];
        languages[language] = repeat_text;

        let repeat_line = Line {
            parts: vec![Part {
                chord: None,
                languages,
                comment: true,
            }],
        };

        content.push_str(&render_line::render_line(
            &repeat_line,
            key,
            representation,
            language,
        ));
    }

    format!(
        "<p><span class=\"keyword\">{}</span><br>{}</p>",
        section.title, content
    )
}

#[cfg(test)]
mod tests {
    use crate::outputs::FormatHTML;
    use crate::types::{ChordRepresentation, Line, Part, Section, SimpleChord, Song};

    fn make_song_with_section(title: &str, repeat_count: u32) -> Song {
        let section = Section {
            title: title.to_string(),
            lines: vec![Line {
                parts: vec![Part {
                    chord: None,
                    languages: vec!["Line".to_string()],
                    comment: false,
                }],
            }],
            repeat_count,
        };

        Song {
            titles: vec!["Test".to_string()],
            subtitle: None,
            copyright: None,
            key: Some(SimpleChord::default()),
            artists: vec![],
            languages: vec![],
            tempo: None,
            time: None,
            tags: Default::default(),
            sections: vec![section],
        }
    }

    #[test]
    fn html_does_not_show_repeat_marker_for_default() {
        let song = make_song_with_section("Chorus", 1);
        let html = (&song)
            .format_html(None, Some(&ChordRepresentation::Default), None, None)
            .expect("render");

        assert!(html.contains("<span class=\"keyword\">Chorus</span>"));
        assert!(!html.contains("(repeat"));
    }

    #[test]
    fn html_shows_repeat_marker_for_section_with_repeat_count() {
        let song = make_song_with_section("Chorus", 2);
        let html = (&song)
            .format_html(None, Some(&ChordRepresentation::Default), None, None)
            .expect("render");

        assert!(html.contains("<span class=\"comment\">(repeat)</span>"));
    }
}