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
//! Minifies Rust code.
//!
//! ```
//! # ();
//! use syn::parse_quote;
//!
//! assert_eq!(
//!     r#"fn main(){println!("{}",module::f());}mod module{pub(crate)fn f()->i32{1+1}}"#,
//!     rustminify::minify_file(&rustminify::remove_docs(parse_quote! {
//!         //! crate-level doc
//!
//!         fn main() {
//!             println!("{}", module::f());
//!         }
//!
//!         mod module {
//!             //! module-level doc
//!
//!             /// doc for an item
//!             pub(crate) fn f() -> i32 {
//!                 1 + 1
//!             }
//!         }
//!     })),
//! );
//! ```
#![forbid(unsafe_code)]
#![warn(missing_docs, rust_2018_idioms)]

use std::mem;

use proc_macro2::{Delimiter, LineColumn, Spacing, TokenStream, TokenTree};
use quote::{quote, ToTokens as _};
use syn::{
    parse_quote,
    visit_mut::{self, VisitMut},
    AttrStyle, Attribute, Field, FieldValue, File, ForeignItemFn, ForeignItemMacro,
    ForeignItemStatic, ForeignItemType, ImplItemConst, ImplItemMacro, ImplItemMethod, ImplItemType,
    ItemConst, ItemEnum, ItemExternCrate, ItemFn, ItemForeignMod, ItemImpl, ItemMacro, ItemMacro2,
    ItemMod, ItemStatic, ItemStruct, ItemTrait, ItemTraitAlias, ItemType, ItemUnion, ItemUse, Meta,
    MetaList, NestedMeta, Path, TraitItemConst, TraitItemMacro, TraitItemMethod, TraitItemType,
    Variant,
};

/// Minifies a [`File`].
///
/// Currently this is just a shorthand for `minify_tokens(file.to_token_stream())`.
/// Unnecessary spaces may be left.
///
/// ```
/// use syn::parse_quote;
///
/// assert_eq!(
///     r#"mod a{fn hello()->&'static str{"Hello"}}"#,
///     rustminify::minify_file(&parse_quote! {
///         mod a {
///             fn hello() -> &'static str {
///                 "Hello"
///             }
///         }
///     }),
/// );
/// ```
///
/// [`File`]: https://docs.rs/syn/1/syn/struct.File.html
pub fn minify_file(file: &File) -> String {
    minify_tokens(file.to_token_stream())
}

