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
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
use std::borrow::Cow;
use std::cmp::max;
use std::fmt;
use std::ops::{Add, Sub};
use std::time::{Duration, SystemTime};

use std::convert::TryInto;

/// Indicates the time of the period in relation to the time of the utterance
#[derive(Clone, Copy, Debug, Hash, PartialEq, PartialOrd)]
pub enum Tense {
    Past,
    Present,
    Future,
}

/// The accuracy of the representation
#[derive(Clone, Copy, Debug, Hash, PartialEq, PartialOrd)]
pub enum Accuracy {
    /// Rough approximation, easy to grasp, but not necessarily accurate
    Rough,
    /// Concise expression, accurate, but not necessarily easy to grasp
    Precise,
}

impl Accuracy {
    /// Returns whether this accuracy is precise
    #[must_use]
    pub fn is_precise(self) -> bool {
        self == Self::Precise
    }

    /// Returns whether this accuracy is rough
    #[must_use]
    pub fn is_rough(self) -> bool {
        self == Self::Rough
    }
}

// Number of seconds in various time periods
const S_MINUTE: u64 = 60;
const S_HOUR: u64 = S_MINUTE * 60;
const S_DAY: u64 = S_HOUR * 24;
const S_WEEK: u64 = S_DAY * 7;
const S_MONTH: u64 = S_DAY * 30;
const S_YEAR: u64 = S_DAY * 365;

#[derive(Clone, Copy, Debug)]
enum TimePeriod {
    Now,
    Nanos(u64),
    Micros(u64),
    Millis(u64),
    Seconds(u64),
    Minutes(u64),
    Hours(u64),
    Days(u64),
    Weeks(u64),
    Months(u64),
    Years(u64),
    Eternity,
}

impl TimePeriod {
    fn to_text_precise(self) -> Cow<'static, str> {
        match self {
            Self::Now => "now".into(),
            Self::Nanos(n) => format!("{} ns", n).into(),
            Self::Micros(n) => format!("{} µs", n).into(),
            Self::Millis(n) => format!("{} ms", n).into(),
            Self::Seconds(1) => "1 second".into(),
            Self::Seconds(n) => format!("{} seconds", n).into(),
            Self::Minutes(1) => "1 minute".into(),
            Self::Minutes(n) => format!("{} minutes", n).into(),
            Self::Hours(1) => "1 hour".into(),
            Self::Hours(n) => format!("{} hours", n).into(),
            Self::Days(1) => "1 day".into(),
            Self::Days(n) => format!("{} days", n).into(),
            Self::Weeks(1) => "1 week".into(),
            Self::Weeks(n) => format!("{} weeks", n).into(),
            Self::Months(1) => "1 month".into(),
            Self::Months(n) => format!("{} months", n).into(),
            Self::Years(1) => "1 year".into(),
            Self::Years(n) => format!("{} years", n).into(),
            Self::Eternity => "eternity".into(),
        }
    }

    fn to_text_rough(self) -> Cow<'static, str> {
        match self {
            Self::Now => "now".into(),
            Self::Nanos(n) => format!("{} ns", n).into(),
            Self::Micros(n) => format!("{} µs", n).into(),
            Self::Millis(n) => format!("{} ms", n).into(),
            Self::Seconds(n) => format!("{} seconds", n).into(),
            Self::Minutes(1) => "a minute".into(),
            Self::Minutes(n) => format!("{} minutes", n).into(),
            Self::Hours(1) => "an hour".into(),
            Self::Hours(n) => format!("{} hours", n).into(),
            Self::Days(1) => "a day".into(),
            Self::Days(n) => format!("{} days", n).into(),
            Self::Weeks(1) => "a week".into(),
            Self::Weeks(n) => format!("{} weeks", n).into(),
            Self::Months(1) => "a month".into(),
            Self::Months(n) => format!("{} months", n).into(),
            Self::Years(1) => "a year".into(),
            Self::Years(n) => format!("{} years", n).into(),
            Self::Eternity => "eternity".into(),
        }
    }

    fn to_text(self, accuracy: Accuracy) -> Cow<'static, str> {
        match accuracy {
            Accuracy::Rough => self.to_text_rough(),
            Accuracy::Precise => self.to_text_precise(),
        }
    }
}

/// `Duration` wrapper that helps expressing the duration in human languages
#[derive(Clone, Copy, Debug, PartialEq, PartialOrd)]
pub struct HumanTime {
    duration: Duration,
    is_positive: bool,
}

