Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add tests for readODS_progress() ref#220 #221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chainsawriot merged 1 commit into from
Nov 19, 2025
Merged

Add tests for readODS_progress() ref#220 #221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 19 additions & 18 deletions R/read_ods.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,23 @@ readODS_progress <- function() {
if (isFALSE(getOption("readODS.show_progress", TRUE))) {
return(FALSE)
}

# Don't show in non-interactive sessions
if (!interactive()) {
# make mockable (see utils.R)
if (!.is_interactive()) {
return(FALSE)
}

# Don't show when knitting
if (isTRUE(getOption("knitr.in.progress", FALSE))) {
return(FALSE)
}

# Don't show in RStudio notebook chunks
if (Sys.getenv("RSTUDIO_NOTEBOOK") != "") {
return(FALSE)
}

return(TRUE)
}

Expand All @@ -37,12 +38,12 @@ readODS_progress <- function() {
noop <- function(...) invisible(NULL)
return(list(tick = noop, terminate = noop, update = noop))
}

# Efficient progress bar with minimal overhead
start_time <- Sys.time()
current_progress <- 0L
last_displayed_percent <- -1L

list(
tick = function() {
current_progress <<- current_progress + 1L
Expand Down Expand Up @@ -76,11 +77,11 @@ readODS_progress <- function() {
percent <- min(100L, as.integer((current / total) * 100))
bar_width <- 50L
filled_width <- as.integer((percent / 100) * bar_width)

# Pre-allocate strings for efficiency
equals <- strrep("=", filled_width)
spaces <- strrep(" ", bar_width - filled_width)

elapsed <- as.numeric(difftime(Sys.time(), start_time, units = "secs"))
if (elapsed > 0 && current > 0) {
rate <- current / elapsed
Expand All @@ -97,10 +98,10 @@ readODS_progress <- function() {
} else {
eta_str <- ""
}

# Construct progress bar display
bar <- sprintf("[%s%s]", equals, spaces)

# Use carriage return to overwrite the same line
cat(sprintf("\r%s %3d%% %s", bar, percent, eta_str))
flush.console()
Expand Down Expand Up @@ -316,27 +317,27 @@ readODS_progress <- function() {
guess_max,
progress)
path <- normalizePath(path)

# Initialize progress bar
pb <- .create_progress_bar(progress, total_work = 5)

if (flat) {
.get_sheet_names_func <- get_flat_sheet_names_
.read_ods_func <- read_flat_ods_
} else {
.get_sheet_names_func <- get_sheet_names_
.read_ods_func <- read_ods_
}

pb$tick() # Step 1: Setup complete
## Get cell range info
limits <- .standardise_limits(range, skip, n_max)
pb$tick() # Step 2: Range calculated

sheet_index <- .standardise_sheet(sheet = sheet, sheet_names = .get_sheet_names_func(file = path, include_external_data = TRUE),
range = range)
pb$tick() # Step 3: Sheet identified

strings <- .read_ods_func(file = path,
start_row = limits["min_row"],
stop_row = limits["max_row"],
Expand Down Expand Up @@ -373,10 +374,10 @@ readODS_progress <- function() {
if (as_tibble) {
res <- tibble::as_tibble(x = res, .name_repair = .name_repair)
}

pb$tick() # Step 5: Data processed
pb$terminate() # Finish progress bar

return(res)
}

Expand Down
4 changes: 4 additions & 0 deletions R/utils.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,7 @@ check_nonnegative_integer <- function(x, argument) {
## if ncol == 0, without as.character would return `logical(0)`
as.character(ifelse(unlist(lapply(x, function(x) class(x)[1])) %in% c("integer", "numeric"), "float", "string"))
}

.is_interactive <- function(...) {
interactive()
}
29 changes: 29 additions & 0 deletions tests/testthat/test_progress.R
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
test_that("readODs_progress, normal case", {
## pretend to be interactive
local_mocked_bindings(.is_interactive = function(...) TRUE)
expect_true(readODS_progress())
})

test_that("readODs_progress, suppress in batch", {
## pretend to be batch
local_mocked_bindings(.is_interactive = function(...) FALSE)
expect_false(readODS_progress())
})

test_that("readODS_progress, suppression by options", {
## pretend to be interactive
local_mocked_bindings(.is_interactive = function(...) TRUE)

withr::with_options(list(readODS.show_progress = FALSE), {
expect_false(readODS_progress())
})
withr::with_options(list(knitr.in.progress = TRUE), {
expect_false(readODS_progress())
})
withr::with_envvar(new = c("RSTUDIO_NOTEBOOK" = "123"), {
expect_false(readODS_progress())
})
withr::with_envvar(new = c("RSTUDIO_NOTEBOOK" = ""), {
expect_true(readODS_progress())
})
})
Loading