rh-foundation 0.1.0-beta.1

Foundation crate providing common utilities, error handling, and shared functionality
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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ElementPath {
    parts: Vec<String>,
    original: String,
}

impl ElementPath {
    pub fn new(path: &str) -> Self {
        let parts: Vec<String> = path.split('.').map(|s| s.to_string()).collect();
        Self {
            parts,
            original: path.to_string(),
        }
    }

    /// Constructs an `ElementPath` from a vector of parts.
    ///
    /// This is more efficient than `new()` when you already have the parts vector,
    /// as it avoids the split operation. Useful when converting from `parent()` results.
    ///
    /// # Example
    ///
    /// ```
    /// use rh_foundation::snapshot::ElementPath;
    ///
    /// let path = ElementPath::new("Patient.name.given");
    /// let parent_parts = path.parent().unwrap();
    /// let parent_path = ElementPath::from_parts(parent_parts.to_vec());
    /// assert_eq!(parent_path.as_str(), "Patient.name");
    /// ```
    pub fn from_parts(parts: Vec<String>) -> Self {
        let original = parts.join(".");
        Self { parts, original }
    }

    pub fn parts(&self) -> &[String] {
        &self.parts
    }

    pub fn as_str(&self) -> &str {
        &self.original
    }

    pub fn depth(&self) -> usize {
        self.parts.len()
    }

    pub fn is_parent_of(&self, other: &ElementPath) -> bool {
        if self.depth() >= other.depth() {
            return false;
        }

        for (i, part) in self.parts.iter().enumerate() {
            if other.parts.get(i) != Some(part) {
                return false;
            }
        }

        true
    }

    pub fn is_child_of(&self, other: &ElementPath) -> bool {
        other.is_parent_of(self)
    }

    pub fn is_immediate_child_of(&self, parent: &ElementPath) -> bool {
        self.depth() == parent.depth() + 1 && self.is_child_of(parent)
    }

    /// Returns a slice view of the parent path's parts.
    ///
    /// This is a zero-allocation operation that returns a borrowed slice.
    /// If you need an `ElementPath` instance, use `ElementPath::from_parts(parent.to_vec())`.
    ///
    /// # Returns
    ///
    /// - `Some(&[String])` - A slice containing the parent's path parts
    /// - `None` - If this is a root element (depth <= 1)
    ///
    /// # Example
    ///
    /// ```
    /// use rh_foundation::snapshot::ElementPath;
    ///
    /// let path = ElementPath::new("Patient.name.given");
    /// let parent_parts = path.parent().unwrap();
    /// assert_eq!(parent_parts, &["Patient", "name"]);
    ///
    /// // Convert to ElementPath if needed
    /// let parent_path = ElementPath::from_parts(parent_parts.to_vec());
    /// assert_eq!(parent_path.as_str(), "Patient.name");
    /// ```
    pub fn parent(&self) -> Option<&[String]> {
        if self.parts.len() <= 1 {
            return None;
        }

        Some(&self.parts[0..self.parts.len() - 1])
    }

    pub fn matches_choice_type(&self, base_path: &ElementPath) -> bool {
        if self.depth() != base_path.depth() {
            return false;
        }

        for i in 0..self.parts.len() - 1 {
            if self.parts[i] != base_path.parts[i] {
                return false;
            }
        }

        let base_last = base_path.parts.last().unwrap();
        let self_last = self.parts.last().unwrap();

        if base_last.ends_with("[x]") {
            let base_prefix = &base_last[..base_last.len() - 3];
            self_last.starts_with(base_prefix)
        } else {
            false
        }
    }

    fn is_lowercase_start(s: &str) -> bool {
        s.chars().next().is_some_and(|c| c.is_lowercase())
    }

    pub fn normalize_choice_type(&self) -> ElementPath {
        let mut normalized_parts = self.parts.clone();
        if let Some(last) = normalized_parts.last_mut() {
            if last.len() > 3 && Self::is_lowercase_start(last) {
                for (i, c) in last.char_indices() {
                    if c.is_uppercase() {
                        let prefix = &last[..i];
                        *last = format!("{prefix}[x]");
                        break;
                    }
                }
            }
        }
        Self::from_parts(normalized_parts)
    }

    pub fn is_slice(&self) -> bool {
        self.original.contains(':')
    }

    pub fn slice_name(&self) -> Option<&str> {
        for part in &self.parts {
            if let Some(colon_pos) = part.rfind(':') {
                return Some(&part[colon_pos + 1..]);
            }
        }
        None
    }

