rustache 0.1.0

Mustache templating engine for rust
Documentation
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
// The parser processes a list of mustache tokens created in
// the compiler into a list of templater useable nodes.
// Nodes contain only the necessary information to be used
// to seek out appropriate data for injection.

use compiler::Token;
use compiler::Token::{Text, Variable, OTag, CTag, Raw, Partial, Comment};
use self::Node::*;
use self::ParserStatus::*;

// Node signifies the data structure used by the template to
// determine how to correctly implement data.  Each Node type
// stores the variable name as well as the raw tag for use by
// lambdas.

#[derive(PartialEq, Eq, Clone, Debug)]
pub enum Node<'a> {
    Static(&'a str), // (text)
    Value(&'a str, String), // (name, tag)
    Section(&'a str, Vec<Node<'a>>, bool, String, String), /* (name, children, inverted, otag, ctag) */
    Unescaped(&'a str, String), // (name, tag)
    Part(&'a str, &'a str), // // (name, tag)
}

#[derive(PartialEq, Eq, Debug)]
enum ParserStatus {
    Parse,
    // Sect,
    Skip,
}

trait LocalStringExt {
    fn is_whitespace(&self) -> bool;
}

impl LocalStringExt for String {
    fn is_whitespace(&self) -> bool {
        self.chars().all(|c| c.is_whitespace())
    }
}

impl LocalStringExt for str {
    fn is_whitespace(&self) -> bool {
        self.chars().all(|c| c.is_whitespace())
    }
}

// Parse list of tokens into instruction nodes
// Section nodes will be handled recursively
pub fn parse_nodes<'a>(list: &Vec<Token<'a>>) -> Vec<Node<'a>> {
    let mut nodes: Vec<Node> = vec![];
    let mut it = list.iter().enumerate().peekable();
    let mut status = Parse;

    loop {
        // Iterate while still nodes in the list
        match it.next() {
            Some((i, token)) => {
                match token {
                    &Text(text) => nodes.push(parse_text_node(text, &mut status)),
                    &Variable(name, raw) => nodes.push(parse_variable_node(name, raw)),
                    &Raw(name, raw) => nodes.push(parse_raw_node(name, raw)),
                    &Partial(name, raw) => nodes.push(Part(name, raw)),
                    // Unopened closing tags are ignored
                    // TODO: Return a parser error?
                    &CTag(_, _) => continue,
                    &OTag(name, inverted, raw) => {
                        let mut children: Vec<Token<'a>> = vec![];
                        let mut count = 0u32;
                        let mut otag_count = 1u32;
                        for item in list[i + 1..].iter() {
                            count += 1;
                            match *item {
                                OTag(title, _, _) => {
                                    if title == name {
                                        otag_count += 1;
                                    }
                                    children.push((*item).clone());
                                }
                                CTag(title, temp) => {
                                    if title == name && otag_count == 1 {
                                        nodes.push(Section(name,
                                                           parse_nodes(&children).clone(),
                                                           inverted,
                                                           raw.to_string(),
                                                           temp.to_string()));
                                        break;
                                    } else if title == name && otag_count > 1 {
                                        otag_count -= 1;
                                        children.push((*item).clone());
                                    } else {
                                        children.push((*item).clone());
                                        continue;
                                    }
                                }
                                _ => {
                                    children.push((*item).clone());
                                    continue;
                                }
                            }
                        }

                        // Advance the iterator to the position of the CTAG.  If the
                        // OTag is never closed, these children will never be processed.
                        // TODO: Return a parser warning in the case of an unclosed tag?
                        while count > 1 {
                            it.next();
                            count -= 1;
                        }
                    }
                    &Comment => {
                        // Check the next element for whitespace
                        match it.peek() {
                            Some(&(_, token)) => {
                                match parse_comment_node(token, &mut status, &mut nodes) {
                                    true => {
                                        // it.next();
                                    }
                                    false => {}
                                }
                            }
                            None => {
                                match nodes.last().unwrap() {
                                    &Static(text) => {
                                        if text.is_whitespace() {
                                            nodes.pop();
                                        }
                                    }
                                    _ => continue,
                                }
                            }
                        }
                    }
                }
            }
            None => break,
        }
    }

    // Return the populated list of nodes
    nodes
}

// Helper function for handling the creation of a text node
fn parse_text_node<'a>(text: &'a str, status: &mut ParserStatus) -> Node<'a> {
    match *status {
        _ => {
            if text.contains("\n") {
                *status = Skip;
            } else if text.is_whitespace() {
                *status = Skip;
            }
            return Static(text);
        }
    }
}

// Helper function for handling the creation of a variable node
fn parse_variable_node<'a>(name: &'a str, raw: &'a str) -> Node<'a> {
    let dot_notation = name.contains(".");
    match dot_notation {
        false => return Value(name, raw.to_string()),
        true => {
            let parts: Vec<&str> = name.split(".").collect();
            let node = handle_dot_notation(&parts[..], false, false);
            return node;
        }
    }
}

