ironpress 1.4.1

Pure Rust HTML/CSS/Markdown to PDF converter with layout engine, LaTeX math, tables, images, custom fonts, and streaming output. No browser, no system dependencies.
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
//! CLI argument parsing and conversion logic.
//!
//! This module is used by the `ironpress` binary but lives in the library
//! so that all logic is covered by `cargo test`.

use crate::error::IronpressError;
use crate::{HtmlConverter, Margin, PageSize};

/// Parsed CLI options.
#[derive(Debug, Clone)]
pub struct CliOptions {
    /// Page size.
    pub page_size: PageSize,
    /// Landscape orientation.
    pub landscape: bool,
    /// Uniform margin in points.
    pub margin: Margin,
    /// Header text.
    pub header: Option<String>,
    /// Footer text (`{page}` and `{pages}` are substituted).
    pub footer: Option<String>,
    /// Enable HTML sanitization.
    pub sanitize: bool,
    /// Read from stdin instead of a file.
    pub from_stdin: bool,
    /// Positional arguments (input, output).
    pub positional: Vec<String>,
    /// Print help and exit.
    pub help: bool,
    /// Print version and exit.
    pub version: bool,
}

impl Default for CliOptions {
    fn default() -> Self {
        Self {
            page_size: PageSize::A4,
            landscape: false,
            margin: Margin::default(),
            header: None,
            footer: None,
            sanitize: true,
            from_stdin: false,
            positional: Vec::new(),
            help: false,
            version: false,
        }
    }
}

/// Parse CLI arguments into options.
pub fn parse_args(args: &[String]) -> Result<CliOptions, String> {
    let mut opts = CliOptions::default();

    if args.is_empty() || args.iter().any(|a| a == "--help" || a == "-h") {
        opts.help = true;
        return Ok(opts);
    }
    if args.iter().any(|a| a == "--version" || a == "-V") {
        opts.version = true;
        return Ok(opts);
    }

    let mut i = 0;
    while i < args.len() {
        match args[i].as_str() {
            "--page-size" => {
                i += 1;
                let val = args.get(i).ok_or("--page-size requires a value")?;
                opts.page_size = match val.to_ascii_lowercase().as_str() {
                    "a4" => PageSize::A4,
                    "letter" => PageSize::LETTER,
                    "legal" => PageSize::LEGAL,
                    other => {
                        return Err(format!(
                            "Unknown page size: {other}. Use a4, letter, or legal."
                        ));
                    }
                };
            }
            "--landscape" => opts.landscape = true,
            "--margin" => {
                i += 1;
                let val = args.get(i).ok_or("--margin requires a value")?;
                let pt: f32 = val
                    .parse()
                    .map_err(|_| format!("--margin requires a number, got: {val}"))?;
                opts.margin = Margin::uniform(pt);
            }
            "--margin-top" => {
                i += 1;
                let val = args.get(i).ok_or("--margin-top requires a value")?;
                opts.margin.top = val
                    .parse()
                    .map_err(|_| format!("--margin-top requires a number, got: {val}"))?;
            }
            "--header" => {
                i += 1;
                opts.header = Some(args.get(i).ok_or("--header requires a value")?.clone());
            }
            "--footer" => {
                i += 1;
                opts.footer = Some(args.get(i).ok_or("--footer requires a value")?.clone());
            }
            "--sanitize" => {
                i += 1;
                let val = args.get(i).ok_or("--sanitize requires a value")?;
                opts.sanitize = val != "false" && val != "0";
            }
            "--stdin" => opts.from_stdin = true,
            arg if arg.starts_with('-') => {
                return Err(format!("Unknown option: {arg}"));
            }
            _ => opts.positional.push(args[i].clone()),
        }
        i += 1;
    }

    Ok(opts)
}

/// Run the conversion with parsed options and input content.
pub fn convert(opts: &CliOptions, html: &str) -> Result<Vec<u8>, IronpressError> {
    let mut page_size = opts.page_size;
    if opts.landscape {
        page_size = PageSize::new(page_size.height, page_size.width);
    }

    let mut converter = HtmlConverter::new()
        .page_size(page_size)
        .margin(opts.margin)
        .sanitize(opts.sanitize);

    if let Some(ref h) = opts.header {
        converter = converter.header(h.as_str());
    }
    if let Some(ref f) = opts.footer {
        converter = converter.footer(f.as_str());
    }

    converter.convert(html)
}

