chartlet 0.2.0

Compile structured data into deterministic, accessible static charts
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282

use chartlet::{RenderFormat, RenderOptions, Variant, render_json};

/// Every example as name, specification and reviewed SVG.
const EXAMPLES: [(&str, &str, &str); 24] = [
    (
        "monthly-revenue",
        include_str!("../examples/monthly-revenue.json"),
        include_str!("../examples/monthly-revenue.svg"),
    ),
    (
        "quarterly-change",
        include_str!("../examples/quarterly-change.json"),
        include_str!("../examples/quarterly-change.svg"),
    ),
    (
        "budget-vs-actual",
        include_str!("../examples/budget-vs-actual.json"),
        include_str!("../examples/budget-vs-actual.svg"),
    ),
    (
        "monthly-trend",
        include_str!("../examples/monthly-trend.json"),
        include_str!("../examples/monthly-trend.svg"),
    ),
    (
        "operating-costs",
        include_str!("../examples/operating-costs.json"),
        include_str!("../examples/operating-costs.svg"),
    ),
    (
        "support-volume",
        include_str!("../examples/support-volume.json"),
        include_str!("../examples/support-volume.svg"),
    ),
    (
        "revenue-by-channel",
        include_str!("../examples/revenue-by-channel.json"),
        include_str!("../examples/revenue-by-channel.svg"),
    ),
    (
        "signup-conversion",
        include_str!("../examples/signup-conversion.json"),
        include_str!("../examples/signup-conversion.svg"),
    ),
    (
        "headcount",
        include_str!("../examples/headcount.json"),
        include_str!("../examples/headcount.svg"),
    ),
    (
        "csat-by-region",
        include_str!("../examples/csat-by-region.json"),
        include_str!("../examples/csat-by-region.svg"),
    ),
    (
        "daily-orders",
        include_str!("../examples/daily-orders.json"),
        include_str!("../examples/daily-orders.svg"),
    ),
    (
        "revenue-vs-forecast",
        include_str!("../examples/revenue-vs-forecast.json"),
        include_str!("../examples/revenue-vs-forecast.svg"),
    ),
    (
        "topicmap-sample",
        include_str!("../examples/topicmap-sample.json"),
        include_str!("../examples/topicmap-sample.svg"),
    ),
    (
        "knowledge-landscape",
        include_str!("../examples/knowledge-landscape.json"),
        include_str!("../examples/knowledge-landscape.svg"),
    ),
    (
        "temperature-projection",
        include_str!("../examples/temperature-projection.json"),
        include_str!("../examples/temperature-projection.svg"),
    ),
    (
        "annual-mean-threshold",
        include_str!("../examples/annual-mean-threshold.json"),
        include_str!("../examples/annual-mean-threshold.svg"),
    ),
    (
        "warming-stripes",
        include_str!("../examples/warming-stripes.json"),
        include_str!("../examples/warming-stripes.svg"),
    ),
    (
        "daily-anomaly-calendar",
        include_str!("../examples/daily-anomaly-calendar.json"),
        include_str!("../examples/daily-anomaly-calendar.svg"),
    ),
    (
        "warming-contributions",
        include_str!("../examples/warming-contributions.json"),
        include_str!("../examples/warming-contributions.svg"),
    ),
    (
        "emission-pathways",
        include_str!("../examples/emission-pathways.json"),
        include_str!("../examples/emission-pathways.svg"),
    ),
    (
        "sensor-readings",
        include_str!("../examples/sensor-readings.json"),
        include_str!("../examples/sensor-readings.svg"),
    ),
    (
        "release-incidents",
        include_str!("../examples/release-incidents.json"),
        include_str!("../examples/release-incidents.svg"),
    ),
    (
        "share-price",
        include_str!("../examples/share-price.json"),
        include_str!("../examples/share-price.svg"),
    ),
    (
        "mobile-revenue",
        include_str!("../examples/mobile-revenue.json"),
        include_str!("../examples/mobile-revenue.svg"),
    ),
];

/// Examples with a mobile variant, and its reviewed SVG.
const MOBILE_EXAMPLES: [(&str, &str, &str); 1] = [(
    "mobile-revenue",
    include_str!("../examples/mobile-revenue.json"),
    include_str!("../examples/mobile-revenue.mobile.svg"),
)];

