lucisearch 0.8.0

Embeddable, in-process search engine — the SQLite/DuckDB of Elasticsearch
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
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
/// Token filters transform, remove, or add tokens after tokenization.
///
/// Filters operate on the full token list rather than streaming, which
/// simplifies filters that need to remove tokens (like `stop`) or inspect
/// context (like `shingle`).
///
/// See [[analyzers#Token Filters]].
use std::collections::HashSet;

use crate::analysis::token::Token;

/// Transforms tokens in the analysis pipeline.
///
/// Implementations must be thread-safe (`Send + Sync`) so that analyzers
/// can be shared across indexing threads.
pub trait TokenFilter: Send + Sync {
    /// Apply the filter to `tokens`, modifying in place.
    fn apply(&self, tokens: &mut Vec<Token>);
}

/// Lowercases all token text.
///
/// Uses Unicode-aware lowercasing (`str::to_lowercase`). This is the most
/// common token filter — used by `standard`, `simple`, `stop`, and `pattern`
/// analyzers.
///
/// See [[analyzers#Token Filters]].
pub struct LowercaseFilter;

impl TokenFilter for LowercaseFilter {
    fn apply(&self, tokens: &mut Vec<Token>) {
        for token in tokens.iter_mut() {
            // Only allocate if the text actually changes.
            let lowered = token.text.to_lowercase();
            if lowered != token.text {
                token.text = lowered;
            }
        }
    }
}

/// Removes stop words from the token stream.
///
/// Stop words are common words (like "the", "is", "at") that carry little
/// meaning for search. Removing them reduces index size and can improve
/// precision. Positions are preserved so phrase queries still work correctly.
///
/// See [[analyzers#Token Filters]].
pub struct StopFilter {
    stop_words: HashSet<String>,
}

impl StopFilter {
    /// Create a stop filter with a custom set of stop words.
    pub fn new(words: impl IntoIterator<Item = impl Into<String>>) -> Self {
        Self {
            stop_words: words.into_iter().map(Into::into).collect(),
        }
    }

    /// Create a stop filter with the default English stop words.
    ///
    /// Uses the same list as Lucene's `EnglishAnalyzer`.
    pub fn english() -> Self {
        Self::new(ENGLISH_STOP_WORDS.iter().copied())
    }
}

impl TokenFilter for StopFilter {
    fn apply(&self, tokens: &mut Vec<Token>) {
        tokens.retain(|token| !self.stop_words.contains(&token.text));
    }
}

/// Default English stop words, matching Lucene's `EnglishAnalyzer`.
const ENGLISH_STOP_WORDS: &[&str] = &[
    "a", "an", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it",
    "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these",
    "they", "this", "to", "was", "will", "with",
];

/// Reduces tokens to their word stems using the Snowball algorithm.
///
/// Stemming maps morphological variants to a common root (e.g., "running" →
/// "run", "cats" → "cat"). This improves recall at the cost of some precision.
///
/// Supports 17+ languages via the Snowball stemming algorithms.
///
/// See [[analyzers#Token Filters]] and
/// [Snowball](https://snowballstem.org/algorithms/).
pub struct StemmerFilter {
    algorithm: rust_stemmers::Algorithm,
}

impl StemmerFilter {
    /// Create a stemmer filter for the given language.
    pub fn new(algorithm: rust_stemmers::Algorithm) -> Self {
        Self { algorithm }
    }

    /// Create an English stemmer filter.
    pub fn english() -> Self {
        Self::new(rust_stemmers::Algorithm::English)
    }
}

impl TokenFilter for StemmerFilter {
    fn apply(&self, tokens: &mut Vec<Token>) {
        let stemmer = rust_stemmers::Stemmer::create(self.algorithm);
        for token in tokens.iter_mut() {
            let stemmed = stemmer.stem(&token.text);
            if stemmed != token.text {
                token.text = stemmed.into_owned();
            }
        }
    }
}

/// Re-export the Algorithm enum so callers don't need to depend on
/// `rust-stemmers` directly.
pub use rust_stemmers::Algorithm as StemmerAlgorithm;

