splitrs 0.3.5

AST-based Rust refactoring tool with trait separation, config files, and intelligent module generation
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

//! Tests for Item #5: Doc-comment preservation.
//!
//! Verifies that file-level `//!` inner doc comments are captured from the
//! source file and emitted at the top of the generated `mod.rs`. Also checks
//! that per-item `///` doc comments travel with their items unchanged.

use splitrs::file_analyzer::FileAnalyzer;
use splitrs::module_generator::{generate_mod_rs, Module};

// ---------------------------------------------------------------------------
// Helpers
// ---------------------------------------------------------------------------

fn parse(code: &str) -> syn::File {
    syn::parse_file(code).expect("test fixture must parse as Rust")
}

fn analyze(code: &str) -> (syn::File, FileAnalyzer) {
    let file = parse(code);
    let mut analyzer = FileAnalyzer::new(false, 500);
    analyzer.analyze(&file);
    (file, analyzer)
}

// ---------------------------------------------------------------------------
// Test 1: file-level `//!` docs are captured and emitted in mod.rs
// ---------------------------------------------------------------------------

#[test]
fn test_file_inner_doc_preserved_in_mod_rs() {
    let code = r#"
//! This is crate documentation.
//! It spans multiple lines.

pub struct Foo {
    value: i32,
}
"#;

    let (_, analyzer) = analyze(code);

    assert!(
        !analyzer.file_inner_docs.is_empty(),
        "expected file_inner_docs to be populated from //! attrs"
    );

    let modules: Vec<Module> = analyzer.group_by_module(500);
    let mod_rs = generate_mod_rs(
        &modules,
        &std::env::temp_dir().join("splitrs-doc-test"),
        None,
        false,
        &analyzer.file_inner_docs,
    )
    .expect("generate_mod_rs must succeed");

    assert!(
        mod_rs.contains("This is crate documentation"),
        "expected doc text in mod.rs output; got:\n{}",
        mod_rs
    );
    assert!(
        mod_rs.contains("//!"),
        "expected //! style doc comment in mod.rs; got:\n{}",
        mod_rs
    );
}

// ---------------------------------------------------------------------------
// Test 2: per-type `///` doc comments travel with the struct definition
// (regression guard — this should always have worked; we confirm it does
// after our changes)
// ---------------------------------------------------------------------------

#[test]
fn test_type_doc_comment_preserved() {
    let code = r#"
/// A documented struct.
/// Has multiple doc lines.
pub struct Documented {
    value: i32,
}

impl Documented {
    pub fn new(value: i32) -> Self { Self { value } }
}
"#;

    let (file, analyzer) = analyze(code);
    let modules = analyzer.group_by_module(500);

    let dummy_needs_pub: std::collections::HashSet<String> = std::collections::HashSet::new();
    let dummy_fields: std::collections::HashMap<String, std::collections::HashSet<String>> =
        std::collections::HashMap::new();
    let empty_uses: Vec<syn::Item> = Vec::new();
    let type_to_module: std::collections::HashMap<String, String> = modules
        .iter()
        .flat_map(|m| m.types.iter().map(|t| (t.name.clone(), m.name.clone())))
        .collect();

    // Find the module that contains `Documented`
    let doc_module = modules
        .iter()
        .find(|m| m.types.iter().any(|t| t.name == "Documented"))
        .expect("expected a module containing 'Documented'");

    let content = doc_module.generate_content(
        &file,
        &empty_uses,
        &type_to_module,
        &dummy_needs_pub,
        None,
        &dummy_fields,
        None,
        &dummy_needs_pub,
    );

    assert!(
        content.contains("A documented struct"),
        "expected struct doc comment in module content; got:\n{}",
        content
    );
}

// ---------------------------------------------------------------------------
// Test 3: `///` docs on a function land in `functions.rs` unchanged
// ---------------------------------------------------------------------------

#[test]
fn test_regular_item_doc_unchanged() {
    let code = r#"
/// A very helpful utility function.
/// Returns x plus one.
pub fn increment(x: i32) -> i32 {
    x + 1
}
"#;

    let (file, analyzer) = analyze(code);
    let modules = analyzer.group_by_module(500);

    let dummy_needs_pub: std::collections::HashSet<String> = std::collections::HashSet::new();
    let dummy_fields: std::collections::HashMap<String, std::collections::HashSet<String>> =
        std::collections::HashMap::new();
    let empty_uses: Vec<syn::Item> = Vec::new();
    let type_to_module: std::collections::HashMap<String, String> =
        std::collections::HashMap::new();

    // Find the functions module
    let fn_module = modules
        .iter()
        .find(|m| m.name == "functions")
        .expect("expected 'functions' module");

    let content = fn_module.generate_content(
        &file,
        &empty_uses,
        &type_to_module,
        &dummy_needs_pub,
        None,
        &dummy_fields,
        None,
        &dummy_needs_pub,
    );

    assert!(
        content.contains("A very helpful utility function"),
        "expected function doc comment in functions module; got:\n{}",
        content
    );
    assert!(
        content.contains("Returns x plus one"),
        "expected second doc line in functions module; got:\n{}",
        content
    );
}