/// Examples with a reviewed print variant: hatched bands and modeled lines on a light chart, and
/// a dark chart with a color declared as a CSS variable.
const PRINT_EXAMPLES: [(&str, &str, &str); 2] = [
    (
        "temperature-projection",
        include_str!("../examples/temperature-projection.json"),
        include_str!("../examples/temperature-projection.print.svg"),
    ),
    (
        "revenue-vs-forecast",
        include_str!("../examples/revenue-vs-forecast.json"),
        include_str!("../examples/revenue-vs-forecast.print.svg"),
    ),
];

/// Examples with a reviewed social variant.
const SOCIAL_EXAMPLES: [(&str, &str, &str); 1] = [(
    "temperature-projection",
    include_str!("../examples/temperature-projection.json"),
    include_str!("../examples/temperature-projection.social.svg"),
)];

/// The committed SVGs are the reviewed reference output. Each example must render to exactly the
/// bytes that are checked into `examples/`, on every supported platform.
#[test]
fn every_example_matches_its_reviewed_svg() {
    for (name, specification, expected) in EXAMPLES {
        let actual = render_json(specification, RenderFormat::Svg, &RenderOptions::default())
            .unwrap_or_else(|error| panic!("{name} should render: {error}"));
        assert_eq!(
            actual.content, expected,
            "{name} drifted from its reviewed SVG"
        );
    }
}

/// The mobile variant is reference output too.
#[test]
fn every_mobile_variant_matches_its_reviewed_svg() {
    for (name, specification, expected) in MOBILE_EXAMPLES {
        let actual = render_json(
            specification,
            RenderFormat::Svg,
            &RenderOptions {
                variant: Variant::Mobile,
                ..RenderOptions::default()
            },
        )
        .unwrap_or_else(|error| panic!("{name} should render its mobile variant: {error}"));
        assert_eq!(
            actual.content, expected,
            "{name} drifted from its reviewed mobile SVG"
        );
    }
}

fn print_options() -> RenderOptions {
    RenderOptions {
        variant: Variant::Print,
        ..RenderOptions::default()
    }
}

/// The print variant is reference output too.
#[test]
fn every_print_variant_matches_its_reviewed_svg() {
    for (name, specification, expected) in PRINT_EXAMPLES {
        let actual = render_json(specification, RenderFormat::Svg, &print_options())
            .unwrap_or_else(|error| panic!("{name} should render its print variant: {error}"));
        assert_eq!(
            actual.content, expected,
            "{name} drifted from its reviewed print SVG"
        );
    }
}

/// No example's print variant leaves a color to CSS custom properties, `currentColor` or a rule
/// that needs a browser.
#[test]
fn every_print_variant_carries_literal_colors_only() {
    for (name, specification, _) in EXAMPLES {
        let svg = render_json(specification, RenderFormat::Svg, &print_options())
            .unwrap_or_else(|error| panic!("{name} should render its print variant: {error}"))
            .content;
        for needle in [
            "var(",
            "--chartlet",
            "currentColor",
            ":has(",
            "@container",
            "[class",
        ] {
            assert!(
                !svg.contains(needle),
                "{name}'s print variant contains {needle}"
            );
        }
    }
}

/// The social variant is reference output too.
#[test]
fn every_social_variant_matches_its_reviewed_svg() {
    for (name, specification, expected) in SOCIAL_EXAMPLES {
        let actual = render_json(
            specification,
            RenderFormat::Svg,
            &RenderOptions {
                variant: Variant::Social,
                ..RenderOptions::default()
            },
        )
        .unwrap_or_else(|error| panic!("{name} should render its social variant: {error}"));
        assert_eq!(
            actual.content, expected,
            "{name} drifted from its reviewed social SVG"
        );
    }
}

/// Every example renders a social variant at 1200 × 630 with literal colors only and without the
/// tooltips of its marks.
#[test]
fn every_social_variant_is_a_resolved_1200_by_630_canvas() {
    for (name, specification, _) in EXAMPLES {
        let svg = render_json(
            specification,
            RenderFormat::Svg,
            &RenderOptions {
                variant: Variant::Social,
                ..RenderOptions::default()
            },
        )
        .unwrap_or_else(|error| panic!("{name} should render its social variant: {error}"))
        .content;
        assert!(
            svg.starts_with(
                "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"1200\" height=\"630\" viewBox=\"0 0 1200 630\""
            ),
            "{name}'s social variant is not 1200 × 630"
        );
        for needle in ["var(", "--chartlet", "currentColor", ":has(", "<title>"] {
            assert!(
                !svg.contains(needle),
                "{name}'s social variant contains {needle}"
            );
        }
    }
}