tests/testthat/test-mappy.R

In robertzk/mappy: mappy (http://github.com/robertzk/mappy)

context("mappy")
library(testthatsomemore)

package_stub("base", "interactive", function() TRUE, {
  describe("Setting shortcuts", {
    test_that("it does not accept one unnamed expression", {
      expect_error(mappy(register = FALSE, test), "must be named")
    })

    test_that("it does not accept one named and one unnamed expression", {
      expect_error(mappy(register = FALSE, test, b = test), "must be named")
    })

    test_that("it does not allow duplication in expression names", {
      expect_error(mappy(register = FALSE, b = test, b = test), "must be unique")
    })

    test_that("it errors when a non-logical of length 1 is passed for the register param", {
      expect_error(register(5, quote(cat("hi"), register = 1)))
      expect_error(register(5, quote(cat("hi"), register = c(FALSE, TRUE))))
    })

    test_that("setting a shortcut is possible in the global environment", {
      mappy(register = FALSE, hi = cat("Hello world"))
      expect_output(hi, "Hello world")
      rm("hi", envir = globalenv()) # Clean up
    })

    test_that("setting a shortcut is possible in a custom environment", {
      env <- new.env()
      mappy(register = FALSE, hi = cat("Hello world"), envir = env)
      expect_output(env$hi, "Hello world")
    })

    test_that("it can give a list of all shortcuts", {
      with_mappy({
        mappy(hi = cat("Hello world"))
        expect_equal(names(mappy_all()), "hi")
        unmappy("hi")
      })
    })

    test_that("gives a warning when overwriting a binding", {
      env <- new.env()
      mappy(register = FALSE, hi = cat("Hello world"), envir = env)
      expect_warning(
        mappy(register = FALSE, hi = cat("Hello world"), envir = env),
        "is already a binding"
      )
    })
  })

  describe("Unmapping shortcuts", {
    test_that("it complains when you try to unmap non-character shortcuts", {
      expect_error(unmappy(1))
      expect_error(unmappy(TRUE))
      expect_error(unmappy(function() { }))
    })

    test_that("it issues a warning when attempting to unmap a non-existent shortcut", {
      expect_warning(unmappy("not a thing yo"), "not a shortcut")
    })

    test_that("it can unmap one shortcut", {
      env <- new.env()
      mappy(register = FALSE, x = cat("Hello"), envir = env)
      unmappy("x", envir = env)
      expect_null(env$x)
    })

    test_that("it can unmap multiple shortcut", {
      env <- new.env()
      mappy(register = FALSE, x = cat("Hello"), y = cat("Hi"), envir = env)
      unmappy(c("x", "y"), envir = env)
      expect_null(env$x)
    })
  })
})

memoise::forget(mappy_file)
memoise::forget(registry_dir)
memoise::forget(registry_obj)