artifact-app 0.6.3

Artifact is a design doc tool made for developers. It allows anyone to easily write and link their design docs both to each other and to source code, making it easy to track how complete their project is. Documents are revision controllable, can be rendered as a static web page and have a full suite of command line tools for searching, formatting and displaying them.
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

use dev_prefix::*;
use super::*; // data directory constants
use super::super::types::*;
use super::super::load::*;
use super::super::link::*;


#[test]
fn test_done() {
    let mut project = Project::default();
    let path = PathBuf::from("hi/there");
    let req_foo = ArtNameRc::from_str("REQ-foo").unwrap();
    let spc_foo = ArtNameRc::from_str("spc-foo").unwrap();

    load_toml(&path, TOML_DONE, &mut project).unwrap();
    assert_eq!(project.artifacts.get(&spc_foo).unwrap().done,
               Done::Defined("foo".to_string()));

    do_links(&mut project.artifacts).unwrap();
    assert_eq!(project.artifacts.get(&req_foo).unwrap().completed, 1.0);
    assert_eq!(project.artifacts.get(&req_foo).unwrap().tested, 1.0);
}

#[test]
fn test_basic_link() {
    let mut project = Project::default();
    let path = PathBuf::from("hi/there");
    let req_name = Arc::new(ArtNameRc::from_str("REQ-1").unwrap().parent().unwrap());

    // get te artifacts
    let num = load_toml(&path, TOML_RST, &mut project).unwrap();

    let mut artifacts = project.artifacts;
    // note: SPC-bar is done via attribute
    for sname in &["SPC-foo", "TST-foo"] {
        let art = artifacts.get_mut(&ArtNameRc::from_str(sname).unwrap()).unwrap();
        art.done = Done::Code(Loc {
            path: path.clone(),
            line: 1,
        });
    }

    validate_done(&artifacts).unwrap();
    link_named_partofs(&mut artifacts);

    create_parents(&mut artifacts);
    assert!(artifacts.contains_key(&req_name));
    assert!(artifacts.contains_key(&ArtNameRc::from_str("REQ-parts").unwrap()));
    assert!(artifacts.contains_key(&ArtNameRc::from_str("REQ-parts-p1").unwrap()));
    assert!(artifacts.contains_key(&ArtNameRc::from_str("REQ-parts-p1-a").unwrap()));

    // test linking
    link_parents(&mut artifacts);
    validate_partof(&artifacts).unwrap();
    assert_eq!(link_parts(&mut artifacts), 3);
    assert_eq!(set_completed(&mut artifacts), 0);
    assert_eq!(set_tested(&mut artifacts), 0);

    let req = artifacts.get(&req_name).unwrap();
    let req_parts = artifacts.get(&ArtNameRc::from_str("REQ-parts").unwrap()).unwrap();
    let req_parts_p1 = artifacts.get(&ArtNameRc::from_str("REQ-parts-p1").unwrap()).unwrap();
    let req_parts_p1_a = artifacts.get(&ArtNameRc::from_str("REQ-parts-p1-a").unwrap()).unwrap();
    let spc_foo = artifacts.get(&ArtNameRc::from_str("SPC-foo").unwrap()).unwrap();
    let req_foo = artifacts.get(&ArtNameRc::from_str("REQ-foo").unwrap()).unwrap();
    let tst_foo = artifacts.get(&ArtNameRc::from_str("TST-foo").unwrap()).unwrap();

    // test parts
    assert_eq!(req.partof, HashSet::new());
    assert_eq!(req.parts,
               HashSet::from_iter(["REQ-parts", "REQ-foo"]
                   .iter()
                   .map(|n| ArtNameRc::from_str(n).unwrap())));

    assert_eq!(req_parts.partof,
               ArtNames::from_iter(vec![req_name.clone()]));
    assert_eq!(req_parts.parts,
               HashSet::from_iter(["REQ-parts-p1", "REQ-parts-p2"]
                   .iter()
                   .map(|n| ArtNameRc::from_str(n).unwrap())));

    assert_eq!(req_foo.parts,
               HashSet::from_iter(["SPC-foo", "SPC-bar"]
                   .iter()
                   .map(|n| ArtNameRc::from_str(n).unwrap())));
    assert_eq!(spc_foo.partof,
               HashSet::from_iter(["REQ-foo", "SPC"]
                   .iter()
                   .map(|n| ArtNameRc::from_str(n).unwrap())));

    assert_eq!(req_parts_p1_a.partof,
               HashSet::from_iter(["REQ-parts-p1"]
                   .iter()
                   .map(|n| ArtNameRc::from_str(n).unwrap())));
    assert_eq!(req_parts_p1_a.parts, HashSet::new());

    // test completed %
    assert_eq!(spc_foo.completed, 1.);
    assert_eq!(req_foo.completed, 1.);
    assert_eq!(req_parts.completed, 0.);
    assert_eq!(req_parts_p1.completed, 0.);
    assert_eq!(req_parts_p1_a.completed, 0.);

    // test tested %
    assert_eq!(tst_foo.tested, 1.);
    assert_eq!(spc_foo.tested, 1.);
    assert_eq!(req_foo.tested, 0.5);
    assert_eq!(req_parts.tested, 0.);
    assert_eq!(req_parts_p1.tested, 0.);
    assert_eq!(req_parts_p1_a.tested, 0.);
}