    pub fn base_path(&self) -> ElementPath {
        if !self.is_slice() {
            return self.clone();
        }

        let base_parts: Vec<String> = self
            .parts
            .iter()
            .map(|part| {
                if let Some(colon_pos) = part.rfind(':') {
                    part[..colon_pos].to_string()
                } else {
                    part.clone()
                }
            })
            .collect();

        Self::from_parts(base_parts)
    }

    pub fn is_reslice(&self) -> bool {
        if let Some(last_part) = self.parts.last() {
            last_part.matches(':').count() > 1
        } else {
            false
        }
    }

    pub fn parent_slice(&self) -> Option<ElementPath> {
        if !self.is_reslice() {
            return None;
        }

        if let Some(last_part) = self.parts.last() {
            let colon_pos = last_part.rfind(':').unwrap();
            let mut parent_parts = self.parts.clone();
            parent_parts.pop();
            parent_parts.push(last_part[..colon_pos].to_string());
            return Some(Self::from_parts(parent_parts));
        }

        None
    }
}

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

    #[test]
    fn test_path_parsing() {
        let path = ElementPath::new("Patient.name.given");
        assert_eq!(path.parts(), &["Patient", "name", "given"]);
        assert_eq!(path.as_str(), "Patient.name.given");
        assert_eq!(path.depth(), 3);
    }

    #[test]
    fn test_single_part_path() {
        let path = ElementPath::new("Patient");
        assert_eq!(path.parts(), &["Patient"]);
        assert_eq!(path.depth(), 1);
    }

    #[test]
    fn test_is_parent_of() {
        let parent = ElementPath::new("Patient.name");
        let child = ElementPath::new("Patient.name.given");
        let not_child = ElementPath::new("Patient.identifier");

        assert!(parent.is_parent_of(&child));
        assert!(!parent.is_parent_of(&not_child));
        assert!(!parent.is_parent_of(&parent));
    }

    #[test]
    fn test_is_child_of() {
        let parent = ElementPath::new("Patient.name");
        let child = ElementPath::new("Patient.name.given");

        assert!(child.is_child_of(&parent));
        assert!(!parent.is_child_of(&child));
    }

    #[test]
    fn test_is_immediate_child_of() {
        let parent = ElementPath::new("Patient.name");
        let immediate_child = ElementPath::new("Patient.name.given");
        let grandchild = ElementPath::new("Patient.name.given.extension");

        assert!(immediate_child.is_immediate_child_of(&parent));
        assert!(!grandchild.is_immediate_child_of(&parent));
        assert!(!parent.is_immediate_child_of(&immediate_child));
    }

    #[test]
    fn test_parent() {
        let path = ElementPath::new("Patient.name.given");
        let parent_parts = path.parent().unwrap();
        assert_eq!(parent_parts, &["Patient", "name"]);

        let root = ElementPath::new("Patient");
        assert!(root.parent().is_none());
    }

    #[test]
    fn test_matches_choice_type() {
        let base = ElementPath::new("Observation.value[x]");
        let string_variant = ElementPath::new("Observation.valueString");
        let quantity_variant = ElementPath::new("Observation.valueQuantity");
        let codeable_variant = ElementPath::new("Observation.valueCodeableConcept");
        let other = ElementPath::new("Observation.status");

        assert!(string_variant.matches_choice_type(&base));
        assert!(quantity_variant.matches_choice_type(&base));
        assert!(codeable_variant.matches_choice_type(&base));
        assert!(!other.matches_choice_type(&base));
    }

    #[test]
    fn test_normalize_choice_type() {
        let string_path = ElementPath::new("Observation.valueString");
        let normalized = string_path.normalize_choice_type();
        assert_eq!(normalized.as_str(), "Observation.value[x]");

        let quantity_path = ElementPath::new("Observation.valueQuantity");
        let normalized = quantity_path.normalize_choice_type();
        assert_eq!(normalized.as_str(), "Observation.value[x]");

        let codeable_path = ElementPath::new("Observation.valueCodeableConcept");
        let normalized = codeable_path.normalize_choice_type();
        assert_eq!(normalized.as_str(), "Observation.value[x]");
    }

    #[test]
    fn test_normalize_non_choice_type() {
        let normal_path = ElementPath::new("Patient.name");
        let normalized = normal_path.normalize_choice_type();
        assert_eq!(normalized.as_str(), "Patient.name");
    }

    #[test]
    fn test_multi_level_parent_child() {
        let root = ElementPath::new("Patient");
        let level1 = ElementPath::new("Patient.name");
        let level2 = ElementPath::new("Patient.name.given");
        let level3 = ElementPath::new("Patient.name.given.extension");

        assert!(root.is_parent_of(&level1));
        assert!(root.is_parent_of(&level2));
        assert!(root.is_parent_of(&level3));

        assert!(level1.is_parent_of(&level2));
        assert!(level1.is_parent_of(&level3));

        assert!(level2.is_parent_of(&level3));
    }

    #[test]
    fn test_parent_chain() {
        let path = ElementPath::new("Patient.name.given.extension");

        // Test single parent access
        let parent1 = path.parent().unwrap();
        assert_eq!(parent1, &["Patient", "name", "given"]);

        // For chaining, convert back to ElementPath
        let parent1_path = ElementPath::from_parts(parent1.to_vec());
        let parent2 = parent1_path.parent().unwrap();
        assert_eq!(parent2, &["Patient", "name"]);

        let parent2_path = ElementPath::from_parts(parent2.to_vec());
        let parent3 = parent2_path.parent().unwrap();
        assert_eq!(parent3, &["Patient"]);

        let parent3_path = ElementPath::from_parts(parent3.to_vec());
        assert!(parent3_path.parent().is_none());
    }

    #[test]
    fn test_is_slice() {
        let slice_path = ElementPath::new("Patient.identifier:MRN");
        let normal_path = ElementPath::new("Patient.identifier");

        assert!(slice_path.is_slice());
        assert!(!normal_path.is_slice());
    }

    #[test]
    fn test_slice_name() {
        let slice_path = ElementPath::new("Patient.identifier:MRN");
        assert_eq!(slice_path.slice_name(), Some("MRN"));

        let normal_path = ElementPath::new("Patient.identifier");
        assert_eq!(normal_path.slice_name(), None);

        let nested_slice = ElementPath::new("Patient.identifier:MRN.system");
        assert_eq!(nested_slice.slice_name(), Some("MRN"));
    }

    #[test]
    fn test_base_path() {
        let slice_path = ElementPath::new("Patient.identifier:MRN");
        let base = slice_path.base_path();
        assert_eq!(base.as_str(), "Patient.identifier");

        let normal_path = ElementPath::new("Patient.identifier");
        let base_normal = normal_path.base_path();
        assert_eq!(base_normal.as_str(), "Patient.identifier");
    }

    #[test]
    fn test_is_reslice() {
        let reslice_path = ElementPath::new("Patient.identifier:MRN:subslice");
        let slice_path = ElementPath::new("Patient.identifier:MRN");
        let normal_path = ElementPath::new("Patient.identifier");

        assert!(reslice_path.is_reslice());
        assert!(!slice_path.is_reslice());
        assert!(!normal_path.is_reslice());
    }

    #[test]
    fn test_parent_slice() {
        let reslice_path = ElementPath::new("Patient.identifier:MRN:subslice");
        let parent = reslice_path.parent_slice().unwrap();
        assert_eq!(parent.as_str(), "Patient.identifier:MRN");

        let slice_path = ElementPath::new("Patient.identifier:MRN");
        assert!(slice_path.parent_slice().is_none());
    }

    #[test]
    fn test_slice_with_children() {
        let slice_child = ElementPath::new("Patient.identifier:MRN.system");
        assert!(slice_child.is_slice());
        assert_eq!(slice_child.slice_name(), Some("MRN"));

        let base = slice_child.base_path();
        assert_eq!(base.as_str(), "Patient.identifier.system");
    }

    #[test]
    fn test_is_lowercase_start() {
        assert!(ElementPath::is_lowercase_start("abc"));
        assert!(!ElementPath::is_lowercase_start("Abc"));
        assert!(!ElementPath::is_lowercase_start(""));
        assert!(!ElementPath::is_lowercase_start("123"));
        assert!(!ElementPath::is_lowercase_start("ABC"));
    }

    #[test]
    fn test_normalize_choice_type_minimum_length() {
        // "valA" -> len 4. >3. 'v' is lowercase. 'A' is upper. -> "val[x]"
        let path = ElementPath::new("Observation.valA");
        let normalized = path.normalize_choice_type();
        assert_eq!(normalized.as_str(), "Observation.val[x]");

        // "vaA" -> len 3. Not >3. -> "vaA"
        let short_path = ElementPath::new("Observation.vaA");
        let short_normalized = short_path.normalize_choice_type();
        assert_eq!(short_normalized.as_str(), "Observation.vaA");
    }
}