formualizer-workbook 0.5.2

Ergonomic workbook API over the Formualizer engine (sheets, loaders, staging, undo/redo)
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
use formualizer_common::{LiteralValue, RangeAddress};
use formualizer_workbook::{IoError, LoadStrategy, Workbook, WorkbookConfig};

fn assert_numeric_eq(v: Option<LiteralValue>, expected: f64) {
    match v {
        Some(LiteralValue::Number(n)) => assert!((n - expected).abs() < 1e-9),
        Some(LiteralValue::Int(i)) => assert!(((i as f64) - expected).abs() < 1e-9),
        other => panic!("expected numeric {expected}, got {other:?}"),
    }
}

fn assert_emptyish(v: Option<LiteralValue>) {
    assert!(matches!(v, None | Some(LiteralValue::Empty)));
}

#[test]
fn values_roundtrip_and_range() {
    let mut wb = Workbook::new();
    wb.add_sheet("S").unwrap();
    wb.set_value("S", 1, 1, LiteralValue::Int(10)).unwrap();
    wb.set_value("S", 2, 1, LiteralValue::Number(2.5)).unwrap();

    assert_numeric_eq(wb.get_value("S", 1, 1), 10.0);
    assert_eq!(wb.get_value("S", 2, 1), Some(LiteralValue::Number(2.5)));

    let ra = RangeAddress::new("S", 1, 1, 2, 1).unwrap();
    let vals = wb.read_range(&ra);
    assert_eq!(vals.len(), 2);
    // read_range reads from Arrow which stores Int as Number
    assert_eq!(vals[0][0], LiteralValue::Number(10.0));
    assert_eq!(vals[1][0], LiteralValue::Number(2.5));
}

#[test]
fn deferred_formula_evaluation() {
    let mut wb = Workbook::new();
    wb.add_sheet("S").unwrap();
    wb.set_value("S", 1, 1, LiteralValue::Int(7)).unwrap();
    // Stage a formula without '='; deferred graph building should handle it
    wb.set_formula("S", 1, 2, "A1*3").unwrap();

    // Not evaluated yet; no value stored for a staged formula
    assert_emptyish(wb.get_value("S", 1, 2));

    // Demand-driven eval builds graph for sheet S and computes
    let v = wb.evaluate_cell("S", 1, 2).unwrap();
    assert_eq!(v, LiteralValue::Number(21.0));
}

#[cfg(feature = "json")]
#[test]
fn load_from_json_reader() {
    use formualizer_workbook::backends::JsonAdapter;
    use formualizer_workbook::traits::SpreadsheetWriter;

    let mut json = JsonAdapter::new();
    json.create_sheet("S").unwrap();
    json.write_cell(
        "S",
        1,
        1,
        formualizer_workbook::traits::CellData::from_value(LiteralValue::Int(4)),
    )
    .unwrap();
    json.write_cell(
        "S",
        1,
        2,
        formualizer_workbook::traits::CellData::from_formula("A1*5"),
    )
    .unwrap();

    let cfg = WorkbookConfig::interactive();
    let mut wb = Workbook::from_reader(json, LoadStrategy::EagerAll, cfg).unwrap();
    // Deferred mode: formula not evaluated yet (no stored value)
    assert_emptyish(wb.get_value("S", 1, 2));
    // Evaluate
    let v = wb.evaluate_cell("S", 1, 2).unwrap();
    assert_eq!(v, LiteralValue::Number(20.0));
}

#[test]
fn value_edit_triggers_recompute_in_deferred_mode() {
    let mut wb = Workbook::new();
    wb.add_sheet("S").unwrap();
    wb.set_value("S", 1, 1, LiteralValue::Int(3)).unwrap();
    wb.set_formula("S", 1, 2, "A1*2").unwrap();

    assert_numeric_eq(wb.get_value("S", 1, 1), 3.0);
    assert_eq!(wb.get_formula("S", 1, 2), Some("A1*2".to_string()));

    let v = wb.evaluate_cell("S", 1, 2).unwrap();
    assert_eq!(v, LiteralValue::Number(6.0));

    // Edit precedent A1 and ensure recompute happens on next evaluate
    wb.set_value("S", 1, 1, LiteralValue::Int(10)).unwrap();
    let v2 = wb.evaluate_cell("S", 1, 2).unwrap();
    assert_eq!(v2, LiteralValue::Number(20.0));
}