/// Converts Unicode characters to their ASCII equivalents.
///
/// Follows Lucene's `ASCIIFoldingFilter` — a lookup table covering Latin
/// Extended, IPA Extensions, Presentation Forms, and more. Characters
/// below U+0080 pass through unchanged (fast path).
///
/// Matches ES `asciifolding` token filter.
///
/// See [[analyzers#Token Filters]].
pub struct AsciiFoldingFilter {
    pub preserve_original: bool,
}

impl AsciiFoldingFilter {
    pub fn new(preserve_original: bool) -> Self {
        Self { preserve_original }
    }
}

impl TokenFilter for AsciiFoldingFilter {
    fn apply(&self, tokens: &mut Vec<Token>) {
        if self.preserve_original {
            let mut extra = Vec::new();
            for token in tokens.iter_mut() {
                let folded = ascii_fold(&token.text);
                if folded != token.text {
                    extra.push(Token {
                        text: folded,
                        offset_from: token.offset_from,
                        offset_to: token.offset_to,
                        position: token.position, // same position
                    });
                }
            }
            tokens.extend(extra);
        } else {
            for token in tokens.iter_mut() {
                let folded = ascii_fold(&token.text);
                if folded != token.text {
                    token.text = folded;
                }
            }
        }
    }
}

/// Fold a string to ASCII equivalents.
fn ascii_fold(s: &str) -> String {
    let mut result = String::with_capacity(s.len());
    for ch in s.chars() {
        if (ch as u32) < 0x80 {
            result.push(ch);
        } else {
            result.push_str(fold_char(ch));
        }
    }
    result
}

