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
//! Templater management.
//!
//! This can use Handlebars, Liquid, Tera.
//!
//! This can be expanded for potential future formats.
use crate::app::args::Args;
use crate::types::{html::*, set::*};
pub trait TemplaterTrait {
// Create a new templater.
//
// Example:
//
// ```
// let templater: Templater = TemplaterWithHandlebars::new();
// ```
//
#[allow(dead_code)]
fn new() -> Self where Self: Sized;
// Create a new templater with args.
//
// Example:
//
// ```
// let args = Args::default();
// let templater: Templater = TemplaterWithHandlebars::new_with_args(&args);
// ```
//
#[allow(dead_code)]
fn new_with_args(args: &Args) -> Self where Self: Sized;
// Get the template name default e.g. "default".
//
// ```
// let name = template_name_default();
// assert_eq!(name, "default");
// ```
//
#[allow(dead_code)]
fn template_name_default(&self) -> String;
// Get the template content text e.g. "{{{ content }}}".
//
// ```
// let content_text = template_content_text_default();
// assert_eq!(content_text, "{{{ content }}}");
// ```
//
#[allow(dead_code)]
fn template_content_text_default(&self) -> String;
// Add a default template.
//
// Example:
//
// ```
// let templater: Templater = TemplaterWithHandlebars::new();
// register_template_via_default(templater);
// //-> Handlebars now has a template name "default" with content "{{{ content }}}"
// ```
//
#[allow(dead_code)]
fn register_template_via_default(
&mut self
) -> Result<(), impl std::error::Error> where Self: Sized {
self.register_template_via_name_and_content_text(
self.template_name_default(),
self.template_content_text_default()
)
}
// Add a template via template name (i.e. key) and template text (i.e. value).
//
// Example:
//
// ```
// let templater: Templater = TemplaterWithHandlebars::new();
// let name = "alfa";
// let content_text = "{{ bravo }}";
// templater.register_template_via_name_and_content_text(&name, &content_text);
// ```
//
#[allow(dead_code)]
fn register_template_via_name_and_content_text(
&mut self,
name: impl AsRef<str>,
content_text: impl AsRef<str>
) -> Result<(), impl std::error::Error>;
// Does the templater contain any template?
//
// Example:
//
// ```
// let mut templater: Templater = TemplaterWithHandlebars::new();
// templater.register_template_via_name_and_content_text("alfa", "bravo");
// let flag = templater.contains_any_template();
// assert_eq!(flag, true);
// ```
//
#[allow(dead_code)]
fn contains_any_template(
&self
) -> bool;
// Does the templater contain a specific template key i.e. template name?
//
// Example:
//
// ```
// let mut templater: Templater = TemplaterWithHandlebars::new();
// templater.register_template_via_name_and_content_text("alfa", "bravo");
// let flag = templater.contains_template_name("alfa");
// assert_eq!(flag, true);
// ```
//
#[allow(dead_code)]
fn contains_template_name(
&self,
name: impl AsRef<str>
) -> bool;
// Get the template names.
//
// Example:
//
// ```
// let mut templater: Templater = TemplaterWithHandlebars::new();
// register_template_via_name_and_content_text("alfa", "alfa text".into());
// register_template_via_name_and_content_text("bravo", "bravo text".into());
// let template_names: Set<&str> = template_names_as_set_str(&templater);
// assert_eq!(template_names, set!["alfa", "bravo"]);
// ```
//
#[allow(dead_code)]
fn template_names_as_set_str(
&self
) -> Set<&str>;
// Render a template name with the state.
//
// ```
// let templater: Templater = TemplaterWithHandlebars::new();
// templater.register_template_via_name_and_content_text("alfa", "<p>{{ bravo }}</p>");
// let state_enum = crate::state::state_enum::StateEnum::StateWithMap(map!("bravo" => "charlie"));
// let html = templater.render_template_with_state_enum("alfa", &state_enum).expect("render_template_with_state_enum");
// assert_eq!(html, "<p>charlie</p>");
// ```
//
#[allow(dead_code)]
fn render_template_with_state_enum(
&self,
name: impl AsRef<str>,
state_enum: &crate::state::state_enum::StateEnum
) -> Result<HtmlString, impl std::error::Error>;
}
#[cfg(test)]
mod tests {
use super::*;
use crate::app::args::Args;
use crate::templater::templater_with_handlebars::TemplaterWithHandlebars;
type TemplaterX<'templater> = TemplaterWithHandlebars<'templater>;
#[test]
fn test_new() {
let templater = TemplaterX::new();
assert!(!templater.contains_any_template()); // Exists
}
#[test]
fn test_new_with_args() {
let args = Args::default();
let templater = TemplaterX::new_with_args(&args);
assert!(!templater.contains_any_template()); // Exists
}
#[test]
fn test_template_name_default() {
let templater = TemplaterX::new();
let actual: String = templater.template_name_default();
assert!(actual.len() > 0); // Exists
}
#[test]
fn test_template_content_text_default() {
let templater = TemplaterX::new();
let actual: String = templater.template_content_text_default();
assert!(actual.len() > 0); // Exists
}
#[test]
fn test_register_template_via_default() {
let mut templater = TemplaterX::new();
assert!(!templater.contains_any_template());
templater.register_template_via_default().expect("register_template_via_default");
assert!(templater.contains_any_template());
}
#[test]
fn test_register_template_via_name_and_content_text() {
let mut templater = TemplaterX::new();
let name = "alfa";
let content_text = "{{ bravo }}";
assert!(!templater.contains_any_template());
templater.register_template_via_name_and_content_text(
name,
String::from(content_text)
).expect("register_template_via_name_and_content_text");
assert!(templater.contains_any_template());
}
#[test]
fn test_contains_any_template_x_true() {
let mut templater = TemplaterX::new();
templater.register_template_via_name_and_content_text(
"my-name",
"my-content"
).expect("register_template_via_name_and_content_text");
let flag = templater.contains_any_template();
assert_eq!(
flag,
true
);
}
#[test]
fn test_contains_any_template_x_false() {
let templater = TemplaterX::new();
let flag = templater.contains_any_template();
assert_eq!(
flag,
false
);
}
#[test]
fn test_contains_template_name() {
let mut templater = TemplaterX::new();
let name = "alfa";
let content_text = "bravo";
assert!(!templater.contains_template_name(name));
templater.register_template_via_name_and_content_text(
name,
content_text
).expect("register_template_via_name_and_content_text");
assert!(templater.contains_template_name(name));
}
#[test]
fn test_template_names_as_set_str() {
let mut templater: TemplaterWithHandlebars = TemplaterX::new();
let name_0 = "my-name-0";
let name_1 = "my-name-1";
let content_text_0 = "my text 0";
let content_text_1 = "my text 1";
templater.register_template_via_name_and_content_text(
name_0,
content_text_0
).expect("register_template_via_name_and_content_text");
templater.register_template_via_name_and_content_text(
name_1,
content_text_1
).expect("register_template_via_name_and_content_text");
let actual: Set<&str> = templater.template_names_as_set_str();
let expect: Set<&str> = set!(name_0, name_1);
assert_eq!(actual, expect);
}
#[test]
fn test_render_template_with_state_enum() {
let mut templater: TemplaterWithHandlebars = TemplaterX::new();
templater.register_template_via_name_and_content_text("alfa", "<p>{{ bravo }}</p>");
let map = map!(
String::from("bravo") => String::from("charlie")
);
let state_enum = crate::state::state_enum::StateEnum::StateWithMap(map);
let html = templater.render_template_with_state_enum("alfa", &state_enum).expect("render_template_with_state_enum");
assert_eq!(html, "<p>charlie</p>");
}
}