// Helper function for handling the creation of an unescaped variable node
fn parse_raw_node<'a>(name: &'a str, raw: &'a str) -> Node<'a> {
    let dot_notation = name.contains(".");
    let ampersand = raw.contains("&");
    match dot_notation {
        false => {
            return Unescaped(name, raw.to_string());
        }
        true => {
            let parts: Vec<&str> = name.split(".").collect();
            match ampersand {
                true => {
                    let node = handle_dot_notation(&parts[..], true, true);
                    return node;
                }
                false => {
                    let node = handle_dot_notation(&parts[..], true, false);
                    return node;
                }
            };
        }
    }
}

// Helper function for handling the creation of comment nodes and
// properly handle whitespace
fn parse_comment_node<'a>(token: &Token,
                          status: &mut ParserStatus,
                          nodes: &mut Vec<Node<'a>>)
                          -> bool {
    match *token {
        Text(ref value) => {
            match *status {
                Skip => {
                    // If whitespace and should skip, advance to next token
                    if value.is_whitespace() {
                        match nodes.last().unwrap() {
                            &Static(text) => {
                                // If the previous node is whitespace and has a newline
                                // then remove it
                                if text.is_whitespace() && text.contains("\n") {
                                    nodes.pop();
                                }
                            }
                            _ => {}
                        }
                        *status = Parse;
                        return true;
                    } else {
                        *status = Parse;
                        return false;
                    }
                }
                Parse => return false,
                // Sect => return false,
            }
        }
        _ => return false,
    }
}

// Recursively handle tag names that utilize dot notation shorthand
fn handle_dot_notation<'a>(parts: &[&'a str], unescaped: bool, amp: bool) -> Node<'a> {
    let variable = parts[0];
    match parts.len() {
        // Determine if the remaining portion of the tag name is the
        // variable or another section.
        1 => {
            match unescaped {
                // Determine if the matching tag is unesecaped or normal.
                true => {
                    match amp {
                        true => {
                            let mut var = "{{&".to_string();
                            var.push_str(variable);
                            var.push_str("}}");
                            return Unescaped(variable, var);
                        }
                        false => {
                            let mut var = "{{{".to_string();
                            var.push_str(variable);
                            var.push_str("}}}");
                            return Unescaped(variable, var);
                        }
                    }
                }
                false => {
                    let mut var = "{{".to_string();
                    var.push_str(variable);
                    var.push_str("}}");
                    return Value(variable, var);
                }
            }
        }
        _ => {
            let mut otag = "{{#".to_string();
            let mut ctag = "{{/".to_string();

            otag.push_str(variable);
            otag.push_str("}}");
            ctag.push_str(variable);
            ctag.push_str("}}");

            // Enter recursion and assign the results as children.
            return Section(variable,
                           vec![handle_dot_notation(&parts[1..], unescaped, amp)],
                           false,
                           otag,
                           ctag);
        }
    }
}

#[cfg(test)]
mod parser_tests {
    use compiler::Token;
    use compiler::Token::{Text, Variable, OTag, CTag, Raw, Partial};
    use parser;
    use parser::Node;
    use parser::Node::{Static, Value, Section, Unescaped, Part};

    #[test]
    fn parse_dot_notation_simple() {
        let tokens: Vec<Token> = vec![Variable("section.child_tag", "{{ section.child_tag }}")];
        let nodes = parser::parse_nodes(&tokens);
        let expected: Vec<Node> = vec![Section("section",
                                               vec![Value("child_tag",
                                                          "{{child_tag}}".to_string())],
                                               false,
                                               "{{#section}}".to_string(),
                                               "{{/section}}".to_string())];
        assert_eq!(nodes, expected);
    }

    #[test]
    fn parse_dot_notation_triple_mustache() {
        let tokens: Vec<Token> = vec![Raw("section.child_tag", "{{{ section.child_tag }}}")];
        let nodes = parser::parse_nodes(&tokens);
        let expected: Vec<Node> = vec![Section("section",
                                               vec![Unescaped("child_tag",
                                                              "{{{child_tag}}}".to_string())],
                                               false,
                                               "{{#section}}".to_string(),
                                               "{{/section}}".to_string())];
        assert_eq!(nodes, expected);
    }

    #[test]
    fn parse_dot_notation_ampersand() {
        let tokens: Vec<Token> = vec![Raw("section.child_tag", "{{& section.child_tag }}")];
        let nodes = parser::parse_nodes(&tokens);
        let expected: Vec<Node> = vec![Section("section",
                                               vec![Unescaped("child_tag",
                                                              "{{&child_tag}}".to_string())],
                                               false,
                                               "{{#section}}".to_string(),
                                               "{{/section}}".to_string())];
        assert_eq!(nodes, expected);
    }

    #[test]
    fn parse_nested_dot_notation_basic() {
        let tokens: Vec<Token> = vec![Variable("section.child.tag", "{{ section.child.tag }}")];
        let nodes = parser::parse_nodes(&tokens);
        let expected: Vec<Node> = vec![Section("section",
                                               vec![Section("child",
                                                            vec![Value("tag",
                                                                       "{{tag}}".to_string())],
                                                            false,
                                                            "{{#child}}".to_string(),
                                                            "{{/child}}".to_string())],
                                               false,
                                               "{{#section}}".to_string(),
                                               "{{/section}}".to_string())];
        assert_eq!(nodes, expected);
    }

