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
#![crate_type = "proc-macro"]
#![doc(html_root_url = "https://docs.rs/avocado_derive/0.2.0")]
#![deny(missing_debug_implementations, missing_copy_implementations,
trivial_casts, trivial_numeric_casts,
unsafe_code,
unstable_features,
anonymous_parameters, bare_trait_objects,
variant_size_differences,
unused_import_braces, unused_qualifications,
)]
#![allow(clippy::single_match, clippy::match_same_arms, clippy::match_ref_pats,
clippy::clone_on_ref_ptr, clippy::needless_pass_by_value)]
#![deny(clippy::wrong_pub_self_convention, clippy::used_underscore_binding,
clippy::stutter, clippy::similar_names, clippy::pub_enum_variant_names,
clippy::missing_docs_in_private_items,
clippy::non_ascii_literal, clippy::unicode_not_nfc,
clippy::result_unwrap_used, clippy::option_unwrap_used,
clippy::option_map_unwrap_or_else, clippy::option_map_unwrap_or, clippy::filter_map,
clippy::shadow_unrelated, clippy::shadow_reuse, clippy::shadow_same,
clippy::int_plus_one, clippy::string_add_assign, clippy::if_not_else,
clippy::invalid_upcast_comparisons,
clippy::cast_precision_loss,
clippy::cast_possible_wrap, clippy::cast_possible_truncation,
clippy::mutex_integer, clippy::mut_mut, clippy::items_after_statements,
clippy::print_stdout, clippy::mem_forget, clippy::maybe_infinite_iter)]
#[macro_use]
extern crate quote;
#[macro_use]
extern crate syn;
extern crate proc_macro;
extern crate proc_macro2;
#[macro_use]
mod error;
mod meta;
mod attr;
mod case;
mod index;
use proc_macro::TokenStream;
use proc_macro2::Span;
use syn::{
DeriveInput, Data, Generics, Fields, Ident,
Type, Attribute, TypePath, Path, PathSegment,
};
use self::{
meta::*,
case::RenameRule,
index::Spec,
error::{ Result, err_msg },
};
#[proc_macro_derive(Doc, attributes(avocado, index, id_type))]
pub fn derive_avocado_doc(input: TokenStream) -> TokenStream {
impl_avocado_doc(input).unwrap_or_else(|error| panic!("{}", error))
}
fn impl_avocado_doc(input: TokenStream) -> Result<TokenStream> {
let parsed_ast: DeriveInput = syn::parse(input)?;
let ty = parsed_ast.ident;
let generics = parsed_ast.generics;
let ty_name = serde_renamed_ident(&parsed_ast.attrs, ty.to_string())?;
let (impl_gen, ty_gen, where_cls) = generics.split_for_impl();
let id_ty = raw_id_type(&parsed_ast.attrs)?;
let indexes = Spec::from_attributes(&parsed_ast.attrs)?;
ensure_only_lifetime_params(&generics)?;
match parsed_ast.data {
Data::Struct(s) => {
ensure_id_exists_and_unique(s.fields, &parsed_ast.attrs)?;
let ast = quote! {
impl #impl_gen ::avocado::doc::Doc for #ty #ty_gen #where_cls {
const NAME: &'static str = #ty_name;
type Id = #id_ty;
fn indexes() -> Vec<::avocado::prelude::IndexModel> {
vec![
#(#indexes),*
]
}
}
};
Ok(ast.into())
},
_ => err_msg(
"only a `struct` can be a top-level `Doc`; consider wrapping this type in a struct"
),
}
}
fn serde_renamed_ident(attrs: &[Attribute], ident: String) -> Result<String> {
serde_name_value(attrs, "rename")?
.as_ref()
.map_or(Ok(ident), value_as_str)
}
fn field_is_always_skipped(attrs: &[Attribute]) -> Result<bool> {
Ok(
has_serde_word(attrs, "skip")? || (
has_serde_word(attrs, "skip_serializing")?
&&
has_serde_word(attrs, "skip_deserializing")?
)
)
}
fn raw_id_type(attrs: &[Attribute]) -> Result<Type> {
literal_value_for_name(attrs, "id_type")
.map(|maybe_ty| maybe_ty.unwrap_or_else(|| {
Type::Path(TypePath {
qself: None,
path: Path {
leading_colon: Some(Default::default()),
segments: vec!["avocado", "prelude", "ObjectId"]
.into_iter()
.map(|name| PathSegment {
ident: Ident::new(name, Span::call_site()),
arguments: Default::default(),
})
.collect()
},
})
}))
}
fn ensure_id_exists_and_unique(fields: Fields, attrs: &[Attribute]) -> Result<()> {
let named = match fields {
Fields::Named(fields) => fields.named,
_ => return err_msg("a `Doc` must be a struct with named fields"),
};
let rename_attr = serde_name_value(attrs, "rename_all")?;
let rename_rule: Option<RenameRule> = match rename_attr {
None => None,
Some(kv) => Some(value_as_str(&kv)?.parse()?)
};
let mut has_id = false;
for field in named {
if field_is_always_skipped(&field.attrs)? {
continue;
}
let ident = match field.ident {
Some(ident) => ident,
None => continue,
};
let rename_all_ident = rename_rule.map_or_else(
|| ident.to_string(),
|rule| rule.apply_to_field(ident.to_string()),
);
let field_name = serde_renamed_ident(&field.attrs, rename_all_ident)?;
if field_name == "_id" {
if has_id {
return err_msg("more than one fields serialize as `_id`");
} else {
has_id = true;
}
}
}
if has_id {
Ok(())
} else {
err_msg("a `Doc` must contain a field serialized as `_id`")
}
}
fn ensure_only_lifetime_params(generics: &Generics) -> Result<()> {
let make_error = |param_type| err_fmt!(
"`Doc` can't be derived for a type that is generic over {} parameters",
param_type
);
if generics.type_params().next().is_some() {
return make_error("type");
}
if generics.const_params().next().is_some() {
return make_error("const");
}
Ok(())
}