logoxide 0.1.1

Bibles, commentaries, lexicons, books, and media as versioned packages: read from USX, USFM, and more, cached, and shared
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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294

#![cfg(feature = "read")]

//! Releasing: summaries, version checks, and reading a release's summary alone

use std::{path::Path, process::Command, sync::Arc};

use logoxide::reader::DefaultReader;
use logoxide::{
    Features, FsStorage, Package, Storage,
    git::{Fetcher, GitCli, GitRef},
    release::{check, plan, release},
    summary::{Change, SUMMARY, Summary, VERSES, summarize},
};

fn git(dir: &Path, args: &[&str]) {
    let out = Command::new("git")
        .args([
            "-c",
            "user.name=t",
            "-c",
            "user.email=t@t",
            "-c",
            "commit.gpgsign=false",
            "-c",
            "tag.gpgsign=false",
        ])
        .args(args)
        .current_dir(dir)
        .output()
        .unwrap();
    assert!(
        out.status.success(),
        "git {args:?}: {}",
        String::from_utf8_lossy(&out.stderr)
    );
}

/// A repository whose own config names its author, as a user's does: `lx release` commits and
/// tags in it, and a machine with no global identity (CI's) would refuse
fn init(repo: &Path) {
    git(repo, &["init", "-q", "-b", "main"]);
    for (key, value) in [
        ("user.name", "t"),
        ("user.email", "t@t"),
        ("commit.gpgsign", "false"),
        ("tag.gpgsign", "false"),
    ] {
        git(repo, &["config", key, value]);
    }
}

fn write(repo: &Path, version: &str, verses: &[(u8, &str)]) {
    let body: String = verses
        .iter()
        .map(|(n, text)| format!("<verse number=\"{n}\" style=\"v\"/>{text} "))
        .collect();
    std::fs::create_dir_all(repo.join("usx")).unwrap();
    std::fs::write(
        repo.join("usx/JHN.usx"),
        format!("<usx version=\"3.0\"><book code=\"JHN\" style=\"id\"/><chapter number=\"3\" style=\"c\"/><para style=\"p\">{body}<note style=\"f\">a note</note></para></usx>"),
    )
    .unwrap();
    std::fs::write(
        repo.join("logoxide.toml"),
        format!("[package]\nid = \"tb\"\nname = \"tb\"\nabbreviation = \"TB\"\nversion = \"{version}\"\nlanguage = \"en\"\n\n[formats]\nusx = {{ path = \"usx/\" }}\n"),
    )
    .unwrap();
}

