badness 0.3.0

An LSP, formatter, and linter for LaTeX
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

//! Tests for the salsa incremental harness (`incremental.rs`): memoization,
//! revision-driven re-runs, the unchanged-text short-circuit, and that the
//! cached parse path preserves losslessness.

use badness::incremental::{IncrementalDatabase, QueryKind};

/// How many times `parsed_document` actually ran, per the query log.
fn parse_count(db: &IncrementalDatabase) -> usize {
    db.query_log()
        .iter()
        .filter(|entry| entry.kind == QueryKind::ParsedDocument)
        .count()
}

/// How many times `document_signatures` actually ran, per the query log.
fn signatures_count(db: &IncrementalDatabase) -> usize {
    db.query_log()
        .iter()
        .filter(|entry| entry.kind == QueryKind::DocumentSignatures)
        .count()
}

/// How many times `parsed_bib_document` actually ran, per the query log.
fn bib_parse_count(db: &IncrementalDatabase) -> usize {
    db.query_log()
        .iter()
        .filter(|entry| entry.kind == QueryKind::ParsedBibDocument)
        .count()
}

/// How many times `bib_semantic_model` actually ran, per the query log.
fn bib_model_count(db: &IncrementalDatabase) -> usize {
    db.query_log()
        .iter()
        .filter(|entry| entry.kind == QueryKind::BibSemanticModel)
        .count()
}

/// An owned, sorted projection of the scanned command names.
fn scanned_commands(
    db: &IncrementalDatabase,
    file: badness::incremental::SourceFile,
) -> Vec<String> {
    let mut names: Vec<String> = db
        .document_signatures(file)
        .command_names()
        .map(str::to_string)
        .collect();
    names.sort();
    names
}

#[test]
fn parsed_document_is_memoized() {
    let db = IncrementalDatabase::default();
    let file = db.add_file("\\section{Hi}\n");

    // Many reads — including two distinct consumers of the cached parse — but
    // the parse itself runs exactly once.
    let _ = db.parsed_tree(file);
    let _ = db.parsed_tree(file);
    let _ = db.parse_diagnostics(file);

    assert_eq!(parse_count(&db), 1);
}

#[test]
fn editing_text_reparses() {
    let mut db = IncrementalDatabase::default();
    let file = db.add_file("a\n");

    let _ = db.parsed_tree(file);
    assert_eq!(parse_count(&db), 1);

    db.set_file_text(file, "b\n");
    let _ = db.parsed_tree(file);
    assert_eq!(parse_count(&db), 2);
}

#[test]
fn upsert_unchanged_text_does_not_reparse() {
    let mut db = IncrementalDatabase::default();
    let path = std::path::Path::new("/tmp/doc.tex");

    let file = db.upsert_file(path, "x\n".to_string());
    let _ = db.parsed_tree(file);
    assert_eq!(parse_count(&db), 1);

    // Re-upserting identical text must not bump the revision, so the cached
    // parse stands.
    let same = db.upsert_file(path, "x\n".to_string());
    assert!(same == file);
    let _ = db.parsed_tree(same);
    assert_eq!(parse_count(&db), 1);

    // Changing the text does re-parse.
    let changed = db.upsert_file(path, "y\n".to_string());
    assert!(changed == file);
    let _ = db.parsed_tree(changed);
    assert_eq!(parse_count(&db), 2);
}

#[test]
fn cached_tree_is_lossless() {
    let db = IncrementalDatabase::default();
    let input = "\\section{Hi}\n\nbody $x^2$ % c\n";
    let file = db.add_file(input);

    assert_eq!(db.parsed_tree(file).to_string(), input);
}

#[test]
fn remove_file_stops_tracking() {
    let mut db = IncrementalDatabase::default();
    let path = std::path::Path::new("/tmp/doc.tex");

    let file = db.upsert_file(path, "x\n".to_string());
    assert!(db.lookup_file(path) == Some(file));

    // Eviction returns the dropped handle and makes the path untracked.
    assert!(db.remove_file(path) == Some(file));
    assert!(db.lookup_file(path).is_none());
    assert!(db.remove_file(path).is_none());

    // Re-opening the same path mints a *fresh* input, not the evicted one.
    let reopened = db.upsert_file(path, "x\n".to_string());
    assert!(reopened != file);
    assert!(db.lookup_file(path) == Some(reopened));
}

#[test]
fn snapshot_reads_cached_parse() {
    let mut db = IncrementalDatabase::default();
    let path = std::path::Path::new("/tmp/snap.tex");
    let file = db.upsert_file(path, "\\emph{hi}\n".to_string());
    let _ = db.parsed_tree(file);

    // A read-only snapshot sees the same cached parse off the writer.
    let snap = db.snapshot();
    let snap_file = snap.lookup_file(path).expect("tracked file");
    assert!(snap_file == file);
    assert_eq!(snap.file_text(file), "\\emph{hi}\n");
    assert!(snap.parse_diagnostics(file).is_empty());
    assert_eq!(snap.parsed_tree(file).to_string(), "\\emph{hi}\n");
}

