alef 0.72.0

Opinionated polyglot binding generator for Rust libraries
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

//! Snippet path resolution, docs-path validation, and language-alias tests, split
//! out of [`super`] (`mod.rs`), which the 1,000-line file-size cap no longer let
//! hold this concern inline.

use super::*;

#[test]
fn snippet_paths_reject_traversal() {
    let mut docs = FixtureDocs {
        topic: "..".into(),
        stem: None,
        paths: BTreeMap::new(),
        title: None,
        description: None,
        input: None,
        shows: Vec::new(),
        error: None,
        presentation: None,
        client: None,
        side_effects: Default::default(),
        coverage_exceptions: BTreeMap::new(),
    };
    assert!(
        snippet_path(
            "docs/snippets",
            &docs,
            "basic",
            "python",
            DocumentationLanguage::Binding(Language::Python)
        )
        .is_err()
    );
    docs.topic = "fallback".into();
    docs.paths.insert("python".into(), "../escape.md".into());
    assert!(
        snippet_path(
            "docs/snippets",
            &docs,
            "basic",
            "python",
            DocumentationLanguage::Binding(Language::Python)
        )
        .is_err()
    );
}

#[test]
fn target_path_override_precedes_topic_and_stem() {
    let docs = FixtureDocs {
        topic: "fallback".into(),
        stem: Some("fallback".into()),
        paths: BTreeMap::from([("node".into(), "config/basic_usage.md".into())]),
        title: None,
        description: None,
        input: None,
        shows: Vec::new(),
        error: None,
        presentation: None,
        client: None,
        side_effects: Default::default(),
        coverage_exceptions: BTreeMap::new(),
    };

    assert_eq!(
        snippet_path(
            "docs/snippets",
            &docs,
            "fixture",
            "node",
            DocumentationLanguage::Binding(Language::Node)
        )
        .expect("safe target path"),
        Path::new("docs/snippets/typescript/config/basic_usage.md")
    );
}

#[test]
fn docs_path_target_must_be_configured() {
    let mut fixture = documented_fixture();
    fixture
        .docs
        .as_mut()
        .expect("fixture docs")
        .paths
        .insert("wasm".into(), "browser/basic.md".into());

    assert!(validate_docs_paths(&fixture, &["node".into()]).is_err());
    assert!(validate_docs_paths(&fixture, &["node".into(), "wasm".into()]).is_ok());
}

#[test]
fn language_aliases_include_core_and_ffi_targets() {
    assert_eq!(
        parse_language("rust_core"),
        Some(DocumentationLanguage::Binding(Language::Rust))
    );
    assert_eq!(parse_language("ffi"), Some(DocumentationLanguage::Binding(Language::C)));
    assert_eq!(parse_language("brew"), Some(DocumentationLanguage::Shell));
    assert_eq!(parse_language("homebrew"), Some(DocumentationLanguage::Shell));
    assert_eq!(generator_name("rust_core"), "rust");
    assert_eq!(generator_name("ffi"), "c");
}

#[test]
fn generated_docs_use_validator_canonical_language_identity() {
    let docs = FixtureDocs {
        topic: "api".into(),
        stem: None,
        paths: BTreeMap::new(),
        title: None,
        description: None,
        input: None,
        shows: Vec::new(),
        error: None,
        presentation: None,
        client: None,
        side_effects: SideEffectClass::Safe,
        coverage_exceptions: BTreeMap::new(),
    };
    let cases = [
        ("node", Language::Node, "typescript", "typescript"),
        ("wasm", Language::Wasm, "typescript", "wasm"),
        ("kotlin_android", Language::KotlinAndroid, "kotlin", "kotlin-android"),
    ];

    for (target_language, binding_language, canonical_name, output_slug) in cases {
        let language = DocumentationLanguage::Binding(binding_language);
        let fixture = documented_fixture();
        let rendered = render_snippet_markdown("example()", &fixture, &docs, target_language, language);
        let path =
            snippet_path("docs/snippets", &docs, "example", target_language, language).expect("snippet path is valid");

        // ~keep Assert the WHOLE document, not a set of `contains` probes. Substring probes
        // pin only the fields they name, so `level`, `requires` and `side_effect` become
        // unguarded: a renderer emitting a bogus value for any of them still passes. See
        // `frontmatter_fields_are_pinned_by_exact_equality` for the controls.
        assert_eq!(
            rendered,
            format!(
                "---\nid: fixture_{target_language}_extension_owned\nlanguage: {canonical_name}\ntarget: {target_language}\nrequires: []\nside_effect: safe\n---\n\n{SNIPPET_HEADER}Extension-owned example\n\n```{canonical_name} title=\"{}\"\nexample()\n```\n",
                language.display_name()
            )
        );
        assert_eq!(
            path,
            Path::new("docs/snippets").join(output_slug).join("api/example.md")
        );
        assert_ne!(
            crate::snippets::types::Language::from_fence_tag(canonical_name),
            crate::snippets::types::Language::Unknown
        );
    }
}