varna 1.0.0

Varna — multilingual language engine: phoneme inventories, G2P rules, scripts, grammar, and lexicon for 50+ languages
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
//! Adversarial tests — edge-case and boundary inputs for all public APIs.
//!
//! These tests probe the library with empty strings, invalid codes, Unicode
//! edge cases, and boundary values to ensure graceful handling.

use std::borrow::Cow;

// ---------------------------------------------------------------------------
// Registry — empty, invalid, and boundary inputs
// ---------------------------------------------------------------------------

#[test]
fn registry_info_empty_string() {
    assert!(varna::registry::info("").is_none());
}

#[test]
fn registry_info_very_long_code() {
    let long = "a".repeat(1000);
    assert!(varna::registry::info(&long).is_none());
}

#[test]
fn registry_info_unicode_garbage() {
    assert!(varna::registry::info("🔥💀").is_none());
    assert!(varna::registry::info("\0").is_none());
    assert!(varna::registry::info("\u{FEFF}").is_none()); // BOM
    assert!(varna::registry::info("en\0").is_none());
}

#[test]
fn registry_phonemes_empty_string() {
    assert!(varna::registry::phonemes("").is_none());
}

#[test]
fn registry_phonemes_unicode_garbage() {
    assert!(varna::registry::phonemes("🔥").is_none());
    assert!(varna::registry::phonemes("\0\0\0").is_none());
}

#[test]
fn registry_primary_script_empty() {
    assert!(varna::registry::primary_script("").is_none());
}

#[test]
fn registry_primary_script_invalid() {
    assert!(varna::registry::primary_script("zzzzz").is_none());
}

// ---------------------------------------------------------------------------
// Script — empty and invalid lookups
// ---------------------------------------------------------------------------

#[test]
fn script_by_code_empty() {
    assert!(varna::script::by_code("").is_none());
}

#[test]
fn script_by_code_lowercase() {
    // ISO 15924 codes are case-sensitive (Latn, not latn)
    assert!(varna::script::by_code("latn").is_none());
}

#[test]
fn script_by_code_unicode_garbage() {
    assert!(varna::script::by_code("🔥🔥🔥🔥").is_none());
}

#[test]
fn script_contains_codepoint_zero() {
    let s = varna::script::latin();
    assert!(!s.contains_codepoint(0));
}

#[test]
fn script_contains_codepoint_max() {
    let s = varna::script::latin();
    assert!(!s.contains_codepoint(u32::MAX));
}

#[test]
fn script_contains_codepoint_just_outside_ranges() {
    let s = varna::script::devanagari();
    // Devanagari range: 0x0900-0x097F
    assert!(!s.contains_codepoint(0x08FF));
    assert!(s.contains_codepoint(0x0900));
    assert!(s.contains_codepoint(0x097F));
    assert!(!s.contains_codepoint(0x0980));
}

// ---------------------------------------------------------------------------
// Phoneme inventory — edge-case lookups
// ---------------------------------------------------------------------------

#[test]
fn phoneme_find_empty_string() {
    let en = varna::phoneme::english();
    assert!(en.find("").is_none());
    assert!(!en.has(""));
}

#[test]
fn phoneme_find_unicode_garbage() {
    let en = varna::phoneme::english();
    assert!(en.find("🔥").is_none());
    assert!(en.find("\0").is_none());
    assert!(en.find("\u{200B}").is_none()); // zero-width space
}

#[test]
fn phoneme_find_very_long_string() {
    let en = varna::phoneme::english();
    let long = "ʃ".repeat(1000);
    assert!(en.find(&long).is_none());
}

#[test]
fn phoneme_find_similar_but_wrong() {
    let en = varna::phoneme::english();
    // Lookalike characters that are NOT the same as IPA symbols
    assert!(en.find("S").is_none()); // Latin S vs IPA
    assert!(en.find("g").is_none()); // ASCII g vs IPA ɡ
}

// ---------------------------------------------------------------------------
// Builder — edge-case construction
// ---------------------------------------------------------------------------

#[test]
fn builder_empty_inventory() {
    let inv = varna::phoneme::PhonemeInventoryBuilder::new("xx", "Empty").build();
    assert_eq!(inv.consonant_count(), 0);
    assert_eq!(inv.vowel_count(), 0);
    assert_eq!(inv.phonemes.len(), 0);
    assert!(inv.find("a").is_none());
    assert!(!inv.has("a"));
}

