alix 0.8.0

A learning tool built for understanding, not just remembering.
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194

use std::sync::LazyLock;

use crate::config::Audience;

const REVIEW_HTML: &str = include_str!("../../web/alix/review.html");
const KIDS_HTML: &str = include_str!("../../web/alix-kids/kids.html");
pub(super) const THEME_CSS: &str = include_str!("../../web/shared/theme.css");
pub(super) const THEME_JS: &str = include_str!("../../web/shared/theme.js");
pub(super) const ALIX_LOGO_JS: &str = include_str!("../../web/shared/alix-logo.js");
const HEAD_HTML: &str = include_str!("../../web/shared/_head.html");
const BRAND_HTML: &str = include_str!("../../web/shared/_brand.html");

macro_rules! composed_asset_sources {
    ($body:ident, $sources:ident, $($name:literal => $path:literal),+ $(,)?) => {
        const $body: &str = concat!($(include_str!($path), "\n",)+);

        #[cfg(test)]
        pub(super) const $sources: &[&str] = &[$($name),+];
    };
}

composed_asset_sources!(REVIEW_CSS, REVIEW_CSS_SOURCES,
    "shell.css" => "../../web/alix/review/shell.css",
    "dom.css" => "../../web/alix/review/dom.css",
    "sheets.css" => "../../web/alix/review/sheets.css",
    "study.css" => "../../web/alix/review/study.css",
    "picker.css" => "../../web/alix/review/picker.css",
    "tutor.css" => "../../web/alix/review/tutor.css",
    "exam.css" => "../../web/alix/review/exam.css",
    "augment.css" => "../../web/alix/review/augment.css",
    "walk.css" => "../../web/alix/review/walk.css",
);
composed_asset_sources!(REVIEW_JS, REVIEW_JS_SOURCES,
    "contracts.js" => "../../web/alix/review/contracts.js",
    "api.js" => "../../web/alix/review/api.js",
    "model.js" => "../../web/alix/review/model.js",
    "dom.js" => "../../web/alix/review/dom.js",
    "picker.js" => "../../web/alix/review/picker.js",
    "study.js" => "../../web/alix/review/study.js",
    "tutor.js" => "../../web/alix/review/tutor.js",
    "exam.js" => "../../web/alix/review/exam.js",
    "walk.js" => "../../web/alix/review/walk.js",
    "augment.js" => "../../web/alix/review/augment.js",
    "sheets.js" => "../../web/alix/review/sheets.js",
    "app.js" => "../../web/alix/review/app.js",
);

composed_asset_sources!(KIDS_CSS, KIDS_CSS_SOURCES,
    "shell.css" => "../../web/alix-kids/kids/shell.css",
    "dom.css" => "../../web/alix-kids/kids/dom.css",
    "picker.css" => "../../web/alix-kids/kids/picker.css",
    "study.css" => "../../web/alix-kids/kids/study.css",
    "tutor.css" => "../../web/alix-kids/kids/tutor.css",
    "settings.css" => "../../web/alix-kids/kids/settings.css",
);
composed_asset_sources!(KIDS_JS, KIDS_JS_SOURCES,
    "api.js" => "../../web/alix-kids/kids/api.js",
    "model.js" => "../../web/alix-kids/kids/model.js",
    "dom.js" => "../../web/alix-kids/kids/dom.js",
    "theme.js" => "../../web/alix-kids/kids/theme.js",
    "picker.js" => "../../web/alix-kids/kids/picker.js",
    "study.js" => "../../web/alix-kids/kids/study.js",
    "tutor.js" => "../../web/alix-kids/kids/tutor.js",
    "settings.js" => "../../web/alix-kids/kids/settings.js",
    "app.js" => "../../web/alix-kids/kids/app.js",
);

#[cfg(test)]
pub(super) const REVIEW_ASSET_MANIFEST: &str = include_str!("../../web/alix/review/manifest.json");
#[cfg(test)]
pub(super) const KIDS_ASSET_MANIFEST: &str = include_str!("../../web/alix-kids/kids/manifest.json");

const PLEX_SANS_400: &[u8] = include_bytes!("../../web/shared/fonts/ibm-plex-sans-400.woff2");
const PLEX_SANS_500: &[u8] = include_bytes!("../../web/shared/fonts/ibm-plex-sans-500.woff2");
const PLEX_SANS_600: &[u8] = include_bytes!("../../web/shared/fonts/ibm-plex-sans-600.woff2");
const PLEX_SANS_700: &[u8] = include_bytes!("../../web/shared/fonts/ibm-plex-sans-700.woff2");
const PLEX_MONO_400: &[u8] = include_bytes!("../../web/shared/fonts/ibm-plex-mono-400.woff2");
const PLEX_MONO_500: &[u8] = include_bytes!("../../web/shared/fonts/ibm-plex-mono-500.woff2");
const PLEX_MONO_600: &[u8] = include_bytes!("../../web/shared/fonts/ibm-plex-mono-600.woff2");
const PLEX_MONO_700: &[u8] = include_bytes!("../../web/shared/fonts/ibm-plex-mono-700.woff2");

