diff --git a/r/R/metadata.R b/r/R/metadata.R index b7d7609e23a2..6630cd313e5e 100644 --- a/r/R/metadata.R +++ b/r/R/metadata.R @@ -176,8 +176,49 @@ apply_arrow_r_metadata <- function(x, r_metadata) { if (is.data.frame(x)) { # if columns metadata exists, apply it here if (length(names(x)) && !is.null(columns_metadata) && !all(map_lgl(columns_metadata, is.null))) { - for (name in intersect(names(columns_metadata), names(x))) { - x[[name]] <- apply_arrow_r_metadata(x[[name]], columns_metadata[[name]]) + column_names <- intersect(names(columns_metadata), names(x)) + standard_data_frame <- identical(class(x), "data.frame") || + identical(class(x), c("tbl_df", "tbl", "data.frame")) + regular_names <- !anyNA(names(x)) && !anyDuplicated(names(x)) && all(nzchar(names(x))) + restored <- NULL + column_indices <- match(column_names, names(x)) + metadata_indices <- match(column_names, names(columns_metadata)) + simple_columns <- FALSE + if (standard_data_frame && regular_names && !is.object(columns_metadata)) { + simple_columns <- all(vapply(seq_along(column_indices), function(i) { + column <- x[[column_indices[[i]]]] + metadata <- columns_metadata[[metadata_indices[[i]]]] + if (!is.atomic(column) || is.object(column) || is.object(metadata)) { + return(FALSE) + } + if (is.null(metadata)) { + return(TRUE) + } + is.list(metadata) && is.null(metadata[["columns"]]) && + !is.object(metadata[["attributes"]]) && + !any(c("class", ".group_vars") %in% names(metadata[["attributes"]])) + }, logical(1))) + } + if (standard_data_frame && regular_names && simple_columns) { + # Assign once instead of copying a wide data frame for every column. + # Retry exceptional metadata in order, preserving partial restoration. + restored <- tryCatch({ + result <- x + result[column_indices] <- lapply(seq_along(column_indices), function(i) { + apply_arrow_r_metadata( + x[[column_indices[[i]]]], columns_metadata[[metadata_indices[[i]]]] + ) + }) + result + }, warning = function(w) NULL, error = function(e) NULL) + } + if (!is.null(restored)) { + x <- restored + } else { + # Preserve replacement-method dispatch for data frame subclasses. + for (name in column_names) { + x[[name]] <- apply_arrow_r_metadata(x[[name]], columns_metadata[[name]]) + } } } } else if (is.list(x) && !inherits(x, "POSIXlt") && !is.null(columns_metadata)) { diff --git a/r/tests/testthat/test-metadata.R b/r/tests/testthat/test-metadata.R index f9955efaf916..eaaaa5b7c5b8 100644 --- a/r/tests/testthat/test-metadata.R +++ b/r/tests/testthat/test-metadata.R @@ -525,3 +525,109 @@ test_that("metadata keys starting with 'r' don't cause partial matching - GH-501 expect_no_warning(as.data.frame(tbl)) expect_no_warning(collect.ArrowTabular(tbl)) }) + +test_that("wide data frame metadata is restored without changing column order", { + x <- tibble::tibble(`a b` = 1:3, untouched = letters[1:3], z = 4:6) + metadata <- list( + columns = list( + z = list(attributes = list(label = "last")), + missing = list(attributes = list(label = "absent")), + `a b` = list(attributes = list(label = "first")) + ), + attributes = list(description = "table") + ) + expected <- x + attr(expected$z, "label") <- "last" + attr(expected[["a b"]], "label") <- "first" + attr(expected, "description") <- "table" + expect_identical(apply_arrow_r_metadata(x, metadata), expected) + expect_identical( + apply_arrow_r_metadata(as.data.frame(x), metadata), + as.data.frame(expected) + ) +}) + +test_that("metadata restoration preserves duplicate names and empty rows", { + for (n in c(0L, 3L)) { + x <- data.frame(a = seq_len(n), b = seq_len(n)) + names(x) <- c("same", "same") + metadata <- list(columns = list(same = list(attributes = list(label = "first")))) + expected <- x + attr(expected[[1]], "label") <- "first" + expect_identical(apply_arrow_r_metadata(x, metadata), expected) + } +}) + +test_that("metadata restoration retains replacement methods for subclasses", { + rlang::local_bindings( + `[[<-.metadata_test_df` = function(x, i, value) { + attr(value, "restored") <- TRUE + NextMethod() + }, + `[<-.metadata_test_df` = function(x, i, value) { + stop("Should use the subclass's single-column replacement method") + }, + .env = globalenv() + ) + x <- structure(data.frame(a = 1:3), class = c("metadata_test_df", "data.frame")) + metadata <- list(columns = list(a = list(attributes = list(label = "a")))) + result <- apply_arrow_r_metadata(x, metadata) + expect_identical(attr(result$a, "label"), "a") + expect_true(attr(result$a, "restored")) + expect_identical(class(result), class(x)) +}) + +test_that("metadata restoration preserves empty and missing column names", { + metadata_for <- function(name) list(attributes = list(label = name)) + for (special_name in c("", NA_character_)) { + x <- data.frame(a = 1:3, unnamed = 4:6, b = 7:9) + names(x)[[2]] <- special_name + metadata <- list( + columns = setNames(lapply(c("a", "ignored", "b"), metadata_for), names(x)), + attributes = list(description = "table") + ) + # Preserve the existing single-column replacement behavior for unusual names. + expected <- x + if (is.na(special_name)) { + expected[[NA_character_]] <- NULL + } + attr(expected$a, "label") <- "a" + attr(expected$b, "label") <- "b" + attr(expected, "description") <- "table" + expect_identical(apply_arrow_r_metadata(x, metadata), expected) + } +}) + +test_that("invalid column metadata preserves earlier restored columns", { + x <- data.frame(a = 1:4, b = 5:8, c = 9:12) + metadata <- list(columns = list( + a = list(attributes = list(label = "first")), + b = list(attributes = list(dim = c(2L, 2L))), + c = list(attributes = list(label = "last")) + )) + expected <- x + attr(expected$a, "label") <- "first" + expect_warning(result <- apply_arrow_r_metadata(x, metadata), "Invalid metadata", fixed = TRUE) + expect_identical(result, expected) +}) + +test_that("failed metadata restoration does not visit later custom columns", { + visits <- 0L + rlang::local_bindings( + `[[<-.metadata_nested_df` = function(x, i, value) { + visits <<- visits + 1L + NextMethod() + }, + .env = globalenv() + ) + x <- data.frame(a = 1:4, b = 5:8) + x$c <- structure(data.frame(k = 1:4), class = c("metadata_nested_df", "data.frame")) + metadata <- list(columns = list( + a = list(attributes = list(label = "first")), + b = list(attributes = list(dim = c(2L, 2L))), + c = list(columns = list(k = list(attributes = list(label = "nested")))) + )) + expect_warning(result <- apply_arrow_r_metadata(x, metadata), "Invalid metadata", fixed = TRUE) + expect_identical(visits, 0L) + expect_identical(attr(result$a, "label"), "first") +})