/// Map a single non-ASCII character to its ASCII equivalent(s).
/// Covers the most common Latin Extended characters. Returns the original
/// char as a string if no mapping exists.
fn fold_char(ch: char) -> &'static str {
    match ch {
        // Latin-1 Supplement
        '\u{00C0}'..='\u{00C5}' => "A", // À Á Â Ã Ä Å
        '\u{00C6}' => "AE",             // Æ
        '\u{00C7}' => "C",              // Ç
        '\u{00C8}'..='\u{00CB}' => "E", // È É Ê Ë
        '\u{00CC}'..='\u{00CF}' => "I", // Ì Í Î Ï
        '\u{00D0}' => "D",              // Ð
        '\u{00D1}' => "N",              // Ñ
        '\u{00D2}'..='\u{00D6}' => "O", // Ò Ó Ô Õ Ö
        '\u{00D8}' => "O",              // Ø
        '\u{00D9}'..='\u{00DC}' => "U", // Ù Ú Û Ü
        '\u{00DD}' => "Y",              // Ý
        '\u{00DE}' => "TH",             // Þ
        '\u{00DF}' => "ss",             // ß
        '\u{00E0}'..='\u{00E5}' => "a", // à á â ã ä å
        '\u{00E6}' => "ae",             // æ
        '\u{00E7}' => "c",              // ç
        '\u{00E8}'..='\u{00EB}' => "e", // è é ê ë
        '\u{00EC}'..='\u{00EF}' => "i", // ì í î ï
        '\u{00F0}' => "d",              // ð
        '\u{00F1}' => "n",              // ñ
        '\u{00F2}'..='\u{00F6}' => "o", // ò ó ô õ ö
        '\u{00F8}' => "o",              // ø
        '\u{00F9}'..='\u{00FC}' => "u", // ù ú û ü
        '\u{00FD}' | '\u{00FF}' => "y", // ý ÿ
        '\u{00FE}' => "th",             // þ

        // Latin Extended-A
        '\u{0100}' | '\u{0102}' | '\u{0104}' => "A",
        '\u{0101}' | '\u{0103}' | '\u{0105}' => "a",
        '\u{0106}' | '\u{0108}' | '\u{010A}' | '\u{010C}' => "C",
        '\u{0107}' | '\u{0109}' | '\u{010B}' | '\u{010D}' => "c",
        '\u{010E}' | '\u{0110}' => "D",
        '\u{010F}' | '\u{0111}' => "d",
        '\u{0112}' | '\u{0114}' | '\u{0116}' | '\u{0118}' | '\u{011A}' => "E",
        '\u{0113}' | '\u{0115}' | '\u{0117}' | '\u{0119}' | '\u{011B}' => "e",
        '\u{011C}' | '\u{011E}' | '\u{0120}' | '\u{0122}' => "G",
        '\u{011D}' | '\u{011F}' | '\u{0121}' | '\u{0123}' => "g",
        '\u{0124}' | '\u{0126}' => "H",
        '\u{0125}' | '\u{0127}' => "h",
        '\u{0128}' | '\u{012A}' | '\u{012C}' | '\u{012E}' | '\u{0130}' => "I",
        '\u{0129}' | '\u{012B}' | '\u{012D}' | '\u{012F}' | '\u{0131}' => "i",
        '\u{0132}' => "IJ",
        '\u{0133}' => "ij",
        '\u{0134}' => "J",
        '\u{0135}' => "j",
        '\u{0136}' => "K",
        '\u{0137}' | '\u{0138}' => "k",
        '\u{0139}' | '\u{013B}' | '\u{013D}' | '\u{013F}' | '\u{0141}' => "L",
        '\u{013A}' | '\u{013C}' | '\u{013E}' | '\u{0140}' | '\u{0142}' => "l",
        '\u{0143}' | '\u{0145}' | '\u{0147}' | '\u{014A}' => "N",
        '\u{0144}' | '\u{0146}' | '\u{0148}' | '\u{0149}' | '\u{014B}' => "n",
        '\u{014C}' | '\u{014E}' | '\u{0150}' => "O",
        '\u{014D}' | '\u{014F}' | '\u{0151}' => "o",
        '\u{0152}' => "OE",
        '\u{0153}' => "oe",
        '\u{0154}' | '\u{0156}' | '\u{0158}' => "R",
        '\u{0155}' | '\u{0157}' | '\u{0159}' => "r",
        '\u{015A}' | '\u{015C}' | '\u{015E}' | '\u{0160}' => "S",
        '\u{015B}' | '\u{015D}' | '\u{015F}' | '\u{0161}' => "s",
        '\u{0162}' | '\u{0164}' | '\u{0166}' => "T",
        '\u{0163}' | '\u{0165}' | '\u{0167}' => "t",
        '\u{0168}' | '\u{016A}' | '\u{016C}' | '\u{016E}' | '\u{0170}' | '\u{0172}' => "U",
        '\u{0169}' | '\u{016B}' | '\u{016D}' | '\u{016F}' | '\u{0171}' | '\u{0173}' => "u",
        '\u{0174}' => "W",
        '\u{0175}' => "w",
        '\u{0176}' => "Y",
        '\u{0177}' => "y",
        '\u{0178}' => "Y",
        '\u{0179}' | '\u{017B}' | '\u{017D}' => "Z",
        '\u{017A}' | '\u{017C}' | '\u{017E}' => "z",

        // Common additional mappings
        '\u{0218}' | '\u{021A}' => "S", // Ș
        '\u{0219}' | '\u{021B}' => "s", // ș
        '\u{01A0}' | '\u{01A2}' => "O",
        '\u{01A1}' | '\u{01A3}' => "o",
        '\u{01AF}' => "U",
        '\u{01B0}' => "u",

        // Fullwidth Latin
        '\u{FF21}'..='\u{FF3A}' => {
            // Fullwidth A-Z → regular A-Z
            // We can't return a dynamic &'static str, so handle the common case
            return leak_fold(ch);
        }
        '\u{FF41}'..='\u{FF5A}' => {
            return leak_fold(ch);
        }

        // No mapping found — return original char
        _ => return leak_fold(ch),
    }
}

