zenith-tool 0.0.4

The Zenith command-line interface (the `zenith` binary) for the design-document toolchain.
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
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
use super::*;
use zenith_core::resolve_tokens;

// A small doc with page → group → [rect, ellipse], plus a top-level text.
const SMALL_DOC: &str = r##"zenith version=1 {
  project id="proj.1" name="Inspect Test"
  tokens format="zenith-token-v1" {}
  styles {}
  document id="doc.1" title="Inspect Test" {
    page id="page.1" w=(px)800 h=(px)600 {
      group id="group.1" x=(px)10 y=(px)20 w=(px)300 h=(px)200 {
        rect id="rect.1" x=(px)10 y=(px)20 w=(px)100 h=(px)50
        ellipse id="ellipse.1" x=(px)120 y=(px)20 w=(px)80 h=(px)80
      }
      text id="text.1" x=(px)0 y=(px)250 w=(px)400 h=(px)40
    }
  }
}
"##;

// A doc with a hidden and locked node.
const FLAGS_DOC: &str = r##"zenith version=1 {
  project id="proj.f" name="Flags Test"
  tokens format="zenith-token-v1" {}
  styles {}
  document id="doc.f" title="Flags Test" {
    page id="page.f" w=(px)400 h=(px)300 {
      rect id="rect.hidden" x=(px)0 y=(px)0 w=(px)100 h=(px)100 visible=#false
      rect id="rect.locked" x=(px)0 y=(px)0 w=(px)100 h=(px)100 locked=#true
    }
  }
}
"##;

// ── build_doc_tree ────────────────────────────────────────────────────────

#[test]
fn doc_tree_page_count() {
    let doc = KdlAdapter.parse(SMALL_DOC.as_bytes()).unwrap();
    let pages = build_doc_tree(&doc.body.pages, &resolve_tokens(&doc.tokens).resolved);
    assert_eq!(pages.len(), 1, "expected exactly 1 page");
}

#[test]
fn doc_tree_page_dimensions() {
    let doc = KdlAdapter.parse(SMALL_DOC.as_bytes()).unwrap();
    let pages = build_doc_tree(&doc.body.pages, &resolve_tokens(&doc.tokens).resolved);
    let page = &pages[0];
    assert_eq!(page.width, 800.0);
    assert_eq!(page.height, 600.0);
}

#[test]
fn doc_tree_page_children_order() {
    let doc = KdlAdapter.parse(SMALL_DOC.as_bytes()).unwrap();
    let pages = build_doc_tree(&doc.body.pages, &resolve_tokens(&doc.tokens).resolved);
    let children = &pages[0].children;
    // Top-level: group.1 then text.1 (source order).
    assert_eq!(children.len(), 2);
    assert_eq!(children[0].id, "group.1");
    assert_eq!(children[0].kind, "group");
    assert_eq!(children[1].id, "text.1");
    assert_eq!(children[1].kind, "text");
}

#[test]
fn doc_tree_group_children() {
    let doc = KdlAdapter.parse(SMALL_DOC.as_bytes()).unwrap();
    let pages = build_doc_tree(&doc.body.pages, &resolve_tokens(&doc.tokens).resolved);
    let group = &pages[0].children[0];
    assert_eq!(group.children.len(), 2, "group must have 2 children");
    assert_eq!(group.children[0].id, "rect.1");
    assert_eq!(group.children[0].kind, "rect");
    assert_eq!(group.children[1].id, "ellipse.1");
    assert_eq!(group.children[1].kind, "ellipse");
}

#[test]
fn doc_tree_geometry_values() {
    let doc = KdlAdapter.parse(SMALL_DOC.as_bytes()).unwrap();
    let pages = build_doc_tree(&doc.body.pages, &resolve_tokens(&doc.tokens).resolved);
    let rect = &pages[0].children[0].children[0]; // group.1 → rect.1
    let geom = rect.geometry.as_ref().unwrap();
    assert_eq!(geom.x, Some(10.0));
    assert_eq!(geom.y, Some(20.0));
    assert_eq!(geom.w, Some(100.0));
    assert_eq!(geom.h, Some(50.0));
}

