hydracache-macros 0.18.0

Procedural macros for HydraCache.
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170

use proc_macro2::{Span, TokenStream as TokenStream2};
use proc_macro_crate::{crate_name, FoundCrate};
use quote::quote;

pub(crate) fn cache_entity_trait_path() -> TokenStream2 {
    resolve_exported_type_path(
        crate_name("hydracache-db").ok(),
        crate_name("hydracache-sqlx").ok(),
        "CacheEntity",
    )
}

pub(crate) fn query_cache_policy_path() -> TokenStream2 {
    resolve_exported_type_path(
        crate_name("hydracache-db").ok(),
        crate_name("hydracache-sqlx").ok(),
        "QueryCachePolicy",
    )
}

pub(crate) fn cache_options_path() -> TokenStream2 {
    resolve_runtime_type_path(crate_name("hydracache").ok(), "CacheOptions")
}

fn resolve_runtime_type_path(
    runtime_crate: Option<FoundCrate>,
    exported_type: &str,
) -> TokenStream2 {
    if let Some(found) = runtime_crate {
        exported_type_path_for("hydracache", found, exported_type)
    } else {
        let exported_type = syn::Ident::new(exported_type, Span::call_site());
        quote!(::hydracache::#exported_type)
    }
}

fn resolve_exported_type_path(
    db_crate: Option<FoundCrate>,
    sqlx_crate: Option<FoundCrate>,
    exported_type: &str,
) -> TokenStream2 {
    if let Some(found) = db_crate {
        exported_type_path_for("hydracache_db", found, exported_type)
    } else if let Some(found) = sqlx_crate {
        exported_type_path_for("hydracache_sqlx", found, exported_type)
    } else {
        let exported_type = syn::Ident::new(exported_type, Span::call_site());
        quote!(::hydracache_db::#exported_type)
    }
}

fn exported_type_path_for(
    default_name: &str,
    found: FoundCrate,
    exported_type: &str,
) -> TokenStream2 {
    let crate_name = match found {
        FoundCrate::Itself => default_name.to_owned(),
        FoundCrate::Name(name) => name,
    };
    let ident = syn::Ident::new(&crate_name.replace('-', "_"), Span::call_site());
    let exported_type = syn::Ident::new(exported_type, Span::call_site());

    quote!(::#ident::#exported_type)
}

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

    #[test]
    fn resolves_cache_entity_path_for_current_crate() {
        assert_eq!(
            exported_type_path_for("hydracache_db", FoundCrate::Itself, "CacheEntity").to_string(),
            ":: hydracache_db :: CacheEntity"
        );
    }

    #[test]
    fn resolves_cache_entity_path_for_renamed_crate() {
        assert_eq!(
            exported_type_path_for(
                "hydracache_db",
                FoundCrate::Name("cache-db".to_owned()),
                "CacheEntity",
            )
            .to_string(),
            ":: cache_db :: CacheEntity"
        );
    }

    #[test]
    fn resolves_query_cache_policy_path_for_renamed_crate() {
        assert_eq!(
            exported_type_path_for(
                "hydracache_db",
                FoundCrate::Name("cache-db".to_owned()),
                "QueryCachePolicy",
            )
            .to_string(),
            ":: cache_db :: QueryCachePolicy"
        );
    }

    #[test]
    fn fallback_paths_are_available_without_adapter_dependencies() {
        assert_eq!(
            cache_entity_trait_path().to_string(),
            ":: hydracache_db :: CacheEntity"
        );
        assert_eq!(
            query_cache_policy_path().to_string(),
            ":: hydracache_db :: QueryCachePolicy"
        );
    }

    #[test]
    fn fallback_runtime_path_is_available_without_runtime_dependency() {
        assert_eq!(
            cache_options_path().to_string(),
            ":: hydracache :: CacheOptions"
        );
    }

    #[test]
    fn resolves_runtime_path_for_current_crate() {
        assert_eq!(
            resolve_runtime_type_path(Some(FoundCrate::Itself), "CacheOptions").to_string(),
            ":: hydracache :: CacheOptions"
        );
    }

    #[test]
    fn resolves_runtime_path_for_renamed_crate() {
        assert_eq!(
            resolve_runtime_type_path(
                Some(FoundCrate::Name("local-cache".to_owned())),
                "CacheOptions",
            )
            .to_string(),
            ":: local_cache :: CacheOptions"
        );
    }

    #[test]
    fn resolver_prefers_database_neutral_crate() {
        assert_eq!(
            resolve_exported_type_path(
                Some(FoundCrate::Name("cache-db".to_owned())),
                Some(FoundCrate::Name("cache-sqlx".to_owned())),
                "QueryCachePolicy",
            )
            .to_string(),
            ":: cache_db :: QueryCachePolicy"
        );
    }

    #[test]
    fn resolver_falls_back_to_sqlx_adapter_crate() {
        assert_eq!(
            resolve_exported_type_path(
                None,
                Some(FoundCrate::Name("cache-sqlx".to_owned())),
                "QueryCachePolicy",
            )
            .to_string(),
            ":: cache_sqlx :: QueryCachePolicy"
        );
    }
}