/// For chars without a static mapping, convert to a string.
/// This leaks memory for unmapped non-ASCII chars, but in practice these
/// are rare and the leak is bounded (one allocation per unique char).
fn leak_fold(ch: char) -> &'static str {
    // For fullwidth Latin letters, map to regular ASCII
    let code = ch as u32;
    if (0xFF21..=0xFF3A).contains(&code) {
        let ascii = (code - 0xFF21 + b'A' as u32) as u8 as char;
        return match ascii {
            'A' => "A",
            'B' => "B",
            'C' => "C",
            'D' => "D",
            'E' => "E",
            'F' => "F",
            'G' => "G",
            'H' => "H",
            'I' => "I",
            'J' => "J",
            'K' => "K",
            'L' => "L",
            'M' => "M",
            'N' => "N",
            'O' => "O",
            'P' => "P",
            'Q' => "Q",
            'R' => "R",
            'S' => "S",
            'T' => "T",
            'U' => "U",
            'V' => "V",
            'W' => "W",
            'X' => "X",
            'Y' => "Y",
            'Z' => "Z",
            _ => unreachable!(),
        };
    }
    if (0xFF41..=0xFF5A).contains(&code) {
        let ascii = (code - 0xFF41 + b'a' as u32) as u8 as char;
        return match ascii {
            'a' => "a",
            'b' => "b",
            'c' => "c",
            'd' => "d",
            'e' => "e",
            'f' => "f",
            'g' => "g",
            'h' => "h",
            'i' => "i",
            'j' => "j",
            'k' => "k",
            'l' => "l",
            'm' => "m",
            'n' => "n",
            'o' => "o",
            'p' => "p",
            'q' => "q",
            'r' => "r",
            's' => "s",
            't' => "t",
            'u' => "u",
            'v' => "v",
            'w' => "w",
            'x' => "x",
            'y' => "y",
            'z' => "z",
            _ => unreachable!(),
        };
    }

    // No mapping — return the char as-is using a leaked static string
    // This only happens for unmapped non-ASCII chars and each unique char
    // leaks at most 4 bytes.
    let s = ch.to_string();
    Box::leak(s.into_boxed_str())
}

/// Generates n-grams from each token.
///
/// Unlike the NGram *tokenizer*, this operates on existing tokens rather
/// than raw text.
///
/// Matches ES `ngram` token filter.
///
/// See [[analyzers#Token Filters]].
pub struct NGramTokenFilter {
    pub min_gram: usize,
    pub max_gram: usize,
}

impl NGramTokenFilter {
    pub fn new(min_gram: usize, max_gram: usize) -> Self {
        Self { min_gram, max_gram }
    }
}

impl TokenFilter for NGramTokenFilter {
    fn apply(&self, tokens: &mut Vec<Token>) {
        let original = std::mem::take(tokens);
        for token in &original {
            let chars: Vec<(usize, char)> = token.text.char_indices().collect();
            for n in self.min_gram..=self.max_gram {
                if n > chars.len() {
                    break;
                }
                for i in 0..=chars.len() - n {
                    let start = chars[i].0;
                    let end = if i + n < chars.len() {
                        chars[i + n].0
                    } else {
                        token.text.len()
                    };
                    tokens.push(Token {
                        text: token.text[start..end].to_string(),
                        offset_from: token.offset_from,
                        offset_to: token.offset_to,
                        position: token.position,
                    });
                }
            }
        }
    }
}

/// Generates edge n-grams (prefix n-grams) from each token.
///
/// Matches ES `edge_ngram` token filter.
///
/// See [[analyzers#Token Filters]].
pub struct EdgeNGramTokenFilter {
    pub min_gram: usize,
    pub max_gram: usize,
    pub preserve_original: bool,
}

impl EdgeNGramTokenFilter {
    pub fn new(min_gram: usize, max_gram: usize, preserve_original: bool) -> Self {
        Self {
            min_gram,
            max_gram,
            preserve_original,
        }
    }
}

impl TokenFilter for EdgeNGramTokenFilter {
    fn apply(&self, tokens: &mut Vec<Token>) {
        let original = std::mem::take(tokens);
        for token in &original {
            let chars: Vec<(usize, char)> = token.text.char_indices().collect();
            let mut emitted_original = false;
            for n in self.min_gram..=self.max_gram.min(chars.len()) {
                let end = if n < chars.len() {
                    chars[n].0
                } else {
                    token.text.len()
                };
                if n == chars.len() {
                    emitted_original = true;
                }
                tokens.push(Token {
                    text: token.text[..end].to_string(),
                    offset_from: token.offset_from,
                    offset_to: token.offset_to,
                    position: token.position,
                });
            }
            if self.preserve_original && !emitted_original {
                tokens.push(token.clone());
            }
        }
    }
}