// ── token-resolved geometry + role ────────────────────────────────────────

// A doc whose geometry mixes px literals with `(token)` dimension refs (one a
// direct dimension, one an alias chain), plus an authored `role`, so we can
// assert that inspect resolves refs to px and surfaces the role.
const TOKEN_GEOM_DOC: &str = r##"zenith version=1 {
  project id="proj.tk" name="Token Geom"
  tokens format="zenith-token-v1" {
    token id="size.rule" type="dimension" value=(px)8
    token id="size.rule.alias" type="dimension" value=(token)"size.rule"
  }
  styles {}
  document id="doc.tk" title="Token Geom" {
    page id="page.tk" w=(px)800 h=(px)600 {
      rect id="bar" role="accent-rule" x=(px)96 y=(px)100 w=(px)200 h=(token)"size.rule"
      rect id="bar.alias" x=(px)96 y=(px)200 w=(px)200 h=(token)"size.rule.alias"
      rect id="bar.missing" x=(px)96 y=(px)300 w=(px)200 h=(token)"size.absent"
    }
  }
}
"##;

#[test]
fn token_ref_dimension_resolves_to_px() {
    let doc = KdlAdapter.parse(TOKEN_GEOM_DOC.as_bytes()).unwrap();
    let pages = build_doc_tree(&doc.body.pages, &resolve_tokens(&doc.tokens).resolved);
    let bar = &pages[0].children[0];
    let geom = bar.geometry.as_ref().unwrap();
    // Direct dimension token `size.rule` → 8px.
    assert_eq!(geom.h, Some(8.0), "direct token ref must resolve to px");
    assert_eq!(geom.w, Some(200.0), "px literal unchanged");
}

#[test]
fn token_ref_alias_chain_resolves() {
    let doc = KdlAdapter.parse(TOKEN_GEOM_DOC.as_bytes()).unwrap();
    let pages = build_doc_tree(&doc.body.pages, &resolve_tokens(&doc.tokens).resolved);
    let alias = &pages[0].children[1];
    assert_eq!(
        alias.geometry.as_ref().unwrap().h,
        Some(8.0),
        "alias chain to a dimension token must resolve"
    );
}

#[test]
fn token_ref_missing_token_is_none() {
    let doc = KdlAdapter.parse(TOKEN_GEOM_DOC.as_bytes()).unwrap();
    let pages = build_doc_tree(&doc.body.pages, &resolve_tokens(&doc.tokens).resolved);
    let missing = &pages[0].children[2];
    assert_eq!(
        missing.geometry.as_ref().unwrap().h,
        None,
        "an unresolvable token ref must stay None (field omitted)"
    );
}

#[test]
fn role_is_surfaced_when_authored() {
    let doc = KdlAdapter.parse(TOKEN_GEOM_DOC.as_bytes()).unwrap();
    let pages = build_doc_tree(&doc.body.pages, &resolve_tokens(&doc.tokens).resolved);
    assert_eq!(pages[0].children[0].role.as_deref(), Some("accent-rule"));
    assert_eq!(pages[0].children[1].role, None, "no role → None");
}

#[test]
fn role_emitted_in_json_and_omitted_when_absent() {
    let out = run(TOKEN_GEOM_DOC, None, true).expect("run must succeed");
    let v: serde_json::Value = serde_json::from_str(&out).unwrap();
    let children = v["pages"][0]["children"].as_array().unwrap();
    assert_eq!(children[0]["role"], "accent-rule");
    assert_eq!(children[0]["geometry"]["h"], 8.0);
    // A node without a role must omit the field entirely.
    assert!(
        children[1].get("role").is_none(),
        "role must be absent in JSON when not authored"
    );
}