#[test]
fn builder_empty_strings() {
    let inv = varna::phoneme::PhonemeInventoryBuilder::new("", "")
        .consonant(
            "",
            varna::phoneme::Manner::Plosive,
            varna::phoneme::Place::Bilabial,
            false,
        )
        .build();
    assert_eq!(inv.language_code, "");
    assert_eq!(inv.consonant_count(), 1);
    // Can find the empty-string phoneme
    assert!(inv.has(""));
}

#[test]
fn builder_unicode_ipa_symbols() {
    let inv = varna::phoneme::PhonemeInventoryBuilder::new("xx", "Unicode Test")
        .consonant(
            "🔥",
            varna::phoneme::Manner::Plosive,
            varna::phoneme::Place::Bilabial,
            false,
        )
        .build();
    assert!(inv.has("🔥"));
}

#[test]
fn builder_with_zero_capacity() {
    let inv = varna::phoneme::PhonemeInventoryBuilder::with_capacity("xx", "Zero Cap", 0)
        .consonant(
            "p",
            varna::phoneme::Manner::Plosive,
            varna::phoneme::Place::Bilabial,
            false,
        )
        .build();
    assert_eq!(inv.consonant_count(), 1);
}

// ---------------------------------------------------------------------------
// Grammar — edge-case lookups
// ---------------------------------------------------------------------------

#[test]
fn grammar_by_code_empty() {
    assert!(varna::grammar::by_code("").is_none());
}

#[test]
fn grammar_by_code_unicode() {
    assert!(varna::grammar::by_code("中文").is_none());
}

// ---------------------------------------------------------------------------
// Lexicon — edge-case lookups
// ---------------------------------------------------------------------------

#[test]
fn lexicon_find_empty_string() {
    let lex = varna::lexicon::Lexicon {
        language_code: Cow::Borrowed("en"),
        entries: vec![],
    };
    assert!(lex.find("").is_none());
    assert!(lex.swadesh().is_empty());
    assert!(lex.most_frequent(100).is_empty());
}

#[test]
fn lexicon_most_frequent_zero() {
    let lex = varna::lexicon::swadesh::by_code("es").unwrap();
    assert!(lex.most_frequent(0).is_empty());
}

#[test]
fn lexicon_most_frequent_huge_n() {
    let lex = varna::lexicon::swadesh::by_code("es").unwrap();
    // Requesting more than available should just return all available
    let freq = lex.most_frequent(1_000_000);
    assert!(freq.len() <= lex.entries.len());
}

// ---------------------------------------------------------------------------
// Swadesh — edge-case lookups
// ---------------------------------------------------------------------------

#[test]
fn swadesh_by_code_empty() {
    assert!(varna::lexicon::swadesh::by_code("").is_none());
}

#[test]
fn swadesh_by_code_invalid() {
    assert!(varna::lexicon::swadesh::by_code("xx").is_none());
    assert!(varna::lexicon::swadesh::by_code("🔥").is_none());
}

// ---------------------------------------------------------------------------
// Cognate — edge-case lookups
// ---------------------------------------------------------------------------

#[test]
fn cognate_for_language_empty() {
    let cog = varna::lexicon::cognate::water_cognates();
    assert!(cog.for_language("").is_none());
}

#[test]
fn cognate_for_language_invalid() {
    let cog = varna::lexicon::cognate::water_cognates();
    assert!(cog.for_language("zz").is_none());
}

// ---------------------------------------------------------------------------
// Transliteration — edge-case inputs
// ---------------------------------------------------------------------------

#[test]
fn transliteration_empty_string() {
    let table = varna::script::transliteration::devanagari_iast();
    assert_eq!(table.transliterate(""), "");
}

#[test]
fn transliteration_ascii_passthrough() {
    let table = varna::script::transliteration::devanagari_iast();
    assert_eq!(table.transliterate("hello world"), "hello world");
}

#[test]
fn transliteration_emoji_passthrough() {
    let table = varna::script::transliteration::greek_beta_code();
    assert_eq!(table.transliterate("🔥"), "🔥");
}

#[test]
fn transliteration_null_bytes() {
    let table = varna::script::transliteration::greek_beta_code();
    assert_eq!(table.transliterate("\0"), "\0");
}

#[test]
fn transliterate_char_empty() {
    let table = varna::script::transliteration::devanagari_iast();
    assert!(table.transliterate_char("").is_none());
}

#[test]
fn transliteration_reverse_map_not_empty() {
    let table = varna::script::transliteration::devanagari_iast();
    let rev = table.reverse_map();
    assert!(!rev.is_empty());
}

// ---------------------------------------------------------------------------
// Numerals — edge-case inputs
// ---------------------------------------------------------------------------

