Merge branch 'main' into feature/Support-win-arm64-in-rust-source

Author: Ilia-Kosenkov

.github/workflows/R-CMD-check.yaml

@@ -44,6 +44,13 @@ jobs:
           toolchain: ${{ matrix.config.rust-version }}
           targets: ${{ matrix.config.rust-target }}
 
+      # Add rust-cache for faster builds
+      - name: Cache Rust dependencies
+        uses: Swatinem/rust-cache@v2
+        with:
+          shared-key: ${{ matrix.config.os }}-${{ matrix.config.rust-version }}
+          cache-on-failure: true
+
       - uses: baptiste0928/cargo-install@v3
         if: matrix.config.r == 'release'
         with:

NEWS.md

@@ -6,6 +6,8 @@
   * Replaces internal `invoke_cargo()` with `run_cargo()` in `rust_source()` 
   * Simplifies handling of macro options in `rust_function(extendr_fn_options = list())` 
   * Unknown macro options in dev and release now throw errors instead of warnings
+* `vendor_pkgs()` now has a `clean` argument to remove the `src/rust/vendor` directory after creating the `vendor.tar.xz` file. (#479)
+* `Makevars`(.win) now uses the `vendor/`, if it exists, before unzipping the tarball. (#479)
 
 # rextendr 0.4.2
 

R/cran-compliance.R

@@ -7,6 +7,10 @@
 #  the vendored dependencies using [`vendor_pkgs()`].
 #'
 #' @inheritParams use_extendr
+#'
+#' @param clean `logical(1)` indicating whether the `vendor/` directory should be removed after
+#' creating the `vendor.tar.xz` file. Defaults to `FALSE`.
+#'
 #' @returns
 #'
 #' - `vendor_pkgs()` returns a data.frame with two columns `crate` and `version`
@@ -16,7 +20,7 @@
 #' vendor_pkgs()
 #' }
 #' @export
-vendor_pkgs <- function(path = ".", quiet = FALSE, overwrite = NULL) {
+vendor_pkgs <- function(path = ".", quiet = FALSE, overwrite = NULL, clean = FALSE) {
   stderr_line_callback <- function(x, proc) {
     if (!cli::ansi_grepl("To use vendored sources", x) && cli::ansi_nzchar(x)) {
       cli::cat_bullet(stringi::stri_trim_left(x))
@@ -119,7 +123,7 @@ vendor_pkgs <- function(path = ".", quiet = FALSE, overwrite = NULL) {
   }
 
   # clean up vendor directory
-  if (dir.exists(file.path(src_dir, "vendor"))) {
+  if (clean && dir.exists(file.path(src_dir, "vendor"))) {
     cli::cli_alert_info("Removing {.path src/rust/vendor} directory")
     unlink(file.path(src_dir, "vendor"), recursive = TRUE)
   }

R/find_exports.R

@@ -5,7 +5,11 @@ find_exports <- function(clean_lns) {
 
   # start and end may empty
   if (rlang::is_empty(start) || rlang::is_empty(end)) {
-    return(data.frame(name = character(0), type = character(0), lifetime = character(0)))
+    return(data.frame(
+      name = character(0),
+      type = character(0),
+      lifetime = character(0)
+    ))
   }
 
   map2(start, end, \(.x, .y) extract_meta(clean_lns[.x:.y])) |>
@@ -16,8 +20,9 @@ find_exports <- function(clean_lns) {
 }
 
 # Finds lines which contain #[extendr] (allowing additional spaces)
+# Excludes #[extendr(default=...)] which is used for function arguments
 find_extendr_attrs_ids <- function(lns) {
-  which(stringi::stri_detect_regex(lns, r"{#\s*\[\s*extendr(\s*\(.*\))?\s*\]}"))
+  which(stringi::stri_detect_regex(lns, r"{#\s*\[\s*extendr(\s*\((?!.*default\s*=).*\))?\s*\]}"))
 }
 
 # Gets function/module metadata from a subset of lines.
@@ -29,7 +34,15 @@ extract_meta <- function(lns) {
     "(?:(?<struct>struct)|(?<enum>enum)|(?<fn>fn)|(?<impl>impl)(?:\\s*<(?<lifetime>.+?)>)?)\\s+(?<name>(?:r#)?(?:_\\w+|[A-z]\\w*))" # nolint: line_length_linter
   ) |>
     as.data.frame() |>
-    rlang::set_names(c("match", "struct", "enum", "fn", "impl", "lifetime", "name")) |>
+    rlang::set_names(c(
+      "match",
+      "struct",
+      "enum",
+      "fn",
+      "impl",
+      "lifetime",
+      "name"
+    )) |>
     dplyr::filter(!is.na(.data$match))
 
   # If no matches have been found, then the attribute is misplaced
@@ -38,10 +51,10 @@ extract_meta <- function(lns) {
     # meaningful output or source line numbers.
     code_sample <- stringi::stri_sub(
       glue_collapse(lns, sep = "\n  "),
-      1, 80
+      1,
+      80
     )
 
-
     rlang::abort(
       cli::cli_fmt({
         cli::cli_text(

inst/templates/Makevars.in

@@ -19,10 +19,16 @@ VENDOR_DIR = $(CURDIR)/vendor
 # CRAN note: Cargo and Rustc versions are reported during
 # configure via tools/msrv.R.
 #
-# vendor.tar.xz, if present, is unzipped and used for offline compilation.
+# If a vendor directory exists, it is used for offline compilation. Otherwise if
+# vendor.tar.xz exists, it is unzipped and used for offline compilation.
 $(STATLIB):
 
-	if [ -f ./rust/vendor.tar.xz ]; then \
+	if [ -d ./vendor ]; then \
+		echo "=== Using offline vendor directory ==="; \
+		mkdir -p $(CARGOTMP) && \
+		cp rust/vendor-config.toml $(CARGOTMP)/config.toml; \
+	elif [ -f ./rust/vendor.tar.xz ]; then \
+		echo "=== Using offline vendor tarball ==="; \
 		tar xf rust/vendor.tar.xz && \
 		mkdir -p $(CARGOTMP) && \
 		cp rust/vendor-config.toml $(CARGOTMP)/config.toml; \

inst/templates/Makevars.win.in

@@ -18,7 +18,14 @@ $(STATLIB):
 	mkdir -p $(TARGET_DIR)/libgcc_mock
 	touch $(TARGET_DIR)/libgcc_mock/libgcc_eh.a
 
-	if [ -f ./rust/vendor.tar.xz ]; then \
+  # If a vendor directory exists, it is used for offline compilation. Otherwise if
+  # vendor.tar.xz exists, it is unzipped and used for offline compilation.
+	if [ -d ./vendor ]; then \
+		echo "=== Using offline vendor directory ==="; \
+		mkdir -p $(CARGOTMP) && \
+		cp rust/vendor-config.toml $(CARGOTMP)/config.toml; \
+	elif [ -f ./rust/vendor.tar.xz ]; then \
+		echo "=== Using offline vendor tarball ==="; \
 		tar xf rust/vendor.tar.xz && \
 		mkdir -p $(CARGOTMP) && \
 		cp rust/vendor-config.toml $(CARGOTMP)/config.toml; \

man/vendor_pkgs.Rd

@@ -0,0 +1,15 @@
+
+```{r, include = FALSE}
+library(rextendr)
+```
+
+
+```{extendrsrc engine.opts = list(use_dev_extendr=TRUE)}
+#[extendr]
+fn check_default(#[extendr(default = "NULL")] x: Robj) ->  bool {
+  x.is_null()
+}
+```
+```{r}
+testthat::expect_true(check_default())
+```

tests/data/test-default-arg.Rmd

@@ -212,10 +212,16 @@
       # CRAN note: Cargo and Rustc versions are reported during
       # configure via tools/msrv.R.
       #
-      # vendor.tar.xz, if present, is unzipped and used for offline compilation.
+      # If a vendor directory exists, it is used for offline compilation. Otherwise if
+      # vendor.tar.xz exists, it is unzipped and used for offline compilation.
       $(STATLIB):
       
-      	if [ -f ./rust/vendor.tar.xz ]; then \
+      	if [ -d ./vendor ]; then \
+      		echo "=== Using offline vendor directory ==="; \
+      		mkdir -p $(CARGOTMP) && \
+      		cp rust/vendor-config.toml $(CARGOTMP)/config.toml; \
+      	elif [ -f ./rust/vendor.tar.xz ]; then \
+      		echo "=== Using offline vendor tarball ==="; \
       		tar xf rust/vendor.tar.xz && \
       		mkdir -p $(CARGOTMP) && \
       		cp rust/vendor-config.toml $(CARGOTMP)/config.toml; \
@@ -273,7 +279,14 @@
       	mkdir -p $(TARGET_DIR)/libgcc_mock
       	touch $(TARGET_DIR)/libgcc_mock/libgcc_eh.a
       
-      	if [ -f ./rust/vendor.tar.xz ]; then \
+        # If a vendor directory exists, it is used for offline compilation. Otherwise if
+        # vendor.tar.xz exists, it is unzipped and used for offline compilation.
+      	if [ -d ./vendor ]; then \
+      		echo "=== Using offline vendor directory ==="; \
+      		mkdir -p $(CARGOTMP) && \
+      		cp rust/vendor-config.toml $(CARGOTMP)/config.toml; \
+      	elif [ -f ./rust/vendor.tar.xz ]; then \
+      		echo "=== Using offline vendor tarball ==="; \
       		tar xf rust/vendor.tar.xz && \
       		mkdir -p $(CARGOTMP) && \
       		cp rust/vendor-config.toml $(CARGOTMP)/config.toml; \
@@ -442,10 +455,16 @@
       # CRAN note: Cargo and Rustc versions are reported during
       # configure via tools/msrv.R.
       #
-      # vendor.tar.xz, if present, is unzipped and used for offline compilation.
+      # If a vendor directory exists, it is used for offline compilation. Otherwise if
+      # vendor.tar.xz exists, it is unzipped and used for offline compilation.
       $(STATLIB):
       
-      	if [ -f ./rust/vendor.tar.xz ]; then \
+      	if [ -d ./vendor ]; then \
+      		echo "=== Using offline vendor directory ==="; \
+      		mkdir -p $(CARGOTMP) && \
+      		cp rust/vendor-config.toml $(CARGOTMP)/config.toml; \
+      	elif [ -f ./rust/vendor.tar.xz ]; then \
+      		echo "=== Using offline vendor tarball ==="; \
       		tar xf rust/vendor.tar.xz && \
       		mkdir -p $(CARGOTMP) && \
       		cp rust/vendor-config.toml $(CARGOTMP)/config.toml; \

tests/testthat/_snaps/use_extendr.md

@@ -34,3 +34,15 @@ test_that("Snapshot test of knitr-engine", {
   knitr::knit(input, output)
   expect_snapshot(cat_file(output))
 })
+
+
+test_that("knitr-engine for #[extendr(default = )]", {
+  skip_if_cargo_unavailable()
+  skip_if_not_installed("knitr")
+  skip_on_cran()
+
+  input <- file.path("../data/test-default-arg.Rmd")
+  output <- withr::local_file("snapshot-extendr-default.md")
+  knitr::knit(input, output)
+  expect_true(check_default())
+})