// ── find_node_tree ────────────────────────────────────────────────────────

#[test]
fn find_top_level_node() {
    let doc = KdlAdapter.parse(SMALL_DOC.as_bytes()).unwrap();
    let found = find_node_tree(
        &doc.body.pages,
        "text.1",
        &resolve_tokens(&doc.tokens).resolved,
    );
    assert!(found.is_some(), "text.1 must be found");
    let e = found.unwrap();
    assert_eq!(e.id, "text.1");
    assert_eq!(e.kind, "text");
}

#[test]
fn find_nested_node() {
    let doc = KdlAdapter.parse(SMALL_DOC.as_bytes()).unwrap();
    let found = find_node_tree(
        &doc.body.pages,
        "ellipse.1",
        &resolve_tokens(&doc.tokens).resolved,
    );
    assert!(found.is_some(), "ellipse.1 must be found inside group");
    let e = found.unwrap();
    assert_eq!(e.id, "ellipse.1");
    assert_eq!(e.kind, "ellipse");
}

#[test]
fn find_container_node_includes_children() {
    let doc = KdlAdapter.parse(SMALL_DOC.as_bytes()).unwrap();
    let found = find_node_tree(
        &doc.body.pages,
        "group.1",
        &resolve_tokens(&doc.tokens).resolved,
    );
    assert!(found.is_some(), "group.1 must be found");
    let group = found.unwrap();
    assert_eq!(
        group.children.len(),
        2,
        "group subtree must include 2 children"
    );
    // Children must be in source order.
    assert_eq!(group.children[0].id, "rect.1");
    assert_eq!(group.children[1].id, "ellipse.1");
}

#[test]
fn find_missing_node_returns_none() {
    let doc = KdlAdapter.parse(SMALL_DOC.as_bytes()).unwrap();
    let found = find_node_tree(
        &doc.body.pages,
        "nonexistent.node",
        &resolve_tokens(&doc.tokens).resolved,
    );
    assert!(found.is_none());
}

// ── run() integration ─────────────────────────────────────────────────────

#[test]
fn run_human_whole_doc() {
    let out = run(SMALL_DOC, None, false).expect("run must succeed");
    assert!(out.contains("page page.1"), "must contain page line");
    assert!(out.contains("group group.1"), "must contain group line");
    assert!(out.contains("rect rect.1"), "must contain rect line");
    assert!(out.contains("ellipse ellipse.1"), "must contain ellipse");
    assert!(out.contains("text text.1"), "must contain text");
}

#[test]
fn run_human_indentation() {
    let out = run(SMALL_DOC, None, false).expect("run must succeed");
    // group is indented 2 spaces (depth 1), rect is indented 4 (depth 2).
    let group_line = out.lines().find(|l| l.contains("group.1")).unwrap();
    let rect_line = out.lines().find(|l| l.contains("rect.1")).unwrap();
    assert!(
        group_line.starts_with("  "),
        "group must be at depth 1 (2 spaces)"
    );
    assert!(
        rect_line.starts_with("    "),
        "rect must be at depth 2 (4 spaces)"
    );
}

#[test]
fn run_human_flags() {
    let out = run(FLAGS_DOC, None, false).expect("run must succeed");
    assert!(
        out.contains("[hidden]"),
        "hidden node must show [hidden] flag"
    );
    assert!(
        out.contains("[locked]"),
        "locked node must show [locked] flag"
    );
}

#[test]
fn run_json_whole_doc_schema() {
    let out = run(SMALL_DOC, None, true).expect("run must succeed");
    assert!(
        out.contains("zenith-inspect-v1"),
        "JSON must have schema field"
    );
}

#[test]
fn run_json_has_pages_array() {
    let out = run(SMALL_DOC, None, true).expect("run must succeed");
    let v: serde_json::Value = serde_json::from_str(&out).expect("must be valid JSON");
    let pages = v["pages"].as_array().expect("pages must be array");
    assert_eq!(pages.len(), 1);
    assert_eq!(pages[0]["id"], "page.1");
}

