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 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
//! This module contains the `HtmlPage` struct, which serves as the major entry point for the program
use crate::attributes::Attributes;
use crate::html_container::HtmlContainer;
use crate::Html;
mod header_content;
mod version;
pub use version::HtmlVersion;
/// An entire page of HTML which can built up by chaining addition methods.
///
/// To convert an `HtmlPage` to a [`String`] which can be sent back to a client, use the
/// [`Html::to_html_string()`] method
///
/// # Example
/// ```
/// # use build_html::*;
/// let page: String = HtmlPage::new()
/// .with_title("My Page")
/// .with_header(1, "Header Text")
/// .to_html_string();
///
/// assert_eq!(page, concat!(
/// "<!DOCTYPE html><html><head><title>My Page</title></head>",
/// "<body><h1>Header Text</h1></body></html>"
/// ));
/// ```
#[derive(Debug, Default)]
pub struct HtmlPage {
version: version::HtmlVersion,
head: String,
body: String,
}
impl Html for HtmlPage {
fn to_html_string(&self) -> String {
format!(
"{}<html{}><head>{}</head><body>{}</body></html>",
self.version.doctype(),
self.version.html_attrs(),
self.head,
self.body,
)
}
}
impl HtmlContainer for HtmlPage {
#[inline]
fn add_html<H: Html>(&mut self, html: H) {
self.body.push_str(html.to_html_string().as_str());
}
}
impl HtmlPage {
/// Creates a new HTML page with no content
pub fn new() -> Self {
Self::with_version(HtmlVersion::HTML5)
}
/// Create a new HTML page with the specified version.
///
/// # Example
/// ```
/// # use build_html::{Html, HtmlPage, HtmlVersion};
/// assert_eq!(
/// HtmlPage::with_version(HtmlVersion::HTML4).to_html_string(),
/// concat!(
/// r#"<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "#,
/// r#""http://www.w3.org/TR/HTML4/loose.dtd">"#,
/// "<html><head></head><body></body></html>",
/// ),
/// )
/// ```
pub fn with_version(version: HtmlVersion) -> Self {
HtmlPage {
version,
head: String::new(),
body: String::new(),
}
}
/// Helper function similar to [`HtmlContainer::add_html`]
#[inline]
fn add_html_head<H: Html>(&mut self, html: H) {
self.head.push_str(html.to_html_string().as_str());
}
/// Helper function similar to [`HtmlContainer::with_html`]
#[inline]
fn with_html_head<H: Html>(mut self, html: H) -> Self {
self.add_html_head(html);
self
}
/// Adds a new link element to the HTML head.
///
/// # Example
/// ```
/// # use build_html::*;
/// let mut page = HtmlPage::new();
/// page.add_head_link("favicon.ico", "icon");
///
/// assert_eq!(page.to_html_string(), concat!(
/// "<!DOCTYPE html><html><head>",
/// r#"<link href="favicon.ico" rel="icon">"#,
/// "</head><body></body></html>"
/// ));
/// ```
pub fn add_head_link(&mut self, href: impl ToString, rel: impl ToString) {
self.add_html_head(header_content::Link {
href: href.to_string(),
rel: rel.to_string(),
attr: Attributes::default(),
})
}
/// Adds a new link to the HTML head.
///
/// # Example
/// ```
/// # use build_html::*;
/// let page = HtmlPage::new()
/// .with_head_link("favicon.ico", "icon")
/// .to_html_string();
///
/// assert_eq!(page, concat!(
/// "<!DOCTYPE html><html><head>",
/// r#"<link href="favicon.ico" rel="icon">"#,
/// "</head><body></body></html>"
/// ));
/// ```
pub fn with_head_link(self, href: impl ToString, rel: impl ToString) -> Self {
self.with_html_head(header_content::Link {
href: href.to_string(),
rel: rel.to_string(),
attr: Attributes::default(),
})
}
/// Adds a new link to the HTML head with the specified additional attributes
///
/// # Example
/// ```
/// # use build_html::*;
/// let mut page = HtmlPage::new();
/// page.add_head_link_attr("print.css", "stylesheet", [("media", "print")]);
///
/// assert_eq!(page.to_html_string(), concat!(
/// "<!DOCTYPE html><html><head>",
/// r#"<link href="print.css" rel="stylesheet" media="print">"#,
/// "</head><body></body></html>"
/// ));
/// ```
pub fn add_head_link_attr<A, S>(&mut self, href: impl ToString, rel: impl ToString, attr: A)
where
A: IntoIterator<Item = (S, S)>,
S: ToString,
{
self.add_html_head(header_content::Link {
href: href.to_string(),
rel: rel.to_string(),
attr: attr.into(),
})
}
/// Adds a new link to the HTML head with the specified additional attributes
///
/// # Example
/// ```
/// # use build_html::*;
/// let page = HtmlPage::new()
/// .with_head_link_attr("print.css", "stylesheet", [("media", "print")])
/// .to_html_string();
///
/// assert_eq!(page, concat!(
/// "<!DOCTYPE html><html><head>",
/// r#"<link href="print.css" rel="stylesheet" media="print">"#,
/// "</head><body></body></html>"
/// ));
/// ```
pub fn with_head_link_attr<A, S>(self, href: impl ToString, rel: impl ToString, attr: A) -> Self
where
A: IntoIterator<Item = (S, S)>,
S: ToString,
{
self.with_html_head(header_content::Link {
href: href.to_string(),
rel: rel.to_string(),
attr: attr.into(),
})
}
/// Adds the specified metadata elements to this `HtmlPage`
///
/// Attributes are specified in a `HashMap`
///
/// # Example
/// ```
/// # use build_html::*;
/// let mut page = HtmlPage::new();
/// page.add_meta(vec![("charset", "utf-8")]);
///
/// assert_eq!(page.to_html_string(), concat!(
/// "<!DOCTYPE html><html><head>",
/// r#"<meta charset="utf-8">"#,
/// "</head><body></body></html>"
/// ));
/// ```
pub fn add_meta<A, S>(&mut self, attributes: A)
where
A: IntoIterator<Item = (S, S)>,
S: ToString,
{
self.add_html_head(header_content::Meta {
attr: attributes.into(),
})
}
/// Adds the specified metadata elements to this `HtmlPage`
///
/// Attributes are specified in a `HashMap`
///
/// # Example
/// ```
/// # use build_html::*;
///
/// let page = HtmlPage::new()
/// .with_meta(vec![("charset", "utf-8")])
/// .to_html_string();
///
/// assert_eq!(page, concat!(
/// "<!DOCTYPE html><html><head>",
/// r#"<meta charset="utf-8">"#,
/// "</head><body></body></html>"
/// ));
/// ```
pub fn with_meta<A, S>(self, attributes: A) -> Self
where
A: IntoIterator<Item = (S, S)>,
S: ToString,
{
self.with_html_head(header_content::Meta {
attr: attributes.into(),
})
}
/// Adds the specified external script to the `HtmlPage`
///
/// # Example
/// ```
/// # use build_html::*;
/// let mut page = HtmlPage::new();
/// page.add_script_link("myScript.js");
///
/// assert_eq!(page.to_html_string(), concat!(
/// "<!DOCTYPE html><html><head>",
/// r#"<script src="myScript.js"></script>"#,
/// "</head><body></body></html>"
/// ));
/// ```
pub fn add_script_link(&mut self, src: impl ToString) {
self.add_html_head(header_content::ScriptLink {
src: src.to_string(),
attr: Attributes::default(),
})
}
/// Adds the specified external script to the `HtmlPage`
///
/// # Example
/// ```
/// # use build_html::*;
/// let page = HtmlPage::new()
/// .with_script_link("myScript.js")
/// .to_html_string();
///
/// assert_eq!(page, concat!(
/// "<!DOCTYPE html><html><head>",
/// r#"<script src="myScript.js"></script>"#,
/// "</head><body></body></html>"
/// ));
/// ```
pub fn with_script_link(self, src: impl ToString) -> Self {
self.with_html_head(header_content::ScriptLink {
src: src.to_string(),
attr: Attributes::default(),
})
}
/// Adds a script link with additional attributes to the `HtmlPage`
pub fn add_script_link_attr<A, S>(&mut self, src: impl ToString, attributes: A)
where
A: IntoIterator<Item = (S, S)>,
S: ToString,
{
self.add_html_head(header_content::ScriptLink {
src: src.to_string(),
attr: attributes.into(),
})
}
/// Adds a script link with additional attributes to the `HtmlPage`
pub fn with_script_link_attr<A, S>(self, src: impl ToString, attributes: A) -> Self
where
A: IntoIterator<Item = (S, S)>,
S: ToString,
{
self.with_html_head(header_content::ScriptLink {
src: src.to_string(),
attr: attributes.into(),
})
}
/// Adds the specified script to this `HtmlPage`
///
/// # Example
/// ```
/// # use build_html::*;
/// let mut page = HtmlPage::new();
/// page.add_script_literal(r#"window.onload = () => console.log("Hello World");"#);
///
/// assert_eq!(page.to_html_string(), concat!(
/// "<!DOCTYPE html><html><head><script>",
/// r#"window.onload = () => console.log("Hello World");"#,
/// "</script></head><body></body></html>"
/// ));
/// ```
///
/// In order to lint the code, it can be helpful to define your script in
/// its own file. That file can be inserted into the html page using the
/// [`include_str`] macro:
///
/// ```rust, ignore (cannot-doctest-external-file-dependency)
/// let mut page = HtmlPage::new();
/// page.add_script_literal(include_str!("myScript.js"));
/// ```
pub fn add_script_literal(&mut self, code: impl ToString) {
self.add_html_head(header_content::ScriptLiteral {
code: code.to_string(),
})
}
/// Adds the specified script to this `HtmlPage`
///
/// # Example
/// ```
/// # use build_html::*;
/// let page = HtmlPage::new()
/// .with_script_literal(r#"window.onload = () => console.log("Hello World");"#)
/// .to_html_string();
///
/// assert_eq!(page, concat!(
/// "<!DOCTYPE html><html><head><script>",
/// r#"window.onload = () => console.log("Hello World");"#,
/// "</script></head><body></body></html>"
/// ));
/// ```
///
/// In order to lint the code, it can be helpful to define your script in
/// its own file. That file can be inserted into the html page using the
/// [`include_str`] macro:
///
/// ```ignore (cannot-doctest-external-file-dependency)
/// let page = HtmlPage::new()
/// .with_script_literal(include_str!("myScript.js"))
/// .to_html_string();
/// ```
pub fn with_script_literal(self, code: impl ToString) -> Self {
self.with_html_head(header_content::ScriptLiteral {
code: code.to_string(),
})
}
/// Adds raw style data to this `HtmlPage`
///
/// # Example
/// ```
/// # use build_html::*;
/// let mut page = HtmlPage::new();
/// page.add_style(r#"p{font-family:"Liberation Serif";}"#);
///
/// assert_eq!(page.to_html_string(), concat!(
/// "<!DOCTYPE html><html><head>",
/// r#"<style>p{font-family:"Liberation Serif";}</style>"#,
/// "</head><body></body></html>"
/// ));
/// ```
///
/// To allow for linting, it can be helpful to define CSS in its own file.
/// That file can be included at compile time using the [`include_str`] macro:
///
/// ```ignore (cannot-doctest-external-file-dependency)
/// let mut page = HtmlPage::new();
/// page.add_style(include_str!("styles.css"));
/// ```
pub fn add_style(&mut self, css: impl ToString) {
self.add_html_head(header_content::Style {
css: css.to_string(),
attr: Attributes::default(),
})
}
/// Adds raw style data to this `HtmlPage`
///
/// # Example
/// ```
/// # use build_html::*;
/// let page = HtmlPage::new()
/// .with_style(r#"p{font-family:"Liberation Serif";}"#)
/// .to_html_string();
///
/// assert_eq!(page, concat!(
/// "<!DOCTYPE html><html><head>",
/// r#"<style>p{font-family:"Liberation Serif";}</style>"#,
/// "</head><body></body></html>"
/// ));
/// ```
///
/// To allow for linting, it can be helpful to define CSS in its own file.
/// That file can be included at compile time using the [`include_str`] macro:
///
/// ```ignore (cannot-doctest-external-file-dependency)
/// let page = HtmlPage::new()
/// .with_style(include_str!("styles.css"))
/// .to_html_string();
/// ```
pub fn with_style(self, css: impl ToString) -> Self {
self.with_html_head(header_content::Style {
css: css.to_string(),
attr: Attributes::default(),
})
}
/// Adds the specified style data with the specified attributes
pub fn add_style_attr<A, S>(&mut self, css: impl ToString, attributes: A)
where
A: IntoIterator<Item = (S, S)>,
S: ToString,
{
self.add_html_head(header_content::Style {
css: css.to_string(),
attr: attributes.into(),
})
}
/// Adds the specified style data with the specified attributes
pub fn with_style_attr<A, S>(self, css: impl ToString, attributes: A) -> Self
where
A: IntoIterator<Item = (S, S)>,
S: ToString,
{
self.with_html_head(header_content::Style {
css: css.to_string(),
attr: attributes.into(),
})
}
/// Adds the specified stylesheet to the HTML head.
///
/// This method uses [`add_head_link`](HtmlPage::add_head_link) internally
///
/// # Example
/// ```
/// # use build_html::*;
/// let mut page = HtmlPage::new();
/// page.add_stylesheet("print.css");
///
/// assert_eq!(page.to_html_string(), concat!(
/// "<!DOCTYPE html><html><head>",
/// r#"<link href="print.css" rel="stylesheet">"#,
/// "</head><body></body></html>"
/// ));
/// ```
#[inline]
pub fn add_stylesheet(&mut self, source: impl ToString) {
self.add_head_link(source, "stylesheet")
}
/// Adds the specified stylesheet to the HTML head.
///
/// This method uses [`add_head_link`](HtmlPage::add_head_link) internally
///
/// # Example
/// ```
/// # use build_html::*;
/// let page = HtmlPage::new()
/// .with_stylesheet("print.css")
/// .to_html_string();
///
/// assert_eq!(page, concat!(
/// "<!DOCTYPE html><html><head>",
/// r#"<link href="print.css" rel="stylesheet">"#,
/// "</head><body></body></html>"
/// ));
/// ```
#[inline]
pub fn with_stylesheet(self, source: impl ToString) -> Self {
self.with_head_link(source, "stylesheet")
}
/// Adds a title to this HTML page
///
/// # Example
/// ```
/// # use build_html::*;
/// let mut page = HtmlPage::new();
/// page.add_title("My Page");
///
/// assert_eq!(page.to_html_string(), concat!(
/// "<!DOCTYPE html><html><head>",
/// "<title>My Page</title>",
/// "</head><body></body></html>"
/// ));
/// ```
pub fn add_title(&mut self, title_text: impl ToString) {
self.add_html_head(header_content::Title {
content: title_text.to_string(),
})
}
/// Adds a title to this HTML page
///
/// # Example
/// ```
/// # use build_html::*;
/// let page = HtmlPage::new()
/// .with_title("My Page")
/// .to_html_string();
///
/// assert_eq!(page, concat!(
/// "<!DOCTYPE html><html><head>",
/// "<title>My Page</title>",
/// "</head><body></body></html>"
/// ));
/// ```
pub fn with_title(self, title_text: impl ToString) -> Self {
self.with_html_head(header_content::Title {
content: title_text.to_string(),
})
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn default() {
// Arrange
let sut = HtmlPage::default();
// Act
let html_string = sut.to_html_string();
// Assert
assert_eq!(
html_string,
"<!DOCTYPE html><html><head></head><body></body></html>"
)
}
}