blackline 0.4.2

Agent-first CLI for DOCX / XLSX / PPTX
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
//! Pipeline tests: a canned completer drives blackline. No model download.

use super::apply::ApplyOptions;
use super::cli::run_with_completer;
use super::plan::{Op, Plan, Position, StaticCompleter};
use blackline_docx::Docx;
use blackline_pptx::{CreateSpec, Pptx, SlideSpec};
use blackline_xlsx::Xlsx;
use tempfile::TempDir;

fn dir() -> TempDir {
    TempDir::new().unwrap()
}

#[tokio::test]
async fn docx_replace_is_a_tracked_redline() {
    let dir = dir();
    let input = dir.path().join("in.docx");
    let output = dir.path().join("out.docx");
    Docx::from_paragraphs(&["The notice period is thirty (30) days."])
        .unwrap()
        .save(&input)
        .unwrap();

    let plan = Plan {
        ops: vec![Op::Replace {
            index: 1,
            old: "thirty (30)".into(),
            new: "sixty (60)".into(),
        }],
    };
    let report = run_with_completer(
        &input,
        "change thirty days to sixty",
        Some(&output),
        ApplyOptions {
            author: Some("Jane Doe".into()),
            ..ApplyOptions::default()
        },
        &StaticCompleter::new(plan),
    )
    .await
    .unwrap();
    assert_eq!(report.apply.failed, 0);
    assert_eq!(report.apply.applied, 1);

    let original = Docx::open(&input).unwrap();
    let edited = Docx::open(&output).unwrap();
    assert!(edited.check_against(&original).unwrap().passed());
    assert!(edited.visible_text().unwrap().contains("sixty (60)"));
}

#[tokio::test]
async fn docx_reject_all_restores_original() {
    let dir = dir();
    let input = dir.path().join("in.docx");
    let output = dir.path().join("out.docx");
    let original_text = "Pay within thirty days.";
    Docx::from_paragraphs(&[original_text])
        .unwrap()
        .save(&input)
        .unwrap();

    let plan = Plan {
        ops: vec![Op::Replace {
            index: 1,
            old: "thirty".into(),
            new: "sixty".into(),
        }],
    };
    run_with_completer(
        &input,
        "thirty to sixty",
        Some(&output),
        ApplyOptions {
            author: Some("Jane".into()),
            ..ApplyOptions::default()
        },
        &StaticCompleter::new(plan),
    )
    .await
    .unwrap();

    let edited = Docx::open(&output).unwrap();
    let settled = edited
        .edit([blackline_docx::EditOp::RejectAll { author: None }])
        .author("Jane")
        .apply()
        .unwrap()
        .document
        .unwrap();
    assert_eq!(settled.visible_text().unwrap(), original_text);
}

#[tokio::test]
async fn docx_comment_and_insert() {
    let dir = dir();
    let input = dir.path().join("in.docx");
    let output = dir.path().join("out.docx");
    Docx::from_paragraphs(&["Indemnity survives closing."])
        .unwrap()
        .save(&input)
        .unwrap();

    let plan = Plan {
        ops: vec![
            Op::Comment {
                index: 1,
                anchor: "Indemnity".into(),
                text: "Confirm survival period.".into(),
            },
            Op::Insert {
                index: 1,
                position: Position::End,
                text: " The period is two years.".into(),
            },
        ],
    };
    let report = run_with_completer(
        &input,
        "comment indemnity and extend",
        Some(&output),
        ApplyOptions {
            author: Some("Jane".into()),
            ..ApplyOptions::default()
        },
        &StaticCompleter::new(plan),
    )
    .await
    .unwrap();
    assert_eq!(report.apply.failed, 0, "{:?}", report.apply);
    let edited = Docx::open(&output).unwrap();
    assert_eq!(edited.comments().unwrap().len(), 1);
}

