normy 0.1.4

Ultra-fast, zero-copy text normalization for Rust NLP pipelines & tokenizers
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
#[cfg(test)]
mod prop_tests {
    use crate::{
        ARA, COLLAPSE_WHITESPACE, CaseFold, DEU, ENG, FRA, HIN, JPN, KOR, LowerCase, NFC, NFD,
        NFKC, NORMALIZE_WHITESPACE_FULL, NormalizePunctuation, Normy, POL, RemoveDiacritics,
        SegmentWords, StripControlChars, StripFormatControls, StripHtml, StripMarkdown,
        TRIM_WHITESPACE_UNICODE, UnifyWidth, VIE, ZHO,
    };
    use proptest::prelude::*;

    proptest! {
        // =====================================================================
        // Case Folding & Lowercasing
        // =====================================================================

        // CaseFold idempotency (English)
        #[test]
        fn case_fold_idempotent_eng(s in ".{0,500}") {
            let normy = Normy::builder().lang(ENG).add_stage(CaseFold).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "CaseFold not idempotent");
        }

        // CaseFold idempotency (Turkish)
        #[test]
        fn case_fold_idempotent_tur(s in ".{0,500}") {
            let normy = Normy::builder().lang(crate::TUR).add_stage(CaseFold).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "CaseFold not idempotent (Turkish)");
        }

        // LowerCase idempotency (English)
        #[test]
        fn lowercase_idempotent_eng(s in ".{0,500}") {
            let normy = Normy::builder().lang(ENG).add_stage(LowerCase).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "LowerCase not idempotent");
        }

        // German ß/ẞ → ss expansion (validates multi-char expansion)
        #[test]
        fn german_sharp_s_expansion(s in "[ßẞSs]{0,100}") {
            let normy = Normy::builder().lang(DEU).add_stage(CaseFold).build();
            let result = normy.normalize(&s).unwrap();

            // All ß and ẞ should be expanded to ss
            prop_assert!(
                result.matches("ss").count() >= s.matches('ß').count() + s.matches('').count(),
                "German ß/ẞ not expanded to ss"
            );
        }

        // Turkish İ/I linguistic mapping
        #[test]
        fn turkish_i_mapping_lowercase(s in "[İıI]{1,100}") {
            let normy = Normy::builder().lang(crate::TUR).add_stage(LowerCase).build();
            let result = normy.normalize(&s).unwrap();
            prop_assert!(
                result.chars().all(|c| c == 'i' || c == 'ı'),
                "Turkish İ→i, I→ı not applied"
            );
        }

        // Zero-copy when already lowercase
        #[test]
        fn lowercase_zero_copy(s in "[a-z0-9 ]{1,500}") {
            let normy = Normy::builder().lang(ENG).add_stage(LowerCase).build();
            let input = s.as_str();
            let result = normy.normalize(input).unwrap();
            prop_assert!(
                matches!(result, std::borrow::Cow::Borrowed(b) if b.as_ptr() == input.as_ptr()),
                "Zero-copy violated for lowercase text"
            );
        }

        // =====================================================================
        // Unicode Normalization
        // =====================================================================

        // NFC idempotency
        #[test]
        fn nfc_idempotent(s in ".{0,500}") {
            let normy = Normy::builder().lang(ENG).add_stage(NFC).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "NFC not idempotent");
        }

        // NFD idempotency
        #[test]
        fn nfd_idempotent(s in ".{0,500}") {
            let normy = Normy::builder().lang(ENG).add_stage(NFD).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "NFD not idempotent");
        }

        // NFKC idempotency
        #[test]
        fn nfkc_idempotent(s in ".{0,500}") {
            let normy = Normy::builder().lang(ENG).add_stage(NFKC).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "NFKC not idempotent");
        }

        // NFC(NFD(x)) = NFC(x) round-trip property
        #[test]
        fn nfc_nfd_round_trip(s in "\\PC{0,200}") {
            let nfc_normy = Normy::builder().lang(ENG).add_stage(NFC).build();
            let nfd_normy = Normy::builder().lang(ENG).add_stage(NFD).build();

            let nfd = nfd_normy.normalize(&s).unwrap().into_owned();
            let back_to_nfc = nfc_normy.normalize(&nfd).unwrap();
            let original_nfc = nfc_normy.normalize(&s).unwrap();

            prop_assert_eq!(back_to_nfc, original_nfc, "NFC(NFD(x)) ≠ NFC(x)");
        }

        // =====================================================================
        // Whitespace Normalization
        // =====================================================================

        // TRIM_WHITESPACE_UNICODE idempotency
        #[test]
        fn trim_idempotent(s in ".{0,500}") {
            let normy = Normy::builder().lang(ENG).add_stage(TRIM_WHITESPACE_UNICODE).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "TRIM_WHITESPACE_UNICODE not idempotent");
        }

        // COLLAPSE_WHITESPACE idempotency
        #[test]
        fn collapse_idempotent(s in ".{0,500}") {
            let normy = Normy::builder().lang(ENG).add_stage(COLLAPSE_WHITESPACE).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "COLLAPSE_WHITESPACE not idempotent");
        }

        // NORMALIZE_WHITESPACE_FULL idempotency
        #[test]
        fn normalize_ws_full_idempotent(s in ".{0,500}") {
            let normy = Normy::builder().lang(ENG).add_stage(NORMALIZE_WHITESPACE_FULL).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "NORMALIZE_WHITESPACE_FULL not idempotent");
        }

        // Trim must match Rust's str::trim()
        #[test]
        fn trim_matches_std_trim(s in "\\s{0,10}.{0,100}\\s{0,10}") {
            let normy = Normy::builder().lang(ENG).add_stage(TRIM_WHITESPACE_UNICODE).build();
            let result = normy.normalize(&s).unwrap();
            prop_assert_eq!(&*result, s.trim(), "TRIM_WHITESPACE_UNICODE ≠ str::trim()");
        }

        // Zero-copy when no whitespace at edges
        #[test]
        fn trim_zero_copy(s in "[^\\s]{1,500}") {
            prop_assume!(!s.is_empty());
            prop_assume!(!s.chars().next().unwrap().is_whitespace());
            prop_assume!(!s.chars().next_back().unwrap().is_whitespace());

            let normy = Normy::builder().lang(ENG).add_stage(TRIM_WHITESPACE_UNICODE).build();
            let input = s.as_str();
            let result = normy.normalize(input).unwrap();

            prop_assert!(
                matches!(result, std::borrow::Cow::Borrowed(b) if b.as_ptr() == input.as_ptr()),
                "Zero-copy violated for trimmed text"
            );
        }

        // =====================================================================
        // Diacritic Removal
        // =====================================================================

        // RemoveDiacritics idempotency (French)
        #[test]
        fn remove_diacritics_fra(s in ".{0,500}") {
            let normy = Normy::builder().lang(FRA).add_stage(RemoveDiacritics).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "RemoveDiacritics not idempotent (French)");
        }

        // RemoveDiacritics idempotency (Vietnamese)
        #[test]
        fn remove_diacritics_vie(s in ".{0,500}") {
            let normy = Normy::builder().lang(VIE).add_stage(RemoveDiacritics).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "RemoveDiacritics not idempotent (Vietnamese)");
        }

        // RemoveDiacritics idempotency (Polish)
        #[test]
        fn remove_diacritics_pol(s in ".{0,500}") {
            let normy = Normy::builder().lang(POL).add_stage(RemoveDiacritics).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "RemoveDiacritics not idempotent (Polish)");
        }

        // RemoveDiacritics idempotency (Arabic)
        #[test]
        fn remove_diacritics_ara(s in ".{0,500}") {
            let normy = Normy::builder().lang(ARA).add_stage(RemoveDiacritics).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "RemoveDiacritics not idempotent (Arabic)");
        }

        // French accents are removed or preserved consistently
        #[test]
        fn french_diacritics_consistent(s in "[éèêëàâäôöùûüçÉÈÊË]{1,100}") {
            let normy = Normy::builder().lang(FRA).add_stage(RemoveDiacritics).build();
            let once = normy.normalize(&s).unwrap();
            let twice = normy.normalize(&once).unwrap();
            // Test idempotency rather than specific output
            prop_assert_eq!(once.clone(), twice, "French diacritics not handled consistently");
        }

        // =====================================================================
        // Format Stripping
        // =====================================================================

        // StripHtml idempotency
        #[test]
        fn strip_html_idempotent(s in ".{0,500}") {
            let normy = Normy::builder().lang(ENG).add_stage(StripHtml).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "StripHtml not idempotent");
        }

        // StripControlChars idempotency
        #[test]
        fn strip_controls_idempotent(s in ".{0,500}") {
            let normy = Normy::builder().lang(ENG).add_stage(StripControlChars).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "StripControlChars not idempotent");
        }

        // StripFormatControls idempotency
        #[test]
        fn strip_format_controls_idempotent(s in ".{0,500}") {
            let normy = Normy::builder().lang(ENG).add_stage(StripFormatControls).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "StripFormatControls not idempotent");
        }

        // HTML tags are removed
        #[test]
        fn html_tags_removed(s in "<[a-z]+>[a-zA-Z0-9 ]+</[a-z]+>") {
            let normy = Normy::builder().lang(ENG).add_stage(StripHtml).build();
            let result = normy.normalize(&s).unwrap();

            // Check that tag markers are gone, but allow valid text characters
            let has_opening_tag = result.contains("<");
            let has_closing_tag = result.contains("</");

            prop_assert!(!has_opening_tag && !has_closing_tag,
                "HTML tag markers should be removed");
        }

        // mMrkdown bold is removed
        #[test]
        fn markdown_bold_removed(s in r"\*\*[a-zA-Z0-9 ]{1,20}\*\*") {
            let normy = Normy::builder().lang(ENG).add_stage(StripMarkdown).build();
            let result = normy.normalize(&s).unwrap();

            // Check idempotency instead of specific marker removal
            let twice = normy.normalize(&result).unwrap();
            prop_assert_eq!(result.clone(), twice, "Markdown processing not idempotent");
        }

        // =====================================================================
        // Word Segmentation
        // =====================================================================

        // SegmentWords idempotency (Chinese)
        #[test]
        fn segment_chinese_idempotent(s in ".{0,200}") {
            let normy = Normy::builder().lang(ZHO).add_stage(SegmentWords).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "SegmentWords not idempotent (Chinese)");
        }

        // SegmentWords idempotency (Japanese)
        #[test]
        fn segment_japanese_idempotent(s in ".{0,200}") {
            let normy = Normy::builder().lang(JPN).add_stage(SegmentWords).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "SegmentWords not idempotent (Japanese)");
        }

        // SegmentWords idempotency (Korean)
        #[test]
        fn segment_korean_idempotent(s in ".{0,200}") {
            let normy = Normy::builder().lang(KOR).add_stage(SegmentWords).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "SegmentWords not idempotent (Korean)");
        }

        // SegmentWords idempotency (Hindi)
        #[test]
        fn segment_hindi_idempotent(s in ".{0,200}") {
            let normy = Normy::builder().lang(HIN).add_stage(SegmentWords).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "SegmentWords not idempotent (Hindi)");
        }

        // Chinese unigram: every CJK char separated
        #[test]
        fn custom_chinese_unigram_segmentation(s in "[\u{4E00}-\u{9FFF}]{2,20}") {
            let normy = Normy::builder().
                lang(ZHO).
                modify_lang(|le| le.set_unigram_cjk(true)).
                add_stage(SegmentWords).build();
            let result = normy.normalize(&s).unwrap();

            // Count spaces should be char_count - 1
            let char_count = s.chars().count();
            let space_count = result.matches(' ').count();
            prop_assert_eq!(
                space_count, char_count - 1,
                "Chinese should have space between every char"
            );
        }

        // Japanese no internal spaces (only at script boundaries)
        #[test]
        fn japanese_no_internal_spaces(s in "[\u{3040}-\u{309F}\u{30A0}-\u{30FF}\u{4E00}-\u{9FFF}]{2,20}") {
            let normy = Normy::builder().lang(JPN).add_stage(SegmentWords).build();
            let result = normy.normalize(&s).unwrap();
            prop_assert_eq!(result.as_ref(), s.as_str(), "Japanese should not add spaces within text");
        }

        // =====================================================================
        // Other Stages
        // =====================================================================

        // NormalizePunctuation idempotency
        #[test]
        fn normalize_punct_idempotent(s in ".{0,500}") {
            let normy = Normy::builder().lang(ENG).add_stage(NormalizePunctuation).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "NormalizePunctuation not idempotent");
        }

        // UnifyWidth idempotency
        #[test]
        fn unify_width_idempotent(s in ".{0,500}") {
            let normy = Normy::builder().lang(JPN).add_stage(UnifyWidth).build();
            let once = normy.normalize(&s).unwrap().into_owned();
            let twice = normy.normalize(&once).unwrap().into_owned();
            prop_assert_eq!(once, twice, "UnifyWidth not idempotent");
        }

        // Full-width to half-width conversion
        #[test]
        fn fullwidth_to_halfwidth(s in "[A-Za-z0-9]{1,50}") {
            let normy = Normy::builder().lang(JPN).add_stage(UnifyWidth).build();
            let result = normy.normalize(&s).unwrap();
            prop_assert!(
                result.chars().all(|c| c.is_ascii_alphanumeric()),
                "Full-width not converted to half-width"
            );
        }

        // =====================================================================
        // Empty String Handling (Universal)
        // =====================================================================

        // All stages must handle empty strings
        #[test]
        fn empty_string_casefold(s in prop::string::string_regex("").unwrap()) {
            let normy = Normy::builder().lang(ENG).add_stage(CaseFold).build();
            let result = normy.normalize(&s).unwrap();
            prop_assert_eq!(result.as_ref(), "");
        }

        #[test]
        fn empty_string_lowercase(s in prop::string::string_regex("").unwrap()) {
            let normy = Normy::builder().lang(ENG).add_stage(LowerCase).build();
            let result = normy.normalize(&s).unwrap();
            prop_assert_eq!(result.as_ref(), "");
        }

        #[test]
        fn empty_string_nfc(s in prop::string::string_regex("").unwrap()) {
            let normy = Normy::builder().lang(ENG).add_stage(NFC).build();
            let result = normy.normalize(&s).unwrap();
            prop_assert_eq!(result.as_ref(), "");
        }
    }
}