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

mod common;

use lazyspec::engine::document::{DocMeta, Status};
use std::fs;

#[test]
fn create_spec_produces_flat_file() {
    let fixture = common::TestFixture::new();
    let config = fixture.config();

    let path = lazyspec::cli::create::run(
        fixture.root(),
        &config,
        &fixture.store(),
        "spec",
        "Auth Flow",
        "jkaloger",
        |_| {},
    )
    .unwrap();

    // Returned path should be a flat .md file
    assert!(
        path.to_str().unwrap().ends_with(".md"),
        "expected .md file, got: {:?}",
        path
    );
    assert!(path.exists(), "spec file should exist");

    let filename = path.file_name().unwrap().to_str().unwrap();
    assert!(filename.starts_with("SPEC-001-"), "got: {}", filename);
    assert!(filename.ends_with("auth-flow.md"), "got: {}", filename);
}

#[test]
fn created_spec_has_correct_frontmatter() {
    let fixture = common::TestFixture::new();
    let config = fixture.config();

    let path = lazyspec::cli::create::run(
        fixture.root(),
        &config,
        &fixture.store(),
        "spec",
        "Payment Gateway",
        "alice",
        |_| {},
    )
    .unwrap();

    let content = fs::read_to_string(&path).unwrap();
    let meta = DocMeta::parse(&content).unwrap();

    assert_eq!(meta.title, "Payment Gateway");
    assert_eq!(meta.doc_type.as_str(), "spec");
    assert_eq!(meta.status, Status::Draft);
    assert_eq!(meta.author, "alice");
}

#[test]
fn created_spec_loads_in_store() {
    let fixture = common::TestFixture::new();
    let config = fixture.config();

    let path = lazyspec::cli::create::run(
        fixture.root(),
        &config,
        &fixture.store(),
        "spec",
        "Search Index",
        "carol",
        |_| {},
    )
    .unwrap();

    let store = fixture.store();
    let rel_path = path.strip_prefix(fixture.root()).unwrap();

    let all = store.all_docs();
    let doc = all.iter().find(|d| d.path == rel_path);
    assert!(doc.is_some(), "spec should appear in store");
    assert_eq!(doc.unwrap().doc_type.as_str(), "spec");
}

#[test]
fn non_subdirectory_types_still_produce_flat_files() {
    let fixture = common::TestFixture::new();
    let config = fixture.config();

    let path = lazyspec::cli::create::run(
        fixture.root(),
        &config,
        &fixture.store(),
        "rfc",
        "Flat File Test",
        "dave",
        |_| {},
    )
    .unwrap();

    assert!(path.exists());
    let filename = path.file_name().unwrap().to_str().unwrap();
    assert!(filename.ends_with(".md"), "rfc should be a flat .md file");
    assert!(
        !path
            .parent()
            .unwrap()
            .file_name()
            .unwrap()
            .to_str()
            .unwrap()
            .starts_with("RFC-"),
        "rfc should not be inside a type-prefixed directory"
    );
}