// /// Trait to instantiate `HumanTime` for different time metrics
// trait FromTime {
//     fn from_seconds(seconds: i64) -> HumanTime;
//     fn from_minutes(minutes: i64) -> HumanTime;
//     fn from_hours(hours: i64) -> HumanTime;
//     fn from_days(days: i64) -> HumanTime;
//     fn from_weeks(weeks: i64) -> HumanTime;
//     fn from_months(months: i64) -> HumanTime;
//     fn from_years(years: i64) -> HumanTime;
// }

impl HumanTime {
    const DAYS_IN_MONTH: u64 = 30;

    /// Create `HumanTime` object that corresponds to the current point in time.
    ///. Similar to `chrono::Utc::now()`
    pub fn now() -> Self {
        Self {
            duration: Duration::new(0, 0),
            is_positive: true,
        }
    }

    /// Gives English text representation of the `HumanTime` with given `accuracy` and 'tense`
    #[must_use]
    pub fn to_text_en(self, accuracy: Accuracy, tense: Tense) -> String {
        let mut periods = match accuracy {
            Accuracy::Rough => self.rough_period(),
            Accuracy::Precise => self.precise_period(),
        };

        let first = periods.remove(0).to_text(accuracy);
        let last = periods.pop().map(|last| last.to_text(accuracy));

        let mut text = periods.into_iter().fold(first, |acc, p| {
            format!("{}, {}", acc, p.to_text(accuracy)).into()
        });

        if let Some(last) = last {
            text = format!("{} and {}", text, last).into();
        }

        match tense {
            Tense::Past => format!("{} ago", text),
            Tense::Future => format!("in {}", text),
            Tense::Present => text.into_owned(),
        }
    }

    /// Return `HumanTime` for given seconds from epoch
    pub fn duration_since_timestamp(timestamp: u64) -> HumanTime {
        let since_epoch_duration = SystemTime::now()
            .duration_since(SystemTime::UNIX_EPOCH)
            .unwrap();

        let ts = Duration::from_secs(timestamp);

        let duration = ts - since_epoch_duration;

        // Can something happen when casting from unsigned to signed?
        let duration = duration.as_secs() as i64;

        // Cause we calculate since a timestamp till today, we negate the duration
        HumanTime::from(-duration)
    }

    fn tense(self, accuracy: Accuracy) -> Tense {
        match self.duration.as_secs() {
            0..=10 if accuracy.is_rough() => Tense::Present,
            _ if !self.is_positive => Tense::Past,
            _ if self.is_positive => Tense::Future,
            _ => Tense::Present,
        }
    }

    fn rough_period(self) -> Vec<TimePeriod> {
        let period = match self.duration.as_secs() {
            n if n > 547 * S_DAY => TimePeriod::Years(max(n / S_YEAR, 2)),
            n if n > 345 * S_DAY => TimePeriod::Years(1),
            n if n > 45 * S_DAY => TimePeriod::Months(max(n / S_MONTH, 2)),
            n if n > 29 * S_DAY => TimePeriod::Months(1),
            n if n > 10 * S_DAY + 12 * S_HOUR => TimePeriod::Weeks(max(n / S_WEEK, 2)),
            n if n > 6 * S_DAY + 12 * S_HOUR => TimePeriod::Weeks(1),
            n if n > 36 * S_HOUR => TimePeriod::Days(max(n / S_DAY, 2)),
            n if n > 22 * S_HOUR => TimePeriod::Days(1),
            n if n > 90 * S_MINUTE => TimePeriod::Hours(max(n / S_HOUR, 2)),
            n if n > 45 * S_MINUTE => TimePeriod::Hours(1),
            n if n > 90 => TimePeriod::Minutes(max(n / S_MINUTE, 2)),
            n if n > 45 => TimePeriod::Minutes(1),
            n if n > 10 => TimePeriod::Seconds(n),
            0..=10 => TimePeriod::Now,
            _ => TimePeriod::Eternity,
        };

        vec![period]
    }