/// Run the markdown conversion with parsed options.
pub fn convert_markdown(opts: &CliOptions, md: &str) -> Result<Vec<u8>, IronpressError> {
    let mut page_size = opts.page_size;
    if opts.landscape {
        page_size = PageSize::new(page_size.height, page_size.width);
    }

    let mut converter = HtmlConverter::new()
        .page_size(page_size)
        .margin(opts.margin)
        .sanitize(opts.sanitize);

    if let Some(ref h) = opts.header {
        converter = converter.header(h.as_str());
    }
    if let Some(ref f) = opts.footer {
        converter = converter.footer(f.as_str());
    }

    converter.convert_markdown(md)
}

/// Help text.
pub const HELP: &str = "\
ironpress — HTML/CSS/Markdown to PDF converter

USAGE:
    ironpress [OPTIONS] <input> <output>
    ironpress [OPTIONS] --stdin <output>

ARGS:
    <input>     Input file (.html or .md)
    <output>    Output PDF file

OPTIONS:
    --page-size <SIZE>      Page size: a4, letter, legal (default: a4)
    --landscape             Use landscape orientation
    --margin <PT>           Uniform margin in points (default: 72)
    --header <TEXT>         Header text on each page
    --footer <TEXT>         Footer text ({page} and {pages} for numbering)
    --sanitize <BOOL>       Enable/disable HTML sanitization (default: true)
    --stdin                 Read HTML from stdin instead of a file
    --version               Print version
    --help                  Print this help
";

#[cfg(test)]
mod tests {
    use super::*;

    fn args(s: &str) -> Vec<String> {
        s.split_whitespace().map(String::from).collect()
    }

    #[test]
    fn parse_help() {
        let opts = parse_args(&args("--help")).unwrap();
        assert!(opts.help);
    }

    #[test]
    fn parse_version() {
        let opts = parse_args(&args("--version")).unwrap();
        assert!(opts.version);
    }

    #[test]
    fn parse_short_help() {
        let opts = parse_args(&args("-h")).unwrap();
        assert!(opts.help);
    }

    #[test]
    fn parse_short_version() {
        let opts = parse_args(&args("-V")).unwrap();
        assert!(opts.version);
    }

    #[test]
    fn parse_empty_args_shows_help() {
        let opts = parse_args(&[]).unwrap();
        assert!(opts.help);
    }

    #[test]
    fn parse_basic_args() {
        let opts = parse_args(&args("input.html output.pdf")).unwrap();
        assert_eq!(opts.positional, vec!["input.html", "output.pdf"]);
        assert!(!opts.help);
        assert!(!opts.version);
    }

    #[test]
    fn parse_page_size_letter() {
        let opts = parse_args(&args("--page-size letter input.html out.pdf")).unwrap();
        assert!((opts.page_size.width - 612.0).abs() < 1.0);
    }

    #[test]
    fn parse_page_size_legal() {
        let opts = parse_args(&args("--page-size legal input.html out.pdf")).unwrap();
        assert!((opts.page_size.height - 1008.0).abs() < 1.0);
    }

    #[test]
    fn parse_page_size_a4() {
        let opts = parse_args(&args("--page-size a4 input.html out.pdf")).unwrap();
        assert!((opts.page_size.width - 595.28).abs() < 1.0);
    }

    #[test]
    fn parse_page_size_invalid() {
        let result = parse_args(&args("--page-size tabloid input.html out.pdf"));
        assert!(result.is_err());
        assert!(result.unwrap_err().contains("tabloid"));
    }

    #[test]
    fn parse_page_size_missing_value() {
        let result = parse_args(&args("--page-size"));
        assert!(result.is_err());
    }

    #[test]
    fn parse_landscape() {
        let opts = parse_args(&args("--landscape input.html out.pdf")).unwrap();
        assert!(opts.landscape);
    }

    #[test]
    fn parse_margin() {
        let opts = parse_args(&args("--margin 54 input.html out.pdf")).unwrap();
        assert!((opts.margin.top - 54.0).abs() < 0.1);
        assert!((opts.margin.left - 54.0).abs() < 0.1);
    }

    #[test]
    fn parse_margin_invalid() {
        let result = parse_args(&args("--margin abc input.html out.pdf"));
        assert!(result.is_err());
    }

    #[test]
    fn parse_margin_missing_value() {
        let result = parse_args(&args("--margin"));
        assert!(result.is_err());
    }

    #[test]
    fn parse_header_footer() {
        let a: Vec<String> = vec![
            "--header",
            "My Doc",
            "--footer",
            "Page {page}",
            "in.html",
            "out.pdf",
        ]
        .into_iter()
        .map(String::from)
        .collect();
        let opts = parse_args(&a).unwrap();
        assert_eq!(opts.header.as_deref(), Some("My Doc"));
        assert_eq!(opts.footer.as_deref(), Some("Page {page}"));
    }

