mdbook-plotly 0.3.0-alpha

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

//! Tests for the preprocessor configuration parsing.

use mdbook_plotly::preprocessor::config::PreprocessorConfig;
use toml::Value;

fn parse(text: &str) -> PreprocessorConfig {
    PreprocessorConfig::from_toml(&toml::from_str::<Value>(text).unwrap())
}

#[test]
fn ignores_unknown_top_level_keys() {
    let config = parse(
        r#"
        output-type = "plotly-html"
        input-type = "toml-input"
        unexpected = 1
        [map-eval]
        enabled = false
        extra = true
    "#,
    );
    assert_eq!(
        config.output_type,
        mdbook_plotly::preprocessor::config::PlotlyOutputType::PlotlyHtml
    );
    assert_eq!(
        config.input_type,
        mdbook_plotly::preprocessor::config::PlotlyInputType::TOMLInput
    );
    assert!(!config.map_eval.enabled);
}

#[test]
fn falls_back_for_only_the_bad_field() {
    let config = parse(
        r#"
        output-type = "plotly-html"
        input-type = 42
        [map-eval]
        enabled = false
        reuse-slab = false
        compile-expressions = false
        namespace-scope = "exports-only"
    "#,
    );
    assert_eq!(
        config.output_type,
        mdbook_plotly::preprocessor::config::PlotlyOutputType::PlotlyHtml
    );
    assert_eq!(
        config.input_type,
        mdbook_plotly::preprocessor::config::PlotlyInputType::JSONInput
    );
    assert_eq!(
        config.map_eval.namespace_scope,
        mdbook_plotly::preprocessor::config::MapNamespaceScope::ExportsOnly
    );
    assert!(!config.map_eval.enabled);
    assert!(!config.map_eval.reuse_slab);
    assert!(!config.map_eval.compile_expressions);
}

#[test]
fn falls_back_for_only_the_nested_bad_field() {
    let config = parse(
        r#"
        output-type = "plotly-html"
        input-type = "toml-input"
        [map-eval]
        enabled = "nope"
        reuse-slab = false
        compile-expressions = false
        namespace-scope = "exports-only"
    "#,
    );
    assert_eq!(
        config.output_type,
        mdbook_plotly::preprocessor::config::PlotlyOutputType::PlotlyHtml
    );
    assert_eq!(
        config.input_type,
        mdbook_plotly::preprocessor::config::PlotlyInputType::TOMLInput
    );
    assert!(config.map_eval.enabled);
    assert!(!config.map_eval.reuse_slab);
    assert!(!config.map_eval.compile_expressions);
    assert_eq!(
        config.map_eval.namespace_scope,
        mdbook_plotly::preprocessor::config::MapNamespaceScope::ExportsOnly
    );
}