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
extern crate proc_macro;
use proc_macro::TokenStream;

use syn::parse::Parser;
use syn::{punctuated, Expr, ItemConst, Token};

use std::fs::{create_dir_all, remove_file, OpenOptions};
use std::io::prelude::*;
use std::path::Path;

#[derive(Debug)]
struct Command {
    name: String,
    desc: String,
    args: Vec<Arg>,
}

#[derive(Debug)]
struct Arg {
    name: String,
    desc: String,
    arg_type: String,
    data_type: String,
    kind: String,
    optional: bool,
}

#[proc_macro_attribute]
pub fn rediscmd_doc(attr: TokenStream, item: TokenStream) -> TokenStream {
    let mut output = String::new();

    let parsed: ItemConst = syn::parse(item.clone()).unwrap();
    if let Expr::Macro(mac) = *parsed.expr {
        for token in mac.mac.tokens.into_iter() {
            if let proc_macro2::TokenTree::Group(g) = token {
                let cmd = parse_command(g.stream());
                output = stringify_command(cmd);
                break;
            }
        }
    }

    let filepath = Path::new("doc").join("COMMAND_REFERENCE_GEN.md");

    // delete file if first attr is passed
    if &attr.to_string() == "clean" {
        match remove_file(filepath.clone()) {
            Ok(_) => (),
            Err(e) => println!("Could not delete {:?}: {}", filepath.to_str(), e),
        }
    }

    // write out markdown
    create_dir_all("doc").unwrap();
    let mut file = OpenOptions::new()
        .append(true)
        .create(true)
        .open(filepath.to_str().unwrap())
        .unwrap();
    if let Err(e) = writeln!(file, "{}", output) {
        eprintln!("Couldn't write to file: {}", e);
    };

    item
}

fn parse_command(tokens: proc_macro2::TokenStream) -> Command {
    let mut name = String::new();
    let mut desc = String::new();
    let mut args: Vec<Arg> = Vec::new();

    let mut pos: usize = 0;
    for tt in tokens.into_iter() {
        match tt {
            proc_macro2::TokenTree::Literal(l) => {
                if pos == 0 {
                    name = l.to_string();
                }
                if pos == 1 {
                    desc = l.to_string();
                }
                pos += 1
            }
            proc_macro2::TokenTree::Group(g) => {
                args = parse_args(g.stream());
            }
            _ => (),
        }
    }

    Command { name, desc, args }
}

fn parse_args(tokens: proc_macro2::TokenStream) -> Vec<Arg> {
    let mut args: Vec<Arg> = Vec::new();

    for tt in tokens.into_iter() {
        if let proc_macro2::TokenTree::Group(g) = tt {
            let parser = punctuated::Punctuated::<Expr, Token![,]>::parse_terminated;
            let parsed = parser.parse2(g.stream()).unwrap();

            let mut name = String::new();
            let mut desc = String::new();
            let mut arg_type = String::new();
            let mut data_type = String::new();
            let mut kind = String::new();
            let mut optional = true;

            let mut cursor = parsed.iter();

            let name_expr = cursor.next().unwrap();
            if let Expr::Lit(l) = name_expr {
                if let syn::Lit::Str(s) = &l.lit {
                    name = s.value()
                }
            }

            let desc_expr = cursor.next().unwrap();
            if let Expr::Lit(l) = desc_expr {
                if let syn::Lit::Str(s) = &l.lit {
                    desc = s.value()
                }
            }

            let at_expr = cursor.next().unwrap();
            if let Expr::Path(p) = at_expr {
                let mut segs = p.path.segments.iter();
                if let Some(seg) = segs.next() {
                    if &seg.ident.to_string() == "ArgType" {
                        if let Some(t) = segs.next() {
                            arg_type = t.ident.to_string();
                        }
                    }
                }
            }

            let dt_expr = cursor.next().unwrap();
            if let Expr::Path(p) = dt_expr {
                let mut segs = p.path.segments.iter();
                if let Some(seg) = segs.next() {
                    data_type = seg.ident.to_string();
                }
            }

            let kind_expr = cursor.next().unwrap();
            if let Expr::Path(p) = kind_expr {
                let mut segs = p.path.segments.iter();
                if let Some(seg) = segs.next() {
                    if &seg.ident.to_string() == "Collection" {
                        if let Some(t) = segs.next() {
                            kind = t.ident.to_string();
                        }
                    }
                }
            }

            let default_expr = cursor.next().unwrap();
            if let Expr::Path(p) = default_expr {
                let mut segs = p.path.segments.iter();
                if let Some(seg) = segs.next() {
                    if &seg.ident.to_string() == "None" {
                        optional = false;
                    }
                }
            }

            args.push(Arg {
                name,
                desc,
                arg_type,
                data_type,
                kind,
                optional,
            })
        }
    }

    args
}

fn stringify_command(cmd: Command) -> String {
    let name = cmd.name.to_uppercase().replace("\"", "");
    let desc = cmd.desc.replace("\"", "");
    let args = stringify_args(cmd.args);

    let output = format!(
        "
### {name}
#### Format
```
placeholder
```
#### Description
{desc}
#### Example
```
placeholder
```
#### Parameters
{args}
",
        name = name,
        desc = desc,
        args = args
    );

    output
}

fn stringify_args(args: Vec<Arg>) -> String {
    let mut output = String::new();
    for arg in args {
        let name = arg.name.to_uppercase();
        let desc = arg.desc;
        let optional = if arg.optional { "Optional" } else { "Required" };

        let arg_out = format!(
            "
* **{name}**: {optional}. {desc}
",
            name = name,
            desc = desc,
            optional = optional
        );

        output.push_str(&arg_out);
    }

    output
}