better-config-derive 0.2.4

better-config is a library for managing environment variables in Rust applications, providing a more ergonomic and type-safe configuration management experience.
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
use proc_macro::TokenStream;
use quote::quote;
use syn::{
    parse_macro_input, punctuated::Punctuated, Data, DeriveInput, Field, Fields, Meta, Path, Token,
};

struct StructEnvArgs {
    trait_path: Option<Path>,
    prefix: Option<String>,
    target: Option<String>,
    generic_args: Vec<syn::GenericArgument>,
}

/**
 * `env` macro for deriving environment variable loading functionality.
 *
 * ## Example
 * ```rust,ignore
 *  #[env(EnvConfig)]
 *  pub struct Config {
 *       #[conf(from = "PORT", default = "5432", setter = "set_port", getter = "get_port")]
 *       pub port: u16,
 *   }
 *  ```
 *
 */
fn parse_field_env_args(field: &Field, meta: &Meta) -> Vec<Meta> {
    if field.attrs.iter().any(|attr| attr.path().is_ident("env")) {
        return Vec::new();
    }
    match meta {
        // #[env(name = "value", other = "value2")]
        Meta::List(l) => l
            .parse_args_with(Punctuated::<Meta, Token![,]>::parse_terminated)
            .unwrap_or_else(|err| {
                let field_name = field
                    .ident
                    .as_ref()
                    .map(|i| i.to_string())
                    .unwrap_or_else(|| String::from("unnamed"));

                panic!(
                    "Failed to parse env attribute on field `{}`: {:?}",
                    field_name, err
                )
            })
            .iter()
            .cloned()
            .collect(),
        // #[env]
        Meta::Path(_) => Vec::new(),
        // #[env = "value"]
        _ => vec![meta.clone()],
    }
}

