diff options
| author | Lukasz Kasprzak <lukas@labunix.xyz> | 2026-08-19 11:48:30 +0200 |
|---|---|---|
| committer | Lukasz Kasprzak <lukas@labunix.xyz> | 2026-08-19 11:48:30 +0200 |
| commit | 6762ce46af3cb12bc6ae37cda762c5d95add7903 (patch) | |
| tree | bc1d8c86050d0149ff961a9a4ff838f9c474ac2a /test/test_render_golden.ml | |
| parent | 897c274fd28402159ca6d45eedc1257b1ce98696 (diff) | |
| parent | 390bc6ac5196a946c473d0dbe7760fa41837c428 (diff) | |
| download | colitur-6762ce46af3cb12bc6ae37cda762c5d95add7903.tar.gz colitur-6762ce46af3cb12bc6ae37cda762c5d95add7903.zip | |
feat: output, rendering and publishing
Gives colitur a publishable exit. Until now its only output was terminal
rows; it can now print an ordo booklet and a wall calendar, publish an
iCalendar feed people subscribe to, and serve a static JSON/XML API.
lib/render escaping (six flavours + RFC 5545 folding), a deliberately
logic-less template engine, the view model, and five
emitters (CSV, JSON, XML, iCalendar, S-expression)
CLI emit, table, render, publish -- all accepting --overlay
templates ordo booklet in six flavours, wall grid in three
schema day-v1.json and colitur-v1.xsd, the published contract
man colitur-templates.5, plus colitur.1 updates
The view model is why the engine can stay logic-less: a month grid needs
leading blank cells, week bucketing and an in-month test, and a
logic-less template can compute none of it. Shaping the data in OCaml
keeps the engine safe for untrusted templates and makes the grid
trivial.
Formats split by whether correctness is mechanical. Presentation goes
through templates; iCalendar and XML get dedicated emitters, because
folding, exclusive DTEND, stable UIDs and schema fidelity are rules a
template cannot enforce and each fails silently in a subscriber's
client rather than loudly at generation.
publish is deterministic and non-destructive: two runs produce a
byte-identical tree, and --prune removes only files a previous run
created, refusing any manifest entry that escapes the output directory.
No new dependencies. The kernel and rite modules are untouched, and
colitur day and colitur readings remain byte-identical.
Diffstat (limited to 'test/test_render_golden.ml')
| -rw-r--r-- | test/test_render_golden.ml | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/test/test_render_golden.ml b/test/test_render_golden.ml new file mode 100644 index 0000000..6340109 --- /dev/null +++ b/test/test_render_golden.ml @@ -0,0 +1,42 @@ +(* Pins the six shipped ordo booklet templates, one per flavour, under + templates/ef/, against a byte-for-byte golden render of 2027. These are + the templates a real user ships with colitur, rendered through the same + Template.render_string / View.of_days path colitur table uses -- so a + change to the view shape, the escaping rules, or the templates themselves + that alters output is caught here, not only in test_view.ml's shape + assertions. *) + +module T = Colitur_render.Template +module E = Colitur_render.Escape + +let render_template path year = + let ic = open_in_bin path in + let src = really_input_string ic (in_channel_length ic) in + close_in ic; + let ext = + match String.rindex_opt path '.' with + | Some i -> String.sub path i (String.length path - i) + | None -> "" + in + let flavour = match E.of_extension ext with Some f -> f | None -> Alcotest.failf "flavour for %s" ext in + let v = Test_view.view_of year in + match T.render_string ~flavour src v with Ok s -> s | Error e -> Alcotest.failf "%s: %s" path e + +let read path = + let ic = open_in_bin path in + let s = really_input_string ic (in_channel_length ic) in + close_in ic; + s + +let check_golden name = + let got = render_template ("../templates/ef/" ^ name) 2027 in + let want = read ("golden/" ^ Filename.remove_extension name ^ "-2027" ^ Filename.extension name) in + Alcotest.(check string) name want got + +let cases = + [ "ordo.tex"; "ordo.ms"; "ordo.html"; "ordo.adoc"; "ordo.md"; "ordo.txt"; + "grid.tex"; "grid.ms"; "grid.html" ] + +let suite = + ( "Render/golden", + List.map (fun n -> Alcotest.test_case n `Quick (fun () -> check_golden n)) cases ) |
