dodo 0.3.1

Basic persistence library designed to be a quick and easy way to create a persistent storage.
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

use std::io::{Read, Write};

use uuid::Uuid;

use dodo::storage::{Directory, Result, Storage};

#[test]
fn can_create_directory_storage() {
    let folder = fixture::create_folder();

    let storage = Directory::new(&folder);

    assert!(storage.is_ok(), "storage should have been created");
}

#[test]
fn should_create_sub_folders() {
    let folder = fixture::create_folder().path().join("sub/folder");

    let _storage = Directory::new(&folder).expect("could not create storage");

    assert!(folder.exists(), "storage should have created folder and sub folders");
}

#[test]
fn cant_use_file_as_directory_storage() {
    let folder = fixture::create_folder();
    let file = fixture::create_file_in(&folder, "file", "content");

    let storage = Directory::new(&file);

    assert!(storage.expect_err("shouldn't be able to create storage in a file").is_other(), "shouldn't be able to create storage in a file");
}

#[test]
fn can_create_new_entry() {
    let folder = fixture::create_folder();
    let mut storage = Directory::new(&folder).expect("could not create storage");

    let id = {
        let (id, mut write) = storage.new().expect("could not create new entry");
        write!(&mut write, "{}", "content").expect("could not write to new entry");
        id
    };

    fixture::assert_entry_equals(&folder, id, "content");
}

#[test]
fn can_read_existing_entry() {
    let folder = fixture::create_folder();
    let id = Uuid::parse_str("78190929-3d84-4735-9e40-80e3cd5530e9").unwrap();
    fixture::create_entry_in(&folder, id, "content");
    let storage = Directory::new(&folder).expect("could not create storage");

    let bytes = {
        let mut read = storage.read(id).expect("could not read storage");
        let mut buffer = String::new();
        read.read_to_string(&mut buffer).expect("could not read entry");
        buffer
    };

    assert_eq!(bytes, "content", "entry was read incorrectly");
}

#[test]
fn cant_read_absent_entry() {
    let folder = fixture::create_folder();
    let storage = Directory::new(&folder).expect("could not create storage");

    let entry = storage.read(Uuid::parse_str("78190929-3d84-4735-9e40-80e3cd5530e9").unwrap());

    assert!(entry.expect_err("entry should not exist").is_not_found(), "could not read entry");
}

#[test]
fn can_write_to_absent_entry() {
    let folder = fixture::create_folder();
    let id = Uuid::parse_str("78190929-3d84-4735-9e40-80e3cd5530e9").unwrap();
    let mut storage = Directory::new(&folder).expect("could not create storage");

    {
        let mut write = storage.write(id).expect("could not write to storage");
        write!(&mut write, "{}", "content").expect("could not write entry");
    };

    fixture::assert_entry_equals(&folder, id, "content");
}

#[test]
fn can_write_to_existing_entry() {
    let folder = fixture::create_folder();
    let id = Uuid::parse_str("78190929-3d84-4735-9e40-80e3cd5530e9").unwrap();
    fixture::create_entry_in(&folder, id, "content");
    let mut storage = Directory::new(&folder).expect("could not create storage");

    {
        let mut write = storage.write(id).expect("could not write to storage");
        write!(&mut write, "{}", "new content").expect("could not write entry");
    };

    fixture::assert_entry_equals(&folder, id, "new content");
}

#[test]
fn can_overwrite_existing_entry() {
    let folder = fixture::create_folder();
    let id = Uuid::parse_str("78190929-3d84-4735-9e40-80e3cd5530e9").unwrap();
    fixture::create_entry_in(&folder, id, "content");
    let mut storage = Directory::new(&folder).expect("could not create storage");

    {
        let mut write = storage.overwrite(id).expect("could not write to storage");
        write!(&mut write, "{}", "new content").expect("could not write entry");
    };

    fixture::assert_entry_equals(&folder, id, "new content");
}

