citum-schema-style 0.78.0

Citum style schema types and styling engine
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

/*
SPDX-License-Identifier: MIT OR Apache-2.0
SPDX-FileCopyrightText: © 2023-2026 Bruce D'Arcus and Citum contributors
*/

//! Embedded locale YAML files for common BCP 47 locales.
//!
//! These are baked into the binary at compile time via `include_bytes!`,
//! providing locale data when the CLI is invoked with `--builtin` and there
//! is no `locales/` directory on disk.

use crate::locale::Locale;

/// Raw YAML bytes for an embedded locale by BCP 47 ID.
///
/// Returns `None` for locales not bundled with the binary.
pub fn get_locale_bytes(id: &str) -> Option<&'static [u8]> {
    match id {
        "en-US" => Some(include_bytes!("../../embedded/locales/en-US.yaml")),
        "ar-AR" => Some(include_bytes!("../../embedded/locales/ar-AR.yaml")),
        "de-DE" => Some(include_bytes!("../../embedded/locales/de-DE.yaml")),
        "es-ES" => Some(include_bytes!("../../embedded/locales/es-ES.yaml")),
        "eu-ES" => Some(include_bytes!("../../embedded/locales/eu-ES.yaml")),
        "fr-FR" => Some(include_bytes!("../../embedded/locales/fr-FR.yaml")),
        "fr-CA" => Some(include_bytes!("../../embedded/locales/fr-CA.yaml")),
        "tr-TR" => Some(include_bytes!("../../embedded/locales/tr-TR.yaml")),
        "zh-CN" => Some(include_bytes!("../../embedded/locales/zh-CN.yaml")),
        "ja-JP" => Some(include_bytes!("../../embedded/locales/ja-JP.yaml")),
        "ko-KR" => Some(include_bytes!("../../embedded/locales/ko-KR.yaml")),
        "ru-RU" => Some(include_bytes!("../../embedded/locales/ru-RU.yaml")),
        _ => None,
    }
}

/// Load a fully constructed embedded locale by BCP 47 ID.
///
/// This accessor applies regional inheritance for bundled locale overlays,
/// such as Québec French, before returning the locale to callers.
#[must_use]
pub fn get_locale(id: &str) -> Option<Locale> {
    if id == "fr-CA" {
        return Some(Locale::fr_ca());
    }

    let bytes = get_locale_bytes(id)?;
    let yaml = std::str::from_utf8(bytes).ok()?;
    Locale::from_yaml_str(yaml).ok()
}

/// All available embedded locale IDs.
pub const EMBEDDED_LOCALE_IDS: &[&str] = &[
    "en-US", "ar-AR", "de-DE", "es-ES", "eu-ES", "fr-FR", "fr-CA", "tr-TR", "zh-CN", "ja-JP",
    "ko-KR", "ru-RU",
];

/// Raw YAML bytes for an embedded locale override by ID.
///
/// Returns `None` for overrides not bundled with the binary.
pub fn get_locale_override_bytes(id: &str) -> Option<&'static [u8]> {
    match id {
        "en-US-chicago" => Some(include_bytes!(
            "../../embedded/locales/overrides/en-US-chicago.yaml"
        )),
        "de-DE-chicago" => Some(include_bytes!(
            "../../embedded/locales/overrides/de-DE-chicago.yaml"
        )),
        _ => None,
    }
}

/// All available embedded locale override IDs.
pub const EMBEDDED_LOCALE_OVERRIDE_IDS: &[&str] = &["en-US-chicago", "de-DE-chicago"];

#[cfg(test)]
mod tests {
    use super::get_locale;
    use crate::locale::types::TermForm;
    use crate::template::ContributorRole;

    #[test]
    #[allow(
        clippy::expect_used,
        reason = "The test must fail when the compile-time embedded locale is absent."
    )]
    fn fr_ca_embedded_locale_inherits_french_term_surfaces() {
        let locale = get_locale("fr-CA").expect("fr-CA should be embedded");

        assert_eq!(locale.locale, "fr-CA");
        assert_eq!(
            locale.resolved_role_term(&ContributorRole::Editor, false, &TermForm::Short, None),
            Some("éd.".to_string())
        );
        assert_eq!(
            locale
                .punctuation_realization
                .as_ref()
                .and_then(|realization| realization.semicolon.as_deref()),
            Some("; ")
        );
    }
}