/// Minifies a [`TokenStream`].
///
/// ```
/// use quote::quote;
///
/// assert_eq!(
///     "'a'=>1,'b'=>2,",
///     rustminify::minify_tokens(quote! {
///         'a' => 1,
///         'b' => 2,
///     }),
/// );
/// ```
///
/// [`TokenStream`]: https://docs.rs/proc-macro2/1/proc_macro2/struct.TokenStream.html
pub fn minify_tokens(tokens: TokenStream) -> String {
    let safe = tokens.to_string();
    let mut acc = "".to_owned();
    minify_tokens(tokens.clone(), &mut acc);
    return if acc.parse().map_or(false, |acc| equiv(acc, tokens)) {
        acc
    } else {
        safe
    };

    fn minify_tokens(tokens: TokenStream, acc: &mut String) {
        let mut st = State::None;
        for tt in tokens {
            match tt {
                TokenTree::Group(group) => {
                    if let State::PunctChars(puncts, _, _) = mem::replace(&mut st, State::None) {
                        *acc += &puncts;
                    }
                    let (left, right) = match group.delimiter() {
                        proc_macro2::Delimiter::Parenthesis => ('(', ')'),
                        proc_macro2::Delimiter::Brace => ('{', '}'),
                        proc_macro2::Delimiter::Bracket => ('[', ']'),
                        proc_macro2::Delimiter::None => (' ', ' '),
                    };
                    acc.push(left);
                    minify_tokens(group.stream(), acc);
                    acc.push(right);
                    st = State::None;
                }
                TokenTree::Ident(ident) => {
                    match mem::replace(
                        &mut st,
                        if ident.to_string().contains('#') {
                            State::PoundIdent
                        } else {
                            State::AlnumUnderscoreQuote
                        },
                    ) {
                        State::AlnumUnderscoreQuote | State::PoundIdent => *acc += " ",
                        State::PunctChars(puncts, _, _) => *acc += &puncts,
                        _ => {}
                    }
                    *acc += &ident.to_string();
                }
                TokenTree::Literal(literal) => {
                    let end = literal.span().end();
                    let literal = literal.to_string();
                    let (literal, next) = if let Some(literal) = literal.strip_suffix('.') {
                        (
                            literal,
                            State::PunctChars(".".to_owned(), end, Spacing::Alone),
                        )
                    } else {
                        (&*literal, State::AlnumUnderscoreQuote)
                    };
                    match mem::replace(&mut st, next) {
                        State::AlnumUnderscoreQuote | State::PoundIdent => *acc += " ",
                        State::PunctChars(puncts, _, _) => *acc += &puncts,
                        _ => {}
                    }
                    *acc += literal;
                }
                TokenTree::Punct(punct) => {
                    let cur_pos = punct.span().start();
                    if let State::PunctChars(puncts, prev_pos, spacing) = &mut st {
                        if *spacing == Spacing::Alone {
                            *acc += puncts;
                            // https://docs.rs/syn/1.0.46/syn/token/index.html
                            if !adjacent(*prev_pos, cur_pos)
                                && [
                                    ("!", '='),
                                    ("%", '='),
                                    ("&", '&'),
                                    ("&", '='),
                                    ("*", '='),
                                    ("+", '='),
                                    ("-", '='),
                                    ("-", '>'),
                                    (".", '.'),
                                    ("..", '.'),
                                    ("..", '='),
                                    ("/", '='),
                                    (":", ':'),
                                    ("<", '-'),
                                    ("<", '<'),
                                    ("<", '='),
                                    ("<<", '='),
                                    ("=", '='),
                                    ("=", '>'),
                                    (">", '='),
                                    (">", '>'),
                                    (">>", '='),
                                    ("^", '='),
                                    ("|", '='),
                                    ("|", '|'),
                                ]
                                .contains(&(puncts, punct.as_char()))
                            {
                                *acc += " ";
                            }
                            st = State::PunctChars(
                                punct.as_char().to_string(),
                                cur_pos,
                                punct.spacing(),
                            );
                        } else {
                            puncts.push(punct.as_char());
                            *spacing = punct.spacing();
                        }
                    } else {
                        if st == State::AlnumUnderscoreQuote && "#\"'".contains(punct.as_char()) {
                            *acc += " ";
                        }
                        st = State::PunctChars(
                            punct.as_char().to_string(),
                            cur_pos,
                            punct.spacing(),
                        );
                    }
                }
            }
        }
        if let State::PunctChars(puncts, _, _) = st {
            *acc += &puncts;
        }

        fn adjacent(pos1: LineColumn, pos2: LineColumn) -> bool {
            pos1.line == pos2.line && pos1.column + 1 == pos2.column
        }

        #[derive(PartialEq)]
        enum State {
            None,
            AlnumUnderscoreQuote,
            PoundIdent,
            PunctChars(String, LineColumn, Spacing),
        }
    }

    fn equiv(tokens1: TokenStream, tokens2: TokenStream) -> bool {
        return compress(tokens1) == compress(tokens2);

        fn compress(tokens: TokenStream) -> Vec<LossyTokenTree> {
            tokens.into_iter().map(Into::into).collect()
        }

        #[derive(PartialEq)]
        enum LossyTokenTree {
            Group(Delimiter, Vec<Self>),
            Ident(String),
            Punct(char),
            Literal(String),
        }

        impl From<TokenTree> for LossyTokenTree {
            fn from(tt: TokenTree) -> Self {
                match tt {
                    TokenTree::Group(group) => Self::Group(
                        group.delimiter(),
                        group.stream().into_iter().map(Into::into).collect(),
                    ),
                    TokenTree::Ident(ident) => Self::Ident(ident.to_string()),
                    TokenTree::Punct(punct) => Self::Punct(punct.as_char()),
                    TokenTree::Literal(literal) => Self::Literal(literal.to_string()),
                }
            }
        }
    }
}