#[test]
fn test_link_completed_tested() {
    let mut project = Project::default();
    let path = PathBuf::from("hi/there");
    let req_name = Arc::new(ArtNameRc::from_str("REQ-1").unwrap().parent().unwrap());

    let num = load_toml(&path, TOML_LINK, &mut project).unwrap();
    let mut artifacts = project.artifacts;
    for sname in &["SPC-core-bob-1",
                   "TST-core-bob-1-a",
                   "TST-core-bob-1-b-2",
                   "SPC-core-bob-2-b",
                   "TST-core-bob-2-a"] {
        let art = artifacts.get_mut(&ArtNameRc::from_str(sname).unwrap()).unwrap();
        art.done = Done::Code(Loc {
            path: path.clone(),
            line: 1,
        });
    }

    link_named_partofs(&mut artifacts);
    create_parents(&mut artifacts);
    link_parents(&mut artifacts);
    validate_partof(&artifacts).unwrap();

    // just checking that this artifact is good throughout the process
    assert_eq!(artifacts.get(&ArtNameRc::from_str("SPC-core-bob").unwrap()).unwrap().partof,
               HashSet::from_iter(["REQ-core-bob", "SPC-core"]
                   .iter()
                   .map(|n| ArtNameRc::from_str(n).unwrap())));

    assert_eq!(link_parts(&mut artifacts), 0);
    assert_eq!(set_completed(&mut artifacts), 0);
    assert_eq!(set_tested(&mut artifacts), 0);

    let req = artifacts.get(&req_name).unwrap();
    let req_core = artifacts.get(&ArtNameRc::from_str("REQ-core").unwrap()).unwrap();
    let req_bob = artifacts.get(&ArtNameRc::from_str("REQ-core-bob").unwrap()).unwrap();
    let spc_bob = artifacts.get(&ArtNameRc::from_str("SPC-core-bob").unwrap()).unwrap();
    let spc_bob = artifacts.get(&ArtNameRc::from_str("SPC-core-bob").unwrap()).unwrap();

    // bob 1
    let spc_bob_1 = artifacts.get(&ArtNameRc::from_str("SPC-core-bob-1").unwrap()).unwrap();
    let tst_bob_1 = artifacts.get(&ArtNameRc::from_str("TST-core-bob-1").unwrap()).unwrap();
    let tst_bob_1_a = artifacts.get(&ArtNameRc::from_str("TST-core-bob-1-a").unwrap()).unwrap();
    let tst_bob_1_b = artifacts.get(&ArtNameRc::from_str("TST-core-bob-1-b").unwrap()).unwrap();
    let tst_bob_1_b_1 = artifacts.get(&ArtNameRc::from_str("TST-core-bob-1-b-1").unwrap()).unwrap();
    let tst_bob_1_b_2 = artifacts.get(&ArtNameRc::from_str("TST-core-bob-1-b-2").unwrap()).unwrap();

    // bob 2
    let spc_bob_2 = artifacts.get(&ArtNameRc::from_str("SPC-core-bob-2").unwrap()).unwrap();
    let spc_bob_2_a = artifacts.get(&ArtNameRc::from_str("SPC-core-bob-2-a").unwrap()).unwrap();
    let spc_bob_2_b = artifacts.get(&ArtName::from_str("SPC-core-bob-2-b").unwrap()).unwrap();

    assert_eq!(tst_bob_1_b_2.tested, 1.);

    // jane and joe
    let spc_bob_2_a = artifacts.get(&ArtNameRc::from_str("REQ-core-joe").unwrap()).unwrap();
    let spc_bob_2_b = artifacts.get(&ArtNameRc::from_str("REQ-core-jane").unwrap()).unwrap();

    // assert parts make some sense
    // SPC-core-bob automatically has REQ-core-bob
    // SPC-core-bob automatically has SPC-core
    assert_eq!(req.parts,
               HashSet::from_iter(["REQ-core"].iter().map(|n| ArtNameRc::from_str(n).unwrap())));
    assert_eq!(spc_bob.partof,
               HashSet::from_iter(["SPC-core", "REQ-core-bob"]
                   .iter()
                   .map(|n| ArtNameRc::from_str(n).unwrap())));
    assert_eq!(req_bob.parts,
               HashSet::from_iter(["SPC-core-bob"]
                   .iter()
                   .map(|n| ArtNameRc::from_str(n).unwrap())));
    assert_eq!(spc_bob_1.parts,
               HashSet::from_iter(["TST-core-bob-1"]
                   .iter()
                   .map(|n| ArtNameRc::from_str(n).unwrap())));

    // assert completed
    let bob_complete = (1. + (1. + 0.) / 2.) / 2.;
    assert_eq!(spc_bob_1.completed, 1.);
    assert_eq!(spc_bob.completed, bob_complete);
    assert_eq!(req_bob.completed, bob_complete);
    assert_eq!(req.completed, (bob_complete + 0. + 0.) / 3.0);

    // assert tested
    assert_eq!(tst_bob_1_a.tested, 1.);
    assert_eq!(tst_bob_1_b_2.tested, 1.);
    assert_eq!(tst_bob_1_b.tested, 0.5);
    let bob_1_tested = (1. + 0.5) / 2.;
    assert_eq!(tst_bob_1.tested, bob_1_tested);
    assert_eq!(spc_bob_1.tested, bob_1_tested);
    assert_eq!(spc_bob_2.tested, 0.5);
    let bob_tested = (0.5 + bob_1_tested) / 2.;
    assert_eq!(spc_bob.tested, bob_tested);
    assert_eq!(req_bob.tested, bob_tested);
    assert_eq!(req.tested, (bob_tested + 0. + 0.) / 3.);
}

