edtf 0.2.0

EDTF parser
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

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
//
// Copyright © 2021 Corporation for Digital Scholarship

use super::{
    packed::{DMFlags, DMMask, PackedInt, PackedU8},
    *,
};
use crate::common::{MONTH_DAYCOUNT, MONTH_DAYCOUNT_LEAP};

fn days_in_month(y: i32, m: u8) -> u8 {
    let leap = crate::common::is_leap_year(y);
    let lut = if leap {
        MONTH_DAYCOUNT_LEAP
    } else {
        MONTH_DAYCOUNT
    };
    lut[m as usize - 1]
}

/// # Iterators
impl Date {
    pub(super) fn unspec_start(&self, min_level: StepSize) -> Option<Self> {
        self.reify_unspecified(1, |_, _| 1, 1, min_level)
    }
    pub(super) fn unspec_end(&self, min_level: StepSize) -> Option<Self> {
        self.reify_unspecified(12, days_in_month, 31, min_level)
    }
    fn reify_unspecified(
        &self,
        cap_month: u8,
        mday: fn(i32, u8) -> u8,
        cap_day: u8,
        min_level: StepSize,
    ) -> Option<Self> {
        let (y, _) = self.year.unpack();
        let mut new = *self;
        if let Some(month) = self.month {
            let (m, mflags) = month.unpack();
            match self.day {
                Some(day) if min_level <= StepSize::Day => {
                    let (_, dflags) = day.unpack();
                    match (mflags.mask, dflags.mask) {
                        (DMMask::None, DMMask::Unspecified) => {
                            new.day = PackedU8::pack(
                                mday(y, m),
                                DMFlags::new(dflags.certainty, DMMask::None),
                            )
                        }
                        (DMMask::Unspecified, DMMask::Unspecified) => {
                            new.month = PackedU8::pack(
                                cap_month,
                                DMFlags::new(mflags.certainty, DMMask::None),
                            );
                            new.day = PackedU8::pack(
                                cap_day,
                                DMFlags::new(mflags.certainty, DMMask::None),
                            );
                        }
                        _ => {}
                    }
                }
                None if min_level <= StepSize::Month => {
                    if mflags.mask == DMMask::Unspecified {
                        new.month =
                            PackedU8::pack(cap_month, DMFlags::new(mflags.certainty, DMMask::None));
                    }
                }
                // min_level is too high for the date that we have
                // this means e.g. 2021-08-08.iter_possible_months returns None
                _ => return None,
            }
        } else if min_level <= StepSize::Month {
            return None;
        }
        Some(new)
    }

    /// Iterate days that this date could be referring to. Must have day precision.
    ///
    /// For a single fully specified day, this iterates once and stops. For a date with an
    /// unspecified day, this iterates through all the days it could possibly be referring to.
    ///
    /// - `2021-05-17` iterates only one date.
    /// - `2021-05-XX` iterates through all the days in May 2021.
    /// - `2021-XX-XX` iterates through all every day in the entire year 2021.
    ///
    /// For a date without a day component at all, this returns None.
    pub fn iter_possible_days(&self) -> Option<DayIter> {
        let start = self.unspec_start(StepSize::Day)?;
        let end = self.unspec_end(StepSize::Day)?;
        Edtf::Interval(start, end).iter_days()
    }

    /// Starts at this day (or for -XX, the first of the month/year), steps forward by one day forever.
    pub fn iter_forward_days(&self) -> Option<DayIter> {
        let d = self.unspec_start(StepSize::Day)?.complete()?;
        let ymd = (d.year(), d.month(), d.day());
        Some(DayIter(IncrementIter::raw(Some(ymd), None)))
    }

    /// Iterate months that this date could be referring to. Must have month precision.
    ///
    /// For a single fully specified month, this iterates once and stops. For a date with an
    /// unspecified month, this iterates through all the months in that year.
    ///
    /// - `2021-05` iterates only one month.
    /// - `2021-XX` iterates through all the months in 2021.
    ///
    /// For a date with day precision or no month component at all, this returns None.
    pub fn iter_possible_months(&self) -> Option<MonthIter> {
        let start = self.unspec_start(StepSize::Month)?;
        let end = self.unspec_end(StepSize::Month)?;
        Edtf::Interval(start, end).iter_months()
    }

