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
//! Adds proc macro that adds methods to parse environment variables and write documentation using [doc-writer].
//!
//! # Examples
//! ```
#![doc = include_str!("../examples/http.rs")]
//! ```
//!
//! Would yield the following documentation:
#![doc = include_str!("../examples/http.md")]
//!
//! [doc-writer]: https://docs.rs/doc-writer/

use convert_case::{Case, Casing};
use proc_macro::TokenStream as CompilerTokenStream;
use proc_macro2::{Ident, TokenStream};
use quote::quote;
use syn::{parse_macro_input, Attribute, Data, DataEnum, DataStruct, DeriveInput, Lit, LitStr, Meta};

#[macro_use]
extern crate proc_macro_error;

mod struct_attributes {
    use bae::FromAttributes;
    use syn::LitStr;

    #[derive(Debug, Default, FromAttributes)]
    pub struct Env {
        pub prefix: Option<LitStr>,
    }
}

use struct_attributes::Env as StructAttributes;

mod field_attributes {
    use bae::FromAttributes;
    use syn::{Expr, LitStr};

    #[derive(Debug, Default, FromAttributes)]
    pub struct Env {
        pub rename: Option<LitStr>,
        pub no_prefix: Option<()>,
        pub skip: Option<()>,

        pub default: Option<Expr>,
        pub flatten: Option<()>,
    }
}

use field_attributes::Env as FieldAttributes;

mod enum_attributes {
    use bae::FromAttributes;
    use syn::LitStr;

    #[derive(Debug, Default, FromAttributes)]
    pub struct Env {
        pub rename_all: Option<LitStr>,
    }
}

use enum_attributes::Env as EnumAttributes;

mod variant_attributes {
    use bae::FromAttributes;
    use syn::LitStr;

    #[derive(Debug, Default, FromAttributes)]
    pub struct Env {
        pub rename: Option<LitStr>,
        pub skip: Option<()>,

        pub default: Option<()>,
    }
}

use variant_attributes::Env as VariantAttributes;

/// Derives `EnvConfig` as described in the [module description][self].
#[proc_macro_derive(EnvConfig, attributes(env))]
#[proc_macro_error]
pub fn derive_config(input: CompilerTokenStream) -> CompilerTokenStream {
    let input = parse_macro_input!(input as DeriveInput);
    match input.data {
        Data::Struct(data) => {
            let container_attrs = match StructAttributes::try_from_attributes(&input.attrs) {
                Ok(attrs) => attrs.unwrap_or_default(),
                Err(e) => {
                    emit_error!(input.ident, format!("{}: {}", input.ident, e));
                    return CompilerTokenStream::new();
                }
            };
            derive_config_struct(input.ident, container_attrs, data)
        }
        Data::Enum(data) => {
            let container_attrs = match EnumAttributes::try_from_attributes(&input.attrs) {
                Ok(attrs) => attrs.unwrap_or_default(),
                Err(e) => {
                    emit_error!(input.ident, format!("{}: {}", input.ident, e));
                    return CompilerTokenStream::new();
                }
            };
            derive_config_enum(input.ident, container_attrs, data)
        }
        Data::Union(data) => {
            emit_error!(
                data.union_token,
                "deriving EnvConfig only works on structs and enums"
            );
            TokenStream::new()
        }
    }
    .into()
}