// #[env(EnvConfig(prefix = "APP_", target = ".env"))]
fn parse_struct_env_args(args: Meta) -> StructEnvArgs {
    let mut prefix = None;
    let mut target = None;
    let mut generic_args = Vec::new();
    let trait_path;

    match args {
        // #[env(EnvConfig(prefix = "...", ...))]
        Meta::List(meta_list) => {
            trait_path = Some(meta_list.path.clone());

            if let Some(last_segment) = meta_list.path.segments.last() {
                if let syn::PathArguments::AngleBracketed(angle_bracketed) = &last_segment.arguments
                {
                    generic_args.extend(angle_bracketed.args.iter().cloned());
                }
            }

            let _ = meta_list.parse_nested_meta(|nested_meta| {
                if nested_meta.path.is_ident("prefix") {
                    if let Ok(value) = nested_meta.value()?.parse::<syn::LitStr>() {
                        prefix = Some(value.value());
                    }
                } else if nested_meta.path.is_ident("target") {
                    if let Ok(value) = nested_meta.value()?.parse::<syn::LitStr>() {
                        target = Some(value.value());
                    }
                }
                Ok(())
            });
        }
        // #[env(EnvConfig)]
        Meta::Path(path) => {
            trait_path = Some(path.clone());

            if let Some(last_segment) = path.segments.last() {
                if let syn::PathArguments::AngleBracketed(angle_bracketed) = &last_segment.arguments
                {
                    generic_args.extend(angle_bracketed.args.iter().cloned());
                }
            }
        }
        _ => panic!(
            "Invalid env macro arguments. Expected #[env(EnvConfig)] or #[env(EnvConfig(...))]"
        ),
    }

    // generic_args > 1  => panic!
    if generic_args.len() > 1 {
        panic!("env macro only supports one generic argument");
    }

    StructEnvArgs {
        trait_path,
        prefix,
        target,
        generic_args,
    }
}
#[proc_macro_attribute]
pub fn env(args: TokenStream, input: TokenStream) -> TokenStream {
    let meta = parse_macro_input!(args as Meta);
    let env_args = parse_struct_env_args(meta);

    let input_clone = input.clone();
    let input_ref = parse_macro_input!(input_clone as DeriveInput);
    let struct_name = &input_ref.ident;
    let vis = &input_ref.vis;
    let trait_path = &env_args.trait_path;

    // Extract existing derives
    let existing_derives: Vec<_> = input_ref
        .attrs
        .iter()
        .filter(|attr| attr.path().is_ident("derive"))
        .cloned()
        .collect();

    // Extract fields from the input
    let fields = match &input_ref.data {
        Data::Struct(data_struct) => &data_struct.fields,
        _ => panic!("env macro only supports structs"),
    };

    let builder_field_assigns = fields
        .iter()
        .map(|field| handle_builder_field_assign(&env_args, field));

    let field_defs = fields.iter().map(|field| {
        let field_name = &field.ident;
        let field_type = &field.ty;
        let field_vis = &field.vis;
        quote! {
            #field_vis #field_name: #field_type
        }
    });

    let builder_field_defs = fields.iter().map(|field| {
        let field_name = &field.ident;
        let field_type = &field.ty;
        let field_vis = &field.vis;
        quote! {
            #field_vis #field_name: Option<#field_type>
        }
    });

    let target = match &env_args.target {
        Some(t) => quote! { Some(#t.to_string()) },
        None => quote! { None },
    };

    let params_type = if env_args.generic_args.is_empty() {
        quote! { ::std::collections::HashMap<String, String> }
    } else {
        let generic_arg = &env_args.generic_args[0];
        quote! { #generic_arg }
    };

    let params_field = quote! {
        _params: ::std::collections::HashMap<String, String>
    };

    let params_new_field = quote! {
        _params: ::std::collections::HashMap::new()
    };

    let helper_trait = quote::format_ident!("{}BetterHelper", struct_name);

    let struct_builder = quote::format_ident!("{}Builder", struct_name);

    let loaded_params_var = quote::format_ident!("loaded_params");
    let field_assigns = handle_field_assigns(fields, &env_args, &loaded_params_var);

    let getter_methods = fields.iter().filter_map(|field| {
        let field_env_attr = field.attrs.iter().find(|attr| attr.path().is_ident("conf"));
        if let Some(field_env_attr) = field_env_attr {
            let field_env_args = parse_field_env_args(field, &field_env_attr.meta);
            for attr in field_env_args {
                if attr.path().is_ident("getter") {
                    if let Meta::NameValue(name_value) = attr {
                        if let syn::Expr::Lit(syn::ExprLit {
                            lit: syn::Lit::Str(lit_str),
                            ..
                        }) = &name_value.value
                        {
                            let getter_ident = quote::format_ident!("{}", lit_str.value());
                            let field_type = &field.ty;
                            return Some(quote! {
                                fn #getter_ident(&self,#params_field) -> #field_type;
                            });
                        }
                    }
                }
            }
        }
        None
    });

    // Collect excluded keys for no_env_override
    let excluded_keys = collect_excluded_keys(fields, &env_args);

    // Generate the load call - use load_with_override if there are excluded keys
    // and the trait supports it (file-based loaders)
    let load_call = if excluded_keys.is_empty() {
        quote! {
            <Self as #trait_path<#params_type>>::load(#target)?
        }
    } else {
        let excluded_keys_tokens: Vec<_> = excluded_keys
            .iter()
            .map(|k| quote! { #k.to_string() })
            .collect();
        quote! {
            {
                let mut excluded = ::std::collections::HashSet::new();
                #(excluded.insert(#excluded_keys_tokens);)*
                <Self as #trait_path<#params_type>>::load_with_override(#target, &excluded)?
            }
        }
    };

    let expanded = quote! {
        #(#existing_derives)*
        #vis struct #struct_name {
            #params_field,
            #(#field_defs),*,
        }

        impl #struct_name {
            // builder
            pub fn builder() -> #struct_builder {
                #struct_builder::new()
            }
        }

        #vis struct #struct_builder {
            #params_field,
            #(#builder_field_defs),*,
        }

        impl #struct_builder {
            // new
            pub fn new() -> Self {
                Self {
                    #params_new_field,
                    #(#builder_field_assigns),*,
                }
            }
            // builder methods
            pub fn build(&mut self) -> Result<#struct_name, better_config::Error> {
                // load first (with excluded keys if any)
                let loaded_params = #load_call;
                let config = #struct_name {
                    _params: loaded_params.clone(),
                    #(#field_assigns),*,
                };
                Ok(config)
            }
        }

        // generate a help trait to add getter and setter methods
        trait #helper_trait {
            #(#getter_methods)*
        }

        // First implement AbstractConfig
        impl better_config::AbstractConfig<#params_type> for #struct_name {
            fn load(target: Option<String>) -> Result<#params_type, better_config::Error> {
                // Default to calling EnvConfig's load
                <Self as #trait_path<#params_type>>::load(#target)
            }
        }

        impl better_config::AbstractConfig<#params_type> for #struct_builder {
            fn load(target: Option<String>) -> Result<#params_type, better_config::Error> {
                // Default to calling EnvConfig's load
                <Self as #trait_path<#params_type>>::load(#target)
            }
        }

        impl #trait_path<#params_type> for #struct_name  {}
        impl #trait_path<#params_type> for #struct_builder  {}

    };

    TokenStream::from(expanded)
}

