Better vendor experience (#479)

* feat: condition to clean vendor directory after creating tarball

* feat: use vendor/ directory if it exists

* docs: update NEWS

Author: albersonmiranda

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)
   }

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

@@ -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; \