/// Removes documentation and <code>#[{warn, deny, forbid}([missing_docs])]</code>.
///
/// [missing_docs]: https://doc.rust-lang.org/rustc/lints/listing/allowed-by-default.html#missing-docs
///
/// ```
/// use syn::parse_quote;
///
/// assert_eq!(
///     "#![deny()]pub mod module{pub struct Item;}",
///     rustminify::minify_file(&rustminify::remove_docs(parse_quote! {
///         #![deny(missing_docs)]
///         pub mod module {
///             //! module
///
///             /// Item
///             pub struct Item;
///         }
///     }))
/// );
/// ```
pub fn remove_docs(mut file: File) -> File {
    Visitor.visit_file_mut(&mut file);
    return file;

    struct Visitor;

    macro_rules! visit(($($f:ident(_, &mut $ty:ty);)*) => {
        $(
            fn $f(&mut self, node: &mut $ty) {
                remove_docs(&mut node.attrs);
                visit_mut::$f(self, node);
            }
        )*
    });

    impl VisitMut for Visitor {
        visit! {
            visit_field_mut(_, &mut Field);
            visit_field_value_mut(_, &mut FieldValue);
            visit_file_mut(_, &mut File);
            visit_foreign_item_fn_mut(_, &mut ForeignItemFn);
            visit_foreign_item_macro_mut(_, &mut ForeignItemMacro);
            visit_foreign_item_static_mut(_, &mut ForeignItemStatic);
            visit_foreign_item_type_mut(_, &mut ForeignItemType);
            visit_impl_item_const_mut(_, &mut ImplItemConst);
            visit_impl_item_macro_mut(_, &mut ImplItemMacro);
            visit_impl_item_method_mut(_, &mut ImplItemMethod);
            visit_impl_item_type_mut(_, &mut ImplItemType);
            visit_item_const_mut(_, &mut ItemConst);
            visit_item_enum_mut(_, &mut ItemEnum);
            visit_item_extern_crate_mut(_, &mut ItemExternCrate);
            visit_item_fn_mut(_, &mut ItemFn);
            visit_item_foreign_mod_mut(_, &mut ItemForeignMod);
            visit_item_impl_mut(_, &mut ItemImpl);
            visit_item_macro2_mut(_, &mut ItemMacro2);
            visit_item_macro_mut(_, &mut ItemMacro);
            visit_item_mod_mut(_, &mut ItemMod);
            visit_item_static_mut(_, &mut ItemStatic);
            visit_item_struct_mut(_, &mut ItemStruct);
            visit_item_trait_alias_mut(_, &mut ItemTraitAlias);
            visit_item_trait_mut(_, &mut ItemTrait);
            visit_item_type_mut(_, &mut ItemType);
            visit_item_union_mut(_, &mut ItemUnion);
            visit_item_use_mut(_, &mut ItemUse);
            visit_trait_item_const_mut(_, &mut TraitItemConst);
            visit_trait_item_macro_mut(_, &mut TraitItemMacro);
            visit_trait_item_method_mut(_, &mut TraitItemMethod);
            visit_trait_item_type_mut(_, &mut TraitItemType);
            visit_variant_mut(_, &mut Variant);
        }
    }

    fn remove_docs(attrs: &mut Vec<Attribute>) {
        attrs.retain(|a| !matches!(a.parse_meta(), Ok(m) if m.path().is_ident("doc")));
        for attr in attrs {
            if let Ok(Meta::List(MetaList { path, nested, .. })) = attr.parse_meta() {
                if any(&path, &["warn", "deny", "forbid"]) {
                    let bang = matches!(attr.style, AttrStyle::Inner(_)).then(|| quote!(!));
                    let nested = nested.into_iter().filter(|nested| {
                        !matches!(
                            nested, NestedMeta::Meta(Meta::Path(path))
                            if any(path, &["missing_docs", "missing_crate_level_docs"])
                        )
                    });
                    *attr = parse_quote!(##bang[#path(#(#nested),*)]);
                }
            }
        }

        fn any(path: &Path, idents: &[&str]) -> bool {
            idents.iter().any(|s| path.is_ident(s))
        }
    }
}

#[cfg(test)]
mod tests {
    use core::str::FromStr;
    use proc_macro2::TokenStream;
    use quote::{quote, ToTokens as _};
    use syn::{parse_quote, File};
    use test_case::test_case;

    #[test_case(quote!(a + *b)                                => "a+*b"                           ; "joint_add_deref"       )]
    #[test_case(quote!(a + !b)                                => "a+!b"                           ; "joint_add_not"         )]
    #[test_case(quote!(a + -b)                                => "a+-b"                           ; "joint_add_neg"         )]
    #[test_case(quote!(a + &b)                                => "a+&b"                           ; "joint_add_reference"   )]
    #[test_case(quote!(a && &b)                               => "a&&&b"                          ; "joint_andand_reference")]
    #[test_case(quote!(a & &b)                                => "a& &b"                          ; "space_and_reference"   )]
    #[test_case(quote!(a < -b)                                => "a< -b"                          ; "space_le_neg"          )]
    #[test_case(quote!(0. ..1.)                               => "0. ..1."                        ; "space_dec_point_range" )]
    #[test_case(quote!(x | || ())                             => "x| ||()"                        ; "zero_arg_closure"      )]
    #[test_case(quote!(println!("{}", 2 * 2 + 1))             => r#"println!("{}",2*2+1)"#        ; "println"               )]
    #[test_case(quote!(macro_rules! m { ($($_:tt)*) => {}; }) => "macro_rules!m{($($_:tt)*)=>{};}"; "macro_rules"           )]
    // https://doc.rust-lang.org/reference/tokens.html#reserved-prefixes
    #[test_case(
        quote!(fn x(a: &'a u8[]) -> impl 'a + Clone {}) =>
        "fn x(a:&'a u8[])->impl 'a+Clone{}";
        "impl_lifetime"
    )]
    #[test_case(
        quote!(match "a" { _ => false}) =>
        r#"match "a"{_=>false}"#;
        "match_str_literal"
    )]
    #[test_case(
        quote!('s: loop { loop { break 's; }}) =>
        "'s:loop{loop{break 's;}}";
        "break_label"
    )]
    #[test_case(
        TokenStream::from_str("macro_rules! m { ($($_:tt)*) => {} } m!{ a # foo }").unwrap() =>
        "macro_rules!m{($($_:tt)*)=>{}}m!{a #foo}";
        "macro_punct_pound"
    )]
    #[test_case(
        TokenStream::from_str("macro_rules! m { ($($_:tt)*) => {} } m!{ r#let # foo }").unwrap() =>
        "macro_rules!m{($($_:tt)*)=>{}}m!{r#let#foo}";
        "macro_rawident_punct_pound"
    )]
    fn minify_tokens(tokens: TokenStream) -> String {
        crate::minify_tokens(tokens)
    }

    #[test_case(parse_quote!(#[doc = ""] pub struct Item;) => "pub struct Item;"; "item_struct"      )]
    #[test_case(parse_quote!(#![deny(missing_docs)])       => "#![deny()]"      ; "deny_missing_docs")]
    fn minify_tokens_with_remove_docs(file: File) -> String {
        crate::minify_tokens(crate::remove_docs(file).into_token_stream())
    }
}