Now supporting zero-length progressors (fixes #108)

Author: HenrikBengtsson

NEWS

@@ -1,7 +1,7 @@
 Package: progressr
 ==================
 
-Version: 0.7.0-9000 [2021-02-28]
+Version: 0.7.0-9000 [2021-04-25]
 
 SIGNIFICANT CHANGES:
 
@@ -11,6 +11,9 @@ SIGNIFICANT CHANGES:
 
 NEW FEATURES:
 
+ * Now supporting zero-length progressors, e.g. p <- progressor(along = x)
+   where length(x) == 0.
+   
  * Add handlers("rstudio") to report on progress in the RStudio Console via
    the RStudio Job interface.
 

R/handler_filesize.R

@@ -27,7 +27,7 @@
 handler_filesize <- function(file = "default.progress", intrusiveness = getOption("progressr.intrusiveness.file", 5), target = "file", ...) {
   reporter <- local({
     set_file_size <- function(config, state, progression) {
-      ratio <- state$step / config$max_steps
+      ratio <- if (config$max_steps == 0) 1 else state$step / config$max_steps
       size <- round(100 * ratio)
       current_size <- file.size(file)
       if (is.na(current_size)) file.create(file, showWarnings = FALSE)

R/handler_notifier.R

@@ -29,7 +29,8 @@ handler_notifier <- function(intrusiveness = getOption("progressr.intrusiveness.
   }
 
   notify <- function(step, max_steps, message) {
-    ratio <- sprintf("%.0f%%", 100*step/max_steps)
+    ratio <- if (max_steps == 0) 1 else step / max_steps
+    ratio <- sprintf("%.0f%%", 100*ratio)
     msg <- paste(c("", message), collapse = "")
     notifier_notify(sprintf("[%s] %s", ratio, msg))
   }

R/handler_pbcol.R

@@ -61,7 +61,8 @@ handler_pbcol <- function(adjust = 0.0, pad = 1L, complete = function(s) crayon:
     list(
       initiate = function(config, state, ...) {
         if (!state$enabled || config$times <= 2L) return()
-        redraw_progress_bar(ratio = state$step / config$max_steps, message = state$message, spin = spinner[spin_state+1L])
+        ratio <- if (config$max_steps == 0) 1 else state$step / config$max_steps
+        redraw_progress_bar(ratio = ratio, message = state$message, spin = spinner[spin_state+1L])
       },
 
       reset = function(...) {
@@ -74,14 +75,16 @@ handler_pbcol <- function(adjust = 0.0, pad = 1L, complete = function(s) crayon:
 
       unhide = function(config, state, ...) {
         if (!state$enabled || config$times <= 2L) return()
-        redraw_progress_bar(ratio = state$step / config$max_steps, message = state$message, spin = spinner[spin_state+1L])
+        ratio <- if (config$max_steps == 0) 1 else state$step / config$max_steps
+        redraw_progress_bar(ratio = ratio, message = state$message, spin = spinner[spin_state+1L])
       },
 
       update = function(config, state, progression, ...) {
         if (!state$enabled || config$times <= 2L) return()
         if (state$delta < 0) return()
         spin_state <<- (spin_state+1L) %% length(spinner)
-        redraw_progress_bar(ratio = state$step / config$max_steps, message = state$message, spin = spinner[spin_state+1L])
+        ratio <- if (config$max_steps == 0) 1 else state$step / config$max_steps
+        redraw_progress_bar(ratio = ratio, message = state$message, spin = spinner[spin_state+1L])
       },
 
       finish = function(...) {

R/handler_shiny.R

@@ -25,8 +25,8 @@ handler_shiny <- function(intrusiveness = getOption("progressr.intrusiveness.gui
   reporter <- local({
     list(
       update = function(config, state, progression, ...) {
-        shiny::incProgress(amount = progression$amount / config$max_steps,
-	                   message = state$message)
+        amount <- if (config$max_steps == 0) 1 else progression$amount / config$max_steps
+        shiny::incProgress(amount = amount, message = state$message)
       }
     )
   })

R/make_progression_handler.R

@@ -349,15 +349,16 @@ make_progression_handler <- function(name, reporter = list(), handler = NULL, en
         }
         max_steps <<- p[["steps"]]
         if (debug) mstr(list(max_steps=max_steps))
-        stop_if_not(!is.null(max_steps), is.numeric(max_steps), length(max_steps) == 1L, max_steps >= 1)
+        stop_if_not(!is.null(max_steps), is.numeric(max_steps), length(max_steps) == 1L, max_steps >= 0)
         auto_finish <<- p[["auto_finish"]]
         times <- min(times, max_steps)
         if (debug) mstr(list(auto_finish = auto_finish, times = times, interval = interval, intrusiveness = intrusiveness))
 
         ## Adjust 'times' and 'interval' according to 'intrusiveness'
-        times <- min(times / intrusiveness, max_steps)
+        times <- min(c(times / intrusiveness, max_steps), na.rm = TRUE)
         times <- max(times, 1L)
         interval <- interval * intrusiveness
+        if (debug) mstr(list(times = times, interval = interval))
 
         ## Milestone steps that need to be reach in order to trigger an
         ## update of the reporter