    fn precise_period(self) -> Vec<TimePeriod> {
        let mut periods = vec![];

        let (years, reminder) = self.split_years();
        if let Some(years) = years {
            periods.push(TimePeriod::Years(years));
        }

        let (months, reminder) = reminder.split_months();
        if let Some(months) = months {
            periods.push(TimePeriod::Months(months));
        }

        let (weeks, reminder) = reminder.split_weeks();
        if let Some(weeks) = weeks {
            periods.push(TimePeriod::Weeks(weeks));
        }

        let (days, reminder) = reminder.split_days();
        if let Some(days) = days {
            periods.push(TimePeriod::Days(days));
        }

        let (hours, reminder) = reminder.split_hours();
        if let Some(hours) = hours {
            periods.push(TimePeriod::Hours(hours));
        }

        let (minutes, reminder) = reminder.split_minutes();
        if let Some(minutes) = minutes {
            periods.push(TimePeriod::Minutes(minutes));
        }

        let (seconds, reminder) = reminder.split_seconds();
        if let Some(seconds) = seconds {
            periods.push(TimePeriod::Seconds(seconds));
        }

        let (millis, reminder) = reminder.split_milliseconds();
        if let Some(millis) = millis {
            periods.push(TimePeriod::Millis(millis));
        }

        let (micros, reminder) = reminder.split_microseconds();
        if let Some(micros) = micros {
            periods.push(TimePeriod::Micros(micros));
        }

        let (nanos, reminder) = reminder.split_nanoseconds();
        if let Some(nanos) = nanos {
            periods.push(TimePeriod::Nanos(nanos));
        }

        debug_assert!(reminder.is_zero());

        if periods.is_empty() {
            periods.push(TimePeriod::Seconds(0));
        }

        periods
    }

    /// Split this `HumanTime` into number of whole years and the reminder
    fn split_years(self) -> (Option<u64>, Self) {
        let years = self.duration.as_secs() / S_YEAR;
        let reminder = self.duration - Duration::new(years * S_YEAR, 0);
        Self::normalize_split(years, reminder)
    }

    /// Split this `HumanTime` into number of whole months and the reminder
    fn split_months(self) -> (Option<u64>, Self) {
        let months = self.duration.as_secs() / S_MONTH;
        let reminder = self.duration - Duration::new(months * Self::DAYS_IN_MONTH, 0);
        Self::normalize_split(months, reminder)
    }

    /// Split this `HumanTime` into number of whole weeks and the reminder
    fn split_weeks(self) -> (Option<u64>, Self) {
        let weeks = self.duration.as_secs() / S_WEEK;
        let reminder = self.duration - Duration::new(weeks * S_WEEK, 0);
        Self::normalize_split(weeks, reminder)
    }

    /// Split this `HumanTime` into number of whole days and the reminder
    fn split_days(self) -> (Option<u64>, Self) {
        let days = self.duration.as_secs() / S_DAY;
        let reminder = self.duration - Duration::new(days * S_DAY, 0);
        Self::normalize_split(days, reminder)
    }

    /// Split this `HumanTime` into number of whole hours and the reminder
    fn split_hours(self) -> (Option<u64>, Self) {
        let hours = self.duration.as_secs() / S_HOUR;
        let reminder = self.duration - Duration::new(hours * S_HOUR, 0);
        Self::normalize_split(hours, reminder)
    }

    /// Split this `HumanTime` into number of whole minutes and the reminder
    fn split_minutes(self) -> (Option<u64>, Self) {
        let minutes = self.duration.as_secs() / S_MINUTE;
        let reminder = self.duration - Duration::new(minutes * S_MINUTE, 0);
        Self::normalize_split(minutes, reminder)
    }

    /// Split this `HumanTime` into number of whole seconds and the reminder
    fn split_seconds(self) -> (Option<u64>, Self) {
        let seconds = self.duration.as_secs();
        let reminder = self.duration - Duration::new(seconds, 0);
        Self::normalize_split(seconds, reminder)
    }

    /// Split this `HumanTime` into number of whole milliseconds and the reminder
    fn split_milliseconds(self) -> (Option<u64>, Self) {
        let millis = self.duration.as_millis();
        // We can safely convert u128 to u64, because we got it from the same value
        let reminder = self.duration - Duration::from_millis(millis.try_into().unwrap());
        Self::normalize_split(millis.try_into().unwrap(), reminder)
    }

    /// Split this `HumanTime` into number of whole seconds and the reminder
    fn split_microseconds(self) -> (Option<u64>, Self) {
        let micros = self.duration.as_micros();
        let reminder = self.duration - Duration::from_micros(micros.try_into().unwrap());
        Self::normalize_split(micros.try_into().unwrap(), reminder)
    }

    /// Split this `HumanTime` into number of whole seconds and the reminder
    fn split_nanoseconds(self) -> (Option<u64>, Self) {
        let nanos = self.duration.as_nanos();
        let reminder = self.duration - Duration::from_nanos(nanos.try_into().unwrap());
        Self::normalize_split(nanos.try_into().unwrap(), reminder)
    }

    fn normalize_split(wholes: u64, reminder: Duration) -> (Option<u64>, Self) {
        let whole = match wholes == 0 {
            true => None,
            false => Some(wholes),
        };

        (
            whole,
            Self {
                duration: reminder,
                is_positive: true,
            },
        )
    }