#[test]
fn staged_formula_edit_recomputes_on_demand() {
    let mut wb = Workbook::new();
    wb.add_sheet("S").unwrap();
    wb.set_value("S", 1, 1, LiteralValue::Int(5)).unwrap();
    wb.set_formula("S", 1, 2, "A1*2").unwrap();
    assert_eq!(
        wb.evaluate_cell("S", 1, 2).unwrap(),
        LiteralValue::Number(10.0)
    );

    // Change formula text; with deferred mode this is staged and will rebuild on evaluate
    wb.set_formula("S", 1, 2, "A1*3").unwrap();
    let v2 = wb.evaluate_cell("S", 1, 2).unwrap();
    assert_eq!(v2, LiteralValue::Number(15.0));
}

#[test]
fn bulk_write_mixed_values_and_formulas() {
    use formualizer_workbook::traits::CellData;
    use std::collections::BTreeMap;

    let mut wb = Workbook::new();
    wb.add_sheet("S").unwrap();

    let mut cells: BTreeMap<(u32, u32), CellData> = BTreeMap::new();
    cells.insert((1, 1), CellData::from_value(LiteralValue::Int(2)));
    cells.insert((1, 2), CellData::from_formula("A1+8"));
    wb.write_range("S", (1, 1), cells).unwrap();

    assert_eq!(
        wb.evaluate_cell("S", 1, 2).unwrap(),
        LiteralValue::Number(10.0)
    );

    // Overwrite both via bulk
    let mut cells2: BTreeMap<(u32, u32), CellData> = BTreeMap::new();
    cells2.insert((1, 1), CellData::from_value(LiteralValue::Int(4)));
    cells2.insert((1, 2), CellData::from_formula("A1+6"));
    wb.write_range("S", (1, 1), cells2).unwrap();

    assert_eq!(
        wb.evaluate_cell("S", 1, 2).unwrap(),
        LiteralValue::Number(10.0)
    );
}

#[test]
fn set_values_batch_and_undo() {
    let mut wb = Workbook::new();
    wb.add_sheet("S").unwrap();
    wb.set_changelog_enabled(true);

    let rows = vec![
        vec![LiteralValue::Int(1), LiteralValue::Int(2)],
        vec![LiteralValue::Int(3), LiteralValue::Int(4)],
    ];
    wb.begin_action("seed");
    wb.set_values("S", 1, 1, &rows).unwrap();
    wb.end_action();

    let ra = RangeAddress::new("S", 1, 1, 2, 2).unwrap();
    let vals = wb.read_range(&ra);
    // read_range reads from Arrow which stores Int as Number
    assert_eq!(vals[0][0], LiteralValue::Number(1.0));
    assert_eq!(vals[1][1], LiteralValue::Number(4.0));

    wb.undo().unwrap();
    let vals2 = wb.read_range(&ra);
    assert_eq!(vals2[0][0], LiteralValue::Empty);
    assert_eq!(vals2[1][1], LiteralValue::Empty);
    wb.redo().unwrap();
    let vals3 = wb.read_range(&ra);
    assert_eq!(vals3[0][0], LiteralValue::Number(1.0));
    assert_eq!(vals3[1][1], LiteralValue::Number(4.0));
}

#[test]
fn set_formulas_batch_deferred_then_eval() {
    let mut wb = Workbook::new();
    wb.add_sheet("S").unwrap();
    wb.set_values(
        "S",
        1,
        1,
        &[vec![LiteralValue::Int(5), LiteralValue::Int(6)]],
    )
    .unwrap();
    let forms = vec![vec!["A1*2".to_string(), "B1+1".to_string()]];
    wb.set_formulas("S", 2, 1, &forms).unwrap();
    // No values yet for staged formulas
    assert_emptyish(wb.get_value("S", 2, 1));
    // Evaluate both
    let out = wb.evaluate_cells(&[("S", 2, 1), ("S", 2, 2)]).unwrap();
    assert_eq!(out[0], LiteralValue::Number(10.0));
    assert_eq!(out[1], LiteralValue::Number(7.0));
}

