squeeze-lib 0.5.0

Finders for URLs, emails, IPs, hashes, TODOs, and more in free-form text
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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
use super::{Anchor, ByteSet, Finder, RunClass, RunRule};
use std::ops::Range;

#[derive(Default)]
pub struct Datetime {}

impl Datetime {
    fn try_date(input: &[u8], idx: usize) -> Option<Range<usize>> {
        // YYYY-MM-DD with optional time component
        if idx + 10 > input.len() {
            return None;
        }

        // Boundary before: not preceded by a digit. A preceding '-' is a
        // valid boundary when it is not glued to a digit run, so kebab names
        // like `backup-2024-01-15` match while `01-2024-01-15` stays vetoed.
        if idx > 0 {
            let prev = input[idx - 1];
            if prev.is_ascii_digit() {
                return None;
            }
            if prev == b'-' && idx >= 2 && input[idx - 2].is_ascii_digit() {
                return None;
            }
        }

        // YYYY
        if !Self::is_4_digits(input, idx) {
            return None;
        }
        let year = Self::parse_num(input, idx, 4);
        if !(1000..=9999).contains(&year) {
            return None;
        }

        if input[idx + 4] != b'-' {
            return None;
        }

        // MM
        if !Self::is_2_digits(input, idx + 5) {
            return None;
        }
        let month = Self::parse_num(input, idx + 5, 2);
        if !(1..=12).contains(&month) {
            return None;
        }

        if input[idx + 7] != b'-' {
            return None;
        }

        // DD
        if !Self::is_2_digits(input, idx + 8) {
            return None;
        }
        let day = Self::parse_num(input, idx + 8, 2);
        if !(1..=31).contains(&day) {
            return None;
        }

        let mut end = idx + 10;

        // Optional time component: T/t (RFC 3339) or space followed by HH:MM
        if end < input.len()
            && (input[end] == b'T' || input[end] == b't' || input[end] == b' ')
            && let Some(time_end) = Self::try_time(input, end + 1)
        {
            end = time_end;
        }

        // Boundary after: never followed by a digit. A trailing '-' is only a
        // veto when a digit follows and no timezone consumed it
        // (`2024-01-15-01` stays ambiguous), while `2024-01-15-my-post` is a
        // kebab-case boundary.
        if end < input.len() {
            let next = input[end];
            if next.is_ascii_digit() {
                return None;
            }
            if next == b'-' && end + 1 < input.len() && input[end + 1].is_ascii_digit() {
                return None;
            }
        }

        Some(idx..end)
    }

    fn try_time(input: &[u8], idx: usize) -> Option<usize> {
        // HH:MM[:SS[.fractional]]
        if idx + 5 > input.len() {
            return None;
        }

        if !Self::is_2_digits(input, idx) {
            return None;
        }
        let hour = Self::parse_num(input, idx, 2);
        if hour > 23 {
            return None;
        }

        if input[idx + 2] != b':' {
            return None;
        }

        if !Self::is_2_digits(input, idx + 3) {
            return None;
        }
        let minute = Self::parse_num(input, idx + 3, 2);
        if minute > 59 {
            return None;
        }

        let mut end = idx + 5;

        // Optional :SS
        if end + 3 <= input.len() && input[end] == b':' && Self::is_2_digits(input, end + 1) {
            let second = Self::parse_num(input, end + 1, 2);
            if second <= 60 {
                end += 3;

                // Optional fractional seconds: '.' or the ISO-preferred ','
                // (only consumed when at least one digit follows)
                if end < input.len() && (input[end] == b'.' || input[end] == b',') {
                    let frac_start = end + 1;
                    let mut frac_end = frac_start;
                    while frac_end < input.len() && input[frac_end].is_ascii_digit() {
                        frac_end += 1;
                    }
                    if frac_end > frac_start {
                        end = frac_end;
                    }
                }
            }
        }

        // Optional timezone (only ever after a time component): Z/z,
        // ±HH:MM, ±HHMM, or ±HH.
        if end < input.len() && (input[end] == b'Z' || input[end] == b'z') {
            end += 1;
        } else if end < input.len() && (input[end] == b'+' || input[end] == b'-') {
            // Count the digits directly after the sign (capped: 5 means
            // "5 or more", which is never a valid offset).
            let mut digits = 0;
            while digits < 5
                && end + 1 + digits < input.len()
                && input[end + 1 + digits].is_ascii_digit()
            {
                digits += 1;
            }
            if digits == 2 {
                if end + 6 <= input.len()
                    && input[end + 3] == b':'
                    && Self::is_2_digits(input, end + 4)
                {
                    end += 6; // ±HH:MM
                } else {
                    end += 3; // ±HH
                }
            } else if digits == 4 {
                end += 5; // ±HHMM
            }
            // Any other digit count: leave the sign unconsumed; the
            // boundary check in try_date decides what happens next.
        }

        Some(end)
    }