#[test]
fn releases_follow_what_changed() {
    let root = std::env::temp_dir().join(format!("logoxide-release-{}", std::process::id()));
    let _ = std::fs::remove_dir_all(&root);
    let repo = root.join("tb");
    std::fs::create_dir_all(&repo).unwrap();
    let cli = GitCli::default();

    write(
        &repo,
        "1.0.0",
        &[(16, "For God so loved"), (17, "For God sent")],
    );
    init(&repo);
    // The first release: nothing to compare with
    let first = plan(&repo, &cli, &DefaultReader).unwrap();
    assert!(first.previous.is_none());
    release(&repo, &first, &cli).unwrap();
    assert!(repo.join(SUMMARY).is_file() && repo.join(VERSES).is_file());
    let (summary, verses) = Summary::read(&FsStorage::new(&repo)).unwrap();
    assert_eq!((summary.verses, verses.len()), (2, 2));
    assert_eq!(summary.books["JHN"], [0, 0, 17]);
    assert_eq!(summary.contents["note"], 1);

    // A note changed: a patch. The same version again isn't allowed
    let text = std::fs::read_to_string(repo.join("usx/JHN.usx")).unwrap();
    std::fs::write(
        repo.join("usx/JHN.usx"),
        text.replace("a note", "another note"),
    )
    .unwrap();
    let p = plan(&repo, &cli, &DefaultReader).unwrap();
    assert_eq!(p.change(), Change::Patch);
    assert!(
        check(&p)
            .unwrap_err()
            .to_string()
            .contains("1.0.1 or later")
    );

    // A word changed: a minor change, so 1.0.1 is too small
    write(
        &repo,
        "1.0.1",
        &[(16, "For God so loved the world"), (17, "For God sent")],
    );
    let p = plan(&repo, &cli, &DefaultReader).unwrap();
    assert_eq!(p.change(), Change::Minor);
    assert!(
        check(&p)
            .unwrap_err()
            .to_string()
            .contains("1.1.0 or later")
    );
    write(
        &repo,
        "1.1.0",
        &[(16, "For God so loved the world"), (17, "For God sent")],
    );
    release(&repo, &plan(&repo, &cli, &DefaultReader).unwrap(), &cli).unwrap();

    // A verse removed: major
    write(&repo, "1.2.0", &[(16, "For God so loved the world")]);
    let p = plan(&repo, &cli, &DefaultReader).unwrap();
    assert_eq!(
        (p.change(), p.minimum.clone().unwrap().to_string()),
        (Change::Major, "2.0.0".to_string())
    );
    write(&repo, "2.0.0", &[(16, "For God so loved the world")]);
    release(&repo, &plan(&repo, &cli, &DefaultReader).unwrap(), &cli).unwrap();

    // The published summary matches the text
    let storage: Arc<dyn Storage> = Arc::new(FsStorage::new(&repo));
    let package = Package::open(storage.clone(), Features::default()).unwrap();
    assert_eq!(
        summarize(&package, &DefaultReader).unwrap(),
        Summary::read(storage.as_ref()).unwrap()
    );

    // A release's summary, fetched alone
    let dest = root.join("shown");
    let url = format!("file://{}", repo.display());
    cli.fetch_files(
        &url,
        &GitRef::Tag("v1.1.0".into()),
        &[SUMMARY, VERSES],
        &FsStorage::new(&dest),
    )
    .unwrap();
    assert!(!dest.join("usx").exists());
    let (old, _) = Summary::read(&FsStorage::new(&dest)).unwrap();
    assert_eq!(
        (old.version.to_string(), old.verses),
        ("1.1.0".to_string(), 2)
    );
    let _ = std::fs::remove_dir_all(&root);
}

/// A release whose summary files can't be read as this lx writes them (here a verse file in no
/// known layout, and a summary with no `verse-hash`) is built again from its text, as a release
/// made by another rule would be: hashes made another way are never taken for rewording
#[test]
fn an_unreadable_summary_is_built_again() {
    let root = std::env::temp_dir().join(format!("logoxide-rule-{}", std::process::id()));
    let _ = std::fs::remove_dir_all(&root);
    let repo = root.join("tb");
    std::fs::create_dir_all(&repo).unwrap();
    let cli = GitCli::default();
    write(
        &repo,
        "1.0.0",
        &[(16, "For God so lo\u{AD}ved"), (17, "For God sent")],
    );
    init(&repo);
    let first = plan(&repo, &cli, &DefaultReader).unwrap();
    release(&repo, &first, &cli).unwrap();
    // Summary files in no layout this lx reads: 8 bytes of some hash a verse, no header
    let summary = std::fs::read_to_string(repo.join(SUMMARY)).unwrap();
    assert!(summary.contains("verse-hash = 1"), "{summary}");
    let old: String = (summary.lines())
        .filter(|l| !l.starts_with("verse-hash"))
        .map(|l| format!("{l}\n"))
        .collect();
    std::fs::write(repo.join(SUMMARY), old).unwrap();
    let mut bin = b"XXXX".to_vec();
    for verse in [16u8, 17] {
        bin.extend_from_slice(&[43, 3, verse, verse, 1, 2, 3, 4, 5, 6, 7, 8]);
    }
    std::fs::write(repo.join(VERSES), bin).unwrap();
    git(&repo, &["commit", "-qam", "unreadable summary"]);
    git(&repo, &["tag", "-f", "v1.0.0"]);
    assert!(Summary::read(&FsStorage::new(&repo)).is_err());

    // Nothing but the summary files changed: a patch, not every verse reworded
    write(
        &repo,
        "1.0.1",
        &[(16, "For God so lo\u{AD}ved"), (17, "For God sent")],
    );
    let p = plan(&repo, &cli, &DefaultReader).unwrap();
    assert_eq!(p.change(), Change::Patch);
    let _ = std::fs::remove_dir_all(&root);
}

