artifact-app 1.0.1

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

//! #TST-cmd-tutorial

use tempdir;
use toml;

use dev_prefix::*;
use types::*;
use user;
use cmd::tutorial as tut;
use cmd::init;


#[test]
/// just test some assumptions, like that the different "levels"
/// of files aren't equal and that toml files can be loaded
/// by artifact
///
/// This also test's init files because it fits in easily
fn test_cmd_data_valid() {
    assert_ne!(tut::D_SETTINGS_1_TOML, tut::D_SETTINGS_2_TOML);
    assert_ne!(tut::D_SETTINGS_1_TOML, tut::D_SETTINGS_4_TOML);
    assert_ne!(tut::D_SETTINGS_2_TOML, tut::D_SETTINGS_4_TOML);

    assert_ne!(tut::D_LOAD_1_PY, tut::D_LOAD_2_PY);
    assert_ne!(tut::D_LOAD_1_TOML, tut::D_LOAD_2_TOML);

    let toml_files = vec![
        tut::D_TUTORIAL_TOML,
        tut::D_PURPOSE_TOML,
        tut::D_LOAD_1_TOML,
        tut::D_LOAD_2_TOML,
        init::PURPOSE_TOML,
    ];

    let settings_files = vec![
        tut::D_SETTINGS_1_TOML,
        tut::D_SETTINGS_2_TOML,
        tut::D_SETTINGS_4_TOML,
        init::SETTINGS_TOML,
    ];

    let p = Path::new("foo");
    for (i, toml) in toml_files.iter().enumerate() {
        let mut project = Project::default();
        let text = str::from_utf8(toml).unwrap();
        user::load_toml(&p, text, &mut project)
            .expect(&format!("could not load tutorial toml at index: {}", i));
    }

    for (i, toml) in settings_files.iter().enumerate() {
        let text = str::from_utf8(toml).unwrap();
        toml::from_str::<user::RawSettings>(text)
            .expect(&format!("could not load tutorial settings at index: {}", i));
    }
}

#[test]
fn test_line_length() {
    let files = vec![
        ("tut_toml", tut::D_TUTORIAL_TOML),
        ("tut_md", tut::D_TUTORIAL_MD),
        ("capitols.csv", tut::D_CAPITOLS_CSV),
        //("flash-cards.htm", tut::D_FLASH_CARD_CHALLENGE_HTM), # htm exempt
        ("purpose.toml", tut::D_PURPOSE_TOML),
        ("load-1.py", tut::D_LOAD_1_PY),
        ("load_-1.toml", tut::D_LOAD_1_TOML),
        ("load-2.py", tut::D_LOAD_2_PY),
        ("load_-2.toml", tut::D_LOAD_2_TOML),
        ("test_load.py", tut::D_TEST_LOAD_PY),
        ("test_data.csv", tut::D_TEST_DATA_CSV),
        ("set 1", tut::D_SETTINGS_1_TOML),
        ("set 2", tut::D_SETTINGS_2_TOML),
        ("set 4", tut::D_SETTINGS_4_TOML),
    ];

    for (fname, f) in files {
        let s = str::from_utf8(f).unwrap();
        let mut long = vec![];
        for (i, l) in s.replace("\r", "").split('\n').enumerate() {
            if l.len() > 80 {
                long.push((i, l.len()));
            }
        }
        if !long.is_empty() {
            panic!("{}: several (line,len) have len > 80: {:?}", fname, long);
        }
    }
}

#[test]
/// just make sure we can run the tutorial without errors
/// in any order
fn test_run_through() {
    let tmpdir = tempdir::TempDir::new("artifact").unwrap();
    let tmp = tmpdir.path();
    tut::run_cmd(&tmp, 1).expect("part 1");
    tut::run_cmd(&tmp, 2).expect("part 2");
    tut::run_cmd(&tmp, 3).expect("part 3");
    tut::run_cmd(&tmp, 4).expect("part 4");
    tut::run_cmd(&tmp, 5).expect("part 5");

    tut::run_cmd(&tmp, 1).expect("part 1");
    tut::run_cmd(&tmp, 4).expect("part 4");
    tut::run_cmd(&tmp, 3).expect("part 3");
    tut::run_cmd(&tmp, 5).expect("part 5");
    tut::run_cmd(&tmp, 2).expect("part 2");

    tut::run_cmd(&tmp, 5).expect("part 5");
    tut::run_cmd(&tmp, 4).expect("part 4");

    fs::remove_dir_all(&tmp).expect("couldn't remove");
}