lib-conf-derive 0.3.0

Proc-macro providing library authors with first-class configuration for their end-users
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
use crate::{
    generate::{util, VariantField},
    parse::{self, OriginField, OriginStruct},
};

use proc_macro2::TokenStream;
use quote::{ToTokens, format_ident, quote};
use std::rc::Rc;
use syn::{Ident, parse_quote, Type};

#[derive(Debug, Copy, Clone)]
pub struct OverrideVariant;

// !- Override struct

#[cfg_attr(feature = "syn-debug", derive(Debug))]
#[derive(Clone)]
pub struct OverrideStruct {
    ident: Ident,
    ty: Type,
    fields: Vec<OverrideField>,

    origin: Rc<OriginStruct>,
    phantom_fields: Vec<Rc<OriginField>>,
}
impl OverrideStruct {
    pub fn new(origin: Rc<OriginStruct>) -> Self {
        let with_phantoms = origin.use_phantom_fields();
        let mut fields = Vec::new();
        let mut phantom_fields = Vec::new();
        for field in &origin.fields {
            if !field.attrs.skip_override_field() {
                fields.push(OverrideField::new(field.clone()));
            } else if with_phantoms {
                phantom_fields.push(field.clone());
            }
        }
        let ident = Self::generate_ident(&origin.ident, origin.suffix);
        let ty = util::build_type(&ident, &origin.generics);
        Self {
            ident,
            ty,
            fields,

            origin,
            phantom_fields,
        }
    }
    pub fn ident(&self) -> &Ident {
        &self.ident
    }
    pub fn ty(&self) -> &Type {
        &self.ty
    }
    pub fn has_required_fields(&self) -> bool {
        self.fields.iter().any(OverrideField::is_required)
    }
    #[allow(dead_code)] // only used w/ serde feature
    pub fn has_optional_fields(&self) -> bool {
        self.fields.iter().any(OverrideField::is_optional)
    }
    fn generate_ident(origin_ident: &Ident, suffix: &'static str) -> Ident {
        let ident_str = origin_ident.to_string();
        assert!(ident_str.ends_with(suffix));

        let suf_index = ident_str.rfind(suffix).unwrap();
        let prefix = &ident_str[..suf_index];
        format_ident!("{prefix}Override{suffix}")
    }

