context-footprint 0.1.0

A static analysis tool for measuring architectural context exposure in codebases.
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

//! Sanity check: library and test common module are accessible.

mod common;

use context_footprint::domain::graph::ContextGraph;
use context_footprint::domain::policy::SourceSpan;

#[test]
fn test_library_accessible() {
    let graph = ContextGraph::new();
    assert_eq!(graph.graph.node_count(), 0);
}

#[test]
fn test_mock_size_function() {
    use common::mock::MockSizeFunction;
    use context_footprint::domain::policy::SizeFunction;

    let f = MockSizeFunction::with_size(42);
    let span = SourceSpan {
        start_line: 0,
        start_column: 0,
        end_line: 1,
        end_column: 5,
    };
    assert_eq!(f.compute("hello", &span, &[]), 42);
}

#[test]
fn test_mock_doc_scorer() {
    use common::mock::MockDocScorer;
    use context_footprint::domain::policy::{DocumentationScorer, NodeInfo, NodeType};

    let s = MockDocScorer::with_score(0.8);
    let info = NodeInfo {
        node_type: NodeType::Function,
        name: "foo".into(),
        signature: None,
        language: None,
    };
    assert_eq!(s.score(&info, Some("doc")), 0.8);
    assert_eq!(s.score(&info, None), 0.0);
}

#[test]
fn test_mock_source_reader() {
    use common::mock::MockSourceReader;
    use context_footprint::domain::ports::SourceReader;
    use std::path::Path;

    let reader = MockSourceReader::new().with_file("/test/main.py", "def foo(): pass");
    let out = reader.read(Path::new("/test/main.py")).unwrap();
    assert_eq!(out, "def foo(): pass");
    assert!(reader.read(Path::new("/missing")).is_err());
}