rullst-orm-macros 12.3.0

Procedural macros and derive attributes for the rullst-orm Active Record pattern.
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

//! Optional generated Redis APIs follow the ORM runtime's features.
//!
//! A `#[cfg(feature = "redis")]` written into macro output is evaluated in the
//! crate that invokes the derive, not in `rullst-orm`, so an application that
//! enabled `rullst-orm/redis` never received the Redis methods unless it also
//! declared a `redis` feature of its own. The matching runtime opts into
//! `runtime-feature-gates` and forwards its `redis` feature here, so the
//! decision is made at expansion time. Without that opt-in (an older 12.x
//! runtime resolving a newer macro crate) the legacy attribute is emitted
//! unchanged.

use proc_macro2::TokenStream;
use quote::quote;

/// Attribute placed before Redis-only generated items and statements.
pub(crate) fn redis() -> TokenStream {
    attribute(
        "redis",
        cfg!(feature = "runtime-feature-gates"),
        cfg!(feature = "redis"),
    )
}

/// `runtime_gates` selects expansion-time gating; `enabled` is the runtime's
/// forwarded feature. A disabled item keeps its tokens under `cfg(any())`, the
/// always-false configuration, exactly like the legacy attribute when the
/// invoking crate lacks the feature.
fn attribute(feature: &str, runtime_gates: bool, enabled: bool) -> TokenStream {
    match (runtime_gates, enabled) {
        (false, _) => quote! { #[cfg(feature = #feature)] },
        (true, true) => TokenStream::new(),
        (true, false) => quote! { #[cfg(any())] },
    }
}

#[cfg(test)]
mod tests {
    use super::attribute;

    #[test]
    fn runtime_gates_never_emit_an_application_feature_check() {
        assert_eq!(
            attribute("redis", false, true).to_string(),
            "# [cfg (feature = \"redis\")]"
        );
        assert!(attribute("redis", true, true).is_empty());
        assert_eq!(
            attribute("redis", true, false).to_string(),
            "# [cfg (any ())]"
        );
    }

    #[test]
    fn generated_models_follow_the_runtime_redis_feature() {
        let input: syn::DeriveInput = syn::parse_quote! {
            #[orm(table = "docs")]
            struct Doc {
                id: i32,
                body: String,
            }
        };
        let parsed = crate::parser::parse(&input).expect("test model should parse");
        let rels = crate::relationships::generate(&parsed);
        let generated = format!(
            "{} {}",
            crate::builder::generate(
                &parsed,
                &rels.flags,
                &rels.inits,
                &rels.methods,
                &rels.eager_loads
            ),
            crate::models::generate(&parsed, &rels.model_methods)
        );
        assert!(generated.contains("fn remember"));
        assert!(generated.contains("fn save_to_redis"));
        let application_cfg = generated.contains("cfg (feature = \"redis\")");
        assert_eq!(
            application_cfg,
            !cfg!(feature = "runtime-feature-gates"),
            "{generated}"
        );
    }
}