commonmeta-schema 1.0.0-rc3

Commonmeta JSON Schemas and conformance fixtures
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

#![forbid(unsafe_code)]

use include_dir::{include_dir, Dir};

/// The complete tree of Commonmeta conformance fixtures, embedded at compile
/// time. Organized as `<format>/<name>.<ext>` (e.g. `commonmeta/journal_article.json`,
/// `crossref/journal_article.json`, `orcid/0000-0002-0068-716X.xml`).
///
/// Consumers can look up a single file with [`fixture_str`] / [`fixture_bytes`],
/// or iterate a subtree via `FIXTURES.get_dir("commonmeta").unwrap().files()`.
pub static FIXTURES: Dir<'static> = include_dir!("$CARGO_MANIFEST_DIR/fixtures");

/// Return an embedded fixture's raw bytes by relative path, e.g.
/// `fixture_bytes("commonmeta/journal_article.json")`.
pub fn fixture_bytes(path: &str) -> Option<&'static [u8]> {
    FIXTURES.get_file(path).map(|f| f.contents())
}

/// Return an embedded fixture's UTF-8 contents by relative path, e.g.
/// `fixture_str("crossref/journal_article.json")`. Returns `None` if the file
/// is absent or not valid UTF-8.
pub fn fixture_str(path: &str) -> Option<&'static str> {
    FIXTURES.get_file(path).and_then(|f| f.contents_utf8())
}

/// Embedded Commonmeta schema v1.0rc1.
pub const COMMONMETA_SCHEMA_V1_0RC1: &str = include_str!("../schemas/commonmeta_v1.0rc1.json");

/// Embedded Commonmeta schema v1.0rc2.
pub const COMMONMETA_SCHEMA_V1_0RC2: &str = include_str!("../schemas/commonmeta_v1.0rc2.json");

/// Embedded Commonmeta schema v1.0rc3.
pub const COMMONMETA_SCHEMA_V1_0RC3: &str = include_str!("../schemas/commonmeta_v1.0rc3.json");

/// Embedded Commonmeta journal article fixture.
pub const COMMONMETA_FIXTURE_JOURNAL_ARTICLE: &str =
    include_str!("../fixtures/commonmeta/journal_article.json");

/// Return an embedded schema by Commonmeta version string.
///
/// Currently supported: "1.0rc1", "1.0rc2", "1.0rc3".
pub fn schema(version: &str) -> Option<&'static str> {
    match version {
        "1.0rc1" => Some(COMMONMETA_SCHEMA_V1_0RC1),
        "1.0rc2" => Some(COMMONMETA_SCHEMA_V1_0RC2),
        "1.0rc3" => Some(COMMONMETA_SCHEMA_V1_0RC3),
        _ => None,
    }
}

/// Return an embedded Commonmeta fixture by name.
///
/// Currently supported: "journal_article".
pub fn fixture(name: &str) -> Option<&'static str> {
    match name {
        "journal_article" => Some(COMMONMETA_FIXTURE_JOURNAL_ARTICLE),
        _ => None,
    }
}

#[cfg(test)]
mod tests {
    use super::{fixture, schema};

    #[test]
    fn known_version_is_available() {
        assert!(schema("1.0rc1").is_some());
        assert!(schema("1.0rc2").is_some());
        assert!(schema("1.0rc3").is_some());
    }

    #[test]
    fn unknown_version_is_none() {
        assert!(schema("nope").is_none());
    }

    #[test]
    fn known_fixture_is_available() {
        assert!(fixture("journal_article").is_some());
    }

    #[test]
    fn unknown_fixture_is_none() {
        assert!(fixture("nope").is_none());
    }

    #[test]
    fn embedded_fixtures_are_available() {
        use super::{fixture_bytes, fixture_str, FIXTURES};
        // A known commonmeta fixture is reachable by relative path.
        assert!(fixture_str("commonmeta/journal_article.json").is_some());
        // A non-JSON fixture (ORCID XML) is reachable as bytes.
        assert!(fixture_bytes("orcid/0000-0002-0068-716X.xml").is_some());
        // Subtree iteration works and the commonmeta dir is non-empty.
        let commonmeta = FIXTURES.get_dir("commonmeta").expect("commonmeta dir");
        assert!(commonmeta.files().count() > 0);
        // Absent paths return None rather than panicking.
        assert!(fixture_str("nope/missing.json").is_none());
    }
}