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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
/*
 * This file is part of ActivityStreams Derive.
 *
 * Copyright © 2018 Riley Trautman
 *
 * ActivityStreams Derive is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * ActivityStreams Derive is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with ActivityStreams Derive.  If not, see <http://www.gnu.org/licenses/>.
 */

//! Derive macros for Activity Streams
//!
//! ## Examples
//!
//! ```rust
//! #[macro_use]
//! extern crate activitystreams_derive;
//! extern crate activitystreams_traits;
//! extern crate serde;
//! #[macro_use]
//! extern crate serde_derive;
//! extern crate serde_json;
//!
//! use activitystreams_traits::{Link, Object};
//!
//! /// Using the UnitString derive macro
//! ///
//! /// This macro implements Serialize and Deserialize for the given type, making this type
//! /// represent the string "SomeKind" in JSON.
//! #[derive(Clone, Debug, Default, UnitString)]
//! #[activitystreams(SomeKind)]
//! pub struct MyKind;
//!
//! /// Using the Properties derive macro
//! ///
//! /// This macro generates getters and setters for the associated fields.
//! #[derive(Clone, Debug, Default, Deserialize, Serialize, Properties)]
//! #[serde(rename_all = "camelCase")]
//! pub struct MyProperties {
//!     /// Derive getters and setters for @context with Link and Object traits.
//!     #[serde(rename = "@context")]
//!     #[activitystreams(ab(Object, Link))]
//!     pub context: Option<serde_json::Value>,
//!
//!     /// Use the UnitString MyKind to enforce the type of the object by "SomeKind"
//!     #[serde(rename = "type")]
//!     pub kind: MyKind,
//!
//!     /// Derive getters and setters for required_key with String type.
//!     ///
//!     /// In the Activity Streams spec, 'functional' means there can only be one item for this
//!     /// key. This means all fields not labeled 'functional' can also be serialized/deserialized
//!     /// as Vec<T>.
//!     #[activitystreams(concrete(String), functional)]
//!     pub required_key: serde_json::Value,
//! }
//! #
//! # fn main () {}
//! ```

extern crate proc_macro;
extern crate proc_macro2;
extern crate syn;

#[macro_use]
extern crate quote;

use proc_macro::TokenStream;
use proc_macro2::TokenTree;
use quote::Tokens;
use syn::{Attribute, Data, DeriveInput, Fields, Ident, Type};

#[proc_macro_derive(UnitString, attributes(activitystreams))]
pub fn unit_string(input: TokenStream) -> TokenStream {
    let input: DeriveInput = syn::parse(input).unwrap();

    let name = input.ident;

    let attr = input
        .attrs
        .iter()
        .find(|attribute| {
            attribute
                .path
                .segments
                .last()
                .map(|segment| {
                    let segment = segment.into_value();
                    segment.ident == Ident::new("activitystreams", segment.ident.span())
                })
                .unwrap_or(false)
        })
        .unwrap()
        .clone();

    let value = from_value(attr);

    let visitor_name = Ident::from(format!("{}Visitor", value));

    let serialize = quote! {
        impl ::serde::ser::Serialize for #name {
            fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
            where
                S: ::serde::ser::Serializer,
            {
                serializer.serialize_str(#value)
            }
        }
    };

    let expecting = quote! {
        fn expecting(&self, formatter: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
            write!(formatter, "The string '{}'", #value)
        }
    };

    let visit = quote! {
        fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
        where
            E: ::serde::de::Error,
        {
            if v == #value {
                Ok(#name)
            } else {
                Err(::serde::de::Error::custom("Invalid type"))
            }
        }
    };

    let visitor = quote! {
        struct #visitor_name;

        impl<'de> ::serde::de::Visitor<'de> for #visitor_name {
            type Value = #name;

            #expecting

            #visit
        }
    };

    let deserialize = quote! {
        impl<'de> ::serde::de::Deserialize<'de> for #name {
            fn deserialize<D>(deserializer: D) -> Result<#name, D::Error>
            where
                D: ::serde::de::Deserializer<'de>,
            {
                deserializer.deserialize_str(#visitor_name)
            }
        }
    };

    let c = quote! {
        #serialize
        #visitor
        #deserialize
    };

    c.into()
}

fn from_value(attr: Attribute) -> String {
    let group = attr.tts
        .clone()
        .into_iter()
        .filter_map(|token_tree| match token_tree {
            TokenTree::Group(group) => Some(group),
            _ => None,
        })
        .next()
        .unwrap();

    group
        .stream()
        .clone()
        .into_iter()
        .filter_map(|token_tree| match token_tree {
            TokenTree::Term(term) => Some(term.as_str().to_owned()),
            _ => None,
        })
        .next()
        .unwrap()
}