#[test]
fn changelog_undo_redo_values() {
    // Use default deferred mode
    let mut wb = Workbook::new();
    wb.set_changelog_enabled(true);
    wb.add_sheet("S").unwrap();
    wb.set_value("S", 1, 1, LiteralValue::Int(1)).unwrap();
    wb.set_value("S", 1, 2, LiteralValue::Int(2)).unwrap();
    assert_numeric_eq(wb.get_value("S", 1, 1), 1.0);

    wb.begin_action("edit A1");
    wb.set_value("S", 1, 1, LiteralValue::Int(5)).unwrap();
    wb.end_action();
    assert_numeric_eq(wb.get_value("S", 1, 1), 5.0);

    wb.undo().unwrap();
    assert_numeric_eq(wb.get_value("S", 1, 1), 1.0);
    wb.redo().unwrap();
    assert_numeric_eq(wb.get_value("S", 1, 1), 5.0);
}

#[test]
fn changelog_with_formulas_non_deferred() {
    // Disable deferral so formula graph exists → logs capture formula edits
    let mut cfg = WorkbookConfig::ephemeral();
    cfg.eval.defer_graph_building = false;
    let mut wb = Workbook::new_with_config(cfg);
    wb.set_changelog_enabled(true);
    wb.add_sheet("S").unwrap();
    wb.set_value("S", 1, 1, LiteralValue::Int(2)).unwrap();
    wb.set_formula("S", 1, 2, "A1*3").unwrap();
    assert_eq!(
        wb.evaluate_cell("S", 1, 2).unwrap(),
        LiteralValue::Number(6.0)
    );

    wb.begin_action("change A1");
    wb.set_value("S", 1, 1, LiteralValue::Int(4)).unwrap();
    wb.end_action();
    assert_eq!(
        wb.evaluate_cell("S", 1, 2).unwrap(),
        LiteralValue::Number(12.0)
    );

    wb.undo().unwrap();
    assert_eq!(
        wb.evaluate_cell("S", 1, 2).unwrap(),
        LiteralValue::Number(6.0)
    );
    wb.redo().unwrap();
    assert_eq!(
        wb.evaluate_cell("S", 1, 2).unwrap(),
        LiteralValue::Number(12.0)
    );
}

#[test]
fn set_values_batch_overwrite_then_undo_restores_previous_values() {
    let mut wb = Workbook::new();
    wb.add_sheet("S").unwrap();
    wb.set_changelog_enabled(true);

    // Seed initial values in a compound action
    let seed = vec![
        vec![LiteralValue::Int(1), LiteralValue::Int(2)],
        vec![LiteralValue::Int(3), LiteralValue::Int(4)],
    ];
    wb.begin_action("seed");
    wb.set_values("S", 1, 1, &seed).unwrap();
    wb.end_action();

    let ra = RangeAddress::new("S", 1, 1, 2, 2).unwrap();
    assert_eq!(
        wb.read_range(&ra),
        vec![
            vec![LiteralValue::Number(1.0), LiteralValue::Number(2.0)],
            vec![LiteralValue::Number(3.0), LiteralValue::Number(4.0)],
        ]
    );

    // Bulk overwrite in a new action
    let overwrite = vec![
        vec![LiteralValue::Int(10), LiteralValue::Int(20)],
        vec![LiteralValue::Int(30), LiteralValue::Int(40)],
    ];
    wb.begin_action("overwrite");
    wb.set_values("S", 1, 1, &overwrite).unwrap();
    wb.end_action();

    assert_eq!(
        wb.read_range(&ra),
        vec![
            vec![LiteralValue::Number(10.0), LiteralValue::Number(20.0)],
            vec![LiteralValue::Number(30.0), LiteralValue::Number(40.0)],
        ]
    );

    // Undo must restore the prior values (not Empty)
    wb.undo().unwrap();
    assert_eq!(
        wb.read_range(&ra),
        vec![
            vec![LiteralValue::Number(1.0), LiteralValue::Number(2.0)],
            vec![LiteralValue::Number(3.0), LiteralValue::Number(4.0)],
        ]
    );
}

