liblevenshtein 0.9.1

Levenshtein/Universal Automata for approximate string matching using various dictionary backends
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
//! Tests for StaticContextualCompletionEngine.
//!
//! These tests cover:
//! - Basic completion functionality
//! - Draft buffer lifecycle (insert, delete, finalize)
//! - Context hierarchy creation
//! - Algorithm variants

#![cfg(feature = "pathmap-backend")]

use libdictenstein::double_array_trie::DoubleArrayTrieBuilder;
use liblevenshtein::contextual::{ContextId, StaticContextualCompletionEngine};
use liblevenshtein::transducer::Algorithm;

// ============================================================================
// Basic Construction Tests
// ============================================================================

#[test]
fn test_engine_construction() {
    let mut builder = DoubleArrayTrieBuilder::new();
    builder.insert_with_value("test", Some(vec![0]));
    let dict = builder.build();

    let _engine =
        StaticContextualCompletionEngine::with_double_array_trie(dict, Algorithm::Standard);
}

#[test]
fn test_engine_with_empty_dictionary() {
    let builder = DoubleArrayTrieBuilder::<Vec<ContextId>>::new();
    let dict = builder.build();

    let engine =
        StaticContextualCompletionEngine::with_double_array_trie(dict, Algorithm::Standard);
    let ctx = engine
        .create_root_context(0)
        .expect("create_root_context failed");

    // Should handle empty dictionary gracefully
    let results = engine.complete(ctx, "anything", 2);
    assert!(results.is_ok());
    assert!(results.unwrap().is_empty());
}

// ============================================================================
// Basic Completion Tests
// ============================================================================

#[test]
fn test_basic_completion_from_static_dict() {
    let mut builder = DoubleArrayTrieBuilder::new();
    // Add terms with context 0 visibility
    builder.insert_with_value("hello", Some(vec![0]));
    builder.insert_with_value("help", Some(vec![0]));
    builder.insert_with_value("world", Some(vec![0]));
    let dict = builder.build();

    let engine =
        StaticContextualCompletionEngine::with_double_array_trie(dict, Algorithm::Standard);
    let ctx = engine
        .create_root_context(0)
        .expect("create_root_context failed");

    // Query should find matches from static dictionary
    // "hel" -> "help" = 1 edit (insert 'p')
    // "hel" -> "hello" = 2 edits (insert 'l' and 'o')
    let results = engine.complete(ctx, "hel", 2).expect("complete failed");
    let terms: Vec<&str> = results.iter().map(|c| c.term.as_str()).collect();

    assert!(terms.contains(&"hello"), "Should find 'hello'");
    assert!(terms.contains(&"help"), "Should find 'help'");
}

#[test]
fn test_completion_with_finalized_terms() {
    let mut builder = DoubleArrayTrieBuilder::new();
    builder.insert_with_value("static_term", Some(vec![0]));
    let dict = builder.build();

    let engine =
        StaticContextualCompletionEngine::with_double_array_trie(dict, Algorithm::Standard);
    let ctx = engine
        .create_root_context(0)
        .expect("create_root_context failed");

    // Finalize a new term using the proper workflow
    engine
        .insert_str(ctx, "dynamic_term")
        .expect("insert_str failed");
    engine.finalize(ctx).expect("finalize failed");

    // Should find finalized term
    // "dynamic" -> "dynamic_term" = 5 edits (insert '_term')
    let results = engine.complete(ctx, "dynamic", 5).expect("complete failed");
    let terms: Vec<&str> = results.iter().map(|c| c.term.as_str()).collect();

    assert!(
        terms.contains(&"dynamic_term"),
        "Should find finalized term"
    );
}

#[test]
fn test_exact_match_completion() {
    let mut builder = DoubleArrayTrieBuilder::new();
    builder.insert_with_value("exact", Some(vec![0]));
    let dict = builder.build();

    let engine =
        StaticContextualCompletionEngine::with_double_array_trie(dict, Algorithm::Standard);
    let ctx = engine
        .create_root_context(0)
        .expect("create_root_context failed");

    // Exact match with distance 0
    let results = engine.complete(ctx, "exact", 0).expect("complete failed");
    assert_eq!(results.len(), 1);
    assert_eq!(results[0].term, "exact");
}