    /// Check if `HumanTime` duration is zero
    pub fn is_zero(self) -> bool {
        self.duration.is_zero()
    }

    /// Return a string represenation for a given `Accuracy`
    fn locale_en(&self, accuracy: Accuracy) -> String {
        let tense = self.tense(accuracy);
        self.to_text_en(accuracy, tense)
    }

    /// Return duration as seconds, can be negative
    fn as_secs(&self) -> i64 {
        if self.is_positive {
            self.duration.as_secs() as i64
        } else {
            -(self.duration.as_secs() as i64)
        }
    }
}

/// Instantiate `HumanTime` from different time metrics
impl HumanTime {
    /// Instantiate `HumanTime` for given seconds
    pub fn from_seconds(seconds: i64) -> HumanTime {
        HumanTime::from(seconds)
    }

    /// Instantiate `HumanTime` for given minutes
    pub fn from_minutes(minutes: i64) -> HumanTime {
        HumanTime::from(minutes * S_MINUTE as i64)
    }

    /// Instantiate `HumanTime` for given hours
    pub fn from_hours(hours: i64) -> HumanTime {
        HumanTime::from(hours * S_HOUR as i64)
    }

    /// Instantiate `HumanTime` for given days
    pub fn from_days(days: i64) -> HumanTime {
        HumanTime::from(days * S_DAY as i64)
    }

    /// Instantiate `HumanTime` for given weeks
    pub fn from_weeks(weeks: i64) -> HumanTime {
        HumanTime::from(weeks * S_WEEK as i64)
    }

    /// Instantiate `HumanTime` for given months
    pub fn from_months(months: i64) -> HumanTime {
        HumanTime::from(months * S_MONTH as i64)
    }

    /// Instantiate `HumanTime` for given years
    pub fn from_years(years: i64) -> HumanTime {
        HumanTime::from(years * S_YEAR as i64)
    }
}

impl fmt::Display for HumanTime {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let accuracy = if f.alternate() {
            Accuracy::Precise
        } else {
            Accuracy::Rough
        };

        f.pad(&self.locale_en(accuracy))
    }
}

impl From<Duration> for HumanTime {
    /// Create `HumanTime` from `Duration`
    fn from(duration: Duration) -> Self {
        Self {
            duration,
            is_positive: true,
        }
    }
}

impl Add for HumanTime {
    type Output = Self;

    fn add(self, rhs: Self) -> Self {
        HumanTime::from(self.as_secs() + rhs.as_secs())
    }
}

impl Sub for HumanTime {
    type Output = Self;

    fn sub(self, rhs: Self) -> Self {
        HumanTime::from(self.as_secs() - rhs.as_secs())
    }
}

// TODO: From SystemTime?

impl From<i64> for HumanTime {
    /// Performs conversion from `i64` to `HumanTime`, from seconds.
    fn from(duration_in_sec: i64) -> Self {
        Self {
            duration: Duration::from_secs(duration_in_sec.unsigned_abs()),
            is_positive: duration_in_sec >= 0,
        }
    }
}

/// Display `Duration` as human readable time
pub trait Humanize {
    fn humanize(&self) -> String;
}

impl Humanize for Duration {
    fn humanize(&self) -> String {
        format!("{}", HumanTime::from(*self))
    }
}

#[cfg(test)]
mod tests {

    use super::*;

    #[test]
    fn test_add_human_time() {
        let ht1 = HumanTime::from_seconds(30);
        let ht2 = HumanTime::from_seconds(30);

        let result = ht1 + ht2;
        assert_eq!(result.duration.as_secs(), 60);
        assert!(result.is_positive);
    }

    #[test]
    fn test_add_human_time_neg() {
        let ht1 = HumanTime::from_seconds(30);
        let ht2 = HumanTime::from_seconds(-40);

        let result = ht1 + ht2;
        assert_eq!(result.duration.as_secs(), 10);
        assert!(!result.is_positive);
    }

    #[test]
    fn test_sub_human_time() {
        let ht1 = HumanTime::from_seconds(30);
        let ht2 = HumanTime::from_seconds(30);

        let result = ht1 - ht2;
        assert_eq!(result.duration.as_secs(), 0);
        assert!(result.is_positive);
    }

    #[test]
    fn test_sub_human_time_neg() {
        let ht1 = HumanTime::from_seconds(30);
        let ht2 = HumanTime::from_seconds(-40);

        let result = ht1 + ht2;
        assert_eq!(result.duration.as_secs(), 10);
        assert!(!result.is_positive);
    }
}