Allow progress bar to access caller environment (#1221)

Fixes #1078

Author: jcolt45

NEWS.md

@@ -1,5 +1,7 @@
 # purrr (development version)
 
+* Formatted strings for the progress bar could only access the global environment. `map()`, `map2()`, and `pmap()` have been updated to add  `caller = .purrr_user_env` to `.progress` by default, allowing formatted strings to access to the current/parent environment (@jcolt45, #1078).
+
 * `as_mapper.default()` optimized by removing special named argument handling for primitive functions (@mtcarsalot, #1088).
 
 * `list_flatten()` gains an `is_node` parameter taking a predicate function that determines whether an input element is a node or a leaf (@salim-b, #1179).

R/map.R

@@ -198,6 +198,12 @@ map_ <- function(
   .purrr_user_env = caller_env(2),
   .purrr_error_call = caller_env()
 ) {
+  .progress <- as_progress(
+    .progress,
+    user_env = .purrr_user_env,
+    caller_env = .purrr_error_call
+  )
+
   .x <- vctrs_vec_compat(.x, .purrr_user_env)
   vec_assert(.x, arg = ".x", call = .purrr_error_call)
 

R/map2.R

@@ -69,6 +69,12 @@ map2_ <- function(
   .purrr_user_env = caller_env(2),
   .purrr_error_call = caller_env()
 ) {
+  .progress <- as_progress(
+    .progress,
+    user_env = .purrr_user_env,
+    caller_env = .purrr_error_call
+  )
+
   .x <- vctrs_vec_compat(.x, .purrr_user_env)
   .y <- vctrs_vec_compat(.y, .purrr_user_env)
 

R/pmap.R

@@ -131,6 +131,12 @@ pmap_ <- function(
   .purrr_user_env = caller_env(2),
   .purrr_error_call = caller_env()
 ) {
+  .progress <- as_progress(
+    .progress,
+    user_env = .purrr_user_env,
+    caller_env = .purrr_error_call
+  )
+
   .l <- vctrs_list_compat(.l, error_call = .purrr_error_call)
   .l <- map(.l, vctrs_vec_compat)
 

R/progress-bars.R

@@ -49,3 +49,23 @@
 #'
 #' @name progress_bars
 NULL
+
+as_progress <- function(
+  progress,
+  user_env = caller_env(2),
+  caller_env = caller_env()
+) {
+  if (isFALSE(progress) || isTRUE(progress) || is_string(progress)) {
+    progress
+  } else if (is.list(progress)) {
+    progress$caller <- progress$caller %||% user_env
+    progress
+  } else {
+    stop_input_type(
+      progress,
+      c("TRUE", "FALSE", "a string", "a named list"),
+      arg = ".progress",
+      call = caller_env
+    )
+  }
+}

tests/testthat/_snaps/progress-bars.md

@@ -0,0 +1,8 @@
+# useful for bad progress spec
+
+    Code
+      map(1, .progress = 1)
+    Condition
+      Error in `map()`:
+      ! `.progress` must be TRUE, FALSE, a string, or a named list, not the number 1.
+

tests/testthat/test-progress-bars.R

@@ -0,0 +1,4 @@
+test_that("useful for bad progress spec", {
+  # Test map() to make sure we're passing the caller env correctly
+  expect_snapshot(map(1, .progress = 1), error = TRUE)
+})