#[test]
fn document_signatures_is_memoized() {
    let db = IncrementalDatabase::default();
    let file = db.add_file("\\newcommand{\\foo}{x}\n");

    // Many reads, but the scan runs exactly once.
    let _ = db.document_signatures(file);
    let _ = db.document_signatures(file);
    let _ = db.document_signatures(file);

    assert_eq!(signatures_count(&db), 1);
    assert_eq!(scanned_commands(&db, file), vec!["foo".to_string()]);
}

#[test]
fn editing_definitions_rebuilds_signatures() {
    let mut db = IncrementalDatabase::default();
    let file = db.add_file("\\newcommand{\\foo}{x}\n");

    assert_eq!(scanned_commands(&db, file), vec!["foo".to_string()]);
    assert_eq!(signatures_count(&db), 1);

    // Adding a definition changes the text, so the scan re-runs.
    db.set_file_text(file, "\\newcommand{\\foo}{x}\n\\newcommand{\\bar}{y}\n");
    assert_eq!(
        scanned_commands(&db, file),
        vec!["bar".to_string(), "foo".to_string()]
    );
    assert_eq!(signatures_count(&db), 2);
}

#[test]
fn prose_edit_yields_equal_signatures() {
    // Value-stability stand-in for backdating: an edit touching no definition
    // leaves the scanned DB `==` its prior value, the precondition that makes
    // salsa backdate for completion's consumer.
    let db = IncrementalDatabase::default();
    let file = db.add_file("\\newcommand{\\foo}{x}\n");

    // A fresh db with prose appended must scan to an equal DB.
    let other = IncrementalDatabase::default();
    let other_file = other.add_file("\\newcommand{\\foo}{x}\n\nsome text.\n");

    assert_eq!(
        db.document_signatures(file),
        other.document_signatures(other_file)
    );
}

#[test]
fn parsed_bib_document_is_memoized() {
    let db = IncrementalDatabase::default();
    let file = db.add_file("@article{k, title = {Hi}}\n");

    // Several consumers of the cached bib parse, but the parse runs once.
    let _ = db.parsed_bib_tree(file);
    let _ = db.parsed_bib_tree(file);
    let _ = db.bib_parse_diagnostics(file);
    let _ = db.bib_semantic_model(file);

    assert_eq!(bib_parse_count(&db), 1);
}

#[test]
fn editing_bib_text_reparses() {
    let mut db = IncrementalDatabase::default();
    let file = db.add_file("@misc{a}\n");

    let _ = db.parsed_bib_tree(file);
    assert_eq!(bib_parse_count(&db), 1);

    db.set_file_text(file, "@misc{b}\n");
    let _ = db.parsed_bib_tree(file);
    assert_eq!(bib_parse_count(&db), 2);
}

#[test]
fn cached_bib_tree_is_lossless() {
    let db = IncrementalDatabase::default();
    let input = "@article{k,\n  title = {Hi},\n  year = 2020,\n}\n";
    let file = db.add_file(input);

    assert_eq!(db.parsed_bib_tree(file).to_string(), input);
}

#[test]
fn bib_semantic_model_is_memoized() {
    let db = IncrementalDatabase::default();
    let file = db.add_file("@book{k, publisher = cup}\n@string{cup = {C}}\n");

    let _ = db.bib_semantic_model(file);
    let _ = db.bib_semantic_model(file);

    assert_eq!(bib_model_count(&db), 1);
}

#[test]
fn equal_bib_edit_yields_equal_model() {
    // Value-stability stand-in for backdating: two files whose entries/keys and
    // `@string` set match build `==` models, the precondition that makes salsa
    // backdate `bib_semantic_model` (it is `Eq`, not `no_eq`).
    let db = IncrementalDatabase::default();
    let file = db.add_file("@article{k, title = {A}}\n");

    let other = IncrementalDatabase::default();
    let other_file = other.add_file("@article{k, title = {A}}\n");

    assert_eq!(
        db.bib_semantic_model(file),
        other.bib_semantic_model(other_file)
    );
}

#[test]
fn clone_shares_storage() {
    let db = IncrementalDatabase::default();
    let file = db.add_file("\\emph{hi}\n");
    let _ = db.parsed_tree(file);
    assert_eq!(parse_count(&db), 1);

    // A clone is a second handle onto the same storage: the file's cached parse
    // is visible without re-running, and both handles share the query log.
    let clone = db.clone();
    let _ = clone.parsed_tree(file);
    assert_eq!(parse_count(&clone), 1);
    assert_eq!(clone.file_text(file), "\\emph{hi}\n");
}