    fn is_2_digits(input: &[u8], pos: usize) -> bool {
        pos + 2 <= input.len() && input[pos].is_ascii_digit() && input[pos + 1].is_ascii_digit()
    }

    fn is_4_digits(input: &[u8], pos: usize) -> bool {
        pos + 4 <= input.len()
            && input[pos].is_ascii_digit()
            && input[pos + 1].is_ascii_digit()
            && input[pos + 2].is_ascii_digit()
            && input[pos + 3].is_ascii_digit()
    }

    fn parse_num(input: &[u8], pos: usize, len: usize) -> u32 {
        let mut n = 0u32;
        for i in 0..len {
            n = n * 10 + (input[pos + i] - b'0') as u32;
        }
        n
    }
}

impl Finder for Datetime {
    fn line_agnostic(&self) -> bool {
        // Matches never contain a line terminator and `\n`/`\r` end every
        // walk exactly like the end of the input does.
        true
    }

    fn id(&self) -> &'static str {
        "datetime"
    }

    fn dispatchable(&self) -> bool {
        true
    }

    fn could_start_at(&self, byte: u8) -> bool {
        byte.is_ascii_digit()
    }

    fn could_start_after(&self, prev: u8, _cur: u8) -> bool {
        !prev.is_ascii_digit()
    }

    fn could_continue_with(&self, _cur: u8, next: u8) -> bool {
        next.is_ascii_digit()
    }

    fn anchor(&self) -> Option<Anchor> {
        // `YYYY-MM-DD`: the dash after the month follows three bytes on.
        Some(
            Anchor::new(
                ByteSet::from_bytes(b"-"),
                ByteSet::from_fn(|b| b.is_ascii_digit()),
            )
            .confirm(b"-", &[3], b"-")
            .back(4),
        )
    }

    fn run_rules(&self) -> Vec<RunRule> {
        // `YYYY-MM-`.
        vec![
            RunRule::new(RunClass::Digit, 4, 4)
                .followed_by(b"-")
                .then(RunClass::Digit, 2, 2)
                .followed_by(b"-"),
        ]
    }

    fn try_at(&self, input: &[u8], pos: usize) -> Option<Range<usize>> {
        if !input[pos].is_ascii_digit() {
            return None;
        }
        Self::try_date(input, pos)
    }

    fn find(&self, s: &str) -> Option<Range<usize>> {
        let input = s.as_bytes();
        let mut idx = 0;

        while idx + 10 <= input.len() {
            if input[idx].is_ascii_digit()
                && let Some(range) = Self::try_date(input, idx)
            {
                return Some(range);
            }
            idx += 1;
        }

        None
    }
}

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

    #[test]
    fn id_should_return_datetime() {
        let finder = Datetime::default();
        assert_eq!("datetime", finder.id());
    }

    #[test]
    fn find_should_extract_date() {
        let finder = Datetime::default();
        let input = "created on 2024-01-15 by admin";
        let range = finder.find(input).unwrap();
        assert_eq!("2024-01-15", &input[range]);
    }

    #[test]
    fn find_should_extract_datetime_with_t() {
        let finder = Datetime::default();
        let input = "timestamp: 2024-01-15T10:30:00";
        let range = finder.find(input).unwrap();
        assert_eq!("2024-01-15T10:30:00", &input[range]);
    }

    #[test]
    fn find_should_extract_datetime_with_timezone_z() {
        let finder = Datetime::default();
        let input = "2024-01-15T10:30:00Z";
        let range = finder.find(input).unwrap();
        assert_eq!("2024-01-15T10:30:00Z", &input[range]);
    }

    #[test]
    fn find_should_extract_datetime_with_timezone_offset() {
        let finder = Datetime::default();
        let input = "2024-01-15T10:30:00+05:30";
        let range = finder.find(input).unwrap();
        assert_eq!("2024-01-15T10:30:00+05:30", &input[range]);
    }

    #[test]
    fn find_should_extract_datetime_with_negative_offset() {
        let finder = Datetime::default();
        let input = "2024-01-15T10:30:00-08:00";
        let range = finder.find(input).unwrap();
        assert_eq!("2024-01-15T10:30:00-08:00", &input[range]);
    }

    #[test]
    fn find_should_extract_datetime_with_fractional_seconds() {
        let finder = Datetime::default();
        let input = "2024-01-15T10:30:00.123Z";
        let range = finder.find(input).unwrap();
        assert_eq!("2024-01-15T10:30:00.123Z", &input[range]);
    }

    #[test]
    fn find_should_extract_datetime_with_fractional_and_offset() {
        let finder = Datetime::default();
        let input = "2024-01-15T10:30:00.123456+02:00";
        let range = finder.find(input).unwrap();
        assert_eq!("2024-01-15T10:30:00.123456+02:00", &input[range]);
    }

    #[test]
    fn find_should_extract_datetime_without_seconds() {
        let finder = Datetime::default();
        let input = "2024-01-15T10:30Z";
        let range = finder.find(input).unwrap();
        assert_eq!("2024-01-15T10:30Z", &input[range]);
    }

    #[test]
    fn find_should_extract_date_in_text() {
        let finder = Datetime::default();
        let input = "deployed on 2024-12-25 successfully";
        let range = finder.find(input).unwrap();
        assert_eq!("2024-12-25", &input[range]);
    }

    #[test]
    fn find_should_reject_invalid_month() {
        let finder = Datetime::default();
        assert!(finder.find("2024-13-01").is_none());
    }

    #[test]
    fn find_should_reject_invalid_day() {
        let finder = Datetime::default();
        assert!(finder.find("2024-01-32").is_none());
    }

    #[test]
    fn find_should_reject_month_zero() {
        let finder = Datetime::default();
        assert!(finder.find("2024-00-15").is_none());
    }

    #[test]
    fn find_should_reject_day_zero() {
        let finder = Datetime::default();
        assert!(finder.find("2024-01-00").is_none());
    }

    #[test]
    fn find_should_reject_preceded_by_digit() {
        let finder = Datetime::default();
        assert!(finder.find("x12024-01-15").is_none());
    }

    #[test]
    fn find_should_reject_followed_by_digit() {
        let finder = Datetime::default();
        assert!(finder.find("2024-01-155").is_none());
    }

    #[test]
    fn find_should_handle_empty_input() {
        let finder = Datetime::default();
        assert!(finder.find("").is_none());
    }

    #[test]
    fn find_should_extract_multiple_datetimes_iteratively() {
        let finder = Datetime::default();
        let input = "2024-01-15T10:00:00Z to 2024-01-16T12:00:00Z";

        let mut results = Vec::new();
        let mut idx = 0;
        while idx < input.len() {
            if let Some(range) = finder.find(&input[idx..]) {
                results.push(&input[idx + range.start..idx + range.end]);
                idx += range.end;
            } else {
                break;
            }
        }

        assert_eq!(
            vec!["2024-01-15T10:00:00Z", "2024-01-16T12:00:00Z"],
            results
        );
    }

    #[test]
    fn find_should_extract_date_at_start() {
        let finder = Datetime::default();
        let input = "2024-01-15 is the date";
        let range = finder.find(input).unwrap();
        assert_eq!("2024-01-15", &input[range]);
    }

    #[test]
    fn find_should_extract_date_at_end() {
        let finder = Datetime::default();
        let input = "the date is 2024-01-15";
        let range = finder.find(input).unwrap();
        assert_eq!("2024-01-15", &input[range]);
    }

    #[test]
    fn find_should_reject_invalid_hour() {
        let finder = Datetime::default();
        let input = "2024-01-15T25:00:00";
        let range = finder.find(input).unwrap();
        assert_eq!("2024-01-15", &input[range]);
    }

    #[test]
    fn find_should_reject_invalid_minute() {
        let finder = Datetime::default();
        let input = "2024-01-15T10:61:00";
        let range = finder.find(input).unwrap();
        assert_eq!("2024-01-15", &input[range]);
    }

    #[test]
    fn find_should_extract_datetime_with_space_separator() {
        let finder = Datetime::default();
        let input = "log: 2024-01-15 10:30:00";
        let range = finder.find(input).unwrap();
        assert_eq!("2024-01-15 10:30:00", &input[range]);
    }

    #[test]
    fn try_at_date_at_start() {
        let finder = Datetime::default();
        let input = b"2024-01-15 rest";
        assert_eq!(finder.try_at(input, 0), Some(0..10));
    }

    #[test]
    fn try_at_non_digit() {
        let finder = Datetime::default();
        let input = b"abc";
        assert!(finder.try_at(input, 0).is_none());
    }

    #[test]
    fn try_at_short_input() {
        let finder = Datetime::default();
        let input = b"2024";
        assert!(finder.try_at(input, 0).is_none());
    }

    #[test]
    fn try_at_preceded_by_digit() {
        let finder = Datetime::default();
        let input = b"12024-01-15";
        assert!(finder.try_at(input, 1).is_none());
    }

    #[test]
    fn find_boundary_year_1000() {
        let finder = Datetime::default();
        let input = "1000-01-01";
        assert!(finder.find(input).is_some());
    }

    #[test]
    fn find_boundary_year_9999() {
        let finder = Datetime::default();
        let input = "9999-12-31";
        assert!(finder.find(input).is_some());
    }

    #[test]
    fn find_leap_second() {
        let finder = Datetime::default();
        let input = "2024-06-30T23:59:60Z";
        let range = finder.find(input).unwrap();
        assert_eq!("2024-06-30T23:59:60Z", &input[range]);
    }

    #[test]
    fn find_fractional_seconds_many_digits() {
        let finder = Datetime::default();
        let input = "2024-01-15T10:30:00.123456789Z";
        let range = finder.find(input).unwrap();
        assert_eq!("2024-01-15T10:30:00.123456789Z", &input[range]);
    }

    #[test]
    fn find_single_digit_input() {
        let finder = Datetime::default();
        assert!(finder.find("1").is_none());
    }
}