tests/testthat/test-helpers-datetime.R

In basetable: Fast and Memory-Efficient Base R Table Manipulation

# ---- datetime helpers ------------------------------------------------------

test_that("date component extractors match base R", {
  d <- as.Date(c("2024-03-15", "2024-12-31"))

  expect_equal(year(d), c(2024L, 2024L))
  expect_equal(month(d), c(3L, 12L))
  expect_equal(day(d), c(15L, 31L))
  expect_equal(weekday(d), weekdays(d))
  expect_equal(yearday(d), as.integer(format(d, "%j")))
  expect_equal(week(d), as.integer(format(d, "%U")))
  expect_equal(quarter(d), c(1L, 4L))
})

test_that("time component extractors work on POSIXct", {
  t <- as.POSIXct("2024-03-15 08:30:45", tz = "UTC")

  expect_equal(hour(t), 8L)
  expect_equal(minute(t), 30L)
  expect_equal(second(t), 45L)
})

test_that("adddays/addweeks shift dates by the expected amount", {
  d <- as.Date("2024-01-01")

  expect_equal(adddays(d, 10), as.Date("2024-01-11"))
  expect_equal(addweeks(d, 2), as.Date("2024-01-15"))
  expect_equal(adddays(d, -1), as.Date("2023-12-31"))
})

test_that("dateseq builds a sequence between two dates", {
  out <- dateseq(as.Date("2024-01-01"), as.Date("2024-01-05"))
  expect_equal(out, seq.Date(as.Date("2024-01-01"), as.Date("2024-01-05"), by = "day"))

  out_len <- dateseq(as.Date("2024-01-01"), as.Date("2024-02-01"), length.out = 5)
  expect_equal(length(out_len), 5L)
})

test_that("betweendates is inclusive on both ends", {
  x <- as.Date(c("2024-01-01", "2024-01-05", "2024-01-10", "2024-01-15"))
  out <- betweendates(x, "2024-01-05", "2024-01-10")

  expect_equal(out, c(FALSE, TRUE, TRUE, FALSE))
})

# ---- date helper regressions -----------------------------------------------

test_that("floordate/ceilingdate/rounddate actually round instead of no-op", {
  d <- as.Date(c("2024-03-15", "2024-01-31"))

  expect_equal(floordate(d, "month"), as.Date(c("2024-03-01", "2024-01-01")))
  expect_equal(floordate(d, "year"), as.Date(c("2024-01-01", "2024-01-01")))
  expect_equal(floordate(as.Date("2024-03-15"), "week"), as.Date("2024-03-11"))

  expect_equal(ceilingdate(d, "month"), as.Date(c("2024-04-01", "2024-02-01")))
  expect_equal(ceilingdate(as.Date("2024-03-15"), "year"), as.Date("2025-01-01"))

  expect_equal(rounddate(as.Date("2024-03-20"), "month"), as.Date("2024-04-01"))
  expect_equal(rounddate(as.Date("2024-03-10"), "month"), as.Date("2024-03-01"))
})

test_that("addmonths/addyears are vectorized and honor invalid=", {
  out <- addmonths(as.Date(c("2024-01-15", "2024-02-15")), 1)
  expect_equal(out, as.Date(c("2024-02-15", "2024-03-15")))

  expect_equal(addmonths(as.Date("2024-01-31"), 1, invalid = "previous"), as.Date("2024-02-29"))
  expect_equal(addmonths(as.Date("2024-01-31"), 1, invalid = "next"), as.Date("2024-03-02"))
  expect_equal(addmonths(as.Date("2024-01-31"), 1, invalid = "missing"), as.Date(NA))
  expect_error(addmonths(as.Date("2024-01-31"), 1, invalid = "error"), "invalid date")

  expect_equal(addyears(as.Date("2024-02-29"), 1, invalid = "previous"), as.Date("2025-02-28"))
})

test_that("datediff honors the units argument", {
  x <- as.Date("2024-01-03")
  y <- as.Date("2024-01-01")

  expect_equal(datediff(x, y, units = "days"), 2)
  expect_equal(datediff(x, y, units = "weeks"), 2 / 7)
})