    #[cfg(not(feature = "serde"))]
    fn struct_docs(&self) -> String {
        let origin_ident = &self.origin.ident;
        format!(
"Provides support for configuring [`{origin_ident}`] at run-time.

**Note**: `serde` support is disabled. This struct must be manually initialized. It is provided to allow for retained override/unset support")
    }

    #[cfg(feature = "serde")]
    fn struct_docs(&self) -> String {
        let origin_ident = &self.origin.ident;
        let ident = &self.ident;
        let origin_has_opt_fields = self.origin.has_optional_fields();

        // ! overview features
        let mut support = Vec::new();
        support.push("This struct can be used to:".to_string());
        support.push(format!("- *Set* [`{origin_ident}`] fields"));
        support.push(format!("- *Override* assignments made using [`{origin_ident}Builder`]"));
        if origin_has_opt_fields {
            support.push("- *Revert* field assignments back to library-defined defaults".to_string());
        }
        let support = support.join("\n");

        // ! overview
        let overview = format!(
"Provides support for configuring [`{origin_ident}`] at run-time.

A common method of rust app configuration is deserializing a config file or env vars into a *'Config'* struct at run-time.

`{ident}` is provided for just this case.

{support}"
        );

        // ! example
        let mut default_attr = String::new();
        if !self.has_required_fields() {
            default_attr.push_str("#[serde(default)]\n    ");
        }
        let example = format!(
"```rust,ignore
#[derive(Debug, Clone, Deserialize)]
pub struct Conf {{
    api: ApiConf,
    // ..
    {default_attr}_: {ident},
}}
```"
        );

        // ! fields
        let mut fields = Vec::new();
        let mut unset_fields = Vec::new();
        if origin_has_opt_fields {
            unset_fields.push(format!(
"For each of [`{origin_ident}`]'s optional fields, there is an additional `{{}}_unset` field.

If set to `true`, the associated field will have its value reverted to the library default.\n"
            ));
        }
        for field in &self.fields {
            let mut suffix = String::new();
            if field.is_required() {
                suffix.push_str("  // mandatory");
            }

            let field_ident = field.ident();
            let ty = field.flat_ty().to_token_stream().to_string().replace(' ', "");
            fields.push(format!("- `{field_ident}: {ty}{suffix}`"));
            if let Some(unset_ident) = field.origin.unset_ident() {
                unset_fields.push(format!("- `{unset_ident}: bool`"));
            }
        }
        if self.has_optional_fields() {
            if self.has_required_fields() {
                fields.push("\n**Note**: Each override field is optional unless explicitly stated otherwise.".to_string());
            } else {
                fields.push("\n**Note**: All override fields are optional.".to_string());
            }
        }
        if !unset_fields.is_empty() {
            fields.push("\n## Unset fields\n".to_string());

            let unset_aliases = parse::UNSET_ALIASES.iter().map(|s| format!("`{s}`")).collect::<Vec<_>>().join(", ");
            unset_fields.push(format!("\n**Note**: The following unset aliases are also supported: {unset_aliases}"));
        }
        fields = fields.into_iter().chain(unset_fields).collect();
        let fields = fields.join("\n");

        // !- output
        format!(
"{overview}

# Example

{example}

# Fields

{fields}"
        )
    }
}

// ! Override struct generate methods
impl OverrideStruct {
    fn derive_tokens(&self) -> TokenStream {
        #[cfg(not(feature = "serde"))]
        let base = quote! { #[derive(Debug, Clone)] };
        #[cfg(feature = "serde")]
        let base = quote! { #[derive(Debug, Clone, ::serde::Deserialize)] };

        let custom = self.origin.attrs.has_override_derives().then(|| {
            let derives = &self.origin.attrs.override_derives;
            quote!(#[derive(#(#derives),*)])
        });
        quote! {
            #base
            #custom
        }
    }
    fn attr_tokens(&self) -> Option<TokenStream> {
        self.origin.attrs.has_override_attrs().then(|| {
            let attrs = &self.origin.attrs.override_attrs;
            quote!(#(#[#attrs])*)
        })
    }
    fn phantom_fields_tokens(&self) -> TokenStream {
        let mut out = TokenStream::new();
        for field in &self.phantom_fields {
            let ident = field.phantom_ident();
            let ty = &field.ty;

            #[cfg(feature = "serde")]
            out.extend(quote!(#[serde(default)]));

            out.extend(quote! {
                #ident: ::std::marker::PhantomData<#ty>,
            });
        }
        out
    }
    fn struct_tokens(&self) -> TokenStream {
        let docs = util::doc_lines_split(self.struct_docs(), false);
        let derives = self.derive_tokens();
        let attrs = self.attr_tokens();
        let struct_ident = &self.ident;
        let fields: Vec<_> = self.fields
            .iter()
            .map(ToTokens::into_token_stream)
            .collect();
        let phantom_fields = self.phantom_fields_tokens();
        let generics = &self.origin.generics;
        let where_clause = &generics.where_clause;
        quote! {
            #docs
            #derives
            #attrs
            pub struct #struct_ident #generics
            #where_clause
            {
                #(#fields)*

                #phantom_fields
            }
        }
    }
    fn getter_fns_tokens(&self) -> TokenStream {
        self.fields
            .iter()
            .map(OverrideField::getter_tokens)
            .collect()
    }
    fn impl_tokens(&self) -> TokenStream {
        let ident = &self.ident;
        let getters = self.getter_fns_tokens();
        let (
            impl_generics,
            ty_generics,
            where_clause,
        ) = self.origin.generics.split_for_impl();
        quote! {
            #[automatically_derived]
            impl #impl_generics #ident #ty_generics #where_clause {
                #getters
            }
        }
    }
    fn default_impl_tokens(&self) -> TokenStream {
        assert!(!self.has_required_fields());

        let struct_ident = &self.ident;

        // fields
        let mut fields = TokenStream::new();
        for field in &self.fields {
            // guaranteed to be Option since there are no required fields
            let ident = field.ident();
            fields.extend(quote!(#ident: None,));

            // unset field
            if let Some(unset_ident) = field.origin.unset_ident() {
                fields.extend(quote!(#unset_ident: false,));
            }
        }
        // phantom fields
        let mut phantoms = TokenStream::new();
        for field in &self.phantom_fields {
            let ident = field.phantom_ident();
            phantoms.extend(quote!(#ident: ::std::marker::PhantomData,));
        }
        // generics
        let (
            impl_generics,
            ty_generics,
            where_clause,
        ) = self.origin.generics.split_for_impl();

        // #[allow(clippy::redundant_field_names)] added for:
        //   https://github.com/rust-lang/rust-clippy/issues/17525
        quote! {
            #[automatically_derived]
            #[allow(clippy::redundant_field_names)]
            impl #impl_generics Default for #struct_ident #ty_generics #where_clause {
                fn default() -> Self {
                    Self {
                        #fields
                        #phantoms
                    }
                }
            }
        }
    }
}
impl ToTokens for OverrideStruct {
    fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {
        tokens.extend(self.struct_tokens());
        tokens.extend(self.impl_tokens());
        if !self.has_required_fields() {
            // all fields must be optional for default impl
            tokens.extend(self.default_impl_tokens());
        }
    }
}

// ! Override struct fields

pub type OverrideField = VariantField<OverrideVariant>;

impl OverrideField {
    pub fn is_required(&self) -> bool {
        self.attrs().override_required
    }
    #[allow(dead_code)] // only used w/ serde feature
    pub fn is_optional(&self) -> bool {
        !self.attrs().override_required
    }
    fn attr_tokens(&self) -> Option<TokenStream> {
        self.origin.has_override_attrs().then(|| {
            let attrs = &self.origin.override_attrs;
            quote!(#(#[#attrs])*)
        })
    }
    pub fn flat_ty(&self) -> Type {
        match self.attrs().override_from {
            Some(ref ty) => Type::Path(ty.clone()),
            None => self.origin.flat_ty.clone(),
        }
    }
    pub fn ty(&self) -> Type {
        let mut ty = self.flat_ty();
        if !self.attrs().override_required {
            ty = parse_quote!(Option<#ty>);
        }
        ty
    }
    fn getter_ret_ty(&self) -> Type {
        // copy permitted, direct return
        if self.attrs().copy && self.attrs().override_from.is_none() {
            if self.attrs().override_required {
                return self.origin.flat_ty.clone();
            }
            let inner = &self.origin.flat_ty;
            return parse_quote!(Option<#inner>);
        }

        let ty = self.ty();
        if let Some(inner_ty) = parse::util::unwrap_option(&ty) {
            if parse::util::is_string(inner_ty) {
                // type is Option<String>
                parse_quote!(Option<&str>)
            } else {
                // type is Option<_>
                parse_quote!(Option<&#inner_ty>)
            }
        } else {
            if parse::util::is_string(&ty) {
                // type is String
                parse_quote!(&str)
            } else {
                // Any other type
                parse_quote!(&#ty)
            }
        }
    }
    fn getter_ret_expr(&self) -> TokenStream {
        let ident = self.ident();
        let inner = quote!(self.#ident);

        // copy permitted, direct return
        if self.attrs().copy && self.attrs().override_from.is_none() {
            return inner;
        }

        let ty = self.ty();
        if let Some(inner_ty) = parse::util::unwrap_option(&ty) {
            if parse::util::is_string(inner_ty) {
                // type is Option<String>
                quote!(#inner.as_ref().map(|s| s.as_str()))
            } else {
                // type is Option<_>
                quote!(#inner.as_ref())
            }
        } else {
            if parse::util::is_string(&ty) {
                // type is String
                quote!(#inner.as_str())
            } else {
                // Any other type
                quote!(&#inner)
            }
        }
    }
    pub(super) fn getter_tokens(&self) -> TokenStream {
        let ident = self.ident();
        let docs = self.docs();
        let ty = self.getter_ret_ty();
        let ret = self.getter_ret_expr();
        // include the unset_getter here so that it appears immediately after
        // the normal getter
        let unset_getter = self.unset_getter_tokens();

        quote! {
            #docs
            #[must_use]
            pub fn #ident(&self) -> #ty {
                #ret
            }

            #unset_getter
        }

    }
    pub(super) fn unset_getter_tokens(&self) -> Option<TokenStream> {
        self.origin.unset_ident().map(|unset_ident| {
            let ident = self.ident();
            let docs_txt = format!("Returns true if the `{ident}` unset field has been explicitly set to true");
            let docs = util::doc_line(docs_txt, true);

            quote! {
                #docs
                #[must_use]
                pub fn #unset_ident(&self) -> bool {
                    self.#unset_ident
                }
            }
        })
    }
}
impl ToTokens for OverrideField {
    fn to_tokens(&self, tokens: &mut TokenStream) {
        let ident = self.ident();
        let ty = self.ty();

        #[cfg(feature = "serde")]
        let vis = quote!(pub(crate));
        #[cfg(not(feature = "serde"))]
        let vis = quote!(pub);

        // regular assign field
        let field_docs = self.docs();
        let attrs = self.attr_tokens();
        let field = quote! {
            #field_docs
            #attrs
            #vis #ident: #ty,
        };
        tokens.extend(field);

        // unset field
        if let Some(unset_ident) = self.origin.unset_ident() {
            #[cfg(feature = "serde")]
            {
                let aliases = self.origin.unset_aliases();
                tokens.extend(quote! {
                    #[serde(default, #(alias=#aliases),*)]
                });
            }

            tokens.extend(quote! {
                /// flag allowing for reverting a builder-configured
                /// setting at runtime
                #vis #unset_ident: bool,
            });
        }
    }
}