refactor cargo-processx functions

R/clean.R

@@ -5,8 +5,19 @@
 #' (found by default at `pkg_root/src/rust/target/`).
 #' Useful when Rust code should be recompiled from scratch.
 #' @param path \[ string \] Path to the package root.
+#' @param echo logical scalar, should cargo command and outputs be printed to
+#' console (default is TRUE)
+#'
 #' @export
-clean <- function(path = ".") {
+#'
+#' @examples
+#' \dontrun{
+#' clean()
+#' }
+clean <- function(path = ".", echo = TRUE) {
+  check_string(path, class = "rextendr_error")
+  check_bool(echo, class = "rextendr_error")
+
   root <- rprojroot::find_package_root_file(path = path)
 
   rust_folder <- normalizePath(
@@ -15,7 +26,7 @@ clean <- function(path = ".") {
     mustWork = FALSE
   )
 
-  toml_path <- normalizePath(
+  manifest_path <- normalizePath(
     file.path(rust_folder, "Cargo.toml"),
     winslash = "/",
     mustWork = FALSE
@@ -28,52 +39,34 @@ clean <- function(path = ".") {
     mustWork = FALSE
   )
 
-  if (!file.exists(toml_path)) {
+  if (!file.exists(manifest_path)) {
     cli::cli_abort(c(
       "Unable to clean binaries.",
       "!" = "{.file Cargo.toml} not found in {.path {rust_folder}}.",
       class = "rextendr_error"
     ))
   }
 
-  cargo_envvars <- get_cargo_envvars()
-
   args <- c(
     "clean",
-    glue("--manifest-path={toml_path}"),
-    glue("--target-dir={target_dir}"),
+    glue::glue("--manifest-path={manifest_path}"),
+    glue::glue("--target-dir={target_dir}"),
     if (tty_has_colors()) {
       "--color=always"
     } else {
       "--color=never"
-    },
-    "--quiet"
+    }
   )
-  exec_result <- processx::run(
+
+  processx::run(
     command = "cargo",
     args = args,
-    echo_cmd = FALSE,
-    windows_verbatim_args = FALSE,
-    stderr = "|",
-    stdout = "|",
-    error_on_status = FALSE,
-    env = cargo_envvars
+    error_on_status = TRUE,
+    wd = rust_folder,
+    echo_cmd = echo,
+    echo = echo,
+    env = get_cargo_envvars()
   )
 
-  if (!isTRUE(exec_result$status == 0)) {
-    if (!tty_has_colors()) {
-      err_msg <- cli::ansi_strip(exec_result$stderr)
-    } else {
-      err_msg <- exec_result$stderr
-    }
-    cli::cli_abort(
-      c(
-        "Unable to execute {.code cargo clean}.",
-        "x" = paste(err_msg, collapse = "\n")
-      ),
-      call = caller_env(),
-      class = "rextendr_error"
-    )
-  }
   pkgbuild::clean_dll(path = root)
 }

R/license_note.R

@@ -1,97 +1,120 @@
 #' Generate LICENSE.note file.
 #'
-#' LICENSE.note generated by this function contains information about Rust crate dependencies.
-#' To use this function, the [cargo-license](https://crates.io/crates/cargo-license) command must be installed.
-#' @param force Logical indicating whether to regenerate LICENSE.note if LICENSE.note already exists.
-#' @inheritParams register_extendr
+#' LICENSE.note generated by this function contains information about all
+#' recursive dependencies in Rust crate.
+#'
+#' @param path character scalar, the R package directory
+#' @param echo logical scalar, whether to print cargo command and outputs to the
+#' console (default is `TRUE`)
+#' @param quiet logical scalar, whether to signal successful writing of
+#' LICENSE.note (default is `FALSE`)
+#' @param overwrite logical scalar, whether to regenerate LICENSE.note if
+#' LICENSE.note already exists (default is `TRUE`)
+#'
 #' @return No return value, called for side effects.
+#'
 #' @export
-write_license_note <- function(path = ".", quiet = FALSE, force = TRUE) {
-  if (!cargo_command_available(c("license", "--help"))) {
-    cli::cli_abort(
-      c(
-        "The {.code cargo license} command is required to run the {.fun write_license_note} function.",
-        "*" = "Please install cargo-license ({.url https://crates.io/crates/cargo-license}) first.",
-        i = "Run {.code cargo install cargo-license} from your terminal."
-      ),
-      class = "rextendr_error"
-    )
-  }
+#'
+#' @examples
+#' \dontrun{
+#' write_license_note()
+#' }
+write_license_note <- function(
+    path = ".",
+    echo = TRUE,
+    quiet = FALSE,
+    overwrite = TRUE) {
+  check_string(path, class = "rextendr_error")
+  check_bool(echo, class = "rextendr_error")
+  check_bool(quiet, class = "rextendr_error")
+  check_bool(overwrite, class = "rextendr_error")
+
+  outfile <- rprojroot::find_package_root_file(
+    "LICENSE.note",
+    path = path
+  )
+
+  metadata <- read_cargo_metadata(
+    path = path,
+    dependencies = TRUE
+  )
 
-  manifest_file <- rprojroot::find_package_root_file("src", "rust", "Cargo.toml", path = path)
-  outfile <- rprojroot::find_package_root_file("LICENSE.note", path = path)
+  packages <- metadata[["packages"]]
 
-  if (!isTRUE(force) && file.exists(outfile)) {
-    cli::cli_abort(
-      c(
-        "LICENSE.note already exists.",
-        "If you want to regenerate LICENSE.note, set `force = TRUE` to {.fun write_license_note}."
-      ),
-      class = "rextendr_error"
-    )
+  # exclude current package from LICENSE.note
+  current_package <- metadata[["resolve"]][["root"]]
+
+  packages <- packages[packages[["id"]] != current_package, ]
+
+  replace_na <- function(data, replace = NA, ...) {
+    if (vctrs::vec_any_missing(data)) {
+      missing <- vctrs::vec_detect_missing(data)
+      data <- vctrs::vec_assign(data, missing, replace,
+        x_arg = "data",
+        value_arg = "replace"
+      )
+    }
+    data
   }
 
-  list_license <- processx::run(
-    "cargo",
-    c(
-      "license",
-      "--authors",
-      "--json",
-      "--avoid-build-deps",
-      "--avoid-dev-deps",
-      "--manifest-path", manifest_file
-    )
-  )$stdout %>%
-    jsonlite::parse_json()
-
-  package_names <- processx::run(
-    "cargo",
-    c(
-      "metadata",
-      "--no-deps",
-      "--format-version", "1",
-      "--manifest-path", manifest_file
+  packages[["respository"]] <- replace_na(
+    packages[["repository"]],
+    "unknown"
+  )
+
+  packages[["licenses"]] <- replace_na(
+    packages[["repository"]],
+    "not provided"
+  )
+
+  prep_authors <- function(authors, package) {
+    authors <- ifelse(
+      is.na(authors),
+      paste0(package, " authors"),
+      authors
     )
-  )$stdout %>%
-    jsonlite::parse_json() %>%
-    purrr::pluck("packages") %>%
-    purrr::map_chr("name")
-
-  .prep_authors <- function(authors, package) {
-    ifelse(!is.null(authors), authors, paste0(package, " authors")) %>%
-      stringi::stri_replace_all_regex(r"(\ <.+?>)", "") %>%
-      stringi::stri_replace_all_regex(r"(\|)", ", ")
+
+    authors <- stringi::stri_replace_all_regex(authors, r"(\ <.+?>)", "")
+
+    paste0(authors, collapse = ", ")
   }
 
+  packages[["authors"]] <- unlist(Map(
+    prep_authors,
+    packages[["authors"]],
+    packages[["name"]]
+  ))
+
   separator <- "-------------------------------------------------------------"
 
-  note_header <- paste0(
-    "The binary compiled from the source code of this package contains the following Rust crates:\n",
-    "\n",
-    "\n",
-    separator
+  note_header <- glue::glue(
+    "
+    The binary compiled from the source code of this package \\
+    contains the following Rust crates:
+
+
+    {separator}
+    "
   )
 
-  note_body <- list_license %>%
-    purrr::discard(function(x) x$name %in% package_names) %>%
-    purrr::map_chr(
-      function(x) {
-        paste0(
-          "\n",
-          "Name:        ", x$name, "\n",
-          "Repository:  ", x$repository, "\n",
-          "Authors:     ", .prep_authors(x$authors, x$name), "\n",
-          "License:     ", x$license, "\n",
-          "\n",
-          separator
-        )
-      }
-    )
+  note_body <- glue::glue_data(
+    packages,
+    "
+
+    Name:        {name}
+    Repository:  {repository}
+    Authors:     {authors}
+    License:     {license}
+
+    {separator}
+    "
+  )
 
   write_file(
     text = c(note_header, note_body),
     path = outfile,
     search_root_from = path,
-    quiet = quiet
+    quiet = quiet,
+    overwrite = overwrite
   )
 }

R/read_cargo_metadata.R

@@ -1,6 +1,10 @@
 #' Retrieve metadata for packages and workspaces
 #'
 #' @param path character scalar, the R package directory
+#' @param dependencies logical scalar, whether to include all recursive
+#' dependencies in stdout (default is FALSE)
+#' @param echo logical scalar, should cargo command and outputs be printed to
+#' console (default is TRUE)
 #'
 #' @details
 #' For more details, see
@@ -25,22 +29,44 @@
 #' read_cargo_metadata()
 #' }
 #'
-read_cargo_metadata <- function(path = ".") {
+read_cargo_metadata <- function(
+    path = ".",
+    dependencies = FALSE,
+    echo = TRUE) {
   check_string(path, class = "rextendr_error")
+  check_bool(dependencies, class = "rextendr_error")
+  check_bool(echo, class = "rextendr_error")
 
-  root <- rprojroot::find_package_root_file(path = path)
+  rust_folder <- rprojroot::find_package_root_file(
+    "src", "rust",
+    path = path
+  )
 
-  rust_folder <- normalizePath(
-    file.path(root, "src", "rust"),
-    winslash = "/",
-    mustWork = FALSE
+  args <- c(
+    "metadata",
+    "--format-version=1",
+    if (isFALSE(dependencies)) {
+      "--no-deps"
+    },
+    if (tty_has_colors()) {
+      "--color=always"
+    } else {
+      "--color=never"
+    }
   )
 
   out <- processx::run(
-    "cargo",
-    args = c("metadata", "--format-version=1", "--no-deps"),
-    wd = rust_folder
+    command = "cargo",
+    args = args,
+    error_on_status = TRUE,
+    wd = rust_folder,
+    echo_cmd = echo,
+    echo = echo,
+    env = get_cargo_envvars()
   )
 
-  jsonlite::fromJSON(out[["stdout"]])
+  jsonlite::parse_json(
+    out[["stdout"]],
+    simplifyDataFrame = TRUE
+  )
 }