prosaic-project 0.6.2

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

//! `tests/*.toml` schema — narrative-flow scenarios with discourse assertions.

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Scenario {
    pub name: String,
    #[serde(default)]
    pub description: String,
    #[serde(default)]
    pub engine: ScenarioEngineOverride,
    pub events: Vec<ScenarioEvent>,
    #[serde(default)]
    pub expected: Option<Expected>,
}

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct ScenarioEngineOverride {
    pub variation: Option<String>,
    pub language: Option<String>,
    pub salience_thresholds: Option<crate::manifest::SalienceThresholdsConfig>,
    pub faithfulness_min: Option<f64>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ScenarioEvent {
    pub template: String,
    /// Free-form context map. Values can be strings, numbers, bools, or arrays of strings.
    #[serde(default)]
    pub context: HashMap<String, toml::Value>,
    /// RST relation hint (Elaboration, Contrast, Result, etc.). String form for TOML friendliness.
    #[serde(default)]
    pub rst_relation: Option<String>,
}

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct Expected {
    pub output: Option<String>,
    pub faithfulness_min: Option<f64>,
    pub discourse: Vec<ExpectedDiscourse>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ExpectedDiscourse {
    pub event_index: usize,
    #[serde(default)]
    pub reference_form: Option<String>,
    #[serde(default)]
    pub connective_contains: Option<String>,
    #[serde(default)]
    pub transition: Option<String>,
}

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

    #[test]
    fn parse_minimal_scenario() {
        let toml_str = r#"
            name = "smoke"
            [[events]]
            template = "code.added"
            context = { name = "Foo", entity_type = "class" }
        "#;
        let s: Scenario = toml::from_str(toml_str).unwrap();
        assert_eq!(s.name, "smoke");
        assert_eq!(s.events.len(), 1);
        assert_eq!(s.events[0].template, "code.added");
        assert_eq!(
            s.events[0].context.get("name").unwrap().as_str().unwrap(),
            "Foo"
        );
    }

    #[test]
    fn parse_full_scenario_with_expectations() {
        let toml_str = r#"
            name = "PR 142"
            description = "auth refactor"

            [engine]
            variation = "fixed"
            language = "en"
            faithfulness_min = 0.9

            [[events]]
            template = "code.modified"
            context = { name = "UserService", consumer_count = 6 }

            [[events]]
            template = "code.moved"
            context = { name = "UserService" }
            rst_relation = "elaboration"

            [expected]
            output = "..."
            faithfulness_min = 0.85

            [[expected.discourse]]
            event_index = 1
            reference_form = "Pronoun"

            [[expected.discourse]]
            event_index = 1
            connective_contains = "also"
        "#;
        let s: Scenario = toml::from_str(toml_str).unwrap();
        assert_eq!(s.events.len(), 2);
        assert_eq!(s.events[1].rst_relation.as_deref(), Some("elaboration"));
        let exp = s.expected.unwrap();
        assert_eq!(exp.faithfulness_min, Some(0.85));
        assert_eq!(exp.discourse.len(), 2);
        assert_eq!(exp.discourse[0].reference_form.as_deref(), Some("Pronoun"));
        assert_eq!(
            exp.discourse[1].connective_contains.as_deref(),
            Some("also")
        );
    }

    #[test]
    fn parse_array_context_value() {
        let toml_str = r#"
            name = "list"
            [[events]]
            template = "code.modified"
            context = { name = "X", consumers = ["a", "b", "c"] }
        "#;
        let s: Scenario = toml::from_str(toml_str).unwrap();
        let arr = s.events[0]
            .context
            .get("consumers")
            .unwrap()
            .as_array()
            .unwrap();
        assert_eq!(arr.len(), 3);
        assert_eq!(arr[0].as_str().unwrap(), "a");
    }
}