#[tokio::test]
async fn insert_after_without_match_swaps_the_phrase() {
    let dir = dir();
    let input = dir.path().join("in.docx");
    let output = dir.path().join("out.docx");
    Docx::from_paragraphs(&["Fees are due within thirty days of invoice date."])
        .unwrap()
        .save(&input)
        .unwrap();

    let plan = Plan {
        ops: vec![Op::Insert {
            index: 1,
            position: Position::After,
            text: "sixty days".into(),
        }],
    };
    let report = run_with_completer(
        &input,
        "change thirty days to sixty days",
        Some(&output),
        ApplyOptions {
            author: Some("Jane".into()),
            ..ApplyOptions::default()
        },
        &StaticCompleter::new(plan),
    )
    .await
    .unwrap();
    assert_eq!(report.apply.failed, 0, "{:?}", report.apply);
    assert_eq!(report.apply.applied, 1);
    let edited = Docx::open(&output).unwrap();
    let text = edited.visible_text().unwrap();
    assert!(text.contains("sixty days"), "{text}");
    assert!(!text.contains("thirty days"), "{text}");
}

#[tokio::test]
async fn xlsx_set_cell() {
    let dir = dir();
    let input = dir.path().join("in.xlsx");
    let output = dir.path().join("out.xlsx");
    Xlsx::from_rows("Cap", &[vec!["Name", "Days"], vec!["Notice", "30"]])
        .unwrap()
        .save(&input)
        .unwrap();

    let plan = Plan {
        ops: vec![Op::SetCell {
            sheet: "Cap".into(),
            cell: "B2".into(),
            value: "60".into(),
        }],
    };
    let report = run_with_completer(
        &input,
        "set days to 60",
        Some(&output),
        ApplyOptions::default(),
        &StaticCompleter::new(plan),
    )
    .await
    .unwrap();
    assert_eq!(report.apply.failed, 0);
    let wb = Xlsx::open(&output).unwrap();
    match wb.cell("Cap", "B2").unwrap() {
        blackline_xlsx::CellValue::Number(n) => assert!((n - 60.0).abs() < f64::EPSILON),
        other => panic!("{other:?}"),
    }
}

#[tokio::test]
async fn pptx_set_text() {
    let dir = dir();
    let input = dir.path().join("in.pptx");
    let output = dir.path().join("out.pptx");
    Pptx::create(&CreateSpec {
        slides: vec![SlideSpec {
            texts: vec!["Q2".into(), "Body".into()],
            notes: None,
        }],
    })
    .unwrap()
    .save(&input)
    .unwrap();

    let plan = Plan {
        ops: vec![Op::SetText {
            slide: 1,
            element: 1,
            text: "Q3".into(),
        }],
    };
    let report = run_with_completer(
        &input,
        "title to Q3",
        Some(&output),
        ApplyOptions::default(),
        &StaticCompleter::new(plan),
    )
    .await
    .unwrap();
    assert_eq!(report.apply.failed, 0);
    let deck = Pptx::open(&output).unwrap();
    let view = deck.view().unwrap();
    assert_eq!(
        view.first()
            .and_then(|s| s.elements.first())
            .map(String::as_str),
        Some("Q3")
    );
}

#[tokio::test]
async fn leftover_replace_is_dropped_before_strict_apply() {
    let dir = dir();
    let input = dir.path().join("in.docx");
    let output = dir.path().join("out.docx");
    Docx::from_paragraphs(&["The notice period is thirty days."])
        .unwrap()
        .save(&input)
        .unwrap();

    let plan = Plan {
        ops: vec![
            Op::Replace {
                index: 1,
                old: "thirty".into(),
                new: "sixty".into(),
            },
            Op::Replace {
                index: 1,
                old: "    ".into(),
                new: "    ".into(),
            },
        ],
    };
    let report = run_with_completer(
        &input,
        "thirty to sixty",
        Some(&output),
        ApplyOptions {
            author: Some("Jane".into()),
            ..ApplyOptions::default()
        },
        &StaticCompleter::new(plan),
    )
    .await
    .unwrap();
    assert_eq!(report.apply.failed, 0, "{:?}", report.apply);
    assert_eq!(report.apply.applied, 1);
    assert!(output.exists());
}

