html_compile 0.2.0

A template engine for generating HTML strings within Rust for use with static websites
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

use crate::types::*;

fn build_attribute(attribute_vec: &Vec<Attribute>) -> String {
    let mut attribute_string = String::from("");

    for attribute in attribute_vec {
        attribute_string = format!(
            "{} {}=\"{}\"",
            attribute_string, attribute.label, attribute.value
        );
    }

    attribute_string
}

fn build_tag_with_attributes(component: &Component, end: &str) -> String {
    let mut tag = format!("<{}", component.tag);

    match &component.meta {
        Some(meta) => {
            let attribute_string = build_attribute(&meta);

            tag = format!("{}{}{}", tag, attribute_string, end);
        }
        None => {
            tag = format!("{}{}", tag, end);
        }
    }

    tag
}

fn build_start_tag(component: &Component) -> String {
    build_tag_with_attributes(component, ">")
}

fn build_void_tag(component: &Component) -> String {
    match component.child {
        Child::NoChild => build_tag_with_attributes(component, " />"),
        _ => {
            panic!(
                "{} is a void element and so cannot have contents",
                component.tag
            );
        }
    }
}

fn build_body(component: &Component) -> String {
    let mut markup = "".to_string();

    match &component.child {
        Child::NoChild => {}
        Child::Text(value) => {
            markup = format!("{}", value);
        }
        Child::ComponentVec(value) => {
            for single in value {
                markup = format!("{}{}", markup, build_component(single));
            }
        }
    }

    markup
}

// List of void elements taken from https://html.spec.whatwg.org/#void-elements
fn is_void(component: &Component) -> bool {
    [
        "area", "base", "br", "col", "embed", "hr", "img", "input", "link", "meta", "source",
        "track", "wbr",
    ]
    .contains(&component.tag)
}

/// Generates HTML string using the provided struct `component`
///
/// # Example
///
/// ```
/// use html_compile::compile::*;
/// use html_compile::types::*;
///
/// let input_component = Component {
///     tag: "section",
///     meta: Some(vec![
///         Attribute {
///             label: "style",
///             value: "border: 1px solid black; padding: 10px;",
///         },
///         Attribute {
///             label: "class",
///             value: "Example",
///         },
///     ]),
///     child: Child::ComponentVec(vec![
///         Box::new(Component {
///             tag: "h2",
///             meta: None,
///             child: Child::Text("Text of a Heading"),
///         }),
///         Box::new(Component {
///             tag: "p",
///             meta: None,
///             child: Child::Text("Text of a Paragraph"),
///         }),
///     ]),
/// };
///
/// let output = build_component(&input_component);  
///
/// assert_eq!(output, String::from("<section style=\"border: 1px solid black; padding: 10px;\" class=\"Example\"><h2>Text of a Heading</h2><p>Text of a Paragraph</p></section>"));
///
/// ```
/// In a browser the string will display as follows:
///
/// <section style="border: 1px solid black; padding: 10px;" class="Example">
///     <h2>Text of a Heading</h2>
///     <p>Text of a Paragraph</p>
/// </section>
pub fn build_component(component: &Component) -> String {
    if is_void(component) {
        return build_void_tag(component);
    }

    let start_tag = build_start_tag(component);

    let middle = build_body(component);

    let end_tag = format!("</{}>", component.tag);

    return format!("{}{}{}", start_tag, middle, end_tag);
}

/// Takes a String and swaps the placeholder text `{COMPONENT}` for the HTML String built using the provided struct `component`
///
/// # Example
///
/// ```
/// use html_compile::compile::*;
/// use html_compile::types::*;
///
/// let contents = String::from("<html lang=\"en\"><head><title>Test Data</title></head><body>{COMPONENT}</body></html>");
///
/// let input_component = Component {
///     tag: "section",
///     meta: Some(vec![
///         Attribute {
///             label: "style",
///             value: "border: 1px solid black; padding: 10px;",
///         },
///         Attribute {
///             label: "class",
///             value: "Example",
///         },
///     ]),
///     child: Child::ComponentVec(vec![
///         Box::new(Component {
///             tag: "h2",
///             meta: None,
///             child: Child::Text("Text of a Heading"),
///         }),
///         Box::new(Component {
///             tag: "p",
///             meta: None,
///             child: Child::Text("Text of a Paragraph"),
///         }),
///     ]),
/// };
///
/// let output = insert_components(contents, input_component);  
///
/// assert_eq!(output, String::from("<html lang=\"en\"><head><title>Test Data</title></head><body><section style=\"border: 1px solid black; padding: 10px;\" class=\"Example\"><h2>Text of a Heading</h2><p>Text of a Paragraph</p></section></body></html>"));
/// ```
/// In a browser the string will display as follows:
///
/// <html lang="en">
///     <head>
///         <title>Test Data</title>
///     </head>
/// <body>
///     <section style="border: 1px solid black; padding: 10px;" class="Example">
///         <h2>Text of a Heading</h2>
///         <p>Text of a Paragraph</p>
///     </section>
///</body>
///</html>
///
pub fn insert_components(contents: String, component: Component) -> String {
    const COMPONENT_PLACEHOLDER: &str = "{COMPONENT}";

    let component = build_component(&component);

    return contents.trim().replace(COMPONENT_PLACEHOLDER, &component);
}