dom_renderer 0.2.2

Crate for rendering html (or other DOMs) strings
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

//! provides macros to create DOM Eelement instances

/// creates DOM Document
/// 
/// Use this to create a root node.
#[macro_export]
macro_rules! domdoc {
    ($($x:expr),*) => {
        Document(DomDocument::new(vec![$($x),*]))
    };
    ($($x:expr,)*) => { $crate::domdoc!($($x),*) };
}

/// creates DOM DocumentType
/// # Example
/// ```
/// use dom_renderer::*;
/// assert_eq!("<!DOCTYPE html>", doctype!("html").render());
/// ```
#[macro_export]
macro_rules! doctype {
    ($x:expr) => { DocumentType(DomDocType::new($x)) };
}

/// creates DOM Text Node
/// # Example
/// ```
/// use dom_renderer::*;
/// assert_eq!("Text", domtxt!("Text").render());
/// ```
#[macro_export]
macro_rules! domtxt {
    ($x:expr) => {
        Text(String::from($x))
    };
}

/// creates DOM Empty Element
/// 
/// # Example
/// Tag and attribute lists are separated by ';'
/// 
/// Attributes can be omitted.
/// 
/// ```
/// use dom_renderer::*;
/// 
/// let br = empty!("br");
/// assert_eq!("<br>", br.render());
/// 
/// let input = empty!("input";
///     ("type", "text"),
///     ("name", "user_name"),
/// );
/// assert_eq!(r#"<input type="text" name="user_name">"#, input.render());
/// ```
#[macro_export]
macro_rules! empty {
    ($x:expr) => { EmptyElement(DomEmptyElem::new( $x, Vec::new())) };
    ($x:expr; $(($a:expr,$v:expr)),+) => {
        EmptyElement(DomEmptyElem::new(
            $x,
            vec![ $(($a, String::from($v)),)* ]
        ))
    };
    ($x:expr; $(($a:expr,$v:expr),)+) => { $crate::empty!($x; $(($a,$v)),*) };
}

/// creates DOM Element
/// 
/// # Example
/// Tag, attribute lists, and child elements are separated by ';'
/// 
/// Attributes and child elements can be omitted.
/// 
/// ```
/// use dom_renderer::*;
/// 
/// let div = elem!("div";
///     domtxt!("text"),
///     empty!("br"),
///     domtxt!("text"),
/// );
/// assert_eq!(r#"<div>text<br>text</div>"#, div.render());
/// 
/// let div = elem!("div";
///     ("id", "id1"),
///     ("class", "class1")
/// );
/// assert_eq!(r#"<div id="id1" class="class1"></div>"#, div.render());
/// 
/// let div = elem!("div";
///     ("id", "id1"),
///     ("class", "class1");
///     domtxt!("text"),
///     empty!("br"),
///     domtxt!("text"),
/// );
/// assert_eq!(r#"<div id="id1" class="class1">text<br>text</div>"#, div.render());
/// 
/// ```
#[macro_export]
macro_rules! elem {
    ($x:expr; $(($a:expr,$v:expr)),+; $($e:expr),+) => {
        Element(DomElem::new(
            $x,
            vec![ $(($a, String::from($v)),)* ],
            vec![ $($e,)* ],
        ))
    };
    ($x:expr; $(($a:expr,$v:expr)),+; $($e:expr,)+) => { $crate::elem!($x; $(($a,$v)),*; $($e),*) };
    ($x:expr; $(($a:expr,$v:expr)),+) => {
        Element(DomElem::new(
            $x,
            vec![ $(($a, String::from($v)),)* ],
            Vec::new(),
        ))
    };
    ($x:expr; $(($a:expr,$v:expr),)+) => { $crate::elem!($x; $(($a,$v)),*) };
    ($x:expr; $($e:expr),+) => {
        Element(DomElem::new(
            $x,
            Vec::new(),
            vec![ $($e,)* ],
        ))
    };
    ($x:expr; $($e:expr,)+) => { $crate::elem!($x; $($e),*) };
    ($x:expr) => {
        Element(DomElem::new(
            $x,
            Vec::new(),
            Vec::new(),
        ))
    };
}

/// crates DOM Element that have a single text node.
/// 
/// `end_elem!(tag; attrs..; text)` is extracted as `elem!(tag; attrs..; domtxt!(text))`
/// # Example
/// Tag, attribute lists, and text are separated by ';'
/// 
/// Attributes and child elements can be omitted.
/// ```
/// use dom_renderer::*;
/// assert_eq!("<title>Title</title>", end_elem!("title"; "Title").render());
/// ```
#[macro_export]
macro_rules! end_elem {
    ($x:expr) => { $crate::elem!($x) };
    ($x:expr; $(($a:expr,$v:expr)),+) => { $crate::elem!($x; $(($a,$v)),*) };
    ($x:expr; $(($a:expr,$v:expr),)+) => { $crate::elem!($x; $(($a,$v)),*) };
    ($x:expr; $(($a:expr,$v:expr)),+; $e:expr) => {
        $crate::elem!($x; $(($a,$v)),*; $crate::domtxt!($e))
    };
    ($x:expr; $e:expr) => { $crate::elem!($x; $crate::domtxt!($e)) };
}

/// creates HTML Document contains DocumenType and HTML element
/// # Example
/// ```
/// use dom_renderer::*;
/// let html = html!(
///     ("lang", "en");
///     elem!("head";
///         empty!("meta"; ("charset", "utf-8")),
///         end_elem!("title"; "Page Title")
///     ),
///     elem!("body";
///         end_elem!("h1"; "Section"),
///         end_elem!("p"; "Text goes here..."),
///     ),
/// );
/// let expect = r#"<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><title>Page Title</title></head><body><h1>Section</h1><p>Text goes here...</p></body></html>"#;
/// assert_eq!(expect, html.render());
/// ```
#[macro_export]
macro_rules! html {
    ($($x:expr),*) => {
        $crate::domdoc!(
            $crate::doctype!("html"),
            $crate::elem!("html"; $($x),*)
        )
    };
    ($($x:expr,)*) => { $crate::html!($($x),*) };
    ($(($a:expr,$v:expr)),*; $($x:expr),*) => {
        $crate::domdoc!(
            $crate::doctype!("html"),
            $crate::elem!("html"; $(($a,$v)),*; $($x),*)
        )
    };
    ($(($a:expr,$v:expr)),*; $($x:expr,)*) => {
        $crate::html!($(($a,$v)),*; $($x),*)
    };
}

/// creates HTML Document contains DocumenType and HTML element
/// # Example
/// ```
/// use dom_renderer::*;
/// let html = html_basic!(
///     title: "Page Title",
///     body:
///         end_elem!("h1"; "Section"),
///         end_elem!("p"; "Text goes here..."),
/// );
/// let expect = r#"<!DOCTYPE html><html><head><meta charset="utf-8"><title>Page Title</title></head><body><h1>Section</h1><p>Text goes here...</p></body></html>"#;
/// assert_eq!(expect, html.render());
/// ```
#[macro_export]
macro_rules! html_basic {
    (title: $t:expr, body: $($b:expr),*) => {
        $crate::html!(
            $crate::elem!("head";
                $crate::empty!("meta"; ("charset", "utf-8")),
                $crate::end_elem!("title"; $t),
            ),
            $crate::elem!("body"; $($b),*)
        )
    };
    (title: $t:expr, body: $($b:expr,)+) => {
        $crate::html_basic!(title: $t, body: $($b),+)
    };
}