#[test]
fn run_json_node_kinds_correct() {
    let out = run(SMALL_DOC, None, true).expect("run must succeed");
    let v: serde_json::Value = serde_json::from_str(&out).unwrap();
    let children = v["pages"][0]["children"].as_array().unwrap();
    assert_eq!(children[0]["kind"], "group");
    assert_eq!(children[1]["kind"], "text");
    let group_children = children[0]["children"].as_array().unwrap();
    assert_eq!(group_children[0]["kind"], "rect");
    assert_eq!(group_children[1]["kind"], "ellipse");
}

#[test]
fn run_node_flag_filters_subtree() {
    let out = run(SMALL_DOC, Some("group.1"), false).expect("run must succeed");
    assert!(out.contains("group group.1"), "must have root line");
    assert!(out.contains("rect rect.1"), "must include children");
    assert!(out.contains("ellipse ellipse.1"), "must include children");
    // text.1 is NOT inside group.1 so must not appear.
    assert!(
        !out.contains("text text.1"),
        "text.1 must NOT appear in group subtree"
    );
}

#[test]
fn run_node_json_flag() {
    let out = run(SMALL_DOC, Some("group.1"), true).expect("run must succeed");
    let v: serde_json::Value = serde_json::from_str(&out).unwrap();
    assert_eq!(v["schema"], "zenith-inspect-v1");
    assert_eq!(v["node"]["id"], "group.1");
    assert_eq!(v["node"]["kind"], "group");
    assert_eq!(v["node"]["children"].as_array().unwrap().len(), 2);
}

#[test]
fn run_node_missing_id_errors() {
    let result = run(SMALL_DOC, Some("does.not.exist"), false);
    assert!(result.is_err());
    let err = result.unwrap_err();
    assert_eq!(err.exit_code, 2);
    assert!(err.message.contains("does.not.exist"));
}

#[test]
fn run_parse_error_returns_err() {
    let result = run("not valid kdl {{{", None, false);
    assert!(result.is_err());
    let err = result.unwrap_err();
    assert_eq!(err.exit_code, 2);
}

// ── Table cell descent ────────────────────────────────────────────────────

// A doc with a table whose first cell contains a rect and second cell
// contains a text, so we can assert that inspect descends into cell children.
const TABLE_INSPECT_DOC: &str = r##"zenith version=1 {
  project id="proj.t" name="Table Inspect"
  tokens format="zenith-token-v1" {}
  styles {}
  document id="doc.t" title="Table Inspect" {
    page id="page.t" w=(px)640 h=(px)400 {
      table id="tbl.1" x=(px)0 y=(px)0 w=(px)400 h=(px)200 {
        column width=(px)200
        column width=(px)200
        row {
          cell {
            rect id="cell.rect.1" x=(px)0 y=(px)0 w=(px)50 h=(px)50
          }
          cell {
            text id="cell.text.1" x=(px)0 y=(px)0 w=(px)100 h=(px)30 {
              span "hi"
            }
          }
        }
      }
    }
  }
}
"##;

#[test]
fn find_node_inside_table_cell_returns_entry() {
    let doc = KdlAdapter.parse(TABLE_INSPECT_DOC.as_bytes()).unwrap();
    let found = find_node_tree(
        &doc.body.pages,
        "cell.rect.1",
        &resolve_tokens(&doc.tokens).resolved,
    );
    assert!(
        found.is_some(),
        "cell.rect.1 inside a table cell must be findable"
    );
    let e = found.unwrap();
    assert_eq!(e.id, "cell.rect.1");
    assert_eq!(e.kind, "rect");
}

