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

use proc_macro2::{Span, TokenStream};
use quote::{ToTokens, TokenStreamExt};
use syn;

/// Deprecation notes we want to emit to the user, implementing
/// `quote::ToTokens`.
///
/// Can be expanded at every place that accepts statements and item definitions
/// (e.g. function bodys).
///
/// # Examples
///
/// Will expand to something like the following (depending on settings):
///
/// ```rust
/// # #[macro_use]
/// # extern crate quote;
/// # extern crate derive_builder_core;
/// # use derive_builder_core::DeprecationNotes;
/// # fn main() {
/// #    let mut note = DeprecationNotes::default();
/// #    note.push("Some Warning".to_string());
/// #    assert_eq!(quote!(#note).to_string(), quote!(
///         {
///             #[deprecated(note = "Some Warning")]
///             fn derive_builder_core_deprecation_note() { }
///             derive_builder_core_deprecation_note();
///         }
/// #    ).to_string());
/// # }
/// ```
///
/// This will emit a deprecation warning in the downstream crate. Cool stuff. ^^
///
/// Proof of concept:
/// - https://play.rust-lang.org/?gist=8394141c07d1f6d75d314818389eb4d8
#[derive(Debug, Default, Clone)]
pub struct DeprecationNotes(Vec<String>);

impl ToTokens for DeprecationNotes {
    fn to_tokens(&self, tokens: &mut TokenStream) {
        for note in &self.0 {
            let fn_ident =
                syn::Ident::new("derive_builder_core_deprecation_note", Span::call_site());
            tokens.append_all(quote!(
                {
                    #[deprecated(note=#note)]
                    fn #fn_ident() { }
                    #fn_ident();
                }
            ));
        }
    }
}

impl DeprecationNotes {
    /// Appends a note to the collection.
    pub fn push(&mut self, note: String) {
        self.0.push(note)
    }

    /// Extend this collection with all values from another collection.
    pub fn extend(&mut self, other: &Self) {
        for x in &other.0 {
            self.0.push(x.to_owned())
        }
    }

    /// Create a view of these deprecation notes that can annotate a struct.
    pub const fn as_item(&self) -> DeprecationNotesAsItem {
        DeprecationNotesAsItem(self)
    }
}

/// A view of `DeprecationNotes` that can be used in any context that accept
/// items.
///
/// Expands to a function `__deprecation_notes` which emits the notes.
#[derive(Debug)]
pub struct DeprecationNotesAsItem<'a>(&'a DeprecationNotes);

impl<'a> ToTokens for DeprecationNotesAsItem<'a> {
    fn to_tokens(&self, tokens: &mut TokenStream) {
        let deprecation_notes = self.0;

        if !deprecation_notes.0.is_empty() {
            tokens.append_all(quote!(
                #[doc(hidden)]
                fn derive_builder_core_deprecation_note() {
                    #deprecation_notes
                }
            ))
        }
    }
}

#[test]
fn deprecation_note() {
    let mut note = DeprecationNotes::default();
    note.push("Some Warning".to_string());
    assert_eq!(
        quote!(#note).to_string(),
        quote!({
            #[deprecated(note = "Some Warning")]
            fn derive_builder_core_deprecation_note() {}
            derive_builder_core_deprecation_note();
        })
        .to_string()
    );
}