workshop-rs 1.3.2

Canonical multi-locale Overwatch Workshop semantic core: catalog, parser, WIR, validation, emitter.
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

use crate::common::en;
use workshop_rs::catalog::Catalog;
use workshop_rs::settings::{self, PathPart};
use workshop_rs::{
    Action, Event, MappedText, Program, Rule, SourceMap, Value, emitter, parser, roundtrip,
    validate,
};

#[test]
fn canonical_program_operations_cover_parse_validate_inspect_emit_and_roundtrip() {
    let catalog = Catalog::builtin().expect("built-in catalog");
    let locale = en();
    let source = r#"rule ("public api") {
        event { Ongoing - Global; }
        actions { Wait(1, Ignore Condition); }
    }"#;

    let program = parser::parse_with_context(source, &catalog, &locale, &catalog)
        .expect("Workshop parses into the canonical program");
    program
        .validate()
        .expect("canonical program is structurally valid");
    validate::validate_canonical_ids(&program, &catalog)
        .expect("canonical ids resolve through the public validate API");
    assert!(program.semantic_issues(&catalog).is_empty());

    let emitted = emitter::emit(&program, &catalog, &locale).expect("canonical emission");
    let reparsed = parser::parse(&emitted, &catalog, &locale).expect("emitted Workshop reparses");
    assert!(roundtrip::equivalent(&program, &reparsed));
}

#[test]
fn settings_schema_exposes_enum_values_without_the_internal_table() {
    let definition = settings::definition(&[
        PathPart::Part("lobby"),
        PathPart::Part("enableMatchVoiceChat"),
    ])
    .expect("match voice setting is in the canonical schema");

    let enabled = definition
        .enum_members()
        .next()
        .expect("enum-backed boolean token");
    assert_eq!(enabled.domain(), "matchVoiceChat");
    assert_eq!(enabled.id(), "enabled");
    assert_eq!(enabled.english_name(), "Enabled");
}

#[test]
fn catalog_actions_and_values_are_built_by_canonical_id() {
    let catalog = Catalog::builtin().expect("built-in catalog");
    let locale = en();
    let numbers = |values: &[i32]| values.iter().copied().map(Value::from).collect::<Vec<_>>();

    let mut program = Program::new();
    program.rule(
        Rule::new("catalog calls", Event::Global)
            .action(Action::call(
                "damage",
                [Value::EventPlayer, Value::Null, Value::from(10)],
            ))
            .action(Action::call(
                "teleport",
                [
                    Value::EventPlayer,
                    Value::call("vector", numbers(&[1, 2, 3])),
                ],
            ))
            .action(Action::call(
                "setSlowMotion",
                [Value::call(
                    "countOf",
                    [Value::call("array", numbers(&[4, 5, 6]))],
                )],
            )),
    );
    program.validate().expect("catalog calls validate");
    validate::validate_canonical_ids(&program, &catalog).expect("catalog ids resolve");

    let emitted = emitter::emit(&program, &catalog, &locale).expect("catalog calls emit");
    assert!(
        emitted.contains("Damage(Event Player, Null, 10);"),
        "{emitted}"
    );
    assert!(
        emitted.contains("Teleport(Event Player, Vector(1, 2, 3));"),
        "{emitted}"
    );
    assert!(
        emitted.contains("Set Slow Motion(Count Of(Array(4, 5, 6)));"),
        "{emitted}"
    );

    let reparsed = parser::parse(&emitted, &catalog, &locale).expect("emitted Workshop reparses");
    assert!(roundtrip::equivalent(&program, &reparsed), "{emitted}");

    let actions = &reparsed.rules[0].actions;
    assert!(matches!(
        &actions[0],
        Action::Call { name, args } if name == "damage"
            && matches!(&args[..], [Value::EventPlayer, Value::Null, amount] if is_number(amount, 10.0))
    ));
    assert!(matches!(
        &actions[1],
        Action::Call { name, args } if name == "teleport"
            && matches!(&args[..], [Value::EventPlayer, position]
                if is_call(position, "vector", &[1.0, 2.0, 3.0]))
    ));
    assert!(matches!(
        &actions[2],
        Action::Call { name, args } if name == "setSlowMotion"
            && matches!(&args[..], [Value::Call { name, args }] if name == "countOf"
                && matches!(&args[..], [array] if is_call(array, "array", &[4.0, 5.0, 6.0])))
    ));
}

fn is_call(value: &Value, id: &str, numbers: &[f64]) -> bool {
    matches!(
        value,
        Value::Call { name, args } if name == id
            && args.len() == numbers.len()
            && args.iter().zip(numbers).all(|(arg, expected)| is_number(arg, *expected))
    )
}

fn is_number(value: &Value, expected: f64) -> bool {
    matches!(value, Value::Number(actual) if *actual == expected)
}

#[test]
fn mapped_text_is_constructible_outside_the_crate() {
    let catalog = Catalog::builtin().expect("built-in catalog");
    let locale = en();
    let program = parser::parse(
        r#"rule ("mapped") {
        event { Ongoing - Global; }
        actions { Wait(1, Ignore Condition); }
    }"#,
        &catalog,
        &locale,
    )
    .expect("Workshop parses");
    let text = emitter::emit(&program, &catalog, &locale).expect("canonical emission");

    let artifact = MappedText::new(text.clone(), SourceMap::extract(&program));
    assert_eq!(artifact.text, text);
    let decoded = MappedText::from_json(&artifact.to_json()).expect("artifact decodes");
    assert_eq!(decoded, artifact);
}