liora-core 0.2.6

//! Shared locale key codegen helper for build scripts.
//!
//! Include this file from a Cargo build script to generate typed
//! `locales::section::key` constants from TOML locale resources.
//!
//! ```rust,ignore
//! // build.rs
//! #[path = "../../crates/liora-core/src/locales_codegen.rs"]
//! mod locales_codegen;
//!
//! fn main() {
//!     locales_codegen::generate_locales_from_package("liora_core::Locales");
//! }
//! ```
//!
//! By default it scans `./assets/locales` relative to the package. Additional
//! directories can be configured in `Cargo.toml`:
//!
//! ```toml
//! [package.metadata.liora.locales]
//! paths = ["assets/locales", "../shared/locales"]
//! ```

use std::{
    collections::BTreeMap,
    env, fs,
    path::{Path, PathBuf},
};

type LocaleKeys = BTreeMap<String, BTreeMap<String, String>>;

struct LocalesCodegenOptions {
    manifest_dir: PathBuf,
    out_dir: PathBuf,
    output_file: String,
    key_type_path: String,
    default_dir: PathBuf,
}

impl LocalesCodegenOptions {
    fn from_env(key_type_path: impl Into<String>) -> Self {
        let manifest_dir =
            PathBuf::from(env::var("CARGO_MANIFEST_DIR").expect("CARGO_MANIFEST_DIR"));
        let out_dir = PathBuf::from(env::var("OUT_DIR").expect("OUT_DIR"));
        Self {
            default_dir: manifest_dir.join("assets/locales"),
            manifest_dir,
            out_dir,
            output_file: "locales_keys.rs".into(),
            key_type_path: key_type_path.into(),
        }
    }

    fn output_path(&self) -> PathBuf {
        self.out_dir.join(&self.output_file)
    }
}

/// Generates `locales_keys.rs` for the current package.
///
/// Scans `./assets/locales` by default. If the package `Cargo.toml` contains
/// `[package.metadata.liora.locales] paths = [...]`, those paths are used.
pub fn generate_locales_from_package(key_type_path: impl Into<String>) {
    let options = LocalesCodegenOptions::from_env(key_type_path);
    let dirs = configured_locale_dirs(&options);
    generate_locales_module(&dirs, &options.output_path(), &options.key_type_path);
}

fn configured_locale_dirs(options: &LocalesCodegenOptions) -> Vec<PathBuf> {
    let manifest = options.manifest_dir.join("Cargo.toml");
    println!("cargo:rerun-if-changed={}", manifest.display());

    let mut dirs = package_metadata_locale_paths(&manifest, &options.manifest_dir);
    if dirs.is_empty() {
        dirs.push(options.default_dir.clone());
    }
    dirs
}

fn generate_locales_module(locale_dirs: &[PathBuf], output: &Path, key_type_path: &str) {
    let mut keys = LocaleKeys::new();
    for dir in locale_dirs {
        println!("cargo:rerun-if-changed={}", dir.display());
        collect_locale_dir(dir, &mut keys);
    }

    let generated = render_locales_module(&keys, key_type_path);
    fs::write(output, generated).expect("write generated locale keys");
}

fn package_metadata_locale_paths(manifest: &Path, manifest_dir: &Path) -> Vec<PathBuf> {
    let Ok(content) = fs::read_to_string(manifest) else {
        return Vec::new();
    };
    let value: toml::Value = toml::from_str(&content).unwrap_or_else(|error| {
        panic!(
            "failed to parse Cargo manifest {}: {error}",
            manifest.display()
        )
    });
    let Some(paths) = value
        .get("package")
        .and_then(|value| value.get("metadata"))
        .and_then(|value| value.get("liora"))
        .and_then(|value| value.get("locales"))
        .and_then(|value| value.get("paths"))
        .and_then(toml::Value::as_array)
    else {
        return Vec::new();
    };

    paths
        .iter()
        .map(|value| {
            let Some(path) = value.as_str() else {
                panic!("[package.metadata.liora.locales].paths entries must be strings");
            };
            let path = PathBuf::from(path);
            if path.is_absolute() {
                path
            } else {
                manifest_dir.join(path)
            }
        })
        .collect()
}

fn collect_locale_dir(dir: &Path, keys: &mut LocaleKeys) {
    let Ok(entries) = fs::read_dir(dir) else {
        return;
    };

    let mut files = Vec::new();
    for entry in entries.flatten() {
        let path = entry.path();
        if path.extension().and_then(|ext| ext.to_str()) == Some("toml") {
            files.push(path);
        }
    }
    files.sort();

    for path in files {
        println!("cargo:rerun-if-changed={}", path.display());
        let content = fs::read_to_string(&path).unwrap_or_else(|error| {
            panic!("failed to read locale file {}: {error}", path.display())
        });
        let value: toml::Value = toml::from_str(&content).unwrap_or_else(|error| {
            panic!("failed to parse locale file {}: {error}", path.display())
        });
        collect_toml_keys(None, &value, keys);
    }
}

fn collect_toml_keys(prefix: Option<String>, value: &toml::Value, keys: &mut LocaleKeys) {
    match value {
        toml::Value::String(_) => {
            let Some(path) = prefix else {
                return;
            };
            let Some((group, key)) = path.split_once('.') else {
                panic!(
                    "locale key `{path}` must use at least one table group, e.g. [window] title = ..."
                );
            };
            keys.entry(sanitize_ident(group, &path))
                .or_default()
                .insert(sanitize_ident(key, &path), path);
        }
        toml::Value::Table(table) => {
            for (key, value) in table {
                let next = match &prefix {
                    Some(prefix) => format!("{prefix}.{key}"),
                    None => key.clone(),
                };
                collect_toml_keys(Some(next), value, keys);
            }
        }
        _ => {}
    }
}

fn sanitize_ident(raw: &str, full_path: &str) -> String {
    let mut out = String::new();
    for ch in raw.chars() {
        if ch.is_ascii_alphanumeric() || ch == '_' {
            out.push(ch.to_ascii_lowercase());
        } else {
            out.push('_');
        }
    }
    if out.is_empty() || out.starts_with(|ch: char| ch.is_ascii_digit()) {
        out.insert(0, '_');
    }
    if !out
        .chars()
        .all(|ch| ch.is_ascii_alphanumeric() || ch == '_')
    {
        panic!("locale key `{full_path}` cannot be converted into a Rust identifier");
    }
    out
}

fn render_locales_module(keys: &LocaleKeys, key_type_path: &str) -> String {
    let mut out = String::from(
        "// @generated by locales_codegen. Do not edit manually.\n\
         // Edit assets/locales/*.toml or [package.metadata.liora.locales].paths and rerun cargo.\n",
    );
    for (group, entries) in keys {
        out.push_str(&format!(
            "/// Typed locale keys in the `{group}` resource group.\n"
        ));
        out.push_str(&format!("pub mod {group} {{\n"));
        for (key, path) in entries {
            out.push_str(&format!("    /// Locale key `{path}`.\n"));
            out.push_str(&format!(
                "    pub const fn {key}() -> {key_type_path} {{\n        {key_type_path}::new({path:?})\n    }}\n"
            ));
        }
        out.push_str("}\n");
    }
    out
}