#[test]
fn numeral_value_of_empty() {
    let sys = varna::script::numerals::devanagari_digits();
    assert!(sys.value_of("").is_none());
}

#[test]
fn numeral_value_of_unicode_garbage() {
    let sys = varna::script::numerals::greek_isopsephy();
    assert!(sys.value_of("🔥").is_none());
}

#[test]
fn numeral_char_for_zero_greek() {
    // Greek isopsephy has no zero
    let sys = varna::script::numerals::greek_isopsephy();
    assert!(sys.char_for(0).is_none());
}

#[test]
fn numeral_char_for_u32_max() {
    let sys = varna::script::numerals::devanagari_digits();
    assert!(sys.char_for(u32::MAX).is_none());
}

#[test]
fn numeral_string_value_empty() {
    let sys = varna::script::numerals::greek_isopsephy();
    assert_eq!(sys.string_value(""), Some(0)); // sum of nothing = 0
}

#[test]
fn numeral_string_value_unmapped_char() {
    let sys = varna::script::numerals::greek_isopsephy();
    assert!(sys.string_value("X").is_none()); // Latin X, not Greek
}

#[test]
fn numeral_string_value_mixed_valid_invalid() {
    let sys = varna::script::numerals::greek_isopsephy();
    // α (valid) + X (invalid) → None because X has no mapping
    assert!(sys.string_value("αX").is_none());
}

// ---------------------------------------------------------------------------
// Allophone — edge-case inputs
// ---------------------------------------------------------------------------

#[test]
fn allophone_rules_for_empty() {
    let rules = varna::phoneme::allophone::english_allophones();
    assert!(rules.rules_for("").is_empty());
}

#[test]
fn allophone_realize_unmapped_phoneme() {
    let rules = varna::phoneme::allophone::english_allophones();
    // Phoneme not in English — should return itself unchanged
    let result = rules.realize("ʀ", &varna::phoneme::allophone::Environment::WordInitial);
    assert_eq!(result, "ʀ");
}

#[test]
fn allophone_realize_empty_phoneme() {
    let rules = varna::phoneme::allophone::english_allophones();
    let result = rules.realize("", &varna::phoneme::allophone::Environment::WordInitial);
    assert_eq!(result, "");
}

// ---------------------------------------------------------------------------
// Syllable/Phonotactics — edge-case inputs
// ---------------------------------------------------------------------------

#[test]
fn phonotactics_is_permitted_empty_sequence() {
    let p = varna::phoneme::syllable::english_phonotactics();
    assert_eq!(
        p.is_permitted("", varna::phoneme::syllable::SyllablePosition::Onset),
        None
    );
}

#[test]
fn phonotactics_constraints_at_unused_position() {
    let p = varna::phoneme::syllable::english_phonotactics();
    let nucleus = p.constraints_at(varna::phoneme::syllable::SyllablePosition::Nucleus);
    assert!(nucleus.is_empty());
}

// ---------------------------------------------------------------------------
// Dialect — edge-case inputs
// ---------------------------------------------------------------------------

#[test]
fn dialect_adds_empty() {
    let rp = varna::dialect::british_english();
    assert!(!rp.adds(""));
}

#[test]
fn dialect_removes_empty() {
    let rp = varna::dialect::british_english();
    assert!(!rp.removes(""));
}

#[test]
fn dialect_apply_idempotent() {
    // Applying the same overlay twice should not change the result
    let en = varna::phoneme::english();
    let rp = varna::dialect::british_english();
    let first = rp.apply(&en);
    let second = rp.apply(&first);
    // After second apply, should still have same phoneme set
    // (added phonemes already present, removed already gone)
    assert_eq!(first.consonant_count(), second.consonant_count());
    assert_eq!(first.vowel_count(), second.vowel_count());
}

// ---------------------------------------------------------------------------
// Error type — edge cases
// ---------------------------------------------------------------------------

#[test]
fn error_display_empty_strings() {
    let err = varna::VarnaError::UnknownLanguage(String::new());
    assert_eq!(err.to_string(), "unknown language: ");

    let err = varna::VarnaError::UnknownScript(String::new());
    assert_eq!(err.to_string(), "unknown script: ");
}

#[test]
fn error_display_unicode() {
    let err = varna::VarnaError::UnknownLanguage("🔥💀".into());
    assert!(err.to_string().contains("🔥💀"));
}

#[test]
fn error_display_very_long() {
    let long = "x".repeat(10000);
    let err = varna::VarnaError::UnknownLanguage(long.clone());
    assert!(err.to_string().contains(&long));
}