lazyspec 0.8.0

A little TUI & CLI for project documentation.
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

mod common;

use common::TestFixture;
use lazyspec::engine::document::DocMeta;
use std::fs;

fn setup_two_docs() -> TestFixture {
    let fixture = TestFixture::new();
    fixture.write_rfc("RFC-001-auth.md", "Auth", "accepted");
    fixture.write_adr("ADR-001-adopt-auth.md", "Adopt Auth", "draft", None);
    fixture
}

#[test]
fn link_adds_relationship_to_frontmatter() {
    let fixture = setup_two_docs();
    let store = fixture.store();
    let fs = lazyspec::engine::fs::RealFileSystem;

    lazyspec::cli::link::link(
        fixture.root(),
        &store,
        "docs/adrs/ADR-001-adopt-auth.md",
        "implements",
        "docs/rfcs/RFC-001-auth.md",
        &fs,
    )
    .unwrap();

    let content =
        fs::read_to_string(fixture.root().join("docs/adrs/ADR-001-adopt-auth.md")).unwrap();
    let meta = DocMeta::parse(&content).unwrap();
    assert_eq!(meta.related.len(), 1);
    assert_eq!(meta.related[0].target, "RFC-001");
}

#[test]
fn unlink_removes_relationship() {
    let fixture = setup_two_docs();
    let store = fixture.store();
    let fs = lazyspec::engine::fs::RealFileSystem;

    lazyspec::cli::link::link(
        fixture.root(),
        &store,
        "docs/adrs/ADR-001-adopt-auth.md",
        "implements",
        "docs/rfcs/RFC-001-auth.md",
        &fs,
    )
    .unwrap();

    lazyspec::cli::link::unlink(
        fixture.root(),
        &store,
        "docs/adrs/ADR-001-adopt-auth.md",
        "implements",
        "docs/rfcs/RFC-001-auth.md",
        &fs,
    )
    .unwrap();

    let content =
        fs::read_to_string(fixture.root().join("docs/adrs/ADR-001-adopt-auth.md")).unwrap();
    let meta = DocMeta::parse(&content).unwrap();
    assert!(meta.related.is_empty());
}

#[test]
fn link_with_shorthand_ids() {
    let fixture = setup_two_docs();
    let store = fixture.store();
    let fs = lazyspec::engine::fs::RealFileSystem;

    lazyspec::cli::link::link(
        fixture.root(),
        &store,
        "ADR-001",
        "implements",
        "RFC-001",
        &fs,
    )
    .unwrap();

    let content =
        std::fs::read_to_string(fixture.root().join("docs/adrs/ADR-001-adopt-auth.md")).unwrap();
    let meta = DocMeta::parse(&content).unwrap();
    assert_eq!(meta.related.len(), 1);
    assert_eq!(meta.related[0].target, "RFC-001");
}

#[test]
fn unlink_with_shorthand_ids() {
    let fixture = setup_two_docs();
    let store = fixture.store();
    let fs = lazyspec::engine::fs::RealFileSystem;

    lazyspec::cli::link::link(
        fixture.root(),
        &store,
        "ADR-001",
        "implements",
        "RFC-001",
        &fs,
    )
    .unwrap();

    let store = fixture.store();
    lazyspec::cli::link::unlink(
        fixture.root(),
        &store,
        "ADR-001",
        "implements",
        "RFC-001",
        &fs,
    )
    .unwrap();

    let content =
        std::fs::read_to_string(fixture.root().join("docs/adrs/ADR-001-adopt-auth.md")).unwrap();
    let meta = DocMeta::parse(&content).unwrap();
    assert!(meta.related.is_empty());
}

#[test]
fn link_ambiguous_id_returns_error() {
    let fixture = TestFixture::new();
    fixture.write_rfc("RFC-001-alpha.md", "Alpha", "draft");
    fixture.write_rfc("RFC-001-beta.md", "Beta", "draft");
    fixture.write_adr("ADR-001-test.md", "Test", "draft", None);
    let store = fixture.store();
    let fs = lazyspec::engine::fs::RealFileSystem;

    let result = lazyspec::cli::link::link(
        fixture.root(),
        &store,
        "ADR-001",
        "implements",
        "RFC-001",
        &fs,
    );

    assert!(result.is_err());
    let err_msg = result.unwrap_err().to_string();
    assert!(
        err_msg.contains("Ambiguous"),
        "expected ambiguous error, got: {}",
        err_msg
    );
}

#[test]
fn link_not_found_id_returns_error() {
    let fixture = TestFixture::new();
    fixture.write_adr("ADR-001-test.md", "Test", "draft", None);
    let store = fixture.store();
    let fs = lazyspec::engine::fs::RealFileSystem;

    let result = lazyspec::cli::link::link(
        fixture.root(),
        &store,
        "ADR-001",
        "implements",
        "RFC-999",
        &fs,
    );

    assert!(result.is_err());
    let err_msg = result.unwrap_err().to_string();
    assert!(
        err_msg.contains("not found"),
        "expected not-found error, got: {}",
        err_msg
    );
}