#[allow(unused_parens)]
fn derive_config_struct(
    struct_name: Ident,
    container_attrs: StructAttributes,
    data: DataStruct,
) -> TokenStream {
    let prefix = container_attrs
        .prefix
        .map(|s| s.value())
        .unwrap_or_else(|| "".to_owned());

    let mut default_code = TokenStream::new();
    let mut from_env_code = TokenStream::new();
    let mut doc_code = TokenStream::new();

    for field in data.fields {
        let field_ident = match field.ident {
            Some(ident) => ident,
            None => {
                emit_error!(
                    field.ty,
                    "deriving EnvConfig only works on structs with named fields"
                );
                return TokenStream::new();
            }
        };

        let field_attrs: FieldAttributes = match FieldAttributes::try_from_attributes(&field.attrs)
        {
            Ok(attrs) => attrs.unwrap_or_default(),
            Err(e) => {
                emit_error!(field_ident, format!("{}: {}", field_ident, e));
                return TokenStream::new();
            }
        };

        if let Some(default) = field_attrs.default {
            default_code.extend(quote! { #field_ident: #default, });
        } else {
            default_code.extend(quote! { #field_ident: ::std::default::Default::default(), });
        }

        if field_attrs.skip.is_some() {
            continue;
        }
        if field_attrs.flatten.is_some() {
            emit_error!(
                field_ident,
                format!(
                    "{}: {}",
                    field_ident, "#[env(flatten)] is not yet implemented"
                )
            );
            continue;
        }

        let mut name = String::new();
        if field_attrs.no_prefix.is_none() {
            name.push_str(&prefix);
        }
        name.push_str(
            &field_attrs
                .rename
                .map(|s| s.value())
                .unwrap_or_else(|| field_ident.to_string())
                .to_uppercase(),
        );

        let field_doc = match doc(&field.attrs[..]) {
            Ok(doc) => doc,
            Err(_) => return TokenStream::new(),
        };

        from_env_code.extend(quote! {
            #name => parsed.#field_ident = ::std::str::FromStr::from_str(&val).expect("TODO"),
        });
        doc_code.extend(quote! {
            doc.variable(#name, &self.#field_ident.to_string())?;
            doc.plain(#field_doc)?;
        });
    }

    let ts = quote! {
        impl ::std::default::Default for #struct_name {
            fn default() -> Self {
                Self {
                    #default_code
                }
            }
        }

        impl #struct_name {
            pub fn from_env(vars: impl ::std::iter::Iterator<Item = (::std::string::String, ::std::string::String)>) -> Result<Self, ()> {
                let mut parsed = Self::default();

                for (key, val) in vars {
                    match key.as_str() {
                        #from_env_code
                        _ => { /* skip unknown keys */ },
                    }
                }
                Ok(parsed)
            }

            pub fn document_env<D: ::doc_writer::DocumentationWriter>(&self, doc: &mut D) -> Result<(), D::Error> {
                #doc_code
                Ok(())
            }
        }
    };
    ts
}

fn derive_config_enum(
    enum_name: Ident,
    container_attrs: EnumAttributes,
    data: DataEnum,
) -> TokenStream {
    let case = match parse_case(container_attrs.rename_all) {
        Ok(case) => case,
        Err(_) => return TokenStream::new(),
    };

    let mut default_code = TokenStream::new();
    let mut doc_code = TokenStream::new();
    let mut parse_code = TokenStream::new();
    let mut display_code = TokenStream::new();

    for variant in data.variants {
        let variant_ident = variant.ident;

        let variant_attrs: VariantAttributes =
            match VariantAttributes::try_from_attributes(&variant.attrs) {
                Ok(attrs) => attrs.unwrap_or_default(),
                Err(e) => {
                    emit_error!(variant_ident, format!("{}: {}", variant_ident, e));
                    return TokenStream::new();
                }
            };

        let name = &variant_attrs
            .rename
            .map(|s| s.value())
            .unwrap_or_else(|| variant_ident.to_string())
            .to_case(case);
        let lower_name = name.to_ascii_lowercase();

        if variant_attrs.default.is_some() {
            default_code = quote! {
                impl ::std::default::Default for #enum_name {
                    fn default() -> Self {
                        Self::#variant_ident
                    }
                }
            }
        }

        display_code.extend(quote! {
            Self::#variant_ident => write!(f, #name),
        });

        if variant_attrs.skip.is_some() {
            continue;
        }

        let variant_doc = match doc(&variant.attrs[..]) {
            Ok(attrs) => attrs,
            Err(_) => return TokenStream::new(),
        };

        parse_code.extend(quote! {
            #lower_name => Self::#variant_ident,
        });
        doc_code.extend(quote! {
            doc.variant(#name)?;
            doc.plain(#variant_doc)?;
        });
    }

    let ts = quote! {
        #default_code

        impl ::std::str::FromStr for #enum_name {
            type Err = (); // TODO proper Error

            fn from_str(s: &str) -> Result<Self, Self::Err> {
                let s = s.to_ascii_lowercase();
                Ok(match s.as_str() {
                    #parse_code
                    _ => return Err(())
                })
            }
        }

        impl ::std::fmt::Display for #enum_name {
            fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
                match self {
                    #display_code
                }
            }
        }

        impl #enum_name {
            pub fn document_enum<D: ::doc_writer::DocumentationWriter>(doc: &mut D) -> Result<(), D::Error> {
                #doc_code
                Ok(())
            }
        }
    };
    ts
}

fn parse_case(pattern: Option<LitStr>) -> Result<Case, ()> {
    if let Some(pattern) = pattern {
        Ok(match pattern.value().as_str() {
            "lowercase" => Case::Flat,
            "UPPERCASE" => Case::UpperFlat,
            "PascalCase" => Case::Pascal,
            "camelCase" => Case::Camel,
            "snake_case" => Case::Snake,
            "SCREAMING_SNAKE_CASE" => Case::ScreamingSnake,
            "kebab-case" => Case::Kebab,
            "SCREAMING-KEBAB-CASE" => Case::Cobol,
            _ => {
                emit_error!(
                pattern,
                r#"#[env(rename_all)] only accepts "lowercase", "UPPERCASE", "PascalCase", "camelCase", "snake_case", "SCREAMING_SNAKE_CASE", "kebab-case", and "SCREAMING-KEBAB-CASE"#
            );
                return Err(());
            }
        })
    } else {
        Ok(Case::Pascal)
    }
}

fn doc(attrs: &[Attribute]) -> Result<String, ()> {
    let mut doc = String::new();
    for attr in attrs {
        if !attr.path.is_ident("doc") {
            continue;
        }
        let doc_attr = match attr.parse_meta() {
            Ok(attr) => attr,
            Err(e) => {
                emit_error!(attr.tokens, e.to_string());
                return Err(());
            }
        };
        match doc_attr {
            Meta::NameValue(kv) => match kv.lit {
                Lit::Str(s) => {
                    doc.push_str(&s.value());
                    doc.push('\n')
                }
                _ => {
                    emit_error!(
                        attr.tokens,
                        "#[doc] attributes must consist of literal strings, like #[doc = \"Info\"]"
                    );
                    return Err(());
                }
            },
            _ => {
                emit_error!(
                    attr.tokens,
                    "#[doc] attributes must be assignments, like #[doc = \"Info\"]"
                );
                return Err(());
            }
        }
    }
    Ok(doc)
}