nu-utils 0.114.0

Nushell utility functions
Documentation
use std::borrow::Cow;

use num_format::Locale;

pub const LOCALE_OVERRIDE_ENV_VAR: &str = "NU_TEST_LOCALE_OVERRIDE";

pub fn get_system_locale() -> Locale {
    let locale_string = get_system_locale_string().unwrap_or_else(|| String::from("en-US"));
    // Since get_locale() and Locale::from_name() don't always return the same items
    // we need to try and parse it to match. For instance, a valid locale is de_DE
    // however Locale::from_name() wants only de so we split and parse it out.
    let locale_string = locale_string.replace('_', "-"); // en_AU -> en-AU

    Locale::from_name(&locale_string).unwrap_or_else(|_| {
        let all = num_format::Locale::available_names();
        let locale_prefix = &locale_string.split('-').collect::<Vec<&str>>();
        if all.contains(&locale_prefix[0]) {
            Locale::from_name(locale_prefix[0]).unwrap_or(Locale::en)
        } else {
            Locale::en
        }
    })
}

#[cfg(debug_assertions)]
pub fn get_system_locale_string() -> Option<String> {
    std::env::var(LOCALE_OVERRIDE_ENV_VAR).ok().or_else(
        #[cfg(not(test))]
        {
            sys_locale::get_locale
        },
        #[cfg(test)]
        {
            // For tests, we use the same locale on all systems.
            // To override this, set `LOCALE_OVERRIDE_ENV_VAR`.
            || Some(Locale::en_US_POSIX.name().to_owned())
        },
    )
}

#[cfg(not(debug_assertions))]
pub fn get_system_locale_string() -> Option<String> {
    sys_locale::get_locale()
}

/// Get the current locale from environment variables.
///
/// - Checks multiple environment variables.
/// - Generic over how to read environment variables (can be used to read environment variables from
///   `StateWorkingSet`, `Stack`, or from process environment variables)
/// - Allows specifying a locale category (`LC_TIME`, `LC_NUMERIC`, etc.)
///
/// Priority order as documented in [`gettext` manual][1]:
/// - NU_TEST_LOCALE_OVERRIDE
/// - LC_ALL
/// - `locale_category` (if provided)
/// - LANG
///
/// [1]: https://www.gnu.org/software/gettext/manual/html_node/Locale-Environment-Variables.html
pub fn get_locale_from_env_vars<'a, F, O>(
    locale_category: Option<&str>,
    env_getter: F,
) -> Option<Cow<'a, str>>
where
    F: 'a,
    F: Fn(&str) -> Option<O>,
    O: Into<Cow<'a, str>>,
{
    let mut env_var_names = [LOCALE_OVERRIDE_ENV_VAR, "LC_ALL"]
        .iter()
        .copied()
        .chain(locale_category)
        .chain(["LANG"]);

    let env_var = env_var_names.find_map(env_getter).map(Into::into);
    env_var
        .map(|s| match s {
            Cow::Borrowed(s) => Cow::Borrowed(s.split('.').next().unwrap_or(s)),
            Cow::Owned(s) => Cow::Owned(s.split('.').next().map(ToOwned::to_owned).unwrap_or(s)),
        })
        .or_else(|| {
            get_system_locale_string()
                .map(|l| l.replace('-', "_"))
                .map(Cow::Owned)
        })
}