#[test]
fn cant_overwrite_absent_entry() {
    let folder = fixture::create_folder();
    let id = Uuid::parse_str("78190929-3d84-4735-9e40-80e3cd5530e9").unwrap();
    let mut storage = Directory::new(&folder).expect("could not create storage");

    let entry = storage.overwrite(id);

    assert!(entry.expect_err("entry should not have existed").is_not_found(), "entry should not have been writen");
}

#[test]
fn can_delete_existing_entry() {
    let folder = fixture::create_folder();
    let id = Uuid::parse_str("78190929-3d84-4735-9e40-80e3cd5530e9").unwrap();
    fixture::create_entry_in(&folder, id, "content");
    let mut storage = Directory::new(&folder).expect("could not create storage");

    let deleted = storage.delete(id).expect("could not delete from storage");

    assert!(deleted, "something should have been deleted");
    fixture::assert_entry_not_exists(&folder, id);
}

#[test]
fn can_delete_absent_entry() {
    let folder = fixture::create_folder();
    let id = Uuid::parse_str("78190929-3d84-4735-9e40-80e3cd5530e9").unwrap();
    let mut storage = Directory::new(&folder).expect("could not create storage");

    let deleted = storage.delete(id).expect("could not delete from storage");

    assert!(!deleted, "nothing should have been deleted");
    fixture::assert_entry_not_exists(&folder, id);
}

#[test]
fn can_clear_storage() {
    let folder = fixture::create_folder();
    let id1 = Uuid::parse_str("78190929-3d84-4735-9e40-80e3cd5530e9").unwrap();
    let id2 = Uuid::parse_str("e91b1660-30ee-4db2-bf3d-244a0386c10f").unwrap();
    fixture::create_entry_in(&folder, id1, "content1");
    fixture::create_entry_in(&folder, id2, "content2");
    let mut storage = Directory::new(&folder).expect("could not create storage");

    storage.clear().expect("could not clear storage");

    fixture::assert_entry_not_exists(&folder, id1);
    fixture::assert_entry_not_exists(&folder, id2);
}

#[test]
fn can_clear_empty_storage() {
    let folder = fixture::create_folder();
    let mut storage = Directory::new(&folder).expect("could not create storage");

    storage.clear().expect("could not clear storage");
}

#[test]
fn can_list_existing_entries() {
    let folder = fixture::create_folder();
    let id1 = Uuid::parse_str("78190929-3d84-4735-9e40-80e3cd5530e9").unwrap();
    let id2 = Uuid::parse_str("e91b1660-30ee-4db2-bf3d-244a0386c10f").unwrap();
    fixture::create_entry_in(&folder, id1, "content1");
    fixture::create_entry_in(&folder, id2, "content2");
    let storage = Directory::new(&folder).expect("could not create storage");

    let entries: Vec<Uuid> = storage
        .iter().expect("could not read storage")
        .collect::<Result<Vec<Uuid>>>().expect("could not read storage");

    assert!(entries.contains(&id1), "entry 1 should exist");
    assert!(entries.contains(&id2), "entry 2 should exist.");
}

mod fixture {
    use std::{fs, path::{Path, PathBuf}};

    use uuid::Uuid;

    pub fn create_folder() -> tempfile::TempDir {
        tempfile::tempdir().expect("could not create folder")
    }

    pub fn create_file_in<P: AsRef<Path>>(folder: P, name: &str, content: &str) -> PathBuf {
        let path = folder.as_ref().join(name);
        fs::write(&path, content).expect("could not create file");
        path
    }

    pub fn create_entry_in<P: AsRef<Path>>(folder: P, id: Uuid, content: &str) {
        create_file_in(folder, &id.to_string(), content);
    }

    pub fn assert_entry_equals<P: AsRef<Path>>(folder: P, id: Uuid, expected_content: &str) {
        let path = folder.as_ref().join(id.to_string());
        assert!(path.exists(), "entry does not exist");

        let actual_content = fs::read_to_string(&path).expect("entry does not exist");
        assert_eq!(expected_content, actual_content, "entry has the wrong contents");
    }

    pub fn assert_entry_not_exists<P: AsRef<Path>>(folder: P, id: Uuid) {
        let path = folder.as_ref().join(id.to_string());
        assert!(!path.exists(), "entry should have been deleted");
    }
}