sofie-engine 0.4.0

Screens: the template parser and renderer, and the component catalog.
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

#![cfg(feature = "islands")]

mod common;

use serde_json::json;
use sofie_engine::islands::{IslandBundle, IslandLinks};
use sofie_engine::{Page, Template};

const SCREEN: &str = r#"<section><h2>Orders</h2><Island id="chart" name="order-chart" props={data.summary} /></section>"#;

#[test]
fn an_island_mounts_with_the_bound_value_as_its_props() {
    let template = common::loaded("order/member/orders", SCREEN);
    let data = json!({"summary": {"count": 2, "note": "</script>"}});

    let html = template.render(&data).unwrap();

    assert_eq!(
        html,
        "<section><h2>Orders</h2><order-chart id=\"chart\"><script type=\"application/json\">\
         {\"count\":2,\"note\":\"\\u003c/script\\u003e\"}</script></order-chart></section>"
    );
    let fragment = template.render_fragment(&data, "chart").unwrap();
    assert!(
        fragment.starts_with("<order-chart id=\"chart\">"),
        "{fragment}"
    );
}

#[test]
fn props_the_data_lacks_are_an_empty_object() {
    let template = common::loaded("t", r#"<Island name="order-chart" props={data.none} />"#);

    assert_eq!(
        template.render(&json!({})).unwrap(),
        "<order-chart><script type=\"application/json\">{}</script></order-chart>"
    );
}

#[test]
fn an_island_needs_a_custom_element_name_and_its_props() {
    for (source, expected) in [
        (
            r#"<Island name="chart" props={data} />"#,
            "`chart` is no island name",
        ),
        (
            r#"<Island name="{data.tag}" props={data} />"#,
            "needs `name` as a quoted literal",
        ),
        (r#"<Island name="order-chart" />"#, "needs the `props` prop"),
    ] {
        let error = Template::parse("t", source).unwrap_err().to_string();
        assert!(error.contains(expected), "{source}: {error}");
    }
}

#[test]
fn a_page_with_islands_loads_its_areas_bundle() {
    let bundle = IslandBundle::new("member", b"export {};", b"");
    let links = IslandLinks::of(&bundle);
    let page = Page {
        title: "Orders",
        lang: "en",
        body: "<p>x</p>",
        notice: &[],
        nonce: "n0nce",
        islands: Some(&links),
        script_notices: sofie_engine::ScriptNotices::plain(),
    };

    let html = page.render();

    let script = format!(
        "<script type=\"module\" src=\"{}\" nonce=\"n0nce\" data-sofie-islands></script></head>",
        links.script
    );
    assert!(html.contains(&script), "{html}");
    assert!(html.contains(&format!(
        "<link rel=\"stylesheet\" href=\"{}\" data-sofie-islands>",
        links.stylesheet
    )));
    let plain = Page {
        islands: None,
        ..page
    };
    assert!(!plain.render().contains("data-sofie-islands"));
}

#[cfg(feature = "parse")]
#[test]
fn an_island_screen_is_the_island_parsed() {
    let data = json!({"count": 1});
    let built = sofie_engine::islands::island_screen("t", "order-chart").unwrap();
    let parsed = Template::parse("t", r#"<Island name="order-chart" props={data} />"#).unwrap();

    assert_eq!(built.render(&data).unwrap(), parsed.render(&data).unwrap());
    assert!(sofie_engine::islands::island_screen("t", "Chart").is_err());
}