#[test]
fn find_text_inside_table_cell_returns_entry() {
    let doc = KdlAdapter.parse(TABLE_INSPECT_DOC.as_bytes()).unwrap();
    let found = find_node_tree(
        &doc.body.pages,
        "cell.text.1",
        &resolve_tokens(&doc.tokens).resolved,
    );
    assert!(
        found.is_some(),
        "cell.text.1 inside a table cell must be findable"
    );
    let e = found.unwrap();
    assert_eq!(e.id, "cell.text.1");
    assert_eq!(e.kind, "text");
}

#[test]
fn run_node_flag_table_cell_child_found() {
    // `zenith inspect --node cell.rect.1` must succeed and return that node.
    let out = run(TABLE_INSPECT_DOC, Some("cell.rect.1"), false)
        .expect("inspect of cell child must succeed");
    assert!(
        out.contains("cell.rect.1"),
        "output must mention the node id; got: {out}"
    );
    assert!(
        out.contains("rect"),
        "output must mention the node kind; got: {out}"
    );
}

#[test]
fn run_node_flag_table_cell_child_not_found_errors() {
    // A nonexistent id inside a table must still return not-found.
    let result = run(TABLE_INSPECT_DOC, Some("no.such.node"), false);
    assert!(result.is_err(), "missing id must error");
    let err = result.unwrap_err();
    assert_eq!(err.exit_code, 2);
    assert!(err.message.contains("no.such.node"));
}

// ── Unknown (library) node descent ────────────────────────────────────────

// A doc with an unknown node kind (`mystery`) carrying an `id` and a known
// `rect` child, so we can assert that inspect surfaces the unknown node with
// its id and descends into its children.
const UNKNOWN_INSPECT_DOC: &str = r##"zenith version=1 {
  project id="proj.u" name="Unknown Inspect"
  tokens format="zenith-token-v1" {}
  styles {}
  document id="doc.u" title="Unknown Inspect" {
    page id="page.u" w=(px)640 h=(px)400 {
      mystery id="lib.1" {
        rect id="inner" x=(px)0 y=(px)0 w=(px)50 h=(px)50
      }
    }
  }
}
"##;

#[test]
fn doc_tree_unknown_node_shows_id_and_children() {
    let doc = KdlAdapter.parse(UNKNOWN_INSPECT_DOC.as_bytes()).unwrap();
    let pages = build_doc_tree(&doc.body.pages, &resolve_tokens(&doc.tokens).resolved);
    let unknown = &pages[0].children[0];
    assert_eq!(unknown.id, "lib.1", "unknown node must expose its id");
    assert_eq!(unknown.kind, "mystery", "unknown node keeps its kind");
    assert_eq!(
        unknown.children.len(),
        1,
        "unknown node subtree must include its child"
    );
    assert_eq!(unknown.children[0].id, "inner");
    assert_eq!(unknown.children[0].kind, "rect");
}

#[test]
fn find_unknown_node_by_id() {
    let doc = KdlAdapter.parse(UNKNOWN_INSPECT_DOC.as_bytes()).unwrap();
    let found = find_node_tree(
        &doc.body.pages,
        "lib.1",
        &resolve_tokens(&doc.tokens).resolved,
    );
    assert!(found.is_some(), "unknown node must be findable by id");
    let e = found.unwrap();
    assert_eq!(e.id, "lib.1");
    assert_eq!(e.kind, "mystery");
    assert_eq!(e.children.len(), 1, "subtree must include the child");
    assert_eq!(e.children[0].id, "inner");
}

#[test]
fn find_known_node_inside_unknown() {
    let doc = KdlAdapter.parse(UNKNOWN_INSPECT_DOC.as_bytes()).unwrap();
    let found = find_node_tree(
        &doc.body.pages,
        "inner",
        &resolve_tokens(&doc.tokens).resolved,
    );
    assert!(
        found.is_some(),
        "known rect nested in an unknown node must be findable"
    );
    let e = found.unwrap();
    assert_eq!(e.id, "inner");
    assert_eq!(e.kind, "rect");
}