mdx-rust-analysis 1.0.0

Rust source analysis, bundling, and safe editing for mdx-rust
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
//! Conservative refactor planning analysis for Rust modules.
//!
//! This module is intentionally plan-only. It summarizes module shape and
//! likely refactor pressure without producing edits.

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use std::path::{Path, PathBuf};

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct RefactorAnalysis {
    pub root: PathBuf,
    pub target: Option<PathBuf>,
    pub files_scanned: usize,
    pub files: Vec<RefactorFileSummary>,
    pub module_edges: Vec<ModuleEdge>,
}

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct RefactorFileSummary {
    pub file: PathBuf,
    pub line_count: usize,
    pub function_count: usize,
    pub public_item_count: usize,
    pub largest_function_lines: usize,
    pub has_tests: bool,
    pub public_items: Vec<PublicItemSummary>,
}

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct PublicItemSummary {
    pub kind: String,
    pub name: String,
    pub line: usize,
}

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct ModuleEdge {
    pub from: PathBuf,
    pub to: String,
    pub line: usize,
    pub kind: ModuleEdgeKind,
}

#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
pub enum ModuleEdgeKind {
    ModDeclaration,
    CrateUse,
    SuperUse,
}

#[derive(Debug, Clone, Copy)]
pub struct RefactorAnalyzeConfig<'a> {
    pub target: Option<&'a Path>,
    pub max_files: usize,
}

pub fn analyze_refactor(
    root: &Path,
    config: RefactorAnalyzeConfig<'_>,
) -> anyhow::Result<RefactorAnalysis> {
    let root = root.canonicalize().unwrap_or_else(|_| root.to_path_buf());
    let files = collect_rust_files(&root, config.target)?;
    let mut summaries = Vec::new();
    let mut module_edges = Vec::new();

    for file in files.iter().take(config.max_files) {
        let content = std::fs::read_to_string(file)?;
        let rel = relative_path(&root, file);
        module_edges.extend(find_module_edges(&rel, &content));
        summaries.push(summarize_file(&rel, &content));
    }

    Ok(RefactorAnalysis {
        root,
        target: config.target.map(Path::to_path_buf),
        files_scanned: summaries.len(),
        files: summaries,
        module_edges,
    })
}

fn summarize_file(file: &Path, content: &str) -> RefactorFileSummary {
    let line_count = content.lines().count();
    let has_tests = content.contains("#[cfg(test)]") || content.contains("#[test]");
    let function_ranges = find_function_ranges(content);
    let largest_function_lines = function_ranges
        .iter()
        .map(|range| range.line_count)
        .max()
        .unwrap_or(0);
    let public_items = public_items(content);

    RefactorFileSummary {
        file: file.to_path_buf(),
        line_count,
        function_count: function_ranges.len(),
        public_item_count: public_items.len(),
        largest_function_lines,
        has_tests,
        public_items,
    }
}

fn public_items(content: &str) -> Vec<PublicItemSummary> {
    let parsed = match syn::parse_file(content) {
        Ok(parsed) => parsed,
        Err(_) => return Vec::new(),
    };

    parsed
        .items
        .iter()
        .filter_map(|item| public_item_summary(item, content))
        .collect()
}

fn public_item_summary(item: &syn::Item, content: &str) -> Option<PublicItemSummary> {
    let (kind, name, token) = match item {
        syn::Item::Const(item) if is_public(&item.vis) => (
            "const",
            item.ident.to_string(),
            format!("const {}", item.ident),
        ),
        syn::Item::Enum(item) if is_public(&item.vis) => (
            "enum",
            item.ident.to_string(),
            format!("enum {}", item.ident),
        ),
        syn::Item::Fn(item) if is_public(&item.vis) => (
            "fn",
            item.sig.ident.to_string(),
            format!("fn {}", item.sig.ident),
        ),
        syn::Item::Struct(item) if is_public(&item.vis) => (
            "struct",
            item.ident.to_string(),
            format!("struct {}", item.ident),
        ),
        syn::Item::Trait(item) if is_public(&item.vis) => (
            "trait",
            item.ident.to_string(),
            format!("trait {}", item.ident),
        ),
        syn::Item::Type(item) if is_public(&item.vis) => (
            "type",
            item.ident.to_string(),
            format!("type {}", item.ident),
        ),
        syn::Item::Mod(item) if is_public(&item.vis) => {
            ("mod", item.ident.to_string(), format!("mod {}", item.ident))
        }
        _ => return None,
    };

    Some(PublicItemSummary {
        kind: kind.to_string(),
        name,
        line: line_for_token(content, &token),
    })
}

fn is_public(vis: &syn::Visibility) -> bool {
    matches!(vis, syn::Visibility::Public(_))
}

#[derive(Debug)]
struct FunctionRange {
    line_count: usize,
}

fn find_function_ranges(content: &str) -> Vec<FunctionRange> {
    let lines: Vec<&str> = content.lines().collect();
    let mut ranges = Vec::new();
    let mut index = 0;

    while index < lines.len() {
        let trimmed = lines[index].trim_start();
        let is_fn = trimmed.starts_with("fn ")
            || trimmed.starts_with("pub fn ")
            || trimmed.starts_with("pub(crate) fn ")
            || trimmed.starts_with("pub(super) fn ")
            || trimmed.starts_with("async fn ")
            || trimmed.starts_with("pub async fn ");
        if !is_fn {
            index += 1;
            continue;
        }

        let mut brace_depth: isize = 0;
        let mut saw_open = false;
        let mut end_index = index;
        for (offset, line) in lines[index..].iter().enumerate() {
            let code = line_without_strings(line);
            brace_depth += code.matches('{').count() as isize;
            if code.contains('{') {
                saw_open = true;
            }
            brace_depth -= code.matches('}').count() as isize;
            end_index = index + offset;
            if saw_open && brace_depth <= 0 {
                break;
            }
        }

        ranges.push(FunctionRange {
            line_count: end_index.saturating_sub(index) + 1,
        });
        index = end_index.saturating_add(1);
    }

    ranges
}