// ============================================================================
// Draft Buffer Lifecycle Tests
// ============================================================================

#[test]
fn test_draft_insert_chars() {
    let builder = DoubleArrayTrieBuilder::<Vec<ContextId>>::new();
    let dict = builder.build();

    let engine =
        StaticContextualCompletionEngine::with_double_array_trie(dict, Algorithm::Standard);
    let ctx = engine
        .create_root_context(0)
        .expect("create_root_context failed");

    // Insert characters one by one
    engine.insert_char(ctx, 't').expect("insert failed");
    engine.insert_char(ctx, 'e').expect("insert failed");
    engine.insert_char(ctx, 's').expect("insert failed");
    engine.insert_char(ctx, 't').expect("insert failed");

    let draft = engine.get_draft(ctx).expect("get_draft failed");
    assert_eq!(draft, "test");
}

#[test]
fn test_draft_insert_string() {
    let builder = DoubleArrayTrieBuilder::<Vec<ContextId>>::new();
    let dict = builder.build();

    let engine =
        StaticContextualCompletionEngine::with_double_array_trie(dict, Algorithm::Standard);
    let ctx = engine
        .create_root_context(0)
        .expect("create_root_context failed");

    engine.insert_str(ctx, "hello").expect("insert_str failed");

    let draft = engine.get_draft(ctx).expect("get_draft failed");
    assert_eq!(draft, "hello");
}

#[test]
fn test_draft_delete_char() {
    let builder = DoubleArrayTrieBuilder::<Vec<ContextId>>::new();
    let dict = builder.build();

    let engine =
        StaticContextualCompletionEngine::with_double_array_trie(dict, Algorithm::Standard);
    let ctx = engine
        .create_root_context(0)
        .expect("create_root_context failed");

    engine.insert_str(ctx, "test").expect("insert_str failed");

    // Delete last character
    engine.delete_char(ctx).expect("delete_char failed");
    let draft = engine.get_draft(ctx).expect("get_draft failed");
    assert_eq!(draft, "tes");

    // Delete another
    engine.delete_char(ctx).expect("delete_char failed");
    let draft = engine.get_draft(ctx).expect("get_draft failed");
    assert_eq!(draft, "te");
}

#[test]
fn test_draft_clear() {
    let builder = DoubleArrayTrieBuilder::<Vec<ContextId>>::new();
    let dict = builder.build();

    let engine =
        StaticContextualCompletionEngine::with_double_array_trie(dict, Algorithm::Standard);
    let ctx = engine
        .create_root_context(0)
        .expect("create_root_context failed");

    engine
        .insert_str(ctx, "content")
        .expect("insert_str failed");
    engine.clear_draft(ctx).expect("clear_draft failed");

    let draft = engine.get_draft(ctx).expect("get_draft failed");
    assert_eq!(draft, "");
}

#[test]
fn test_draft_finalize() {
    let builder = DoubleArrayTrieBuilder::<Vec<ContextId>>::new();
    let dict = builder.build();

    let engine =
        StaticContextualCompletionEngine::with_double_array_trie(dict, Algorithm::Standard);
    let ctx = engine
        .create_root_context(0)
        .expect("create_root_context failed");

    // Build draft and finalize
    engine
        .insert_str(ctx, "newterm")
        .expect("insert_str failed");
    engine.finalize(ctx).expect("finalize failed");

    // Draft should be cleared after finalize
    let draft = engine.get_draft(ctx).expect("get_draft failed");
    assert_eq!(draft, "");

    // Term should now be searchable
    let results = engine.complete(ctx, "newterm", 0).expect("complete failed");
    assert!(
        results.iter().any(|c| c.term == "newterm"),
        "Finalized term should be searchable"
    );
}

// ============================================================================
// Context Hierarchy Tests
// ============================================================================

