prosaic-project 1.0.0

Folder-of-files project format and bundler for Prosaic templates.
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
159
160
161
162
163
164
165
166
167

//! `templates/*.toml` schema.

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TemplateFile {
    pub key: String,
    #[serde(default)]
    pub description: String,
    #[serde(default)]
    pub slots_required: Vec<String>,
    #[serde(default)]
    pub slots_optional: Vec<String>,
    pub variants: Vec<Variant>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Variant {
    /// "low" | "medium" | "high"
    #[serde(default = "default_salience")]
    pub salience: String,
    /// BCP-47 lang code; defaults to project language if unspecified.
    #[serde(default)]
    pub language: Option<String>,
    /// Free-form author-defined style tag, e.g. "executive" or "technical".
    #[serde(default)]
    pub style: Option<String>,
    #[serde(default)]
    pub description: String,
    pub body: String,
}

fn default_salience() -> String {
    "medium".to_string()
}

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

    #[test]
    fn parse_minimal_template() {
        let toml_str = r#"
            key = "code.modified"
            variants = [
              { body = "{name|refer} was modified" },
            ]
        "#;
        let t: TemplateFile = toml::from_str(toml_str).unwrap();
        assert_eq!(t.key, "code.modified");
        assert_eq!(t.variants.len(), 1);
        assert_eq!(t.variants[0].salience, "medium");
        assert_eq!(t.variants[0].body, "{name|refer} was modified");
        assert!(t.variants[0].language.is_none());
        assert!(t.variants[0].style.is_none());
    }

    #[test]
    fn parse_multi_variant_with_salience() {
        let toml_str = r#"
            key = "code.modified"
            description = "Render a 'class X was modified' event."
            slots_required = ["name"]
            slots_optional = ["consumer_count"]

            [[variants]]
            salience = "low"
            body = "{name|refer} was modified"

            [[variants]]
            salience = "medium"
            body = """{name|refer} was modified, affecting {consumer_count}"""

            [[variants]]
            salience = "high"
            language = "en"
            style = "executive"
            body = "{name|refer} has been substantially modified"
        "#;
        let t: TemplateFile = toml::from_str(toml_str).unwrap();
        assert_eq!(t.variants.len(), 3);
        assert_eq!(t.variants[0].salience, "low");
        assert_eq!(t.variants[1].salience, "medium");
        assert_eq!(t.variants[2].salience, "high");
        assert_eq!(t.variants[2].language.as_deref(), Some("en"));
        assert_eq!(t.variants[2].style.as_deref(), Some("executive"));
        assert_eq!(t.slots_required, vec!["name"]);
        assert_eq!(t.slots_optional, vec!["consumer_count"]);
    }

    #[test]
    fn parse_multi_language_variants() {
        let toml_str = r#"
            key = "code.modified"

            [[variants]]
            salience = "medium"
            language = "en"
            body = "{name} was modified"

            [[variants]]
            salience = "medium"
            language = "es"
            body = "{name} fue modificado"
        "#;
        let t: TemplateFile = toml::from_str(toml_str).unwrap();
        assert_eq!(t.variants.len(), 2);
        assert_eq!(t.variants[0].language.as_deref(), Some("en"));
        assert_eq!(t.variants[1].language.as_deref(), Some("es"));
    }

    #[test]
    fn parse_style_variants() {
        let toml_str = r#"
            key = "code.modified"

            [[variants]]
            salience = "medium"
            style = "executive"
            body = "{name} changed"
        "#;
        let t: TemplateFile = toml::from_str(toml_str).unwrap();
        assert_eq!(t.variants[0].style.as_deref(), Some("executive"));
    }

    #[test]
    fn missing_key_errors() {
        let toml_str = r#"
            variants = [{ body = "x" }]
        "#;
        let res = toml::from_str::<TemplateFile>(toml_str);
        assert!(res.is_err(), "expected error for missing `key` field");
    }

    #[test]
    fn missing_variant_body_errors() {
        let toml_str = r#"
            key = "x"
            [[variants]]
            salience = "medium"
        "#;
        let res = toml::from_str::<TemplateFile>(toml_str);
        assert!(
            res.is_err(),
            "expected error for missing variant `body` field"
        );
    }

    #[test]
    fn round_trip_serialize() {
        let original: TemplateFile = toml::from_str(
            r#"
            key = "code.added"
            description = "Add event."
            variants = [
              { salience = "medium", body = "{name|refer} was added" },
            ]
            "#,
        )
        .unwrap();
        let serialized = toml::to_string(&original).unwrap();
        let reparsed: TemplateFile = toml::from_str(&serialized).unwrap();
        assert_eq!(reparsed.key, "code.added");
        assert_eq!(reparsed.variants.len(), 1);
        assert_eq!(reparsed.variants[0].body, "{name|refer} was added");
    }
}