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
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

#![cfg(all(feature = "i18n", feature = "islands"))]

mod common;

use serde_json::{Value, json};
use sofie_engine::rendering::Rendering;
use sofie_engine::{Submitted, Template, Translations};
use sofie_values::{Control, FormField, Input};

struct Screen {
    key: &'static str,
    source: &'static str,
    data: Value,
    ids: &'static [&'static str],
    form: Option<(&'static str, &'static str)>,
}

const CREDENTIALS: &[FormField] = &[
    FormField {
        name: "email",
        input: Input::typed(&[("type", "email")]),
        required: true,
        constraints: &[],
    },
    FormField {
        name: "password",
        input: Input::new(Control::Password),
        required: true,
        constraints: &[],
    },
];

fn screens() -> Vec<Screen> {
    let credentials = json!({"action": "/sign-in", "other": "/sign-up?next=<a>"});
    vec![
        Screen {
            key: "order/customer/orders",
            source: include_str!(
                "../../../examples/shop/modules/order/src/areas/customer/screens/orders.html"
            ),
            data: json!([
                {"id": 1, "status": "PLACED", "total": {"minor": 1250, "currency": "EUR"},
                 "status_to": {"CANCELLED": true}},
                {"id": 2, "status": "CANCELLED", "total": {"minor": 99, "currency": "EUR"},
                 "status_to": {"CANCELLED": false}},
            ]),
            ids: &["orders", "place-order", "sign-out"],
            form: Some(("place-order", "/account/orders")),
        },
        Screen {
            key: "board/web/summary",
            source: include_str!(
                "../../../examples/islands/modules/board/src/areas/web/screens/summary.html"
            ),
            data: json!({"title": "Notes <&>", "words": 3}),
            ids: &[],
            form: None,
        },
        Screen {
            key: "sofie_identity/web/sign_in",
            source: include_str!("../../sofie-identity/src/screens/sign_in.html"),
            data: credentials.clone(),
            ids: &["sign-in"],
            form: Some(("sign-in", "/sign-in")),
        },
        Screen {
            key: "sofie_identity/web/sign_up",
            source: include_str!("../../sofie-identity/src/screens/sign_up.html"),
            data: credentials,
            ids: &["sign-up"],
            form: Some(("sign-up", "/sign-in")),
        },
        Screen {
            key: "sofie_identity/console/flags",
            source: include_str!("../../sofie-identity/src/permitted/screens/flags.html"),
            data: json!([{"name": "order.split_payments", "on": true}]),
            ids: &["flags", "switch"],
            form: None,
        },
        Screen {
            key: "sofie_identity/console/shield",
            source: include_str!("../../sofie-identity/src/permitted/screens/shield.html"),
            data: json!([{"id": 1, "caller": "10.0.0.1", "rule": "sign_in", "grade": 2,
                          "until": "2026-10-12T10:00:00Z"}]),
            ids: &["blocks", "lift"],
            form: None,
        },
    ]
}

fn described(template: &mut Template, screen: &Screen) {
    if let Some((form, _)) = screen
        .form
        .filter(|_| screen.key.starts_with("sofie_identity"))
    {
        template.describe_form(form, CREDENTIALS).unwrap();
    }
}

/// Everything a request may ask of a screen, rendered from one program.
fn renders(template: &Template, screen: &Screen, translations: &Translations) -> Vec<String> {
    let mut html = Vec::new();
    for language in ["en", "de", "tr"] {
        let rendering =
            Rendering::new(template).language(translations.negotiate(None, Some(language)));
        html.push(rendering.render(&screen.data).unwrap());
        for id in screen.ids {
            html.push(rendering.render_fragment(&screen.data, id).unwrap());
            html.push(rendering.render_out_of_band(&screen.data, id).unwrap());
        }
        if let Some((_, action)) = screen.form {
            let input = json!({"email": "typed <@>", "password": "x"});
            let errors = [("email", "is taken".to_owned())];
            let submitted = Submitted {
                action,
                input: &input,
                errors: &errors,
            };
            html.push(
                rendering
                    .render_submitted(&screen.data, &submitted)
                    .unwrap(),
            );
        }
    }
    html
}

#[test]
fn every_shipped_screen_renders_the_same_from_its_compiled_program() {
    let translations = Translations::new(&["en", "de", "tr"]).unwrap();
    for screen in screens() {
        let mut parsed = Template::parse(screen.key, screen.source).unwrap();
        let mut loaded = common::loaded(screen.key, screen.source);
        described(&mut parsed, &screen);
        described(&mut loaded, &screen);

        let expected = renders(&parsed, &screen, &translations);
        assert_eq!(
            renders(&loaded, &screen, &translations),
            expected,
            "{}",
            screen.key
        );
        assert!(
            expected.iter().all(|html| !html.is_empty()),
            "{}",
            screen.key
        );
    }
}