#[tokio::test]
async fn leftover_miss_does_not_abort_lenient_apply() {
    let dir = dir();
    let input = dir.path().join("in.docx");
    let output = dir.path().join("out.docx");
    Docx::from_paragraphs(&["The notice period is thirty days."])
        .unwrap()
        .save(&input)
        .unwrap();

    let plan = Plan {
        ops: vec![
            Op::Replace {
                index: 1,
                old: "thirty".into(),
                new: "sixty".into(),
            },
            // Delete is not rewritten by snap, so a miss reaches apply.
            Op::Delete {
                index: 1,
                text: "this text is not in the file".into(),
            },
        ],
    };
    let report = run_with_completer(
        &input,
        "thirty to sixty",
        Some(&output),
        ApplyOptions {
            author: Some("Jane".into()),
            lenient: true,
            ..ApplyOptions::default()
        },
        &StaticCompleter::new(plan),
    )
    .await
    .unwrap();
    assert_eq!(report.apply.applied, 1, "{:?}", report.apply);
    assert_eq!(report.apply.failed, 1);
    assert_eq!(report.apply.mode, "lenient");
    let text = Docx::open(&output).unwrap().visible_text().unwrap();
    assert!(text.contains("sixty days"), "{text}");
}

#[tokio::test]
async fn leftover_miss_aborts_strict_apply() {
    let dir = dir();
    let input = dir.path().join("in.docx");
    let output = dir.path().join("out.docx");
    Docx::from_paragraphs(&["The notice period is thirty days."])
        .unwrap()
        .save(&input)
        .unwrap();

    let plan = Plan {
        ops: vec![
            Op::Replace {
                index: 1,
                old: "thirty".into(),
                new: "sixty".into(),
            },
            Op::Delete {
                index: 1,
                text: "this text is not in the file".into(),
            },
        ],
    };
    let err = run_with_completer(
        &input,
        "thirty to sixty",
        Some(&output),
        ApplyOptions {
            author: Some("Jane".into()),
            ..ApplyOptions::default()
        },
        &StaticCompleter::new(plan),
    )
    .await
    .unwrap_err();
    assert!(err.to_string().contains("not found"), "{err}");
    assert!(!output.exists());
}

#[tokio::test]
async fn wrong_op_for_format_fails() {
    let dir = dir();
    let input = dir.path().join("in.xlsx");
    Xlsx::from_rows("S", &[vec!["A"]])
        .unwrap()
        .save(&input)
        .unwrap();
    let plan = Plan {
        ops: vec![Op::Replace {
            index: 1,
            old: "A".into(),
            new: "B".into(),
        }],
    };
    let err = run_with_completer(
        &input,
        "nope",
        None,
        ApplyOptions {
            dry_run: true,
            ..ApplyOptions::default()
        },
        &StaticCompleter::new(plan),
    )
    .await
    .unwrap_err();
    assert!(err.to_string().contains("docx"), "{err}");
}

#[tokio::test]
async fn dry_run_does_not_write() {
    let dir = dir();
    let input = dir.path().join("in.docx");
    let output = dir.path().join("out.docx");
    Docx::from_paragraphs(&["hello"])
        .unwrap()
        .save(&input)
        .unwrap();
    let plan = Plan {
        ops: vec![Op::Replace {
            index: 1,
            old: "hello".into(),
            new: "goodbye".into(),
        }],
    };
    run_with_completer(
        &input,
        "hello to goodbye",
        Some(&output),
        ApplyOptions {
            author: Some("Jane".into()),
            dry_run: true,
            ..ApplyOptions::default()
        },
        &StaticCompleter::new(plan),
    )
    .await
    .unwrap();
    assert!(!output.exists());
}