tests/testthat/test_dsinfo.R

In s-fleck/dsinfo: Metadata for R Objects

context("dsinfo")


test_that("dsinfo works as expected", {

  x <- 1L

  expect_silent(
    x <- set_dsinfo(x,
      # data package recommended
      name = "test_data",
      id = "t001",
      version = "0.0.1",
      reference_date = as.Date("2016-01-01"),

      # data package recommended
      license = "CC",

      # data package optional
      title = "A test dataset",
      description = "A dataset created for testing purposes \n* test \n* data",
      homepage = "www.zombo.com",

      contributors = "Foobert Bar",
      keywords = c("test", "data"),
      created = Sys.time(),
      sources = dsi_sources(
        dsi_source("a test source", path = tempfile(), email = "blah@blubb.at", date = Sys.Date()),
        dsi_source("a test source", email = "blah@blubb.at", date = Sys.Date()),
        dsi_source("a test source", path = tempfile())
      ),


      # data package-compat
      profile = NULL,  #recommended
      image = NULL,  #optional
      blah = "blubb"
    )
  )


  expect_silent(set_dsinfo(x, reference_date = Sys.Date()))

  expect_silent(set_dsinfo(x, reference_date = dint::as_date_yq(Sys.Date())))
  expect_error(set_dsinfo(x, reference_date = "x"))


  y <- set_dsinfo(1L, homepage = "www.zombo.com")
})



test_that("test if reference data can be a lubridate interval", {

  x <- iris

  if (!requireNamespace("lubridate")){
    skip("Test requires lubridate")
  }
  expect_silent(set_dsinfo(x, reference_date = lubridate::interval(Sys.Date(), Sys.Date())))  #nolint
})




test_that("dsinfo works as expected", {
  expect_true(is_dsinfo_name("ab.1"))
  expect_true(is_dsinfo_name("ab_1"))
  expect_true(is_dsinfo_name("ab-1"))
  expect_false(is_dsinfo_name("ab(1"))
})




test_that("reference_date works as expected", {
  x <- 1L

  expect_silent(
    reference_date(x) <- dint::as_date_ym(201612)
  )

  expect_identical(
    reference_date(x),
    dint::date_ym(2016, 12)
  )

  expect_true(
    has_reference_date(x)
  )

  y <- 2L

  y <- set_reference_date(y, reference_date(x))

  expect_identical(
    reference_date(x),
    reference_date(y)
  )
})




test_that("test print method", {
  x <- set_dsinfo(
    iris,
    name = "iris",
    title = "iris data set",
    reference_date = Sys.Date(),
    sources = dsi_source(title = "wd", path = getwd() )
  )

  expect_output(print(dsinfo(x)))


  x <- set_dsinfo(
    iris,
    name = "iris",
    title = "iris data set",
    reference_date = Sys.Date(),
    sources = dsi_sources(
      dsi_source(title = "wd", path = getwd() ),
      dsi_source(title = "wd2", path = getwd() ))
  )


  expect_output(print(dsinfo(x)))
})




test_that("dsinfo .add = TRUE works as expected", {
  x <- set_dsinfo(
    iris,
    name = "iris",
    title = "iris data set",
    reference_date = Sys.Date(),
    sources = dsi_source(title = "wd", path = getwd() ),
    .add = TRUE
  )

  expect_identical(dsinfo(x)$title, "iris data set")
  expect_identical(dsinfo(x)$name,  "iris")

  x <- set_dsinfo(x, name = "iris2", .add = TRUE)

  expect_identical(dsinfo(x)$title, "iris data set")
  expect_identical(dsinfo(x)$name,  "iris2")
})




test_that("dsinfo doesn't corrupt selfref of data.table", {
  dt <- data.table::as.data.table(iris)

  x <- set_dsinfo(
    dt,
    name = "iris",
    title = "iris data set",
    reference_date = Sys.Date(),
    sources = dsi_source(title = "wd", path = getwd() ),
    .add = TRUE
  )

  expect_equal(data.table:::selfrefok(x), 1)
})




test_that("set_source_script works", {
  tf <- tempfile()
  on.exit(unlink(tf))
  x <- iris

  d1 <- as.Date("2019-01-01")
  d2 <- as.Date("2019-01-02")

  # setting source script works
  res <- dsinfo::set_source_script(x)
  expect_length(dsinfo(res)$sources, 1)

  # set_dsinfo resets the sources again
  res <- dsinfo::set_dsinfo(res, source = dsinfo::dsi_sources_from_paths(c(tf, tf)))
  expect_length(dsinfo(res)$sources, 2)

  # setting source script does not remove other sources
  res <- dsinfo::set_source_script(res, date = d1)
  expect_length(dsinfo(res)$sources, 3)
  expect_identical(dsinfo(res)$sources[[1]]$date, d1)

  # setting source script twice updates the source script
  res <- dsinfo::set_source_script(res, date = d2)
  expect_length(dsinfo(res)$sources, 3)
  expect_identical(dsinfo(res)$sources[[1]]$date, d2)
})