fn handle_builder_field_assign(
    env_args: &StructEnvArgs,
    field: &Field,
) -> proc_macro2::TokenStream {
    let field_name = &field.ident;
    let field_type = &field.ty;

    // nested
    let is_nested = field.attrs.iter().any(|attr| attr.path().is_ident("env"));
    if is_nested {
        return quote! {
            #field_name: None
        };
    }

    let from = get_var_name(field, "from");
    let default = get_var_name(field, "default");
    // if from and default are both None, return None
    if from.is_none() && default.is_none() {
        return quote! {
            #field_name: None
        };
    }

    let mut var_name =
        from.unwrap_or_else(|| field_name.as_ref().unwrap().to_string().to_uppercase());

    // Add prefix if specified
    if let Some(ref prefix) = env_args.prefix {
        var_name = format!("{}{}", prefix, var_name);
    }

    if let Some(default) = default {
        return quote! {
            #field_name: ::better_config::utils::env::get_optional_or::<_,#field_type>(#var_name, #default.parse::<#field_type>().unwrap())
        };
    }

    quote! {
            #field_name: ::better_config::utils::env::get_optional::<_,#field_type>(#var_name)
    }
}

fn handle_field_assign(
    env_args: &StructEnvArgs,
    field: &Field,
    loaded_params_var: &proc_macro2::Ident,
) -> proc_macro2::TokenStream {
    // get field conf attr
    let field_env_attr = field.attrs.iter().find(|attr| attr.path().is_ident("conf"));

    let field_name = &field.ident;

    let is_nested = field.attrs.iter().any(|attr| attr.path().is_ident("env"));

    if is_nested {
        let field_type = &field.ty;
        return quote! {
            #field_name: #field_type::builder()
                .build()
                .expect("Failed to build nested config")
        };
    }

    let assign = if let Some(field_env_attr) = field_env_attr {
        match &field_env_attr.meta {
            Meta::List(_) => handle_field_meta_list(env_args, field, loaded_params_var),
            _ => panic!(
                "Unsupported env attribute on field `{}`",
                field_name.as_ref().unwrap()
            ),
        }
    } else {
        let field_name_str = field_name.as_ref().unwrap().to_string().to_uppercase();
        quote! {
            #field_name: ::better_config::utils::env::get_or_else(#field_name_str, || panic!("Failed to load from var: {}", #field_name_str))?
        }
    };

    quote! {
        #assign
    }
}

fn handle_field_meta_list(
    env_args: &StructEnvArgs,
    field: &Field,
    loaded_params_var: &proc_macro2::Ident,
) -> proc_macro2::TokenStream {
    let field_name = &field.ident;
    let field_type = &field.ty;

    let mut var_name = get_var_name(field, "from")
        .unwrap_or_else(|| field_name.as_ref().unwrap().to_string().to_uppercase());

    // Add prefix if specified
    if let Some(ref prefix) = env_args.prefix {
        var_name = format!("{}{}", prefix, var_name);
    }

    // handle attributes
    let default = get_var_name(field, "default");
    let setter_name = get_var_name(field, "setter");
    let getter_name = get_var_name(field, "getter");

    if let Some(getter) = getter_name {
        let getter_ident = quote::format_ident!("{}", getter);
        quote! {
            #field_name: <Self>::#getter_ident(&self,&#loaded_params_var)
        }
    } else if let Some(setter) = setter_name {
        let setter_ident = quote::format_ident!("{}", setter);
        quote! {
            #field_name: {
                let value = #loaded_params_var.get(#var_name).cloned().unwrap_or_default();
                self.#setter_ident(value.clone());
                value
            }
        }
    } else if let Some(default) = default {
        quote! {
            #field_name: #loaded_params_var.get(#var_name)
                .and_then(|v| v.parse::<#field_type>().ok())
                .unwrap_or_else(|| #default.parse::<#field_type>().unwrap())

        }
    } else {
        quote! {
            #field_name: #loaded_params_var.get(#var_name)
                .and_then(|v| v.parse::<#field_type>().ok())
                .unwrap_or_default()
        }
    }
}

fn handle_field_assigns<'a>(
    fields: &'a Fields,
    env_args: &'a StructEnvArgs,
    loaded_params_var: &'a proc_macro2::Ident,
) -> impl Iterator<Item = proc_macro2::TokenStream> + 'a {
    fields
        .iter()
        .map(move |field| handle_field_assign(env_args, field, loaded_params_var))
}

