rust-relations-explorer 0.1.2

Explore relationships in Rust codebases: build a knowledge graph and run queries (connected files, function usage, cycles, paths, hubs, module centrality, trait impls).
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

use std::fs;
use std::path::PathBuf;

use rust_relations_explorer::graph::KnowledgeGraph;
use rust_relations_explorer::query::{ConnectedFilesQuery, CycleDetectionQuery, Query};

fn make_temp_project(contents: Vec<(&str, &str)>) -> PathBuf {
    let base = std::env::temp_dir().join(format!(
        "knowledge_rs_it_{}_{}",
        std::process::id(),
        std::time::SystemTime::now().elapsed().unwrap().as_nanos()
    ));
    fs::create_dir_all(base.join("src")).unwrap();
    for (path, body) in contents {
        let p = base.join(path);
        if let Some(parent) = p.parent() {
            fs::create_dir_all(parent).unwrap();
        }
        fs::write(p, body).unwrap();
    }
    base
}

#[test]
fn integration_connected_files() {
    let root = make_temp_project(vec![
        (
            "src/lib.rs",
            r#"
            mod a;
            mod b;
            use crate::a::foo;
            pub fn root() { foo(); }
        "#,
        ),
        (
            "src/a.rs",
            r#"
            pub fn foo() {}
        "#,
        ),
        (
            "src/b.rs",
            r#"
            pub fn bar() { crate::a::foo(); }
        "#,
        ),
    ]);

    let graph = KnowledgeGraph::build_from_directory(&root.join("src")).expect("build graph");

    // Connected files for a.rs should include lib.rs due to import use from lib
    let connected = ConnectedFilesQuery::new(root.join("src/a.rs")).run(&graph);
    assert!(connected.contains(&root.join("src/lib.rs")));
}

#[test]
#[ignore = "Call-graph extraction is simplistic and may not detect cycles from source yet; enable when improved."]
fn integration_cycle_detection_simple() {
    let root = make_temp_project(vec![
        (
            "src/lib.rs",
            r#"
            mod a;
            mod b;
        "#,
        ),
        (
            "src/a.rs",
            r#"
            pub fn foo() { crate::b::bar(); }
        "#,
        ),
        (
            "src/b.rs",
            r#"
            pub fn bar() { crate::a::foo(); }
        "#,
        ),
    ]);

    let graph = KnowledgeGraph::build_from_directory(&root.join("src")).expect("build graph");
    let cycles = CycleDetectionQuery::new().run(&graph);
    assert!(cycles.iter().any(|cyc| cyc.len() >= 2));
}