#[proc_macro_derive(Properties, attributes(activitystreams))]
pub fn properties_derive(input: TokenStream) -> TokenStream {
    let input: DeriveInput = syn::parse(input).unwrap();

    let name = input.ident;

    let data = match input.data {
        Data::Struct(s) => s,
        _ => panic!("Can only derive for structs"),
    };

    let fields = match data.fields {
        Fields::Named(fields) => fields,
        _ => panic!("Can only derive for named fields"),
    };

    let impls = fields
        .named
        .iter()
        .filter_map(|field| {
            let our_attr = field.attrs.iter().find(|attribute| {
                attribute
                    .path
                    .segments
                    .last()
                    .map(|segment| {
                        let segment = segment.into_value();
                        segment.ident == Ident::new("activitystreams", segment.ident.span())
                    })
                    .unwrap_or(false)
            });

            if our_attr.is_some() {
                let our_attr = our_attr.unwrap();

                let is_option = match field.ty {
                    Type::Path(ref path) => path.path
                        .segments
                        .last()
                        .map(|seg| {
                            let seg = seg.into_value();
                            seg.ident == Ident::new("Option", seg.ident.span())
                        })
                        .unwrap_or(false),
                    _ => false,
                };

                let is_vec = match field.ty {
                    Type::Path(ref path) => path.path
                        .segments
                        .last()
                        .map(|seg| {
                            let seg = seg.into_value();
                            seg.ident == Ident::new("Vec", seg.ident.span())
                        })
                        .unwrap_or(false),
                    _ => false,
                };

                Some((
                    field.ident.clone().unwrap(),
                    is_option,
                    is_vec,
                    is_functional(our_attr.clone()),
                    our_attr.clone(),
                ))
            } else {
                None
            }
        })
        .flat_map(|(ident, is_option, is_vec, is_functional, attr)| {
            variants(attr)
                .into_iter()
                .map(move |(variant, is_concrete)| {
                    let lower_variant = variant.to_lowercase();
                    let fn_name = Ident::from(format!("{}_{}", ident, lower_variant));
                    let fn_plural = Ident::from(format!("{}_{}_vec", ident, lower_variant));
                    let set_fn_name = Ident::from(format!("set_{}_{}", ident, lower_variant));
                    let set_fn_plural = Ident::from(format!("set_{}_{}_vec", ident, lower_variant));
                    let variant = Ident::from(variant);

                    if is_concrete {
                        if is_option {
                            let single_1 = quote! {
                                /// Retrieve a value from the given struct
                                ///
                                /// This method deserializes the item from JSON, so be wary of using
                                /// this a lot.
                                ///
                                /// Possible errors from this method are `Error::NotFound` and
                                /// `Error::Deserialize`
                                pub fn #fn_name(&self) -> ::activitystreams_traits::Result<#variant> {
                                    ::activitystreams_traits::properties::from_item(&self.#ident)
                                }
                            };

                            let single_2 = quote! {
                                /// Set a value in the given struct
                                ///
                                /// This method serializes the item to JSON, so be wary of using this a
                                /// lot.
                                ///
                                /// Possible errors from this method are `Error::Serialize`
                                pub fn #set_fn_name(&mut self, item: #variant) -> ::activitystreams_traits::Result<()> {
                                    self.#ident = ::activitystreams_traits::properties::to_item(item)?;
                                    Ok(())
                                }
                            };

                            let single = quote! {
                                #single_1
                                #single_2
                            };

                            if is_functional {
                                single
                            } else {
                                let plural_1 = quote! {
                                    /// Retrieve many values from the given struct
                                    ///
                                    /// This method deserializes the item from JSON, so be wary of using
                                    /// this a lot.
                                    ///
                                    /// Possible errors from this method are `Error::NotFound` and
                                    /// `Error::Deserialize`
                                    pub fn #fn_plural(&self) -> ::activitystreams_traits::Result<Vec<#variant>> {
                                        ::activitystreams_traits::properties::from_item(&self.#ident)
                                    }
                                };

                                let plural_2 = quote! {
                                    /// Set many values in the given struct
                                    ///
                                    /// This method serializes the item to JSON, so be wary of using
                                    /// this a lot.
                                    ///
                                    /// Possible errors from this method are `Error::Serialize`
                                    pub fn #set_fn_plural(&mut self, item: Vec<#variant>) -> ::activitystreams_traits::Result<()> {
                                        self.#ident = ::activitystreams_traits::properties::to_item(item)?;
                                        Ok(())
                                    }
                                };

                                quote! {
                                    #single
                                    #plural_1
                                    #plural_2
                                }
                            }
                        } else if is_vec {
                            let single_1 = quote! {
                                /// Retrieve many values from the given struct
                                ///
                                /// This method deserializes the item from JSON, so be wary of using
                                /// this a lot.
                                ///
                                /// Possible errors from this method are `Error::Deserialize`
                                pub fn #fn_name(&self) -> ::activitystreams_traits::Result<Vec<#variant>> {
                                    ::activitystreams_traits::properties::from_vec(&self.#ident)
                                }
                            };

                            let single_2 = quote! {
                                /// Set many values in the given struct
                                ///
                                /// This method serializes the item to JSON, so be wary of using
                                /// this a lot.
                                ///
                                /// Possible errors from this method are `Error::Serialize`
                                pub fn #set_fn_name(&mut self, item: Vec<#variant>>) -> ::activitystreams_traits::Result<()> {
                                    self.#ident = ::activitystreams_traits::properties::to_vec(item)?;
                                    Ok(())
                                }
                            };

                            quote! {
                                #single_1
                                #single_2
                            }
                        } else {
                            let single = quote! {
                                /// Retrieve a value from the given struct
                                ///
                                /// This method deserializes the item from JSON, so be wary of using
                                /// this a lot.
                                ///
                                /// Possible errors from this method are `Error::Deserialize`
                                pub fn #fn_name(&self) -> ::activitystreams_traits::Result<#variant> {
                                    ::activitystreams_traits::properties::from_value(&self.#ident)
                                }

                                /// Set a value in the given struct
                                ///
                                /// This method serializes the item to JSON, so be wary of using this a
                                /// lot.
                                ///
                                /// Possible errors from this method are `Error::Serialize`
                                pub fn #set_fn_name(&mut self, item: #variant) -> ::activitystreams_traits::Result<()> {
                                    self.#ident = ::activitystreams_traits::properties::to_value(item)?;
                                    Ok(())
                                }
                            };

                            if is_functional {
                                single
                            } else {
                                let plural_1 = quote! {
                                    /// Retrieve many values from the given struct
                                    ///
                                    /// This method deserializes the item from JSON, so be wary of using
                                    /// this a lot.
                                    ///
                                    /// Possible errors from this method are `Error::Deserialize`
                                    pub fn #fn_plural(&self) -> ::activitystreams_traits::Result<Vec<#variant>> {
                                        ::activitystreams_traits::properties::from_value(&self.#ident)
                                    }
                                };

                                let plural_2 = quote! {
                                    /// Set many values in the given struct
                                    ///
                                    /// This method serializes the item to JSON, so be wary of using this
                                    /// a lot.
                                    ///
                                    /// Possible errors from this method are `Error::Serialize`
                                    pub #set_fn_plural(&mut self, item: Vec<#variant>) -> ::activitystreams_traits::Result<()> {
                                        self.#ident = ::activitystreams_traits::properties::to_value(item)?;
                                        Ok(())
                                    }
                                };

                                quote! {
                                    #single
                                    #plural_1
                                    #plural_2
                                }
                            }
                        }
                    } else if is_option {
                        let single_1 = quote! {
                            /// Retrieve a value of type T from the given struct
                            ///
                            /// This method deserializes the item from JSON, so be wary of using
                            /// this a lot.
                            ///
                            /// Possible errors from this method are `Error::NotFound` and
                            /// `Error::Deserialize`
                            pub fn #fn_name<T: #variant>(&self) -> ::activitystreams_traits::Result<T> {
                                ::activitystreams_traits::properties::from_item(&self.#ident)
                            }
                        };

                        let single_2 = quote! {
                            /// Set a value of type T in the given struct
                            ///
                            /// This method serializes the item to JSON, so be wary of using this a
                            /// lot.
                            ///
                            /// Possible errors from this method are `Error::Serialize`
                            pub fn #set_fn_name<T: #variant>(&mut self, item: T) -> ::activitystreams_traits::Result<()> {
                                self.#ident = ::activitystreams_traits::properties::to_item(item)?;
                                Ok(())
                            }
                        };

                        let single = quote!{
                            #single_1
                            #single_2
                        };

                        if is_functional {
                            single
                        } else {
                            let plural_1 = quote! {
                                /// Retrieve many values of type T from the given struct
                                ///
                                /// This method deserializes the item from JSON, so be wary of using
                                /// this a lot.
                                ///
                                /// Possible errors from this method are `Error::NotFound` and
                                /// `Error::Deserialize`
                                pub fn #fn_plural<T: #variant>(&self) -> ::activitystreams_traits::Result<Vec<T>> {
                                    ::activitystreams_traits::properties::from_item(&self.#ident)
                                }
                            };

                            let plural_2 = quote! {
                                /// Set many values of type T in the given struct
                                ///
                                /// This method serializes the item to JSON, so be wary of using
                                /// this a lot.
                                ///
                                /// Possible errors from this method are `Error::Serialize`
                                pub fn #set_fn_plural<T: #variant>(&mut self, item: Vec<T>) -> ::activitystreams_traits::Result<()> {
                                    self.#ident = ::activitystreams_traits::properties::to_item(item)?;
                                    Ok(())
                                }
                            };

                            quote! {
                                #single
                                #plural_1
                                #plural_2
                            }
                        }
                    } else if is_vec {
                        let single_1 = quote! {
                            /// Retrieve many values of type T from the given struct
                            ///
                            /// This method deserializes the item from JSON, so be wary of using
                            /// this a lot.
                            ///
                            /// Possible errors from this method are `Error::Deserialize`
                            pub fn #fn_name<T: #variant>(&self) -> ::activitystreams_traits::Result<Vec<T>> {
                                ::activitystreams_traits::properties::from_vec(&self.#ident)
                            }
                        };

                        let single_2 = quote! {
                            /// Set many values of type T in the given struct
                            ///
                            /// This method serializes the item to JSON, so be wary of using
                            /// this a lot.
                            ///
                            /// Possible errors from this method are `Error::Serialize`
                            pub fn #set_fn_name<T: #variant>(&mut self, item: Vec<T>) -> ::activitystreams_traits::Result<()> {
                                self.#ident = ::activitystreams_traits::properties::to_vec(item)?;
                                Ok(())
                            }
                        };

                        quote! {
                            #single_1
                            #single_2
                        }
                    } else {
                        let single_1 = quote! {
                            /// Retrieve a value of type T from the given struct
                            ///
                            /// This method deserializes the item from JSON, so be wary of using
                            /// this a lot.
                            ///
                            /// Possible errors from this method are `Error::Deserialize`
                            pub fn #fn_name<T: #variant>(&self) -> ::activitystreams_traits::Result<T> {
                                ::activitystreams_traits::properties::from_value(&self.#ident)
                            }
                        };

                        let single_2 = quote! {
                            /// Set a value of type T in the given struct
                            ///
                            /// This method serializes the item to JSON, so be wary of using this a
                            /// lot.
                            ///
                            /// Possible errors from this method are `Error::Serialize`
                            pub fn #set_fn_name<T: #variant>(&mut self, item: T) -> ::activitystreams_traits::Result<()> {
                                self.#ident = ::activitystreams_traits::properties::to_value(item)?;
                                Ok(())
                            }
                        };

                        let single = quote! {
                            #single_1
                            #single_2
                        };

                        if is_functional {
                            single
                        } else {
                            let plural_1 = quote! {
                                /// Retrieve many values of type T from the given struct
                                ///
                                /// This method deserializes the item from JSON, so be wary of using
                                /// this a lot.
                                ///
                                /// Possible errors from this method are `Error::Deserialize`
                                pub fn #fn_plural<T: #variant>(&self) -> ::activitystreams_traits::Result<Vec<T>> {
                                    ::activitystreams_traits::properties::from_value(&self.#ident)
                                }
                            };

                            let plural_2 = quote! {
                                /// Set many values of type T in the given struct
                                ///
                                /// This method serializes the item to JSON, so be wary of using this
                                /// a lot.
                                ///
                                /// Possible errors from this method are `Error::Serialize`
                                pub fn #set_fn_plural<T: #variant>(&mut self, item: Vec<T>) -> ::activitystreams_traits::Result<()> {
                                    self.#ident = ::activitystreams_traits::properties::to_value(item)?;
                                    Ok(())
                                }
                            };

                            quote! {
                                #single
                                #plural_1
                                #plural_2
                            }
                        }
                    }
                })
        });

    let mut tokens = Tokens::new();
    tokens.append_all(impls);

    let full = quote!{
        impl #name {
            #tokens
        }
    };

    full.into()
}

