double-derive 0.2.6

use quote::quote;
use syn::ItemTrait;

use crate::{double_trait::double_trait, dummy_impl::dummy_impl};

/// The main implementation of [`crate::dummies`]. This function is not annotated with
/// `#[proc_macro_attribute]` so it can exist in unit tests. It uses only APIs build on top of
/// [`proc_macro2`] in order to be unit testable.
pub fn expand(org_trait: ItemTrait) -> syn::Result<proc_macro2::TokenStream> {
    let trait_with_dummies = double_trait(org_trait.ident.clone(), org_trait.clone())?;
    let dummy_impl = dummy_impl(org_trait.ident.clone(), org_trait);

    let token_stream = quote! {
        #trait_with_dummies

        #dummy_impl
    };
    Ok(token_stream)
}

#[cfg(test)]
mod tests {

    use quote::quote;
    use syn::{ItemTrait, parse2};

    use super::expand;

    #[test]
    fn private_empty_trait() {
        // Given an empty trait
        let empty_trait = given(quote! {
            trait MyTrait {}
        });

        // When expanded with `dummies`
        let output = expand(empty_trait).unwrap();

        // Then it will be unchanged
        let expected = quote! {
            trait MyTrait{}

            impl MyTrait for double_trait::Dummy {}
        };
        assert_eq!(expected.to_string(), output.to_string())
    }

    #[test]
    fn public_empty_trait() {
        // Given a public trait
        let org_trait = given(quote! { pub trait MyTrait {} });

        // When generating the dummy
        let output = expand(org_trait).unwrap();

        // Then the generated trait should be public, too
        let expected = quote! {
            pub trait MyTrait {}

            impl MyTrait for double_trait::Dummy {}
        };
        assert_eq!(expected.to_string(), output.to_string());
    }

    #[test]
    fn empty_default_method() {
        // Given a trait with a method which returns unit
        let item = given(quote! {
            trait MyTrait {
                fn foobar(&self);
            }
        });

        // When generating the dummy
        let output = expand(item).unwrap();

        // Then the generated trait should contain a default implementation doing nothing
        let expected = quote! {
            trait MyTrait {
                fn foobar(&self) {}
            }

            impl MyTrait for double_trait::Dummy {}
        };
        assert_eq!(expected.to_string(), output.to_string());
    }

    #[test]
    fn dummy_default_method() {
        // Given a trait with a method which returns something (e.g. i32)
        let item = given(quote! {
            trait MyTrait {
                fn foobar(&self) -> i32;
            }
        });

        // When generating the dummy
        let output = expand(item).unwrap();

        // Then the generated trait should contain a default implementation calling unimplemented!()
        let expected = quote! {
            trait MyTrait {
                fn foobar(&self) -> i32 {
                    let double_trait_name = stringify!(MyTrait);
                    let fn_name = stringify!(foobar);
                    unimplemented!("{double_trait_name}::{fn_name}")
                }
            }

            impl MyTrait for double_trait::Dummy {}
        };
        assert_eq!(expected.to_string(), output.to_string());
    }

    #[test]
    fn respect_existing_default_impl() {
        // Given a method with a default implementation in the original trait
        let item = given(quote! {
            pub trait MyTrait {
                fn foobar() { println!("Hello Default!") }
            }
        });

        // When generating the dummy
        let output = expand(item).unwrap();

        // Then the generated trait should not overide the existing default
        let expected = quote! {
            pub trait MyTrait {
                fn foobar() { println!("Hello Default!") }
            }

            impl MyTrait for double_trait::Dummy {}
        };
        assert_eq!(expected.to_string(), output.to_string());
    }

    #[test]
    fn forward_async_method_with_unit_return() {
        // Given a trait with an async method returning uint
        let item = given(quote! {
            trait MyTrait {
                async fn foobar(&self);
            }
        });

        // When generating the dummy
        let output = expand(item).unwrap();

        // Then the generated trait should contain an empty default implementation
        let expected = quote! {
            trait MyTrait {
                async fn foobar(&self) {}
            }

            impl MyTrait for double_trait::Dummy {}
        };
        assert_eq!(expected.to_string(), output.to_string());
    }

    fn given(item: proc_macro2::TokenStream) -> ItemTrait {
        let item: ItemTrait = parse2(item).unwrap();
        item
    }
}