    #[test]
    fn parse_header_missing_value() {
        let result = parse_args(&args("--header"));
        assert!(result.is_err());
    }

    #[test]
    fn parse_footer_missing_value() {
        let result = parse_args(&args("--footer"));
        assert!(result.is_err());
    }

    #[test]
    fn parse_sanitize_false() {
        let opts = parse_args(&args("--sanitize false input.html out.pdf")).unwrap();
        assert!(!opts.sanitize);
    }

    #[test]
    fn parse_sanitize_zero() {
        let opts = parse_args(&args("--sanitize 0 input.html out.pdf")).unwrap();
        assert!(!opts.sanitize);
    }

    #[test]
    fn parse_sanitize_true() {
        let opts = parse_args(&args("--sanitize true input.html out.pdf")).unwrap();
        assert!(opts.sanitize);
    }

    #[test]
    fn parse_sanitize_missing_value() {
        let result = parse_args(&args("--sanitize"));
        assert!(result.is_err());
    }

    #[test]
    fn parse_stdin() {
        let opts = parse_args(&args("--stdin out.pdf")).unwrap();
        assert!(opts.from_stdin);
        assert_eq!(opts.positional, vec!["out.pdf"]);
    }

    #[test]
    fn parse_unknown_option() {
        let result = parse_args(&args("--bogus input.html out.pdf"));
        assert!(result.is_err());
        assert!(result.unwrap_err().contains("--bogus"));
    }

    #[test]
    fn parse_all_options() {
        let a: Vec<String> = vec![
            "--page-size",
            "letter",
            "--landscape",
            "--margin",
            "36",
            "--header",
            "Title",
            "--footer",
            "p{page}",
            "--sanitize",
            "false",
            "in.html",
            "out.pdf",
        ]
        .into_iter()
        .map(String::from)
        .collect();
        let opts = parse_args(&a).unwrap();
        assert!(opts.landscape);
        assert!(!opts.sanitize);
        assert!((opts.margin.top - 36.0).abs() < 0.1);
        assert_eq!(opts.header.as_deref(), Some("Title"));
        assert_eq!(opts.positional, vec!["in.html", "out.pdf"]);
    }

    #[test]
    fn convert_html_produces_valid_pdf() {
        let opts = CliOptions::default();
        let pdf = convert(&opts, "<h1>Hello</h1><p>World</p>").unwrap();
        assert!(pdf.starts_with(b"%PDF"));
    }

    #[test]
    fn convert_with_landscape() {
        let opts = CliOptions {
            landscape: true,
            ..Default::default()
        };
        let pdf = convert(&opts, "<p>Landscape</p>").unwrap();
        assert!(pdf.starts_with(b"%PDF"));
    }

    #[test]
    fn convert_with_header_footer() {
        let opts = CliOptions {
            header: Some("Header".into()),
            footer: Some("Page {page}".into()),
            ..Default::default()
        };
        let pdf = convert(&opts, "<p>Content</p>").unwrap();
        let content = String::from_utf8_lossy(&pdf);
        assert!(content.contains("Header"));
    }

    #[test]
    fn convert_markdown_produces_valid_pdf() {
        let opts = CliOptions::default();
        let pdf = convert_markdown(&opts, "# Title\n\nParagraph").unwrap();
        assert!(pdf.starts_with(b"%PDF"));
    }

    #[test]
    fn convert_markdown_with_options() {
        let opts = CliOptions {
            page_size: PageSize::LETTER,
            landscape: true,
            header: Some("MD".into()),
            footer: Some("{page}/{pages}".into()),
            ..Default::default()
        };
        let pdf = convert_markdown(&opts, "# Test\n\nContent").unwrap();
        assert!(pdf.starts_with(b"%PDF"));
    }

    #[test]
    fn convert_with_sanitize_disabled() {
        let opts = CliOptions {
            sanitize: false,
            ..Default::default()
        };
        let pdf = convert(&opts, "<script>alert(1)</script><p>Hi</p>").unwrap();
        assert!(pdf.starts_with(b"%PDF"));
    }

    #[test]
    fn convert_with_custom_margin() {
        let opts = CliOptions {
            margin: Margin::uniform(36.0),
            ..Default::default()
        };
        let pdf = convert(&opts, "<p>Tight margins</p>").unwrap();
        assert!(pdf.starts_with(b"%PDF"));
    }

    #[test]
    fn help_text_contains_usage() {
        assert!(HELP.contains("USAGE:"));
        assert!(HELP.contains("--page-size"));
        assert!(HELP.contains("--stdin"));
    }
}