nestum 0.3.2

Proc-macro for nested enum paths like Enum1::Variant1::VariantA
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

use std::fs;
use std::path::{Path, PathBuf};
use std::process::Command;
use std::time::{SystemTime, UNIX_EPOCH};

fn unique_temp_dir(label: &str) -> PathBuf {
    let nanos = SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .expect("system time should be after unix epoch")
        .as_nanos();
    std::env::temp_dir().join(format!("nestum_{label}_{nanos}"))
}

fn write_file(path: &Path, contents: &str) {
    if let Some(parent) = path.parent() {
        fs::create_dir_all(parent).expect("parent directory should be created");
    }
    fs::write(path, contents).expect("fixture file should be writable");
}

#[test]
fn rustdoc_hides_backing_names_from_downstream_surface() {
    let crate_dir = unique_temp_dir("rustdoc_surface");
    let target_dir = crate_dir.join("target");
    let manifest_dir = Path::new(env!("CARGO_MANIFEST_DIR"));

    write_file(
        &crate_dir.join("Cargo.toml"),
        &format!(
            r#"[package]
name = "nestum_doc_consumer"
version = "0.1.0"
edition = "2024"

[dependencies]
nestum = {{ path = "{}" }}
"#,
            manifest_dir.display()
        ),
    );

    write_file(
        &crate_dir.join("src/lib.rs"),
        r#"use nestum::nestum;

#[nestum]
pub enum DocumentEvent {
    Created,
    Deleted,
}

#[nestum]
pub enum Event {
    Document(DocumentEvent),
    Health,
}

pub fn build() -> Event::Enum {
    Event::Document::Created
}
"#,
    );

    let output = Command::new("cargo")
        .arg("doc")
        .arg("--quiet")
        .arg("--no-deps")
        .arg("--target-dir")
        .arg(&target_dir)
        .current_dir(&crate_dir)
        .output()
        .expect("cargo doc should run");

    if !output.status.success() {
        panic!(
            "cargo doc failed\nstdout:\n{}\nstderr:\n{}",
            String::from_utf8_lossy(&output.stdout),
            String::from_utf8_lossy(&output.stderr)
        );
    }

    let crate_index = fs::read_to_string(target_dir.join("doc/nestum_doc_consumer/index.html"))
        .expect("crate index exists");
    let all_items = fs::read_to_string(target_dir.join("doc/nestum_doc_consumer/all.html"))
        .expect("all items page exists");
    let event_page =
        fs::read_to_string(target_dir.join("doc/nestum_doc_consumer/Event/index.html"))
            .expect("event module page exists");

    assert!(crate_index.contains("DocumentEvent"));
    assert!(!crate_index.contains("__NestumEvent"));
    assert!(crate_index.contains("Event"));
    assert!(all_items.contains("Event::Enum"));
    assert!(all_items.contains("Event::Document::Created"));
    assert!(all_items.contains("Event::Health"));
    assert!(!all_items.contains("__NestumEvent"));
    assert!(!all_items.contains("__NestumDocumentEvent"));
    assert!(!event_page.contains("pub use self::__NestumEvent::Health;"));
    assert!(event_page.contains("constant.Health.html"));

    let _ = fs::remove_dir_all(&crate_dir);
}