Merge pull request #17 from pachadotdev/testthat3e

Testthat3e

Author: pachadotdev

DESCRIPTION

@@ -31,7 +31,6 @@ Suggests:
     glue,
     knitr,
     lobstr,
-    mockery,
     progress,
     rmarkdown,
     scales,

NEWS.md

@@ -4,6 +4,12 @@
 
 * Fixed an issue related to `-Wdeprecated-literal-operator` (#447, @andrjohns).
 
+# cpp11 0.5.1.9000
+
+* Uses testthat 3e style tests (#402).
+* Removes the mockery dependence.
+* The vendoring function accepts a custom path (i.e., to use the GitHub version of the package)
+
 # cpp11 0.5.1
 
 * cpp11 now requires R >=4.0.0, in line with the

R/source.R

@@ -170,12 +170,15 @@ generate_cpp_name <- function(name, loaded_dlls = c("cpp11", names(getLoadedDLLs
   sprintf("%s.%s", new_name, ext)
 }
 
-
-
-generate_include_paths <- function(packages) {
+generate_include_paths <- function(packages, custom_path = NULL) {
   out <- character(length(packages))
   for (i in seq_along(packages)) {
-    path <- system.file(package = packages[[i]], "include")
+    if (!is.null(custom_path)) {
+      path <- custom_path
+    } else {
+      path <- system.file(package = packages[[i]], "include")
+    }
+
     if (is_windows()) {
       path <- utils::shortPathName(path)
     }

R/vendor.R

@@ -16,6 +16,10 @@
 #' code until you run `cpp_vendor()` again.
 #'
 #' @inheritParams cpp_register
+#' @param headers The path to the cpp11 headers to vendor. By default this is
+#'  the path where R installed the cpp11 package. You can change this to
+#'  use a different version of cpp11, such as as the development version
+#'  from GitHub. 
 #' @return The file path to the vendored code (invisibly).
 #' @export
 #' @examples
@@ -30,7 +34,7 @@
 #'
 #' # cleanup
 #' unlink(dir, recursive = TRUE)
-cpp_vendor <- function(path = ".") {
+cpp_vendor <- function(path = ".", headers = system.file("include", "cpp11", package = "cpp11")) {
   new <- file.path(path, "inst", "include", "cpp11")
 
   if (dir.exists(new)) {
@@ -40,16 +44,15 @@ cpp_vendor <- function(path = ".") {
 
   dir.create(new , recursive = TRUE, showWarnings = FALSE)
 
-  current <- system.file("include", "cpp11", package = "cpp11")
-  if (!nzchar(current)) {
+  if (!nzchar(headers)) {
     stop("cpp11 is not installed", call. = FALSE)
   }
 
   cpp11_version <- utils::packageVersion("cpp11")
 
   cpp11_header <- sprintf("// cpp11 version: %s\n// vendored on: %s", cpp11_version, Sys.Date())
 
-  files <- list.files(current, full.names = TRUE)
+  files <- list.files(headers, full.names = TRUE)
 
   writeLines(
     c(cpp11_header, readLines(system.file("include", "cpp11.hpp", package = "cpp11"))),

man/cpp_vendor.Rd

@@ -1,3 +1,11 @@
+# This file is part of the standard setup for testthat.
+# It is recommended that you do not modify it.
+#
+# Where should you do additional test configuration?
+# Learn more about the roles of various files in:
+# * https://r-pkgs.org/testing-design.html#sec-tests-files-overview
+# * https://testthat.r-lib.org/articles/special-files.html
+
 library(testthat)
 library(cpp11)
 

tests/testthat.R

@@ -1,4 +1,4 @@
-# get_call_entries: returns an empty string for packages with .Call entries and NAMESPACE files
+# get_call_entries returns an empty string for packages with .Call entries and NAMESPACE files
 
     Code
       call_entries
@@ -11,7 +11,7 @@
       [6] "    {NULL, NULL, 0}"                           
       [7] "};"                                            
 
-# get_call_entries: works with multiple register functions.
+# get_call_entries works with multiple register functions
 
     Code
       cat(read_file(cpp_bindings))
@@ -60,7 +60,7 @@
         R_forceSymbols(dll, TRUE);
       }
 
-# cpp_register: works with a package that registers a single c++ function
+# cpp_register works with a package that registers a single C++ function
 
     Code
       cat(read_file(r_bindings))
@@ -104,7 +104,7 @@
         R_forceSymbols(dll, TRUE);
       }
 
-# cpp_register: can be run with messages
+# cpp_register can be run with messages
 
     Code
       cpp_register(p, quiet = FALSE)

tests/testthat/_snaps/register.md

@@ -1,24 +1,22 @@
-describe("eng_cpp11", {
-  it("works when code is not evaluated", {
-    skip_on_os("solaris")
-    opts <- knitr::opts_chunk$get()
-    opts <- utils::modifyList(opts, list(eval = FALSE, engine = "cpp11", code = "1 + 1"))
+test_that("eng_cpp11 works when code is not evaluated", {
+  skip_on_os("solaris")
+  opts <- knitr::opts_chunk$get()
+  opts <- utils::modifyList(opts, list(eval = FALSE, engine = "cpp11", code = "1 + 1"))
 
-    expect_equal(
-      eng_cpp11(opts),
-      "1 + 1"
-    )
-  })
+  expect_equal(
+    eng_cpp11(opts),
+    "1 + 1"
+  )
+})
 
-  it("works when code is evaluated", {
-    skip_on_os("solaris")
-    opts <- knitr::opts_chunk$get()
-    code <- "[[cpp11::register]] int foo() { return 0; }"
-    opts <- utils::modifyList(opts, list(eval = TRUE, engine = "cpp11", code = code, quiet = TRUE))
+test_that("eng_cpp11 works when code is evaluated", {
+  skip_on_os("solaris")
+  opts <- knitr::opts_chunk$get()
+  code <- "[[cpp11::register]] int foo() { return 0; }"
+  opts <- utils::modifyList(opts, list(eval = TRUE, engine = "cpp11", code = code, quiet = TRUE))
 
-    expect_equal(
-      eng_cpp11(opts),
-      code
-    )
-  })
+  expect_equal(
+    eng_cpp11(opts),
+    code
+  )
 })