testthat 3e

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: cpp11
 Title: A C++11 Interface for R's C Interface
-Version: 0.5.2.9000
+Version: 0.6.0.9000
 Authors@R:
     c(
       person("Davis", "Vaughan", email = "[email protected]", role = c("aut", "cre"), comment = c(ORCID = "0000-0003-4777-038X")),
@@ -31,7 +31,6 @@ Suggests:
     glue,
     knitr,
     lobstr,
-    mockery,
     progress,
     rmarkdown,
     scales,

NAMESPACE

@@ -4,4 +4,5 @@ export(cpp_eval)
 export(cpp_function)
 export(cpp_register)
 export(cpp_source)
+export(cpp_unvendor)
 export(cpp_vendor)

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/register.R

@@ -77,17 +77,16 @@ cpp_register <- function(path = ".", quiet = !is_interactive(), extension = c(".
     cli::cli_alert_success("generated file {.file {basename(r_path)}}")
   }
 
-
   call_entries <- get_call_entries(path, funs$name, package)
 
   cpp_function_registration <- glue::glue_data(funs, '    {{
     "_cpp11_{name}", (DL_FUNC) &_{package}_{name}, {n_args}}}, ',
     n_args = viapply(funs$args, nrow)
   )
 
-  cpp_function_registration <- glue::glue_collapse(cpp_function_registration, sep  = "\n")
+  cpp_function_registration <- glue::glue_collapse(cpp_function_registration, sep = "\n")
 
-  extra_includes <-  character()
+  extra_includes <- character()
   if (pkg_links_to_rcpp(path)) {
     extra_includes <- c(extra_includes, "#include <cpp11/R.hpp>", "#include <Rcpp.h>", "using namespace Rcpp;")
   }