/// Extracts the variable name from the field attributes, looking for a specific attribute name.
/// If the attribute is not found, it returns `None`.
///
/// # Arguments
/// * `field` - The field from which to extract the variable name.
/// * `field_name` - The name of the attribute to look for.
/// # Returns
/// * `Option<String>` - The variable name if found, otherwise `None`.
///
/// # Example
/// ```rust,ignore
/// let field = ...; // Some syn::Field
/// let var_name = get_var_name(&field, "from");
/// if let Some(name) = var_name {
///     println!("Found variable name: {}", name);
/// } else {
///     println!("Variable name not found.");
/// }
/// ```
fn get_var_name(field: &Field, field_name: &'static str) -> Option<String> {
    for attr in &field.attrs {
        if attr.path().is_ident("conf") {
            if let Meta::List(meta_list) = &attr.meta {
                if let Ok(args) =
                    meta_list.parse_args_with(Punctuated::<Meta, Token![,]>::parse_terminated)
                {
                    for meta in args {
                        if let Meta::NameValue(name_value) = meta {
                            if name_value.path.is_ident(field_name) {
                                if let syn::Expr::Lit(syn::ExprLit {
                                    lit: syn::Lit::Str(lit_str),
                                    ..
                                }) = &name_value.value
                                {
                                    return Some(lit_str.value());
                                }
                            }
                        }
                    }
                }
                let mut result = None;
                let _ = meta_list.parse_nested_meta(|meta| {
                    if meta.path.is_ident(field_name) {
                        if let Ok(value) = meta.value()?.parse::<syn::LitStr>() {
                            result = Some(value.value());
                        }
                    }
                    Ok(())
                });
                if result.is_some() {
                    return result;
                }
            }
        }
    }
    None
}

/// Checks if a field has the `no_env_override` attribute set.
///
/// # Arguments
/// * `field` - The field to check for the `no_env_override` attribute.
///
/// # Returns
/// * `bool` - `true` if the field has `no_env_override`, `false` otherwise.
///
/// # Example
/// ```rust,ignore
/// // For a field with #[conf(from = "KEY", no_env_override)]
/// let has_no_override = has_no_env_override(&field);
/// assert!(has_no_override);
/// ```
fn has_no_env_override(field: &Field) -> bool {
    for attr in &field.attrs {
        if attr.path().is_ident("conf") {
            if let Meta::List(meta_list) = &attr.meta {
                // Try parsing as comma-separated meta items
                if let Ok(args) =
                    meta_list.parse_args_with(Punctuated::<Meta, Token![,]>::parse_terminated)
                {
                    for meta in args {
                        // Check for #[conf(no_env_override)] - path-style attribute
                        if let Meta::Path(path) = &meta {
                            if path.is_ident("no_env_override") {
                                return true;
                            }
                        }
                    }
                }
            }
        }
    }
    false
}

/// Collects all field keys that have the `no_env_override` attribute.
/// These keys should be excluded from environment variable override.
///
/// # Arguments
/// * `fields` - The fields to check.
/// * `env_args` - The struct-level env arguments (for prefix handling).
///
/// # Returns
/// * `Vec<String>` - List of keys that should not be overridden by env vars.
fn collect_excluded_keys(fields: &Fields, env_args: &StructEnvArgs) -> Vec<String> {
    fields
        .iter()
        .filter_map(|field| {
            // Skip nested fields
            if field.attrs.iter().any(|attr| attr.path().is_ident("env")) {
                return None;
            }

            if has_no_env_override(field) {
                // Get the key name (from attribute or field name)
                let key = get_var_name(field, "from").unwrap_or_else(|| {
                    field
                        .ident
                        .as_ref()
                        .map(|i| i.to_string().to_uppercase())
                        .unwrap_or_default()
                });

                // Apply prefix if specified (for consistency with how keys are stored)
                let full_key = if let Some(ref prefix) = env_args.prefix {
                    format!("{}{}", prefix, key)
                } else {
                    key
                };

                Some(full_key)
            } else {
                None
            }
        })
        .collect()
}