/// Expands or replaces tokens with synonyms.
///
/// Supports Solr-format synonym rules:
/// - Equivalent: `quick, fast, speedy` (bidirectional)
/// - Explicit: `big => large` (unidirectional)
///
/// Matches ES `synonym` token filter.
///
/// See [[analyzers#Token Filters]].
pub struct SynonymFilter {
    /// Maps a token text to its synonyms (expansions).
    synonym_map: std::collections::HashMap<String, Vec<String>>,
}

impl SynonymFilter {
    /// Create from Solr-format synonym rules.
    pub fn new(rules: &[String], expand: bool) -> Self {
        let mut synonym_map: std::collections::HashMap<String, Vec<String>> =
            std::collections::HashMap::new();

        for rule in rules {
            let rule = rule.trim();
            if rule.is_empty() || rule.starts_with('#') {
                continue;
            }

            if let Some((left, right)) = rule.split_once("=>") {
                // Explicit mapping: left terms map to right terms
                let left_terms: Vec<String> = left
                    .split(',')
                    .map(|s| s.trim().to_lowercase())
                    .filter(|s| !s.is_empty())
                    .collect();
                let right_terms: Vec<String> = right
                    .split(',')
                    .map(|s| s.trim().to_lowercase())
                    .filter(|s| !s.is_empty())
                    .collect();

                for term in &left_terms {
                    synonym_map
                        .entry(term.clone())
                        .or_default()
                        .extend(right_terms.clone());
                }
            } else {
                // Equivalent synonyms
                let terms: Vec<String> = rule
                    .split(',')
                    .map(|s| s.trim().to_lowercase())
                    .filter(|s| !s.is_empty())
                    .collect();

                if expand {
                    // Each term maps to all other terms
                    for term in &terms {
                        let others: Vec<String> =
                            terms.iter().filter(|t| *t != term).cloned().collect();
                        synonym_map.entry(term.clone()).or_default().extend(others);
                    }
                } else {
                    // All terms map to the first term
                    if let Some(canonical) = terms.first() {
                        for term in &terms[1..] {
                            synonym_map
                                .entry(term.clone())
                                .or_default()
                                .push(canonical.clone());
                        }
                    }
                }
            }
        }

        Self { synonym_map }
    }
}

impl TokenFilter for SynonymFilter {
    fn apply(&self, tokens: &mut Vec<Token>) {
        let mut extra = Vec::new();
        for token in tokens.iter() {
            if let Some(synonyms) = self.synonym_map.get(&token.text) {
                for syn in synonyms {
                    extra.push(Token {
                        text: syn.clone(),
                        offset_from: token.offset_from,
                        offset_to: token.offset_to,
                        position: token.position, // same position as original
                    });
                }
            }
        }
        tokens.extend(extra);
    }
}

/// Produces word-level n-grams (shingles) from the token stream.
///
/// For example, with `min_size=2, max_size=2`, tokens `[the, quick, brown]`
/// produce shingles `[the quick, quick brown]` (and optionally the original
/// unigrams).
///
/// Matches ES `shingle` token filter.
///
/// See [[analyzers#Token Filters]].
pub struct ShingleFilter {
    pub min_size: usize,
    pub max_size: usize,
    pub output_unigrams: bool,
    pub separator: String,
    pub filler_token: String,
}

impl ShingleFilter {
    pub fn new(min_size: usize, max_size: usize, output_unigrams: bool) -> Self {
        Self {
            min_size,
            max_size,
            output_unigrams,
            separator: " ".to_string(),
            filler_token: "_".to_string(),
        }
    }
}