#[test]
fn write_range_overwrite_then_undo_restores_previous_values() {
    use formualizer_workbook::traits::CellData;
    use std::collections::BTreeMap;

    let mut wb = Workbook::new();
    wb.add_sheet("S").unwrap();
    wb.set_changelog_enabled(true);

    // Seed initial values
    let mut seed: BTreeMap<(u32, u32), CellData> = BTreeMap::new();
    seed.insert((1, 1), CellData::from_value(LiteralValue::Int(1)));
    seed.insert((1, 2), CellData::from_value(LiteralValue::Int(2)));
    seed.insert((2, 1), CellData::from_value(LiteralValue::Int(3)));
    seed.insert((2, 2), CellData::from_value(LiteralValue::Int(4)));
    wb.begin_action("seed");
    wb.write_range("S", (1, 1), seed).unwrap();
    wb.end_action();

    let ra = RangeAddress::new("S", 1, 1, 2, 2).unwrap();
    assert_eq!(
        wb.read_range(&ra),
        vec![
            vec![LiteralValue::Number(1.0), LiteralValue::Number(2.0)],
            vec![LiteralValue::Number(3.0), LiteralValue::Number(4.0)],
        ]
    );

    // Overwrite via write_range
    let mut overwrite: BTreeMap<(u32, u32), CellData> = BTreeMap::new();
    overwrite.insert((1, 1), CellData::from_value(LiteralValue::Int(10)));
    overwrite.insert((1, 2), CellData::from_value(LiteralValue::Int(20)));
    overwrite.insert((2, 1), CellData::from_value(LiteralValue::Int(30)));
    overwrite.insert((2, 2), CellData::from_value(LiteralValue::Int(40)));
    wb.begin_action("overwrite");
    wb.write_range("S", (1, 1), overwrite).unwrap();
    wb.end_action();

    assert_eq!(
        wb.read_range(&ra),
        vec![
            vec![LiteralValue::Number(10.0), LiteralValue::Number(20.0)],
            vec![LiteralValue::Number(30.0), LiteralValue::Number(40.0)],
        ]
    );

    wb.undo().unwrap();
    assert_eq!(
        wb.read_range(&ra),
        vec![
            vec![LiteralValue::Number(1.0), LiteralValue::Number(2.0)],
            vec![LiteralValue::Number(3.0), LiteralValue::Number(4.0)],
        ]
    );
}

#[test]
fn undo_spill_clear_restores_spilled_cells_values() {
    // Spill canary: overwrite the spill anchor, then undo should restore the spilled rectangle
    let mut wb = Workbook::new();
    wb.set_changelog_enabled(true);
    wb.add_sheet("S").unwrap();

    // Create a 2x2 spill at A1
    wb.set_formula("S", 1, 1, "{1,2;3,4}").unwrap();
    let _ = wb.evaluate_cell("S", 1, 1).unwrap();

    assert_eq!(wb.get_value("S", 1, 1), Some(LiteralValue::Number(1.0)));
    assert_eq!(wb.get_value("S", 1, 2), Some(LiteralValue::Number(2.0)));
    assert_eq!(wb.get_value("S", 2, 1), Some(LiteralValue::Number(3.0)));
    assert_eq!(wb.get_value("S", 2, 2), Some(LiteralValue::Number(4.0)));

    // Overwrite anchor with a scalar value (clears spill region + logs SpillCleared)
    wb.begin_action("overwrite anchor");
    wb.set_value("S", 1, 1, LiteralValue::Int(99)).unwrap();
    wb.end_action();

    assert_eq!(wb.get_value("S", 1, 1), Some(LiteralValue::Number(99.0)));
    // Spill region should be cleared (computed overlay emptied)
    assert_emptyish(wb.get_value("S", 1, 2));
    assert_emptyish(wb.get_value("S", 2, 1));
    assert_emptyish(wb.get_value("S", 2, 2));

    // Undo must restore spilled computed overlay values from Arrow truth
    wb.undo().unwrap();
    assert_eq!(wb.get_value("S", 1, 1), Some(LiteralValue::Number(1.0)));
    assert_eq!(wb.get_value("S", 1, 2), Some(LiteralValue::Number(2.0)));
    assert_eq!(wb.get_value("S", 2, 1), Some(LiteralValue::Number(3.0)));
    assert_eq!(wb.get_value("S", 2, 2), Some(LiteralValue::Number(4.0)));
}