@@ -215,35 +214,75 @@ generate_init_functions <- function(funs) {
 }
 
 generate_r_functions <- function(funs, package = "cpp11", use_package = FALSE) {
-  funs <- funs[c("name", "return_type", "args")]
+  funs <- funs[c("name", "return_type", "args", "file", "line", "decoration")]
 
   if (use_package) {
     package_call <- glue::glue(', PACKAGE = "{package}"')
     package_names <- glue::glue_data(funs, '"_{package}_{name}"')
   } else {
-    package_names <- glue::glue_data(funs, '`_{package}_{name}`')
+    package_names <- glue::glue_data(funs, "`_{package}_{name}`")
     package_call <- ""
   }
 
-  funs$package <- package
   funs$package_call <- package_call
   funs$list_params <- vcapply(funs$args, glue_collapse_data, "{name}")
   funs$params <- vcapply(funs$list_params, function(x) if (nzchar(x)) paste0(", ", x) else x)
   is_void <- funs$return_type == "void"
   funs$calls <- ifelse(is_void,
-    glue::glue_data(funs, 'invisible(.Call({package_names}{params}{package_call}))'),
-    glue::glue_data(funs, '.Call({package_names}{params}{package_call})')
+    glue::glue_data(funs, "invisible(.Call({package_names}{params}{package_call}))"),
+    glue::glue_data(funs, ".Call({package_names}{params}{package_call})")
   )
 
-  out <- glue::glue_data(funs, '
-    {name} <- function({list_params}) {{
-      {calls}
-    }}
-    ')
+  # Parse and associate Roxygen comments
+  funs$roxygen_comment <- mapply(function(file, line) {
+    if (file.exists(file)) {
+      comments <- extract_roxygen_comments(file)
+      matched_comment <- ""
+      for (comment in comments) {
+        # Check if the comment directly precedes the function without gaps
+        if (line == comment$line + 1) {
+          matched_comment <- comment$text
+          break
+        }
+      }
+      matched_comment
+    } else {
+      ""
+    }
+  }, funs$file, funs$line, SIMPLIFY = TRUE)
+
+  # Generate R functions with or without Roxygen comments
+  out <- mapply(function(name, list_params, calls, roxygen_comment) {
+    if (nzchar(roxygen_comment)) {
+      glue::glue("{roxygen_comment}\n{name} <- function({list_params}) {{\n\t{calls}\n}}")
+    } else {
+      glue::glue("{name} <- function({list_params}) {{\n  {calls}\n}}")
+    }
+  }, funs$name, funs$list_params, funs$calls, funs$roxygen_comment, SIMPLIFY = TRUE)
+
+  out <- glue::trim(out)
   out <- glue::glue_collapse(out, sep = "\n\n")
   unclass(out)
 }
 
+extract_roxygen_comments <- function(file) {
+  lines <- readLines(file)
+  roxygen_start <- grep("^/\\* roxygen start", lines)
+  roxygen_end <- grep("roxygen end \\*/$", lines)
+
+  if (length(roxygen_start) == 0 || length(roxygen_end) == 0) {
+    return(list())
+  }
+
+  roxygen_comments <- mapply(function(start, end) {
+    roxygen_lines <- lines[(start + 1):(end - 1)]
+    roxygen_lines <- sub("^", "#' ", roxygen_lines)
+    list(line = end, text = paste(roxygen_lines, collapse = "\n"))
+  }, roxygen_start, roxygen_end, SIMPLIFY = FALSE)
+
+  roxygen_comments
+}
+
 wrap_call <- function(name, return_type, args) {
   call <- glue::glue('{name}({list_params})', list_params = glue_collapse_data(args, "cpp11::as_cpp<cpp11::decay_t<{type}>>({name})"))
   if (return_type == "void") {

R/source.R

@@ -18,6 +18,13 @@
 #'   uses 'CXX11' if unset.
 #' @param dir The directory to store the generated source files. `tempfile()` is
 #'   used by default. The directory will be removed if `clean` is `TRUE`.
+#' @param local Passed to [dyn.load()]. If `TRUE` (the default) the shared
+#'   library is loaded with local symbols; if `FALSE` symbols are made global
+#'   (equivalent to `dyn.load(..., local = FALSE)`), which can be required when
+#'   other shared objects need to see RTTI/vtable symbols from this library.
+#' @note See the unit test that demonstrates this usage at
+#' \code{tests/testthat/test-source-local.R} (shows how `local = FALSE` exports
+#' the necessary symbols so separate shared objects can link against them).
 #' @return For [cpp_source()] and `[cpp_function()]` the results of
 #'   [dyn.load()] (invisibly). For `[cpp_eval()]` the results of the evaluated
 #'   expression.
@@ -65,7 +72,7 @@
 #' }
 #'
 #' @export
-cpp_source <- function(file, code = NULL, env = parent.frame(), clean = TRUE, quiet = TRUE, cxx_std = Sys.getenv("CXX_STD", "CXX11"), dir = tempfile()) {
+cpp_source <- function(file, code = NULL, env = parent.frame(), clean = TRUE, quiet = TRUE, cxx_std = Sys.getenv("CXX_STD", "CXX11"), dir = tempfile(), local = TRUE) {
   stop_unless_installed(c("brio", "callr", "cli", "decor", "desc", "glue", "tibble", "vctrs"))
   if (!missing(file) && !file.exists(file)) {
     stop("Can't find `file` at this path:\n", file, "\n", call. = FALSE)
@@ -145,7 +152,7 @@ cpp_source <- function(file, code = NULL, env = parent.frame(), clean = TRUE, qu
   brio::write_lines(r_functions, r_path)
   source(r_path, local = env)
 
-  dyn.load(shared_lib, local = TRUE, now = TRUE)
+  dyn.load(shared_lib, local = local, now = TRUE)
 }
 
 the <- new.env(parent = emptyenv())
@@ -163,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)
     }
@@ -183,7 +193,7 @@ generate_makevars <- function(includes, cxx_std) {
 
 #' @rdname cpp_source
 #' @export
-cpp_function <- function(code, env = parent.frame(), clean = TRUE, quiet = TRUE, cxx_std = Sys.getenv("CXX_STD", "CXX11")) {
+cpp_function <- function(code, env = parent.frame(), clean = TRUE, quiet = TRUE, cxx_std = Sys.getenv("CXX_STD", "CXX11"), local = TRUE) {
   cpp_source(code = paste(c('#include "cpp11.hpp"',
         "using namespace ::cpp11;",
         "namespace writable = ::cpp11::writable;",
@@ -193,15 +203,16 @@ cpp_function <- function(code, env = parent.frame(), clean = TRUE, quiet = TRUE,
     env = env,
     clean = clean,
     quiet = quiet,
-    cxx_std = cxx_std
+    cxx_std = cxx_std,
+    local = local
   )
 }
 
 utils::globalVariables("f")
 
 #' @rdname cpp_source
 #' @export
-cpp_eval <- function(code, env = parent.frame(), clean = TRUE, quiet = TRUE, cxx_std = Sys.getenv("CXX_STD", "CXX11")) {
+cpp_eval <- function(code, env = parent.frame(), clean = TRUE, quiet = TRUE, cxx_std = Sys.getenv("CXX_STD", "CXX11"), local = TRUE) {
   cpp_source(code = paste(c('#include "cpp11.hpp"',
         "using namespace ::cpp11;",
         "namespace writable = ::cpp11::writable;",
@@ -214,7 +225,8 @@ cpp_eval <- function(code, env = parent.frame(), clean = TRUE, quiet = TRUE, cxx
     env = env,
     clean = clean,
     quiet = quiet,
-    cxx_std = cxx_std
+    cxx_std = cxx_std,
+    local = local
   )
   f()
 }

R/unvendor.R

@@ -0,0 +1,39 @@
+#' Unvendor the cpp11 dependency
+#'
+#' This function removes the vendored cpp11 headers from your package and
+#' restores the `LinkingTo: cpp11` field in the DESCRIPTION file if it was removed.
+#'
+#' @inheritParams cpp_register
+#' @return The file path to the unvendored code (invisibly).
+#' @export
+#' @examples
+#' # create a new directory
+#' dir <- tempfile()
+#' dir.create(dir)
+#'
+#' # vendor the cpp11 headers into the directory
+#' cpp_vendor(dir)
+#'
+#' # unvendor the cpp11 headers from the directory
+#' cpp_unvendor(dir)
+#'
+#' list.files(file.path(dir, "inst", "include", "cpp11"))
+#'
+#' # cleanup
+#' unlink(dir, recursive = TRUE)
+cpp_unvendor <- function(path = ".") {
+  new <- file.path(path, "inst", "include", "cpp11")
+
+  if (!dir.exists(new)) {
+    stop("'", new, "' does not exist", call. = FALSE)
+  }
+
+  unlink(new, recursive = TRUE)
+
+  cpp11_hpp <- file.path(dirname(new), "cpp11.hpp")
+  if (file.exists(cpp11_hpp)) {
+    unlink(cpp11_hpp)
+  }
+
+  invisible(new)
+}

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,25 +34,25 @@
 #'
 #' # 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)) {
-    stop("'", new, "' already exists\n * run unlink('", new, "', recursive = TRUE)", call. = FALSE)
+    message("'", new, "' already exists, removing it")
+    cpp_unvendor(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"))),

README.md

@@ -78,3 +78,13 @@ Please note that the cpp11 project is released with a [Contributor Code of Condu
 
 cpp11 would not exist without Rcpp.
 Thanks to the Rcpp authors, Dirk Eddelbuettel, Romain Francois, JJ Allaire, Kevin Ushey, Qiang Kou, Nathan Russell, Douglas Bates and John Chambers for their work writing and maintaining Rcpp.
+
+## Clang format
+
+To match GHA, use clang-format-12 to format C++ code. With systems that provide clang-format-14 or newer, you can use Docker:
+
+```bash
+docker run --rm -v "$PWD":/work -w /work ubuntu:22.04 bash -lc "\
+  apt-get update && apt-get install -y clang-format-12 && \
+  find . -name '*.cpp' -o -name '*.hpp' -o -name '*.h' | xargs -r clang-format-12 -i"
+```

_pkgdown.yml

@@ -25,6 +25,7 @@ reference:
   - title: Vendoring cpp11
     contents:
       - cpp_vendor
+      - cpp_unvendor
 
 navbar:
   type: default

cpp11test/.Rbuildignore

@@ -0,0 +1,3 @@
+^\.here$
+^bench$
+^LICENSE\.md$

cpp11test/DESCRIPTION

@@ -12,12 +12,14 @@ Authors@R:
 Description: Provides a test suite and benchmarking code for the 'cpp11' package.
 License: MIT + file LICENSE
 Encoding: UTF-8
-LinkingTo: Rcpp, cpp11, testthat
+LinkingTo: cpp11, Rcpp, testthat
+Imports: cpp11, Rcpp
 Suggests:
     covr,
-    testthat,
+    testthat (>= 3.0.0),
     pkgload,
     xml2
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.1.1
+RoxygenNote: 7.3.2
+Config/testthat/edition: 3

cpp11test/LICENSE

@@ -0,0 +1,2 @@
+YEAR: 2025
+COPYRIGHT HOLDER: cpp11test authors

cpp11test/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2025 cpp11test authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cpp11test/NAMESPACE

@@ -1,6 +1,12 @@
 # Generated by roxygen2: do not edit by hand
 
+export(roxcpp2_)
+export(roxcpp3_)
+export(roxcpp4_)
+export(roxcpp5_)
+export(roxcpp7_)
 export(run_tests)
 exportPattern("_$")
 importFrom(Rcpp,sourceCpp)
+importFrom(cpp11,cpp_source)
 useDynLib(cpp11test, .registration = TRUE)