mdbook-plotly 0.3.0-beta

A mdbook preprocessor that renders plot code blocks (e.g., ```plot) into interactive or static charts during book build.
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

use mdbook_plotly::preprocessor::config::PreprocessorConfig;
use mdbook_plotly::preprocessor::handlers;
use mdbook_preprocessor::book::Chapter;
use pulldown_cmark::Event;
use std::path::Path;

fn chapter(content: &str) -> Chapter {
    Chapter::new("Test", content.to_string(), "test.md", Vec::new())
}

fn handle_content(content: &str) -> String {
    let mut chapter = chapter(content);
    handlers::handle(&mut chapter, &PreprocessorConfig::default(), Path::new("."));
    chapter.content
}

#[cfg(feature = "plotly-html-handler")]
fn plotly_header() -> String {
    match handlers::plotly_html_handler::inject_header() {
        Event::Html(html) => html.to_string(),
        _ => unreachable!(),
    }
}

#[test]
fn handle_leaves_plain_chapter_unchanged() {
    let content = "# Title\n\nPlain content with `inline code`.\n";

    assert_eq!(handle_content(content), content);
}

#[test]
fn handle_leaves_non_plot_fenced_code_unchanged() {
    let content = "# Title\n\n```rust\nfn main() {}\n```\n";

    assert_eq!(handle_content(content), content);
}

#[test]
fn handle_leaves_plain_chapter_with_plot_word_unchanged() {
    let content = "# Title\n\nThis paragraph mentions plotly but has no chart fence.\n";

    assert_eq!(handle_content(content), content);
}

#[cfg(feature = "plotly-html-handler")]
#[test]
fn handle_injects_html_header_only_for_generated_plots() {
    let content = r#"```plot
{
    data: [{
        type: "scatter",
        x: [0, 1],
        y: [1, 2]
    }]
}
```
"#;

    let output = handle_content(content);
    let header = plotly_header();

    assert!(output.contains(&header));
    assert_eq!(output.matches(&header).count(), 1);
}

#[cfg(feature = "plotly-html-handler")]
#[test]
fn handle_detects_plot_fences_inside_lists() {
    let content = r#"- chart

  ```plot
  {
      data: [{
          type: "scatter",
          x: [0, 1],
          y: [1, 2]
      }]
  }
  ```
"#;

    let output = handle_content(content);
    let header = plotly_header();

    assert!(output.contains(&header));
}

#[cfg(feature = "plotly-html-handler")]
#[test]
fn handle_processes_complete_markdown_chapter() {
    let content = r#"# Metrics

Intro paragraph before the chart.

```rust
let untouched = true;
```

```plotly
{
    layout: {
        title: "Trend"
    },
    data: [{
        type: "scatter",
        x: [0, 1],
        y: [1, 2]
    }]
}
```

## After

Closing paragraph.
"#;

    let output = handle_content(content);
    let header = plotly_header();

    assert!(output.contains(&header));
    assert!(output.contains("# Metrics"));
    assert!(output.contains("Intro paragraph before the chart."));
    assert!(output.contains("```rust"));
    assert!(output.contains("let untouched = true;"));
    assert!(output.contains("Trend"));
    assert!(output.contains("## After"));
    assert!(output.contains("Closing paragraph."));
    assert!(!output.contains("```plotly"));
}

#[cfg(feature = "plotly-html-handler")]
#[test]
fn handle_does_not_inject_html_header_for_invalid_plot() {
    let content = "```plot\nnot valid json\n```\n";

    let output = handle_content(content);
    let header = plotly_header();

    assert!(!output.contains(&header));
}