modelcards 0.1.4

A fast modelcard generator with built-in templates
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

use std::{
    fs::{canonicalize, create_dir},
    path::Path
};

use modelcards::{
    assets::{schema, templates, config},
    utils::{strip_unc, create_file, is_directory_empty}
};

use anyhow::{bail, Result};

pub fn create_new_project(name: &str, force: bool) -> Result<()> {
    let path = Path::new(name);
    if path.exists() && !is_directory_empty(path, true)? && !force {
        if name == "." {
            bail!("Can not deploy to current directory.");
        } else {
            bail!("Can not deploy to {}", path.to_string_lossy().to_string());
        }
    }
    println!("Welcome to modelcards!");

    populate(path, config::get_default())?;
    println!();
    println!("Done! Your project was created in {}", strip_unc(&canonicalize(path)?));
    println!();
    println!("Get started by moving into the directory and building your card: modelcads build");
    Ok(())
}

// fn is_directory_empty(path: &Path, allow_hidden: bool) -> Result<bool> {
//     if path.is_dir() {
//         let mut entries = match path.read_dir() {
//             Ok(entries) => entries,
//             Err(e) => bail!("Could not read '{}' because of error: {}", path.to_string_lossy().to_string(), e),
//         };
//         if entries.any(|x| match x {
//             Ok(file) => {
//                 if allow_hidden {
//                     !file.file_name().to_str().expect("Could not convert filename to &str").starts_with('.')
//                 } else {
//                     true
//                 }

//             },
//             Err(_) => true,
//         }) {
//             return Ok(false);
//         }
//         return Ok(true);
//     }
//     Ok(false)
// }


fn populate(path: &Path, config: &str) -> Result<()> {
    if !path.exists() {
        create_dir(path)?;
    }
    create_file(&path.join("config.toml"), config)?;
    create_file(&path.join("sample.json"), schema::get_sample())?;
    create_dir(path.join("schema"))?;
    create_file(&path.join("schema/modelcard.schema.json"), schema::get_schema())?;
    create_dir(path.join("templates"))?;
    create_file(&path.join("templates/modelcard.md.jinja"), templates::get_md())?;
    create_file(&path.join("templates/modelcard.html.jinja"), templates::get_html())?;

    Ok(())
}


#[cfg(test)]
mod tests {
    use super::*;
    use std::{
        env::temp_dir,
        fs::{create_dir, remove_dir, remove_dir_all},
        path::PathBuf
    };

    fn get_temp_dir(path: &str, create: bool) -> PathBuf {
        let mut dir = temp_dir();
        dir.push(path);
        if dir.exists() {
            remove_dir_all(&dir).expect("Could not free test directory");
        }
        if create {
            create_dir(&dir).expect("Could not create test directory");
        }
        dir
    }

    fn check_modelcards_dir(path: &Path) {
        assert!(path.exists());
        assert!(path.join("config.toml").exists());
        assert!(path.join("sample.json").exists());
        assert!(path.join("schema").exists());
        assert!(path.join("schema/modelcard.schema.json").exists());
        assert!(path.join("templates").exists());
        assert!(path.join("templates/modelcard.md.jinja").exists());
        assert!(path.join("templates/modelcard.html.jinja").exists());
    }

    #[test]
    fn init_empty_directory() {
        let dir = get_temp_dir("test_empty_dir", true);
        let allowed = is_directory_empty(&dir, false)
            .expect("An error happened reading the directory's contents");
        remove_dir(&dir).expect("Failed to remove directory");
        assert!(allowed);
    }

    #[test]
    fn init_non_empty_directory() {
        let dir = get_temp_dir("test_non_empty_dir", true);
        let mut content = dir.clone();
        content.push("content");
        create_dir(&content).expect("Failed to create content directory");
        let allowed = is_directory_empty(&dir, false)
            .expect("An error happened reading the directory's contents");
        remove_dir(&content).expect("Failed to remove content directory");
        remove_dir(&dir).expect("Failed to remove directory");
        assert!(!allowed);
    }

    #[test]
    fn init_almost_empty_directory() {
        let dir = get_temp_dir("test_dir_with_hidden", true);
        let mut git = dir.clone();
        git.push(".git");
        create_dir(&git).expect("Failed to create git directory");
        let allowed = is_directory_empty(&dir, true)
            .expect("An error happened reading the directory's contents");
        remove_dir(&git).expect("Failed to remove git directory");
        remove_dir(&dir).expect("Failed to remove directory");
        assert!(allowed);
    }

    #[test]
    fn populate_existing_directory() {
        let dir = get_temp_dir("test_populate_existing_dir", true);
        populate(&dir, "").expect("Could not populate modelcards directories");
        check_modelcards_dir(&dir);
        remove_dir_all(&dir).expect("Failed to remove directory");
    }

    #[test]
    fn populate_non_existing_directory() {
        let dir = get_temp_dir("test_non_existing_dir", false);
        populate(&dir, "").expect("Could not populate modelcards directories");
        check_modelcards_dir(&dir);
        remove_dir_all(&dir).expect("Failed to remove directory");
    }

}