structopt-yaml-derive 0.4.6

extern crate proc_macro;
extern crate syn;
#[macro_use]
extern crate quote;

use proc_macro::TokenStream;
use proc_macro2::TokenTree;
use syn::parse::{Parse, ParseStream};
use syn::punctuated::Punctuated;
use syn::token::Comma;
use syn::{buffer::Cursor, DataStruct, DeriveInput, Field, Ident, LitStr};

#[proc_macro_derive(StructOptYaml, attributes(structopt))]
pub fn structopt_yaml(input: TokenStream) -> TokenStream {
    let input: DeriveInput = syn::parse(input).unwrap();
    let gen = impl_structopt_yaml(&input);
    gen.into()
}

fn impl_structopt_yaml(input: &DeriveInput) -> proc_macro2::TokenStream {
    use syn::Data::*;

    let struct_name = &input.ident;
    let inner_impl = match input.data {
        Struct(DataStruct {
            fields: syn::Fields::Named(ref fields),
            ..
        }) => impl_structopt_for_struct(struct_name, &fields.named),
        _ => panic!("structopt_yaml only supports non-tuple struct"),
    };

    quote!(#inner_impl)
}

fn impl_structopt_for_struct(
    name: &Ident,
    fields: &Punctuated<Field, Comma>,
) -> proc_macro2::TokenStream {
    let merged_fields = gen_merged_fields(fields);

    quote! {
        impl ::structopt_yaml::StructOptYaml for #name {
            fn merge<'a>(from_yaml: Self, from_args: Self, args: &::structopt_yaml::clap::ArgMatches) -> Self where
                Self: Sized,
                Self: ::structopt_yaml::structopt::StructOpt,
                Self: ::structopt_yaml::serde::de::Deserialize<'a>
            {
                Self {
                    #merged_fields
                }
            }
        }

        impl Default for #name {
            fn default() -> Self {
                #name::from_args()
            }
        }
    }
}

fn gen_merged_fields(fields: &Punctuated<Field, Comma>) -> proc_macro2::TokenStream {
    let fields = fields.iter().map(|field| {
        let explicit_name = load_explicit_name(field);

        // If the field is decorated with `#[structopt(flatten)]` we have to treat it differently.
        // We can't check its existence with `args.is_present` and `args.occurrences_of`
        // and instead we delegate and call its own `StructOptYaml` implementation of `merge`
        let is_flatten = is_flatten(field);

        // by default the clap arg name is the field name, unless overwritten with `name=<value>`
        let field_name = field.ident.as_ref().unwrap();
        let field_type = field.ty.clone();
        let name_str = explicit_name.unwrap_or(format!("{}", field_name));
        let structopt_name = LitStr::new(&name_str, field_name.span());
        if is_flatten {
            quote!(
                #field_name: {
                    <#field_type as ::structopt_yaml::StructOptYaml>::merge(
                        from_yaml.#field_name,
                        from_args.#field_name,
                        args
                    )
                }
            )
        } else {
            quote!(
                #field_name: {
                    if args.is_present(#structopt_name) && args.occurrences_of(#structopt_name) > 0 {
                        from_args.#field_name
                    } else {
                        from_yaml.#field_name
                    }
                }
            )
        }
    });
    quote! (
        #( #fields ),*
    )
}

/// Loads the structopt name from the strcutopt attribute.
/// i.e. from an attribute of the form `#[structopt(..., name = "some-name", ...)]`
fn load_explicit_name(field: &Field) -> Option<String> {
    field
        .attrs
        .iter()
        .filter(|&attr| attr.path.is_ident("structopt"))
        .filter_map(|attr| {
            // extract parentheses
            let ts = attr.parse_args().ok()?;
            // find name = `value` in attribute
            syn::parse2::<NameVal>(ts).map(|nv| nv.0).ok()
        })
        .nth(0)
}

/// Checks whether the attribute is marked as flattened
/// i.e. `#[structopt(flatten)]`
fn is_flatten(field: &Field) -> bool {
    field
        .attrs
        .iter()
        .filter(|&attr| attr.path.is_ident("structopt"))
        .filter_map(|attr| attr.parse_meta().ok())
        .map(|meta| {
            let list = match meta {
                syn::Meta::List(list) => list,
                _ => return false,
            };
            let nested = match list.nested.first() {
                Some(nested) => nested,
                _ => return false,
            };
            let inner_meta = match nested {
                syn::NestedMeta::Meta(inner_meta) => inner_meta,
                _ => return false,
            };
            let path = match inner_meta {
                syn::Meta::Path(path) => path,
                _ => return false,
            };
            path.is_ident("flatten")
        })
        .nth(0)
        .unwrap_or(false)
}

#[derive(Debug)]
struct NameVal(String);

impl Parse for NameVal {
    fn parse(input: ParseStream) -> syn::Result<Self> {
        #[derive(PartialEq, Eq, Debug)]
        enum Match {
            NameToken,
            PunctEq,
            LitVal,
        }
        let mut state = Match::NameToken;
        let result = input.step(|cursor| {
            let mut rest = *cursor;
            while let Some((tt, next)) = rest.token_tree() {
                match tt {
                    TokenTree::Ident(ident) if ident == "name" && state == Match::NameToken => {
                        state = Match::PunctEq;
                    }
                    TokenTree::Punct(punct)
                        if punct.as_char() == '=' && state == Match::PunctEq =>
                    {
                        state = Match::LitVal;
                    }
                    TokenTree::Literal(lit) if state == Match::LitVal => {
                        return Ok((lit.to_string().replace("\"", ""), Cursor::empty()));
                    }
                    _ => {
                        // on first incorrect token reset
                        state = Match::NameToken;
                    }
                }
                rest = next;
            }
            Err(cursor.error("End reached"))
        });
        result
            .map(|lit| Self(lit))
            .map_err(|_| input.error("Not found"))
    }
}