glossa 0.0.1-alpha.5

A language localisation library
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

use crate::{
    assets::OnceCell,
    l10n::locales,
    log::{error, trace, warning},
    map_loader::get::GetText,
};
use std::io;
use thiserror::Error;

/// A custom error type for Glossa
#[derive(Error, Debug)]
pub enum GlossaError<'map> {
    MapTextNotFound(&'map str, &'map str), // Error when MapLoader text is not found
    TextNotFound(String),                  // Error when text is not found
    CreateArcLoader(#[source] io::Error),  // Error when creating arc loader fails
}

impl std::fmt::Display for GlossaError<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        use GlossaError::*;
        let msg = static_text_not_found_msg;

        match self {
            TextNotFound(key) => {
                warning!("{} (key: `{key}`)", msg());
                write!(f, r#"{} (key: "{key}")"#, msg())
            }
            CreateArcLoader(e) => {
                let err_msg = "Failed to create arc loader.";
                error!("{err_msg}\nError: {e}");
                write!(f, "{err_msg}\n{e}")
            }
            MapTextNotFound(map, key) => {
                warning!("{} (map: `{map}`, key: `{key}`)", msg());
                write!(f, r#"{} (map: "{map}", key: "{key}")"#, msg())
            }
        }
    }
}

impl<'map> GlossaError<'map> {
    /// Constructor function for TextNotFound error
    pub fn text_not_found<S: Into<String>>(v: S) -> Self {
        Self::TextNotFound(v.into())
    }

    /// Constructor function for MapTextNotFound error
    pub fn map_text_not_found(map: &'map str, key: &'map str) -> Self {
        Self::MapTextNotFound(map, key)
    }
}

/// Helper function to retrieve localised error message
fn static_text_not_found_msg() -> &'static str {
    static MSG: OnceCell<&str> = OnceCell::new();
    trace!("Retrieving static localised error message...");
    MSG.get_or_init(|| {
        locales()
            .get("error", "text-not-found")
            .unwrap_or("No localised text found.")
    })
}

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

    #[test]
    fn text_not_found() {
        let err = GlossaError::text_not_found("hello");
        println!("{err}");
    }

    #[test]
    fn get_or_default_msg() {
        std::env::set_var("RUST_LOG", "debug");
        env_logger::init();
        locales().show_chain();
        let err = locales().get_or_default("error", "test-err-msg");
        eprintln!("{err}");
        let err = locales().get_or_default("errors", "test-err2");
        eprintln!("{err}");
    }

    #[test]
    fn any_error() -> crate::Result<'static, ()> {
        std::env::set_var("RUST_LOG", "trace");
        env_logger::init();
        let err = locales().get("err", "test-err-msg")?;
        eprintln!("{err}");
        Ok(())
    }
}