mig-types 0.22.3

Generated MIG-tree types for EDIFACT messages — shared segments, composites, enums, and PID-specific compositions
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

use std::path::{Path, PathBuf};

/// Base directory for generated MIG schema files, relative to workspace root.
const GENERATED_BASE: &str = "crates/mig-types/src/generated";

/// Returns the directory containing PID schema JSON files for a given
/// format version and message type.
///
/// Both arguments are lowercased automatically.
///
/// Example: `schema_dir("FV2504", "UTILMD")` -> `crates/mig-types/src/generated/fv2504/utilmd/pids`
pub fn schema_dir(format_version: &str, message_type: &str) -> PathBuf {
    Path::new(GENERATED_BASE)
        .join(format_version.to_lowercase())
        .join(message_type.to_lowercase())
        .join("pids")
}

/// Returns the path to a specific PID schema JSON file.
///
/// Example: `pid_schema_file("FV2504", "UTILMD", "55001")` ->
///   `crates/mig-types/src/generated/fv2504/utilmd/pids/pid_55001_schema.json`
pub fn pid_schema_file(format_version: &str, message_type: &str, pid: &str) -> PathBuf {
    schema_dir(format_version, message_type).join(format!("pid_{pid}_schema.json"))
}

/// Returns the base directory for all generated schemas.
pub fn generated_base() -> &'static Path {
    Path::new(GENERATED_BASE)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_schema_dir() {
        assert_eq!(
            schema_dir("FV2504", "UTILMD"),
            PathBuf::from("crates/mig-types/src/generated/fv2504/utilmd/pids")
        );
    }

    #[test]
    fn test_schema_dir_case_insensitive() {
        assert_eq!(
            schema_dir("fv2504", "utilmd"),
            schema_dir("FV2504", "UTILMD")
        );
    }

    #[test]
    fn test_pid_schema_file() {
        assert_eq!(
            pid_schema_file("FV2504", "UTILMD", "55001"),
            PathBuf::from(
                "crates/mig-types/src/generated/fv2504/utilmd/pids/pid_55001_schema.json"
            )
        );
    }

    #[test]
    fn test_generated_base() {
        assert_eq!(
            generated_base(),
            Path::new("crates/mig-types/src/generated")
        );
    }
}

/// The PID a generated sample's file stem stands for: `55001` for `55001` and
/// for its branch sample `55001__ZAP` (a sample of the same PID whose groups
/// exclude the main sample's). `None` for a stem that names no PID
/// (`##alt##`, `aperak`).
pub fn sample_pid(stem: &str) -> Option<&str> {
    let pid = stem.split("__").next()?;
    (!pid.is_empty() && pid.chars().all(|c| c.is_ascii_digit())).then_some(pid)
}

#[cfg(test)]
mod sample_pid_tests {
    use super::sample_pid;

    #[test]
    fn a_branch_sample_names_its_pid() {
        assert_eq!(sample_pid("55001"), Some("55001"));
        assert_eq!(sample_pid("55001__ZAP"), Some("55001"));
        assert_eq!(sample_pid("##alt##"), None);
        assert_eq!(sample_pid("aperak"), None);
    }
}