#[test]
fn test_invalid_partof() {
    let artifacts = load_toml_simple("[REQ-foo]\npartof = 'SPC-bar'\n");
    assert!(validate_partof(&artifacts).is_err());
    let artifacts = load_toml_simple("[REQ-foo]\npartof = 'RSK-bar'\n");
    assert!(validate_partof(&artifacts).is_err());
    let artifacts = load_toml_simple("[REQ-foo]\npartof = 'TST-bar'\n");
    assert!(validate_partof(&artifacts).is_err());

    let artifacts = load_toml_simple("[RSK-foo]\npartof = 'TST-bar'\n");
    assert!(validate_partof(&artifacts).is_err());
    let artifacts = load_toml_simple("[RSK-foo]\npartof = 'SPC-bar'\n");
    assert!(validate_partof(&artifacts).is_err());

    let artifacts = load_toml_simple("[SPC-foo]\npartof = 'TST-bar'\n");
    assert!(validate_partof(&artifacts).is_err());
    let artifacts = load_toml_simple("[SPC-foo]\npartof = 'RSK-bar'\n");
    assert!(validate_partof(&artifacts).is_err());

    let artifacts = load_toml_simple("[TST-foo]\npartof = 'REQ-bar'\n");
    assert!(validate_partof(&artifacts).is_err());
}