#[test]
fn test_create_root_context() {
    let builder = DoubleArrayTrieBuilder::<Vec<ContextId>>::new();
    let dict = builder.build();

    let engine =
        StaticContextualCompletionEngine::with_double_array_trie(dict, Algorithm::Standard);

    let ctx1 = engine
        .create_root_context(0)
        .expect("create_root_context failed");
    let ctx2 = engine
        .create_root_context(1)
        .expect("create_root_context failed");

    assert_eq!(ctx1, 0);
    assert_eq!(ctx2, 1);
}

#[test]
fn test_create_child_context() {
    let builder = DoubleArrayTrieBuilder::<Vec<ContextId>>::new();
    let dict = builder.build();

    let engine =
        StaticContextualCompletionEngine::with_double_array_trie(dict, Algorithm::Standard);

    let parent = engine
        .create_root_context(0)
        .expect("create_root_context failed");
    // API is create_child_context(child_id, parent_id)
    let child = engine
        .create_child_context(1, parent)
        .expect("create_child failed");

    assert_eq!(child, 1);
}

#[test]
fn test_deep_context_hierarchy() {
    let builder = DoubleArrayTrieBuilder::<Vec<ContextId>>::new();
    let dict = builder.build();

    let engine =
        StaticContextualCompletionEngine::with_double_array_trie(dict, Algorithm::Standard);

    // Create a chain: root -> child -> grandchild
    let root = engine
        .create_root_context(0)
        .expect("create_root_context failed");
    let child = engine
        .create_child_context(1, root)
        .expect("create_child failed");
    let grandchild = engine
        .create_child_context(2, child)
        .expect("create_grandchild failed");

    // All contexts should be valid
    assert_eq!(root, 0);
    assert_eq!(child, 1);
    assert_eq!(grandchild, 2);
}

#[test]
fn test_context_visibility_inheritance() {
    let mut builder = DoubleArrayTrieBuilder::new();
    builder.insert_with_value("root_term", Some(vec![0]));
    let dict = builder.build();

    let engine =
        StaticContextualCompletionEngine::with_double_array_trie(dict, Algorithm::Standard);

    let root = engine
        .create_root_context(0)
        .expect("create_root_context failed");
    let child = engine
        .create_child_context(1, root)
        .expect("create_child failed");

    // Child should be able to find terms visible in root
    // "root" -> "root_term" = 5 edits (insert '_term')
    let results = engine.complete(child, "root", 5).expect("complete failed");
    assert!(
        results.iter().any(|c| c.term == "root_term"),
        "Child should see root's terms"
    );
}

// ============================================================================
// Algorithm Variant Tests
// ============================================================================

#[test]
fn test_transposition_algorithm() {
    let mut builder = DoubleArrayTrieBuilder::new();
    builder.insert_with_value("test", Some(vec![0]));
    let dict = builder.build();

    let engine =
        StaticContextualCompletionEngine::with_double_array_trie(dict, Algorithm::Transposition);
    let ctx = engine
        .create_root_context(0)
        .expect("create_root_context failed");

    // "tset" is "test" with 's' and 'e' transposed
    let results = engine.complete(ctx, "tset", 1).expect("complete failed");
    assert!(
        results.iter().any(|c| c.term == "test"),
        "Transposition algorithm should find 'test' from 'tset'"
    );
}

#[test]
fn test_merge_and_split_algorithm() {
    let mut builder = DoubleArrayTrieBuilder::new();
    builder.insert_with_value("hello", Some(vec![0]));
    let dict = builder.build();

    let engine =
        StaticContextualCompletionEngine::with_double_array_trie(dict, Algorithm::MergeAndSplit);
    let ctx = engine
        .create_root_context(0)
        .expect("create_root_context failed");

    // Should find hello with standard edits
    let results = engine.complete(ctx, "helo", 1).expect("complete failed");
    assert!(
        results.iter().any(|c| c.term == "hello"),
        "MergeAndSplit should find 'hello' from 'helo'"
    );
}