    /// Starts at this specific month (or for unspecified month, January of that year), and steps
    /// forward by month forever.
    pub fn iter_forward_months(&self) -> Option<MonthIter> {
        let start = match self.unspec_start(StepSize::Month)?.precision() {
            Precision::Month(y, m) => (y, m),
            _ => return None,
        };
        Some(MonthIter(IncrementIter::raw(Some(start), None)))
    }
}

#[cfg(test)]
macro_rules! date_iter_test {
    ($d:literal::$ident:ident() $( .take($take:literal) )?, vec![ $($tt:tt)*]) => {
        date_iter_test!($d::$ident()$(.take($take))?, Some(vec![$($tt)*]))
    };
    ($d:literal::$ident:ident().take($take:literal), $vec:expr) => {
        assert_eq!(
            Date::parse($d)
                .unwrap()
                .$ident()
                .map(|x| x.take($take).collect_with(Vec::new())),
            $vec
        )
    };
    ($d:literal::$ident:ident(), $vec:expr) => {
        assert_eq!(
            Date::parse($d)
                .unwrap()
                .$ident()
                // prevent unbounded recurson
                .map(|x| x.take(1000).collect_with(Vec::new())),
            $vec
        )
    };
}

#[test]
fn iter_possible_days() {
    date_iter_test!("2020-08-08"::iter_possible_days(), vec![DateComplete::from_ymd(2020, 8, 8)]);
    let date = Date::parse("2020-08-XX").unwrap();
    let days = date.iter_possible_days().unwrap().collect_with(Vec::new());
    assert_eq!(days.len(), 31);
    assert_eq!(
        days,
        Edtf::parse("2020-08-01/2020-08-31")
            .unwrap()
            .iter_days()
            .unwrap()
            .collect_with(Vec::new())
    );
}

#[test]
fn iter_possible_days_of_year() {
    let date = Date::parse("2020-XX-XX").unwrap();
    let count = date.iter_possible_days().unwrap().count();
    assert_eq!(count, 366);
    date_iter_test!("2020-XX-XX"::iter_possible_days().take(5), vec![
        DateComplete::from_ymd(2020, 1, 1),
        DateComplete::from_ymd(2020, 1, 2),
        DateComplete::from_ymd(2020, 1, 3),
        DateComplete::from_ymd(2020, 1, 4),
        DateComplete::from_ymd(2020, 1, 5),
    ]);
}

#[test]
fn iter_possible_days_of_month() {
    let date = Date::parse("2020-06-XX").unwrap();
    let count = date.iter_possible_days().unwrap().count();
    assert_eq!(count, 30);
    date_iter_test!("2020-05-XX"::iter_possible_days().take(5), vec![
        DateComplete::from_ymd(2020, 5, 1),
        DateComplete::from_ymd(2020, 5, 2),
        DateComplete::from_ymd(2020, 5, 3),
        DateComplete::from_ymd(2020, 5, 4),
        DateComplete::from_ymd(2020, 5, 5),
    ]);
}

#[test]
fn iter_possible_days_nounspec() {
    date_iter_test!("2020"::iter_possible_days(), None);
    date_iter_test!("202X"::iter_possible_days(), None);
    date_iter_test!("20XX"::iter_possible_days(), None);
}

#[test]
fn iter_forward_days() {
    date_iter_test!("2020-08-08"::iter_forward_days().take(5), vec![
        DateComplete::from_ymd(2020, 8, 8),
        DateComplete::from_ymd(2020, 8, 9),
        DateComplete::from_ymd(2020, 8, 10),
        DateComplete::from_ymd(2020, 8, 11),
        DateComplete::from_ymd(2020, 8, 12),
    ]);
}

#[test]
fn iter_possible_months() {
    date_iter_test!("20XX"::iter_possible_months(), None);
    date_iter_test!("202X"::iter_possible_months(), None);
    date_iter_test!("2020"::iter_possible_months(), None);
    date_iter_test!("2020-08-XX"::iter_possible_months(), None);
    date_iter_test!("2020-08-09"::iter_possible_months(), None);
    date_iter_test!("2020-09"::iter_possible_months(), vec![(2020, 09)]);
    date_iter_test!("2020-XX"::iter_possible_months().take(5), vec![
         (2020, 01), (2020, 02), (2020, 03), (2020, 04), (2020, 05)
    ]);
}

#[test]
fn iter_forward_months() {
    date_iter_test!("2020-05"::iter_forward_months().take(3), Some(vec![(2020, 05), (2020, 06), (2020, 07)]));
    date_iter_test!("2020-XX"::iter_forward_months().take(3), Some(vec![(2020, 01), (2020, 02), (2020, 03)]));
}