ascfix 0.7.1

Automatic ASCII diagram repair tool for Markdown files
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

//! Documentation validation tests
//!
//! These tests verify that important topics are documented in the right places.

use std::fs;

#[test]
fn readme_mentions_known_limitations() {
    let readme = fs::read_to_string("README.md").expect("README.md should exist");

    assert!(
        readme.contains("## Known Limitations") || readme.contains("# Known Limitations"),
        "README.md should have a 'Known Limitations' section"
    );

    assert!(
        readme.contains("idempotence") || readme.contains("Idempotence"),
        "README.md should mention idempotence limitations"
    );
}

#[test]
fn library_usage_documents_limitations() {
    let lib = fs::read_to_string("LIBRARY_USAGE.md").expect("LIBRARY_USAGE.md should exist");

    assert!(
        lib.contains("## Known Limitations") || lib.contains("# Known Limitations"),
        "LIBRARY_USAGE.md should have a 'Known Limitations' section"
    );

    assert!(
        lib.contains("idempotence") || lib.contains("Idempotence"),
        "LIBRARY_USAGE.md should document idempotence constraints"
    );

    assert!(
        lib.contains("nested") || lib.contains("Nested"),
        "LIBRARY_USAGE.md should mention nested diagram limitations"
    );
}

#[test]
fn architecture_explains_limitations() {
    let arch = fs::read_to_string("ARCHITECTURE.md").expect("ARCHITECTURE.md should exist");

    assert!(
        arch.contains("idempotence") || arch.contains("Idempotence"),
        "ARCHITECTURE.md should explain idempotence limitations technically"
    );

    assert!(
        arch.contains("detection") || arch.contains("Detection"),
        "ARCHITECTURE.md should explain detection phase issues"
    );
}

#[test]
fn cross_references_are_valid() {
    let readme = fs::read_to_string("README.md").expect("README.md should exist");

    // If README mentions LIBRARY_USAGE.md, verify the reference
    if readme.contains("LIBRARY_USAGE.md") {
        assert!(
            std::path::Path::new("LIBRARY_USAGE.md").exists(),
            "Cross-referenced LIBRARY_USAGE.md should exist"
        );
    }

    // If README mentions ARCHITECTURE.md, verify the reference
    if readme.contains("ARCHITECTURE.md") {
        assert!(
            std::path::Path::new("ARCHITECTURE.md").exists(),
            "Cross-referenced ARCHITECTURE.md should exist"
        );
    }
}

#[test]
fn idempotence_tests_exist() {
    // Verify we have tests demonstrating the idempotence behavior
    let test_files = vec!["tests/idempotence_tests.rs", "tests/integration_tests.rs"];

    let mut found_idempotence_test = false;
    for test_file in test_files {
        if let Ok(content) = fs::read_to_string(test_file) {
            if content.contains("idempotence") || content.contains("idempotent") {
                found_idempotence_test = true;
                break;
            }
        }
    }

    assert!(
        found_idempotence_test,
        "Should have tests demonstrating idempotence behavior"
    );
}