#[test]
fn write_range_formula_with_cached_value_overwrites_literal_then_undo_restores_literal_and_clears_formula()
 {
    use formualizer_workbook::traits::CellData;
    use std::collections::BTreeMap;

    let mut wb = Workbook::new();
    wb.set_changelog_enabled(true);
    wb.add_sheet("S").unwrap();

    // Start with a plain literal value.
    wb.set_value("S", 1, 1, LiteralValue::Int(7)).unwrap();
    assert_eq!(wb.get_formula("S", 1, 1), None);
    assert_numeric_eq(wb.get_value("S", 1, 1), 7.0);

    // Overwrite with a CellData that contains both a cached value and a formula.
    // This should behave like "set formula" (i.e. the cached value does not become the truth;
    // evaluation produces the value), but undo must restore the original literal.
    let mut d = CellData::from_value(LiteralValue::Int(999));
    d.formula = Some("1+1".to_string());
    let mut cells: BTreeMap<(u32, u32), CellData> = BTreeMap::new();
    cells.insert((1, 1), d);

    wb.begin_action("overwrite A1 with formula+cached");
    wb.write_range("S", (1, 1), cells).unwrap();
    wb.end_action();

    assert_eq!(wb.get_formula("S", 1, 1), Some("1+1".to_string()));
    // Before evaluation, it is acceptable for the workbook to expose the cached value.
    assert_numeric_eq(wb.get_value("S", 1, 1), 999.0);

    // After evaluation, the formula result must win (cached value must not mask computed overlay).
    assert_eq!(
        wb.evaluate_cell("S", 1, 1).unwrap(),
        LiteralValue::Number(2.0)
    );
    assert_numeric_eq(wb.get_value("S", 1, 1), 2.0);

    // Undo restores the original literal value and clears the formula.
    wb.undo().unwrap();
    assert_eq!(wb.get_formula("S", 1, 1), None);
    assert_numeric_eq(wb.get_value("S", 1, 1), 7.0);
}

#[test]
fn workbook_action_is_atomic_on_error() {
    let mut wb = Workbook::new();
    wb.set_changelog_enabled(true);
    wb.add_sheet("S").unwrap();

    // Create a 2x2 spill at A1 and force evaluation so Arrow computed overlay is populated.
    wb.set_formula("S", 1, 1, "{1,2;3,4}").unwrap();
    let _ = wb.evaluate_cell("S", 1, 1).unwrap();
    assert_eq!(wb.get_value("S", 1, 1), Some(LiteralValue::Number(1.0)));
    assert_eq!(wb.get_value("S", 1, 2), Some(LiteralValue::Number(2.0)));

    // Run an action that clears the spill and writes another cell, then errors.
    let err = wb
        .action("boom", |tx| -> Result<(), IoError> {
            tx.set_value("S", 1, 1, LiteralValue::Int(99))?; // clears spill
            tx.set_value("S", 10, 1, LiteralValue::Int(5))?;
            Err(IoError::Backend {
                backend: "test".to_string(),
                message: "boom".to_string(),
            })
        })
        .unwrap_err();
    assert!(err.to_string().contains("boom"));

    // Must be fully rolled back.
    assert_eq!(wb.get_value("S", 1, 1), Some(LiteralValue::Number(1.0)));
    assert_eq!(wb.get_value("S", 1, 2), Some(LiteralValue::Number(2.0)));
    assert_emptyish(wb.get_value("S", 10, 1));
}