// ============================================================================
// Edge Cases
// ============================================================================

#[test]
fn test_create_child_of_nonexistent_parent() {
    let builder = DoubleArrayTrieBuilder::<Vec<ContextId>>::new();
    let dict = builder.build();

    let engine =
        StaticContextualCompletionEngine::with_double_array_trie(dict, Algorithm::Standard);

    // Try to create child of non-existent parent (child_id, parent_id)
    let result = engine.create_child_context(1, 999);
    assert!(
        result.is_err(),
        "Should fail to create child of non-existent parent"
    );
}

#[test]
fn test_finalize_empty_draft() {
    let builder = DoubleArrayTrieBuilder::<Vec<ContextId>>::new();
    let dict = builder.build();

    let engine =
        StaticContextualCompletionEngine::with_double_array_trie(dict, Algorithm::Standard);
    let ctx = engine
        .create_root_context(0)
        .expect("create_root_context failed");

    // Finalize with empty draft
    let result = engine.finalize(ctx);
    assert!(result.is_ok(), "Finalize should succeed with empty draft");
    assert_eq!(
        result.unwrap(),
        "",
        "Finalized empty draft should return empty string"
    );
}

#[test]
fn test_multiple_finalize_operations() {
    let builder = DoubleArrayTrieBuilder::<Vec<ContextId>>::new();
    let dict = builder.build();

    let engine =
        StaticContextualCompletionEngine::with_double_array_trie(dict, Algorithm::Standard);
    let ctx = engine
        .create_root_context(0)
        .expect("create_root_context failed");

    // Finalize multiple terms
    engine.insert_str(ctx, "term1").expect("insert failed");
    engine.finalize(ctx).expect("finalize failed");

    engine.insert_str(ctx, "term2").expect("insert failed");
    engine.finalize(ctx).expect("finalize failed");

    engine.insert_str(ctx, "term3").expect("insert failed");
    engine.finalize(ctx).expect("finalize failed");

    // All terms should be searchable
    let results = engine.complete(ctx, "term", 1).expect("complete failed");
    let terms: Vec<&str> = results.iter().map(|c| c.term.as_str()).collect();

    assert!(terms.contains(&"term1"));
    assert!(terms.contains(&"term2"));
    assert!(terms.contains(&"term3"));
}

#[test]
fn test_draft_in_completion_results() {
    let builder = DoubleArrayTrieBuilder::<Vec<ContextId>>::new();
    let dict = builder.build();

    let engine =
        StaticContextualCompletionEngine::with_double_array_trie(dict, Algorithm::Standard);
    let ctx = engine
        .create_root_context(0)
        .expect("create_root_context failed");

    // Insert draft without finalizing
    engine.insert_str(ctx, "draft_term").expect("insert failed");

    // Draft should appear in completion results
    // "draft" -> "draft_term" = 5 edits (insert '_term')
    let results = engine.complete(ctx, "draft", 5).expect("complete failed");
    let draft_result = results.iter().find(|c| c.term == "draft_term");

    assert!(draft_result.is_some(), "Draft should appear in completion");
    assert!(
        draft_result.unwrap().is_draft,
        "Draft should be marked as draft"
    );
}

#[test]
fn test_clone_engine() {
    let mut builder = DoubleArrayTrieBuilder::new();
    builder.insert_with_value("test", Some(vec![0]));
    let dict = builder.build();

    let engine =
        StaticContextualCompletionEngine::with_double_array_trie(dict, Algorithm::Standard);
    let ctx = engine
        .create_root_context(0)
        .expect("create_root_context failed");

    // Clone the engine
    let engine_clone = engine.clone();

    // Both should share state (Arc-based cloning)
    engine.insert_str(ctx, "shared").expect("insert failed");

    let draft_original = engine.get_draft(ctx).expect("get_draft failed");
    let draft_clone = engine_clone.get_draft(ctx).expect("get_draft failed");

    assert_eq!(
        draft_original, draft_clone,
        "Cloned engine should share state"
    );
}