icydb-model-macros 0.277.0

//! Module: validate::reserved
//! Responsibility: derive-side validation helpers.
//! Does not own: runtime validation.
//! Boundary: parse-time checks.

use std::{collections::HashSet, sync::LazyLock};

///
/// RESERVED_WORDS
/// Reserved Rust and IcyDB schema numeric identifiers.
///

static RESERVED_WORDS: LazyLock<HashSet<&'static str>> = LazyLock::new(|| {
    let mut words = Vec::new();

    // icydb schema numeric labels
    words.extend(["int128", "nat128"]);

    // rust
    // https://doc.rust-lang.org/reference/keywords.html
    words.extend([
        "as", "break", "const", "continue", "crate", "else", "enum", "extern", "false", "fn",
        "for", "gen", "if", "impl", "in", "let", "loop", "match", "mod", "move", "mut", "pub",
        "ref", "return", "self", "Self", "static", "struct", "super", "trait", "true", "type",
        "unsafe", "use", "where", "while", "async", "await", "dyn", "abstract", "become", "box",
        "do", "final", "macro", "override", "priv", "typeof", "unsized", "virtual", "yield", "try",
    ]);

    words.into_iter().collect()
});

/// Check if an identifier is a reserved word.
pub(crate) fn is_reserved_word(word: &str) -> bool {
    RESERVED_WORDS.contains(word)
}

///
/// TESTS
///

#[cfg(test)]
mod tests {
    use super::RESERVED_WORDS;
    use std::collections::HashSet;

    #[test]
    fn documentation_reserved_identifiers_match_compiled_owner() {
        let guide = std::fs::read_to_string(concat!(
            env!("CARGO_MANIFEST_DIR"),
            "/../../docs/guides/schema-authoring.md"
        ))
        .expect("repository schema authoring guide");
        let section = guide
            .split_once("<!-- icydb-reserved-field-identifiers:start -->")
            .expect("reserved identifier data start")
            .1
            .split_once("<!-- icydb-reserved-field-identifiers:end -->")
            .expect("reserved identifier data end")
            .0;
        let documented = section
            .split('`')
            .skip(1)
            .step_by(2)
            .collect::<HashSet<_>>();
        assert_eq!(&documented, &*RESERVED_WORDS);
    }
}