/// A dictionary package's `<entries>` file with these entries
fn write_dictionary(repo: &Path, version: &str, entries: &[(&str, &str)]) {
    let body: String = (entries.iter())
        .map(|(key, text)| format!("<entry key=\"{key}\">{text}</entry>\n"))
        .collect();
    std::fs::create_dir_all(repo.join("entries")).unwrap();
    std::fs::write(
        repo.join("entries/greek.xml"),
        format!("<entries keys=\"strongs-greek\" markup=\"plain\">\n{body}</entries>\n"),
    )
    .unwrap();
    std::fs::write(
        repo.join("logoxide.toml"),
        format!("[package]\nid = \"strongs\"\nname = \"Strong's\"\nabbreviation = \"STR\"\nversion = \"{version}\"\nlanguage = \"grc\"\nkind = \"lexicon\"\nkeys = \"strongs-greek\"\n\n[formats]\ndictionary = {{ path = \"entries/\" }}\n"),
    )
    .unwrap();
}

/// A dictionary's release writes `logoxide.entries.bin`, and the next release is judged by
/// its entries: reworded or added minor, removed major
#[test]
fn a_dictionarys_entries_are_released_and_compared() {
    use logoxide::summary::ENTRIES;
    let root = std::env::temp_dir().join(format!("logoxide-entries-{}", std::process::id()));
    let _ = std::fs::remove_dir_all(&root);
    let repo = root.join("strongs");
    std::fs::create_dir_all(&repo).unwrap();
    let cli = GitCli::default();
    write_dictionary(&repo, "1.0.0", &[("G0025", "to love"), ("G26", "love")]);
    init(&repo);
    let first = plan(&repo, &cli, &DefaultReader).unwrap();
    assert_eq!((first.summary.entries, first.verses.len()), (2, 0));
    release(&repo, &first, &cli).unwrap();
    let bytes = std::fs::read(repo.join(ENTRIES)).unwrap();
    assert!(bytes.starts_with(b"LXE1"));
    assert_eq!(bytes.len(), 8 + 2 * 15);
    let (summary, _) = Summary::read(&FsStorage::new(&repo)).unwrap();
    assert_eq!(summary.entry_hashes.len(), 2);
    assert_eq!(
        summary.sizes["dictionary"] as usize,
        std::fs::read(repo.join("entries/greek.xml")).unwrap().len()
    );

    // Reworded (the key in another form is the same key): minor
    write_dictionary(
        &repo,
        "1.0.1",
        &[("G25", "to love, cherish"), ("G26", "love")],
    );
    let second = plan(&repo, &cli, &DefaultReader).unwrap();
    let (_, d) = second.previous.as_ref().unwrap();
    assert_eq!((d.entries_changed.len(), d.change()), (1, Change::Minor));
    assert_eq!(logoxide::release::describe(d), "1 entry reworded");
    assert!(check(&second).unwrap_err().to_string().contains("1.1.0"));
    write_dictionary(
        &repo,
        "1.1.0",
        &[("G25", "to love, cherish"), ("G26", "love")],
    );
    let second = plan(&repo, &cli, &DefaultReader).unwrap();
    release(&repo, &second, &cli).unwrap();

    // Removed: major; added: minor
    write_dictionary(
        &repo,
        "1.2.0",
        &[("G25", "to love, cherish"), ("G27", "beloved")],
    );
    let third = plan(&repo, &cli, &DefaultReader).unwrap();
    let (_, d) = third.previous.as_ref().unwrap();
    assert_eq!(
        (d.entries_removed.len(), d.entries_added.len(), d.change()),
        (1, 1, Change::Major)
    );
    assert_eq!(
        logoxide::release::describe(d),
        "1 entry removed, 1 entry added"
    );
    assert!(check(&third).is_err());
    let _ = std::fs::remove_dir_all(&root);
}