impl TokenFilter for ShingleFilter {
    fn apply(&self, tokens: &mut Vec<Token>) {
        if tokens.is_empty() {
            return;
        }

        let original = tokens.clone();
        let mut result = Vec::new();

        for (i, token) in original.iter().enumerate() {
            if self.output_unigrams {
                result.push(token.clone());
            }

            // Generate shingles starting at this token
            for size in self.min_size..=self.max_size {
                if i + size > original.len() {
                    break;
                }
                let shingle_tokens = &original[i..i + size];
                let shingle_text: String = shingle_tokens
                    .iter()
                    .map(|t| t.text.as_str())
                    .collect::<Vec<_>>()
                    .join(&self.separator);

                result.push(Token {
                    text: shingle_text,
                    offset_from: shingle_tokens.first().unwrap().offset_from,
                    offset_to: shingle_tokens.last().unwrap().offset_to,
                    position: token.position,
                });
            }
        }

        *tokens = result;
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn make_tokens(words: &[&str]) -> Vec<Token> {
        words
            .iter()
            .enumerate()
            .map(|(i, w)| Token::new(*w, 0, w.len(), i as u32))
            .collect()
    }

    // --- LowercaseFilter ---

    #[test]
    fn lowercase_basic() {
        let mut tokens = make_tokens(&["Hello", "WORLD", "TeSt"]);
        LowercaseFilter.apply(&mut tokens);
        assert_eq!(tokens[0].text, "hello");
        assert_eq!(tokens[1].text, "world");
        assert_eq!(tokens[2].text, "test");
    }

    #[test]
    fn lowercase_already_lower() {
        let mut tokens = make_tokens(&["hello", "world"]);
        LowercaseFilter.apply(&mut tokens);
        assert_eq!(tokens[0].text, "hello");
        assert_eq!(tokens[1].text, "world");
    }

    #[test]
    fn lowercase_unicode() {
        let mut tokens = make_tokens(&["CAFÉ", "Ñoño"]);
        LowercaseFilter.apply(&mut tokens);
        assert_eq!(tokens[0].text, "café");
        assert_eq!(tokens[1].text, "ñoño");
    }

    #[test]
    fn lowercase_preserves_positions() {
        let mut tokens = make_tokens(&["A", "B", "C"]);
        LowercaseFilter.apply(&mut tokens);
        assert_eq!(tokens[0].position, 0);
        assert_eq!(tokens[1].position, 1);
        assert_eq!(tokens[2].position, 2);
    }

    #[test]
    fn lowercase_empty() {
        let mut tokens: Vec<Token> = Vec::new();
        LowercaseFilter.apply(&mut tokens);
        assert!(tokens.is_empty());
    }

    // --- StopFilter ---

    #[test]
    fn stop_removes_stop_words() {
        let mut tokens = make_tokens(&["the", "quick", "brown", "fox"]);
        StopFilter::english().apply(&mut tokens);
        let texts: Vec<&str> = tokens.iter().map(|t| t.text.as_str()).collect();
        assert_eq!(texts, vec!["quick", "brown", "fox"]);
    }

    #[test]
    fn stop_preserves_positions() {
        let mut tokens = make_tokens(&["the", "quick", "brown", "fox"]);
        StopFilter::english().apply(&mut tokens);
        // Positions from the original tokenization are preserved.
        assert_eq!(tokens[0].position, 1); // "quick" was at position 1
        assert_eq!(tokens[1].position, 2); // "brown" was at position 2
    }

    #[test]
    fn stop_all_removed() {
        let mut tokens = make_tokens(&["the", "a", "is", "it"]);
        StopFilter::english().apply(&mut tokens);
        assert!(tokens.is_empty());
    }

    #[test]
    fn stop_none_removed() {
        let mut tokens = make_tokens(&["quick", "brown", "fox"]);
        StopFilter::english().apply(&mut tokens);
        assert_eq!(tokens.len(), 3);
    }

    #[test]
    fn stop_custom_words() {
        let mut tokens = make_tokens(&["hello", "world", "goodbye"]);
        let filter = StopFilter::new(["hello", "goodbye"]);
        filter.apply(&mut tokens);
        assert_eq!(tokens.len(), 1);
        assert_eq!(tokens[0].text, "world");
    }

    #[test]
    fn stop_case_sensitive() {
        let mut tokens = make_tokens(&["The", "quick"]);
        StopFilter::english().apply(&mut tokens);
        // "The" (uppercase) is NOT in the stop word set — stop filter
        // should be applied after lowercase filter.
        assert_eq!(tokens.len(), 2);
    }

    // --- StemmerFilter ---

    #[test]
    fn stemmer_english_basic() {
        let mut tokens = make_tokens(&["running", "cats", "easily"]);
        StemmerFilter::english().apply(&mut tokens);
        assert_eq!(tokens[0].text, "run");
        assert_eq!(tokens[1].text, "cat");
        assert_eq!(tokens[2].text, "easili");
    }

    #[test]
    fn stemmer_already_stemmed() {
        let mut tokens = make_tokens(&["run", "cat"]);
        StemmerFilter::english().apply(&mut tokens);
        assert_eq!(tokens[0].text, "run");
        assert_eq!(tokens[1].text, "cat");
    }

    #[test]
    fn stemmer_preserves_positions() {
        let mut tokens = make_tokens(&["running", "jumping"]);
        StemmerFilter::english().apply(&mut tokens);
        assert_eq!(tokens[0].position, 0);
        assert_eq!(tokens[1].position, 1);
    }

    #[test]
    fn stemmer_empty() {
        let mut tokens: Vec<Token> = Vec::new();
        StemmerFilter::english().apply(&mut tokens);
        assert!(tokens.is_empty());
    }

    // --- AsciiFoldingFilter ---

    #[test]
    fn asciifolding_basic() {
        let mut tokens = make_tokens(&["café", "résumé", "naïve"]);
        AsciiFoldingFilter::new(false).apply(&mut tokens);
        assert_eq!(tokens[0].text, "cafe");
        assert_eq!(tokens[1].text, "resume");
        assert_eq!(tokens[2].text, "naive");
    }

    #[test]
    fn asciifolding_no_change() {
        let mut tokens = make_tokens(&["hello", "world"]);
        AsciiFoldingFilter::new(false).apply(&mut tokens);
        assert_eq!(tokens[0].text, "hello");
        assert_eq!(tokens[1].text, "world");
    }

    #[test]
    fn asciifolding_preserve_original() {
        let mut tokens = make_tokens(&["café"]);
        AsciiFoldingFilter::new(true).apply(&mut tokens);
        let texts: Vec<&str> = tokens.iter().map(|t| t.text.as_str()).collect();
        assert!(texts.contains(&"café")); // original preserved
        assert!(texts.contains(&"cafe")); // folded added
    }

    #[test]
    fn asciifolding_german() {
        let mut tokens = make_tokens(&["über", "straße"]);
        AsciiFoldingFilter::new(false).apply(&mut tokens);
        assert_eq!(tokens[0].text, "uber");
        assert_eq!(tokens[1].text, "strasse");
    }

    #[test]
    fn asciifolding_ligatures() {
        let mut tokens = make_tokens(&["Æneid", "œuvre"]);
        AsciiFoldingFilter::new(false).apply(&mut tokens);
        assert_eq!(tokens[0].text, "AEneid");
        assert_eq!(tokens[1].text, "oeuvre");
    }

    // --- NGramTokenFilter ---

    #[test]
    fn ngram_filter_basic() {
        let mut tokens = make_tokens(&["quick"]);
        NGramTokenFilter::new(2, 3).apply(&mut tokens);
        let texts: Vec<&str> = tokens.iter().map(|t| t.text.as_str()).collect();
        assert_eq!(texts, vec!["qu", "ui", "ic", "ck", "qui", "uic", "ick"]);
    }

    #[test]
    fn ngram_filter_empty() {
        let mut tokens: Vec<Token> = Vec::new();
        NGramTokenFilter::new(2, 3).apply(&mut tokens);
        assert!(tokens.is_empty());
    }

    // --- EdgeNGramTokenFilter ---

    #[test]
    fn edge_ngram_filter_basic() {
        let mut tokens = make_tokens(&["quick"]);
        EdgeNGramTokenFilter::new(2, 4, false).apply(&mut tokens);
        let texts: Vec<&str> = tokens.iter().map(|t| t.text.as_str()).collect();
        assert_eq!(texts, vec!["qu", "qui", "quic"]);
    }

    #[test]
    fn edge_ngram_filter_preserve_original() {
        let mut tokens = make_tokens(&["quick"]);
        EdgeNGramTokenFilter::new(2, 3, true).apply(&mut tokens);
        let texts: Vec<&str> = tokens.iter().map(|t| t.text.as_str()).collect();
        assert_eq!(texts, vec!["qu", "qui", "quick"]); // original preserved
    }

    // --- SynonymFilter ---

    #[test]
    fn synonym_equivalent() {
        let filter = SynonymFilter::new(&["quick, fast, speedy".to_string()], true);
        let mut tokens = make_tokens(&["quick"]);
        filter.apply(&mut tokens);
        let texts: Vec<&str> = tokens.iter().map(|t| t.text.as_str()).collect();
        assert!(texts.contains(&"quick"));
        assert!(texts.contains(&"fast"));
        assert!(texts.contains(&"speedy"));
    }

    #[test]
    fn synonym_explicit() {
        let filter = SynonymFilter::new(&["big => large".to_string()], true);
        let mut tokens = make_tokens(&["big"]);
        filter.apply(&mut tokens);
        let texts: Vec<&str> = tokens.iter().map(|t| t.text.as_str()).collect();
        assert!(texts.contains(&"big")); // original kept
        assert!(texts.contains(&"large")); // expansion added
    }

    #[test]
    fn synonym_no_match() {
        let filter = SynonymFilter::new(&["quick, fast".to_string()], true);
        let mut tokens = make_tokens(&["slow"]);
        filter.apply(&mut tokens);
        assert_eq!(tokens.len(), 1);
        assert_eq!(tokens[0].text, "slow");
    }

    #[test]
    fn synonym_expand_false() {
        let filter = SynonymFilter::new(&["quick, fast, speedy".to_string()], false);
        let mut tokens = make_tokens(&["fast"]);
        filter.apply(&mut tokens);
        let texts: Vec<&str> = tokens.iter().map(|t| t.text.as_str()).collect();
        assert!(texts.contains(&"fast"));
        assert!(texts.contains(&"quick")); // canonical (first term)
    }

    #[test]
    fn synonym_same_position() {
        let filter = SynonymFilter::new(&["quick, fast".to_string()], true);
        let mut tokens = make_tokens(&["quick"]);
        filter.apply(&mut tokens);
        // All synonyms at same position
        assert!(tokens.iter().all(|t| t.position == 0));
    }

    // --- ShingleFilter ---

    #[test]
    fn shingle_basic() {
        let mut tokens = make_tokens(&["the", "quick", "brown", "fox"]);
        ShingleFilter::new(2, 2, false).apply(&mut tokens);
        let texts: Vec<&str> = tokens.iter().map(|t| t.text.as_str()).collect();
        assert_eq!(texts, vec!["the quick", "quick brown", "brown fox"]);
    }

    #[test]
    fn shingle_with_unigrams() {
        let mut tokens = make_tokens(&["the", "quick", "brown"]);
        ShingleFilter::new(2, 2, true).apply(&mut tokens);
        let texts: Vec<&str> = tokens.iter().map(|t| t.text.as_str()).collect();
        assert_eq!(
            texts,
            vec!["the", "the quick", "quick", "quick brown", "brown"]
        );
    }

    #[test]
    fn shingle_trigrams() {
        let mut tokens = make_tokens(&["a", "b", "c", "d"]);
        ShingleFilter::new(3, 3, false).apply(&mut tokens);
        let texts: Vec<&str> = tokens.iter().map(|t| t.text.as_str()).collect();
        assert_eq!(texts, vec!["a b c", "b c d"]);
    }

    #[test]
    fn shingle_empty() {
        let mut tokens: Vec<Token> = Vec::new();
        ShingleFilter::new(2, 2, false).apply(&mut tokens);
        assert!(tokens.is_empty());
    }
}