    #[test]
    fn parse_nested_dot_notation_triple_mustache() {
        let tokens: Vec<Token> = vec![Raw("section.child.tag", "{{{ section.child.tag }}}")];
        let nodes = parser::parse_nodes(&tokens);
        let expected: Vec<Node> =
            vec![Section("section",
                         vec![Section("child",
                                      vec![Unescaped("tag", "{{{tag}}}".to_string())],
                                      false,
                                      "{{#child}}".to_string(),
                                      "{{/child}}".to_string())],
                         false,
                         "{{#section}}".to_string(),
                         "{{/section}}".to_string())];
        assert_eq!(nodes, expected);
    }

    #[test]
    fn parse_nested_dot_notation_ampersand() {
        let tokens: Vec<Token> = vec![Raw("section.child.tag", "{{& section.child.tag }}")];
        let nodes = parser::parse_nodes(&tokens);
        let expected: Vec<Node> =
            vec![Section("section",
                         vec![Section("child",
                                      vec![Unescaped("tag", "{{&tag}}".to_string())],
                                      false,
                                      "{{#child}}".to_string(),
                                      "{{/child}}".to_string())],
                         false,
                         "{{#section}}".to_string(),
                         "{{/section}}".to_string())];
        assert_eq!(nodes, expected);
    }

    #[test]
    fn parse_static() {
        let tokens: Vec<Token> = vec![Text("Static String ")];
        let nodes = parser::parse_nodes(&tokens);
        let expected: Vec<Node> = vec![Static("Static String ")];
        assert_eq!(nodes, expected);
    }

    #[test]
    fn parse_value() {
        let tokens: Vec<Token> = vec![Variable("token", "{{ token }}")];
        let nodes = parser::parse_nodes(&tokens);
        let expected: Vec<Node> = vec![Value("token", "{{ token }}".to_string())];
        assert_eq!(nodes, expected);
    }

    #[test]
    fn parse_section() {
        let tokens: Vec<Token> = vec![OTag("section", false, "{{# section }}"),
                                      Variable("child_tag", "{{ child_tag }}"),
                                      CTag("section", "{{/ section }}")];
        let nodes = parser::parse_nodes(&tokens);
        let expected: Vec<Node> = vec![Section("section",
                                               vec![Value("child_tag",
                                                          "{{ child_tag }}".to_string())],
                                               false,
                                               "{{# section }}".to_string(),
                                               "{{/ section }}".to_string())];
        assert_eq!(nodes, expected);
    }

    #[test]
    fn parse_inverted() {
        let tokens: Vec<Token> = vec![OTag("inverted", true, "{{^ inverted }}"),
                                      Variable("child_tag", "{{ child_tag }}"),
                                      CTag("inverted", "{{/ inverted }}")];
        let nodes = parser::parse_nodes(&tokens);
        let expected: Vec<Node> = vec![Section("inverted",
                                               vec![Value("child_tag",
                                                          "{{ child_tag }}".to_string())],
                                               true,
                                               "{{^ inverted }}".to_string(),
                                               "{{/ inverted }}".to_string())];
        assert_eq!(nodes, expected);
    }

    #[test]
    fn parse_unescaped() {
        let tokens: Vec<Token> = vec![Raw("unescaped", "{{& unescaped }}")];
        let nodes = parser::parse_nodes(&tokens);
        let expected: Vec<Node> = vec![Unescaped("unescaped", "{{& unescaped }}".to_string())];
        assert_eq!(nodes, expected);
    }

    #[test]
    fn parse_partial() {
        let tokens: Vec<Token> = vec![Partial("new", "{{> new }}")];
        let nodes = parser::parse_nodes(&tokens);
        let expected: Vec<Node> = vec![Part("new", "{{> new }}")];
        assert_eq!(nodes, expected);
    }

    #[test]
    fn parse_all() {
        let tokens: Vec<Token> = vec![Text("Static String "),
                                      Variable("token", "{{ token }}"),
                                      OTag("section", false, "{{# section }}"),
                                      Variable("child_tag", "{{ child_tag }}"),
                                      CTag("section", "{{/ section }}"),
                                      Partial("new", "{{> new }}"),
                                      Raw("unescaped", "{{& unescaped }}")];
        let nodes = parser::parse_nodes(&tokens);
        let static_node = Static("Static String ");
        let value_node = Value("token", "{{ token }}".to_string());
        let section_node = Section("section",
                                   vec![Value("child_tag", "{{ child_tag }}".to_string())],
                                   false,
                                   "{{# section }}".to_string(),
                                   "{{/ section }}".to_string());
        let file_node = Part("new", "{{> new }}");
        let undescaped_node = Unescaped("unescaped", "{{& unescaped }}".to_string());
        let expected: Vec<Node> =
            vec![static_node, value_node, section_node, file_node, undescaped_node];
        assert_eq!(nodes, expected);
    }
}