fn variants(attr: Attribute) -> Vec<(String, bool)> {
    let group = attr.tts
        .clone()
        .into_iter()
        .filter_map(|token_tree| match token_tree {
            TokenTree::Group(group) => Some(group),
            _ => None,
        })
        .next()
        .unwrap();

    let mut is_concrete = false;

    group
        .stream()
        .clone()
        .into_iter()
        .filter_map(|token_tree| match token_tree {
            TokenTree::Term(term) => {
                is_concrete = term.as_str() == "concrete";
                None
            }
            TokenTree::Group(group) => Some(group.stream().into_iter().filter_map(
                move |token_tree| match token_tree {
                    TokenTree::Term(term) => Some((term.as_str().to_owned(), is_concrete)),
                    _ => None,
                },
            )),
            _ => None,
        })
        .flat_map(|i| i)
        .collect()
}

fn is_functional(attr: Attribute) -> bool {
    let group = attr.tts
        .clone()
        .into_iter()
        .filter_map(|token_tree| match token_tree {
            TokenTree::Group(group) => Some(group),
            _ => None,
        })
        .next()
        .unwrap();

    group
        .stream()
        .clone()
        .into_iter()
        .any(|token_tree| match token_tree {
            TokenTree::Term(term) => term.as_str() == "functional",
            _ => false,
        })
}