modo-rs 0.8.0

Rust web framework for small monolithic apps
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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
use std::fmt::Write;

use crate::qrcode::error::QrError;
use crate::qrcode::style::{FinderShape, ModuleShape, QrStyle};

/// Render a QR code matrix as an SVG string.
pub(super) fn render_svg(qr: &fast_qr::QRCode, style: &QrStyle) -> Result<String, QrError> {
    let fg = style.fg_color.to_hex()?;
    let bg = style.bg_color.to_hex()?;
    let m = style.module_size as f64;
    let q = style.quiet_zone as f64 * m;
    let total = qr.size as f64 * m + 2.0 * q;

    let mut svg = String::with_capacity(4096);

    // SVG header — viewBox only, no width/height
    write!(
        svg,
        r#"<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 {total} {total}">"#,
    )
    .unwrap();

    // Background
    write!(svg, r#"<rect fill="{bg}" width="100%" height="100%"/>"#,).unwrap();

    // Render the three finder patterns as grouped elements
    render_finder(style, &mut svg, &fg, &bg, 0, 0); // top-left
    render_finder(style, &mut svg, &fg, &bg, 0, qr.size - 7); // top-right
    render_finder(style, &mut svg, &fg, &bg, qr.size - 7, 0); // bottom-left

    // Render data modules (skip finder regions)
    for row in 0..qr.size {
        for col in 0..qr.size {
            if is_finder_region(row, col, qr.size) {
                continue;
            }
            if !qr[row][col].value() {
                continue; // light module — skip
            }
            let x = q + col as f64 * m;
            let y = q + row as f64 * m;
            render_module(&mut svg, &style.module_shape, x, y, m, &fg);
        }
    }

    svg.push_str("</svg>");
    Ok(svg)
}

/// Check if a cell falls within one of the three 7×7 finder pattern regions.
fn is_finder_region(row: usize, col: usize, size: usize) -> bool {
    let in_top_left = row < 7 && col < 7;
    let in_top_right = row < 7 && col >= size - 7;
    let in_bottom_left = row >= size - 7 && col < 7;
    in_top_left || in_top_right || in_bottom_left
}

/// Render a single data module based on the chosen shape.
fn render_module(svg: &mut String, shape: &ModuleShape, x: f64, y: f64, m: f64, fg: &str) {
    match shape {
        ModuleShape::Square => {
            write!(
                svg,
                r#"<rect x="{x}" y="{y}" width="{m}" height="{m}" fill="{fg}"/>"#
            )
            .unwrap();
        }
        ModuleShape::RoundedSquare { radius } => {
            let r = radius.clamp(0.0, 0.5) as f64 * m;
            write!(
                svg,
                r#"<rect x="{x}" y="{y}" width="{m}" height="{m}" rx="{r}" ry="{r}" fill="{fg}"/>"#,
            )
            .unwrap();
        }
        ModuleShape::Circle => {
            let cx = x + m / 2.0;
            let cy = y + m / 2.0;
            let r = m / 2.0;
            write!(svg, r#"<circle cx="{cx}" cy="{cy}" r="{r}" fill="{fg}"/>"#).unwrap();
        }
        ModuleShape::Diamond => {
            let cx = x + m / 2.0;
            write!(
                svg,
                r#"<polygon points="{cx},{y} {},{} {cx},{} {x},{}" fill="{fg}"/>"#,
                x + m,
                y + m / 2.0,
                y + m,
                y + m / 2.0,
            )
            .unwrap();
        }
    }
}

/// Render a 7×7 finder pattern as a group of concentric shapes.
fn render_finder(
    style: &QrStyle,
    svg: &mut String,
    fg: &str,
    bg: &str,
    start_row: usize,
    start_col: usize,
) {
    let m = style.module_size as f64;
    let q = style.quiet_zone as f64 * m;
    let x = q + start_col as f64 * m;
    let y = q + start_row as f64 * m;

    svg.push_str("<g>");

    match style.finder_shape {
        FinderShape::Square => {
            // Outer 7×7
            let s7 = 7.0 * m;
            write!(
                svg,
                r#"<rect x="{x}" y="{y}" width="{s7}" height="{s7}" fill="{fg}"/>"#
            )
            .unwrap();
            // Middle 5×5 (background gap)
            let s5 = 5.0 * m;
            let x5 = x + m;
            let y5 = y + m;
            write!(
                svg,
                r#"<rect x="{x5}" y="{y5}" width="{s5}" height="{s5}" fill="{bg}"/>"#
            )
            .unwrap();
            // Inner 3×3
            let s3 = 3.0 * m;
            let x3 = x + 2.0 * m;
            let y3 = y + 2.0 * m;
            write!(
                svg,
                r#"<rect x="{x3}" y="{y3}" width="{s3}" height="{s3}" fill="{fg}"/>"#
            )
            .unwrap();
        }
        FinderShape::Rounded => {
            let r_outer = m * 0.5;
            let r_mid = m * 0.4;
            let r_inner = m * 0.3;

            let s7 = 7.0 * m;
            write!(
                svg,
                r#"<rect x="{x}" y="{y}" width="{s7}" height="{s7}" rx="{r_outer}" ry="{r_outer}" fill="{fg}"/>"#,
            )
            .unwrap();
            let s5 = 5.0 * m;
            let x5 = x + m;
            let y5 = y + m;
            write!(
                svg,
                r#"<rect x="{x5}" y="{y5}" width="{s5}" height="{s5}" rx="{r_mid}" ry="{r_mid}" fill="{bg}"/>"#,
            )
            .unwrap();
            let s3 = 3.0 * m;
            let x3 = x + 2.0 * m;
            let y3 = y + 2.0 * m;
            write!(
                svg,
                r#"<rect x="{x3}" y="{y3}" width="{s3}" height="{s3}" rx="{r_inner}" ry="{r_inner}" fill="{fg}"/>"#,
            )
            .unwrap();
        }
        FinderShape::Circle => {
            let center_x = x + 3.5 * m;
            let center_y = y + 3.5 * m;

            let r_outer = 3.5 * m;
            write!(
                svg,
                r#"<circle cx="{center_x}" cy="{center_y}" r="{r_outer}" fill="{fg}"/>"#,
            )
            .unwrap();
            let r_mid = 2.5 * m;
            write!(
                svg,
                r#"<circle cx="{center_x}" cy="{center_y}" r="{r_mid}" fill="{bg}"/>"#,
            )
            .unwrap();
            let r_inner = 1.5 * m;
            write!(
                svg,
                r#"<circle cx="{center_x}" cy="{center_y}" r="{r_inner}" fill="{fg}"/>"#,
            )
            .unwrap();
        }
    }

    svg.push_str("</g>");
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::qrcode::code::QrCode;
    use crate::qrcode::style::{Color, QrStyle};

    fn make_qr() -> QrCode {
        QrCode::new("https://example.com").unwrap()
    }

    #[test]
    fn svg_starts_with_tag() {
        let qr = make_qr();
        let svg = render_svg(&qr.qr, &QrStyle::default()).unwrap();
        assert!(svg.starts_with("<svg"));
    }

    #[test]
    fn svg_ends_with_closing_tag() {
        let qr = make_qr();
        let svg = render_svg(&qr.qr, &QrStyle::default()).unwrap();
        assert!(svg.ends_with("</svg>"));
    }

    #[test]
    fn svg_has_viewbox() {
        let qr = make_qr();
        let svg = render_svg(&qr.qr, &QrStyle::default()).unwrap();
        assert!(svg.contains("viewBox"));
    }

    #[test]
    fn svg_has_xmlns() {
        let qr = make_qr();
        let svg = render_svg(&qr.qr, &QrStyle::default()).unwrap();
        assert!(svg.contains(r#"xmlns="http://www.w3.org/2000/svg""#));
    }

    #[test]
    fn svg_has_background_rect() {
        let qr = make_qr();
        let svg = render_svg(&qr.qr, &QrStyle::default()).unwrap();
        assert!(svg.contains("fill=\"#ffffff\""));
        assert!(svg.contains("width=\"100%\""));
    }

    #[test]
    fn square_modules_produce_rect_elements() {
        let qr = make_qr();
        let style = QrStyle {
            module_shape: ModuleShape::Square,
            finder_shape: FinderShape::Square,
            ..Default::default()
        };
        let svg = render_svg(&qr.qr, &style).unwrap();
        assert!(svg.contains("<rect x="));
    }

    #[test]
    fn rounded_modules_produce_rx_ry() {
        let qr = make_qr();
        let style = QrStyle {
            module_shape: ModuleShape::RoundedSquare { radius: 0.3 },
            ..Default::default()
        };
        let svg = render_svg(&qr.qr, &style).unwrap();
        assert!(svg.contains("rx="));
        assert!(svg.contains("ry="));
    }

    #[test]
    fn circle_modules_produce_circle_elements() {
        let qr = make_qr();
        let style = QrStyle {
            module_shape: ModuleShape::Circle,
            ..Default::default()
        };
        let svg = render_svg(&qr.qr, &style).unwrap();
        let circle_count = svg.matches("<circle").count();
        assert!(
            circle_count > 3,
            "expected data circles, got {circle_count}"
        );
    }

    #[test]
    fn diamond_modules_produce_polygon_elements() {
        let qr = make_qr();
        let style = QrStyle {
            module_shape: ModuleShape::Diamond,
            ..Default::default()
        };
        let svg = render_svg(&qr.qr, &style).unwrap();
        assert!(svg.contains("<polygon"));
    }

    #[test]
    fn square_finders_produce_concentric_rects() {
        let qr = make_qr();
        let style = QrStyle {
            finder_shape: FinderShape::Square,
            module_shape: ModuleShape::Diamond,
            ..Default::default()
        };
        let svg = render_svg(&qr.qr, &style).unwrap();
        let g_count = svg.matches("<g>").count();
        assert_eq!(g_count, 3, "expected 3 finder groups");
    }

    #[test]
    fn rounded_finders_have_rounded_rects() {
        let qr = make_qr();
        let style = QrStyle {
            finder_shape: FinderShape::Rounded,
            module_shape: ModuleShape::Diamond,
            ..Default::default()
        };
        let svg = render_svg(&qr.qr, &style).unwrap();
        let g_start = svg.find("<g>").unwrap();
        let g_end = svg[g_start..].find("</g>").unwrap() + g_start;
        let finder_group = &svg[g_start..g_end];
        assert!(finder_group.contains("rx="));
    }

    #[test]
    fn circle_finders_produce_circle_elements() {
        let qr = make_qr();
        let style = QrStyle {
            finder_shape: FinderShape::Circle,
            module_shape: ModuleShape::Square,
            ..Default::default()
        };
        let svg = render_svg(&qr.qr, &style).unwrap();
        let g_start = svg.find("<g>").unwrap();
        let g_end = svg.rfind("</g>").unwrap() + 4;
        let finder_section = &svg[g_start..g_end];
        let circle_count = finder_section.matches("<circle").count();
        assert_eq!(
            circle_count, 9,
            "expected 9 finder circles, got {circle_count}"
        );
    }

    #[test]
    fn custom_colors_appear_in_svg() {
        let qr = make_qr();
        let style = QrStyle {
            fg_color: Color::Hex("#1a1a2e".into()),
            bg_color: Color::Hex("#e0e0e0".into()),
            ..Default::default()
        };
        let svg = render_svg(&qr.qr, &style).unwrap();
        assert!(svg.contains("#1a1a2e"));
        assert!(svg.contains("#e0e0e0"));
    }

    #[test]
    fn rgb_colors_work() {
        let qr = make_qr();
        let style = QrStyle {
            fg_color: Color::Rgb(255, 0, 0),
            bg_color: Color::Rgb(0, 0, 255),
            ..Default::default()
        };
        let svg = render_svg(&qr.qr, &style).unwrap();
        assert!(svg.contains("#ff0000"));
        assert!(svg.contains("#0000ff"));
    }

    #[test]
    fn invalid_color_returns_error() {
        let qr = make_qr();
        let style = QrStyle {
            fg_color: Color::Hex("not-a-color".into()),
            ..Default::default()
        };
        let err = render_svg(&qr.qr, &style).unwrap_err();
        assert_eq!(err, QrError::InvalidColor("not-a-color".into()));
    }

    #[test]
    fn viewbox_accounts_for_quiet_zone() {
        let qr = make_qr();
        let style = QrStyle {
            module_size: 10,
            quiet_zone: 4,
            ..Default::default()
        };
        let svg = render_svg(&qr.qr, &style).unwrap();
        let expected_total = (qr.size() as f64 * 10.0 + 2.0 * 4.0 * 10.0) as u32;
        let viewbox = format!("viewBox=\"0 0 {0} {0}\"", expected_total);
        assert!(svg.contains(&viewbox), "expected {viewbox} in SVG");
    }

    #[test]
    fn radius_above_half_is_clamped() {
        let qr = make_qr();
        let style = QrStyle {
            module_shape: ModuleShape::RoundedSquare { radius: 0.8 },
            ..Default::default()
        };
        // Should not error — just clamps
        let svg = render_svg(&qr.qr, &style).unwrap();
        assert!(svg.contains("rx="));
    }

    #[test]
    fn negative_radius_is_clamped_to_zero() {
        let qr = make_qr();
        let style = QrStyle {
            module_shape: ModuleShape::RoundedSquare { radius: -1.0 },
            ..Default::default()
        };
        let svg = render_svg(&qr.qr, &style).unwrap();
        assert!(svg.contains("rx="));
    }

    #[test]
    fn finder_region_detects_top_left() {
        assert!(is_finder_region(0, 0, 25));
        assert!(is_finder_region(6, 6, 25));
        assert!(!is_finder_region(7, 0, 25));
        assert!(!is_finder_region(0, 7, 25));
    }

    #[test]
    fn finder_region_detects_top_right() {
        assert!(is_finder_region(0, 18, 25));
        assert!(is_finder_region(6, 24, 25));
        assert!(!is_finder_region(7, 18, 25));
    }

    #[test]
    fn finder_region_detects_bottom_left() {
        assert!(is_finder_region(18, 0, 25));
        assert!(is_finder_region(24, 6, 25));
        assert!(!is_finder_region(18, 7, 25));
    }

    #[test]
    fn non_finder_region() {
        assert!(!is_finder_region(10, 10, 25));
        assert!(!is_finder_region(7, 7, 25));
    }
}