icu_experimental 0.5.0

ICU4X pre-release components under active development; all code in this crate is unstable.
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

// This file is part of ICU4X. For terms of use, please see the file
// called LICENSE at the top level of the ICU4X source tree
// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).

use crate::personnames::api::{NameField, NameFieldKind};

/// Returns a remapped field for missing surname.
/// <https://www.unicode.org/reports/tr35/tr35-personNames.html#handle-missing-surname>
pub fn derive_missing_surname(
    available_name_field: &[NameField],
    requested_name_field: NameField,
    requires_given_name: bool,
) -> Option<NameField> {
    match requested_name_field.kind {
        NameFieldKind::Surname | NameFieldKind::Given => {
            let has_surname = available_name_field
                .iter()
                .any(|&field| field.kind == NameFieldKind::Surname);
            if !has_surname && !requires_given_name {
                if requested_name_field.kind == NameFieldKind::Surname {
                    return Some(NameField {
                        kind: NameFieldKind::Given,
                        modifier: requested_name_field.modifier,
                    });
                }
                return None;
            }
            Some(requested_name_field)
        }
        _ => Some(requested_name_field),
    }
}

#[cfg(test)]
mod tests {
    use NameFieldKind::{Given, Surname};

    use crate::personnames::api::{NameField, NameFieldKind};

    #[test]
    fn test_given_name_unused_no_surname_available_should_be_none_for_given() {
        let requested_name_field = NameField {
            kind: Given,
            modifier: Default::default(),
        };
        let available_name_field = &[NameField {
            kind: Given,
            modifier: Default::default(),
        }];
        let result =
            super::derive_missing_surname(available_name_field, requested_name_field, false);

        assert_eq!(result, None)
    }

    #[test]
    fn test_given_name_unused_no_surname_available_should_be_some_for_surname_and_swapped() {
        let requested_name_field = NameField {
            kind: Surname,
            modifier: Default::default(),
        };
        let available_name_field = &[NameField {
            kind: Given,
            modifier: Default::default(),
        }];
        let result =
            super::derive_missing_surname(available_name_field, requested_name_field, false);

        assert_eq!(
            result,
            Some(NameField {
                kind: Given,
                modifier: Default::default(),
            })
        )
    }

    #[test]
    fn test_given_name_used_no_surname_available_should_be_some() {
        let requested_name_field = NameField {
            kind: Given,
            modifier: Default::default(),
        };
        let available_name_field = &[NameField {
            kind: Given,
            modifier: Default::default(),
        }];
        let result =
            super::derive_missing_surname(available_name_field, requested_name_field, true);

        assert_eq!(
            result,
            Some(NameField {
                kind: Given,
                modifier: Default::default(),
            })
        )
    }

    #[test]
    fn test_given_name_used_surname_available_should_be_some() {
        let requested_name_field = NameField {
            kind: Given,
            modifier: Default::default(),
        };
        let available_name_field = &[
            NameField {
                kind: Given,
                modifier: Default::default(),
            },
            NameField {
                kind: Surname,
                modifier: Default::default(),
            },
        ];
        let result =
            super::derive_missing_surname(available_name_field, requested_name_field, true);

        assert_eq!(
            result,
            Some(NameField {
                kind: Given,
                modifier: Default::default(),
            })
        )
    }

    #[test]
    fn test_given_name_unused_surname_available_should_be_some() {
        let requested_name_field = NameField {
            kind: Given,
            modifier: Default::default(),
        };
        let available_name_field = &[
            NameField {
                kind: Given,
                modifier: Default::default(),
            },
            NameField {
                kind: Surname,
                modifier: Default::default(),
            },
        ];
        let result =
            super::derive_missing_surname(available_name_field, requested_name_field, false);

        assert_eq!(
            result,
            Some(NameField {
                kind: Given,
                modifier: Default::default(),
            })
        )
    }
}