fn find_module_edges(file: &Path, content: &str) -> Vec<ModuleEdge> {
    let mut edges = Vec::new();
    for (index, line) in content.lines().enumerate() {
        let line_no = index + 1;
        let trimmed = line.trim_start();
        if let Some(rest) = module_declaration_rest(trimmed) {
            let module = rest
                .trim_end_matches(';')
                .split_whitespace()
                .next()
                .unwrap_or_default();
            if !module.is_empty() {
                edges.push(ModuleEdge {
                    from: file.to_path_buf(),
                    to: module.to_string(),
                    line: line_no,
                    kind: ModuleEdgeKind::ModDeclaration,
                });
            }
        }

        if let Some(rest) = trimmed.strip_prefix("use crate::") {
            edges.push(ModuleEdge {
                from: file.to_path_buf(),
                to: rest.trim_end_matches(';').to_string(),
                line: line_no,
                kind: ModuleEdgeKind::CrateUse,
            });
        } else if let Some(rest) = trimmed.strip_prefix("use super::") {
            edges.push(ModuleEdge {
                from: file.to_path_buf(),
                to: rest.trim_end_matches(';').to_string(),
                line: line_no,
                kind: ModuleEdgeKind::SuperUse,
            });
        }
    }
    edges
}

fn module_declaration_rest(trimmed: &str) -> Option<&str> {
    trimmed
        .strip_prefix("mod ")
        .or_else(|| trimmed.strip_prefix("pub mod "))
        .or_else(|| trimmed.strip_prefix("pub(crate) mod "))
        .or_else(|| trimmed.strip_prefix("pub(super) mod "))
}

fn line_for_token(content: &str, token: &str) -> usize {
    content
        .lines()
        .position(|line| line.contains(token))
        .map(|index| index + 1)
        .unwrap_or(1)
}

fn line_without_strings(line: &str) -> String {
    let mut output = String::with_capacity(line.len());
    let mut in_string = false;
    let mut escaped = false;
    for ch in line.chars() {
        if in_string {
            if escaped {
                escaped = false;
            } else if ch == '\\' {
                escaped = true;
            } else if ch == '"' {
                in_string = false;
            }
            output.push(' ');
        } else if ch == '"' {
            in_string = true;
            output.push(' ');
        } else {
            output.push(ch);
        }
    }
    output
}

fn collect_rust_files(root: &Path, target: Option<&Path>) -> anyhow::Result<Vec<PathBuf>> {
    let requested_scan_root = target
        .map(|path| {
            if path.is_absolute() {
                path.to_path_buf()
            } else {
                root.join(path)
            }
        })
        .unwrap_or_else(|| root.to_path_buf());
    if target.is_some() && !requested_scan_root.exists() {
        anyhow::bail!(
            "refactor target does not exist: {}",
            requested_scan_root.display()
        );
    }
    let scan_root = requested_scan_root
        .canonicalize()
        .unwrap_or(requested_scan_root);
    if !scan_root.starts_with(root) {
        anyhow::bail!("refactor target is outside root: {}", scan_root.display());
    }

    if scan_root.is_file() {
        return Ok(if scan_root.extension().is_some_and(|ext| ext == "rs") {
            vec![scan_root]
        } else {
            Vec::new()
        });
    }

    let mut files = Vec::new();
    for result in ignore::WalkBuilder::new(scan_root)
        .hidden(false)
        .filter_entry(|entry| {
            let name = entry.file_name().to_string_lossy();
            !matches!(
                name.as_ref(),
                "target" | ".git" | ".worktrees" | ".mdx-rust"
            )
        })
        .build()
    {
        let entry = result?;
        let path = entry.path();
        if path.is_file() && path.extension().is_some_and(|ext| ext == "rs") {
            files.push(path.to_path_buf());
        }
    }
    files.sort();
    Ok(files)
}

fn relative_path(root: &Path, path: &Path) -> PathBuf {
    path.strip_prefix(root).unwrap_or(path).to_path_buf()
}

#[cfg(test)]
mod tests {
    use super::*;
    use tempfile::tempdir;

    #[test]
    fn refactor_analysis_summarizes_public_api_and_modules() {
        let dir = tempdir().unwrap();
        let src = dir.path().join("src");
        std::fs::create_dir_all(&src).unwrap();
        std::fs::write(
            src.join("lib.rs"),
            r#"pub mod api;
use crate::api::Handler;

pub struct Config {
    value: String,
}

pub fn load() -> anyhow::Result<String> {
    Ok(String::new())
}
"#,
        )
        .unwrap();

        let analysis = analyze_refactor(
            dir.path(),
            RefactorAnalyzeConfig {
                target: Some(Path::new("src/lib.rs")),
                max_files: 10,
            },
        )
        .unwrap();

        assert_eq!(analysis.files_scanned, 1);
        assert_eq!(analysis.files[0].public_item_count, 3);
        assert!(analysis.files[0]
            .public_items
            .iter()
            .any(|item| item.name == "load"));
        assert_eq!(analysis.module_edges.len(), 2);
    }

    #[test]
    fn refactor_analysis_rejects_missing_target() {
        let dir = tempdir().unwrap();
        let err = analyze_refactor(
            dir.path(),
            RefactorAnalyzeConfig {
                target: Some(Path::new("src/missing.rs")),
                max_files: 10,
            },
        )
        .unwrap_err();

        assert!(err.to_string().contains("refactor target does not exist"));
    }
}