const BALOO2_400: &[u8] = include_bytes!("../../web/alix-kids/fonts/baloo2-400.woff2");
const BALOO2_500: &[u8] = include_bytes!("../../web/alix-kids/fonts/baloo2-500.woff2");
const BALOO2_600: &[u8] = include_bytes!("../../web/alix-kids/fonts/baloo2-600.woff2");
const BALOO2_700: &[u8] = include_bytes!("../../web/alix-kids/fonts/baloo2-700.woff2");
const BALOO2_800: &[u8] = include_bytes!("../../web/alix-kids/fonts/baloo2-800.woff2");

static REVIEW_PAGE: LazyLock<String> = LazyLock::new(|| compose_page(REVIEW_HTML));
static KIDS_PAGE: LazyLock<String> = LazyLock::new(|| compose_page(KIDS_HTML));

pub(super) fn web_asset(path: &str) -> Option<(&'static str, &'static str)> {
    match path {
        "/review.css" => Some((REVIEW_CSS, "text/css; charset=utf-8")),
        "/review.js" => Some((REVIEW_JS, "application/javascript; charset=utf-8")),
        "/kids.css" => Some((KIDS_CSS, "text/css; charset=utf-8")),
        "/kids.js" => Some((KIDS_JS, "application/javascript; charset=utf-8")),
        _ => None,
    }
}

pub(super) fn font_bytes(name: &str) -> Option<&'static [u8]> {
    match name {
        "ibm-plex-sans-400.woff2" => Some(PLEX_SANS_400),
        "ibm-plex-sans-500.woff2" => Some(PLEX_SANS_500),
        "ibm-plex-sans-600.woff2" => Some(PLEX_SANS_600),
        "ibm-plex-sans-700.woff2" => Some(PLEX_SANS_700),
        "ibm-plex-mono-400.woff2" => Some(PLEX_MONO_400),
        "ibm-plex-mono-500.woff2" => Some(PLEX_MONO_500),
        "ibm-plex-mono-600.woff2" => Some(PLEX_MONO_600),
        "ibm-plex-mono-700.woff2" => Some(PLEX_MONO_700),
        "baloo2-400.woff2" => Some(BALOO2_400),
        "baloo2-500.woff2" => Some(BALOO2_500),
        "baloo2-600.woff2" => Some(BALOO2_600),
        "baloo2-700.woff2" => Some(BALOO2_700),
        "baloo2-800.woff2" => Some(BALOO2_800),
        _ => None,
    }
}

pub(super) fn app_page(audience: Audience) -> &'static str {
    match audience {
        Audience::Adult => &REVIEW_PAGE,
        Audience::Kids => &KIDS_PAGE,
    }
}

fn compose_page(html: &str) -> String {
    html.replace("<!--%head%-->", HEAD_HTML)
        .replace("<!--%brand%-->", BRAND_HTML)
}

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

    // (block name, its custom-property names), one entry per `[data-theme=...]`
    // selector list; a block shared with `:root` is the fallback provider and
    // is skipped (it may define global tokens like fonts).
    fn pure_theme_blocks(css: &str) -> Vec<(String, Vec<String>)> {
        let mut blocks = Vec::new();
        let mut rest = css;
        while let Some(open) = rest.find('{') {
            let (selector, body_on) = rest.split_at(open);
            let close = body_on.find('}').expect("balanced css");
            let body = &body_on[1..close];
            let selector = selector.rsplit('}').next().unwrap_or(selector).trim();
            if selector.contains("[data-theme=") && !selector.contains(":root") {
                let name = selector.split('"').nth(1).unwrap_or(selector).to_string();
                let tokens = body
                    .split(';')
                    .filter_map(|declaration| {
                        let declaration = declaration.trim_start();
                        declaration.starts_with("--").then(|| {
                            declaration
                                .split(':')
                                .next()
                                .unwrap_or("")
                                .trim()
                                .to_string()
                        })
                    })
                    .collect();
                blocks.push((name, tokens));
            }
            rest = &body_on[close + 1..];
        }
        blocks
    }

    #[test]
    fn every_theme_defines_every_token_any_theme_defines() {
        let blocks = pure_theme_blocks(THEME_CSS);
        assert!(blocks.len() > 10, "theme parsing broke: {}", blocks.len());
        let mut union: Vec<&str> = Vec::new();
        for (_, tokens) in &blocks {
            for token in tokens {
                if !union.contains(&token.as_str()) {
                    union.push(token);
                }
            }
        }
        for (name, tokens) in &blocks {
            let missing: Vec<&&str> = union
                .iter()
                .filter(|token| !tokens.iter().any(|t| t == **token))
                .collect();
            assert!(
                missing.is_empty(),
                "theme `{name}` omits {missing:?}; an omitted token silently \
                 inherits the dark default (light-gray text on a light theme)"
            );
        }
    }
}