[protect] allow logical operators in protect worksheet (#662)

JanMarvin · Jun 23, 2023 · 8d6b3ed · 8d6b3ed
1 parent ecd682d
commit 8d6b3ed
Show file tree

Hide file tree

Showing 4 changed files with 61 additions and 9 deletions.
diff --git a/R/class-workbook-wrappers.R b/R/class-workbook-wrappers.R
@@ -1359,12 +1359,20 @@ wb_page_setup <- function(
 #' wb <- wb_workbook()
 #' wb$add_worksheet("S1")
 #' wb$add_data_table(1, x = iris[1:30, ])
-#' # Formatting cells / columns is allowed , but inserting / deleting columns is protected:
-#' wb$protect_worksheet("S1",
+#'
+#' wb$protect_worksheet(
+#'   "S1",
 #'   protect = TRUE,
 #'   properties = c("formatCells", "formatColumns", "insertColumns", "deleteColumns")
 #' )
 #'
+#' # Formatting cells / columns is allowed , but inserting / deleting columns is protected:
+#' wb$protect_worksheet(
+#'   "S1",
+#'   protect = TRUE,
+#'   properties = c(formatCells = FALSE, formatColumns = FALSE, insertColumns = TRUE, deleteColumns = TRUE)
+#' )
+#'
 #' # Remove the protection
 #' wb$protect_worksheet("S1", protect = FALSE)
 wb_protect_worksheet <- function(

diff --git a/R/class-workbook.R b/R/class-workbook.R
@@ -4809,20 +4809,28 @@ wbWorkbook <- R6::R6Class(
 
       if (!is.null(properties)) {
         # ensure only valid properties are listed
-        properties <- match.arg(properties, all_props, several.ok = TRUE)
+        if (is.null(names(properties))) {
+          properties <- match.arg(properties, all_props, several.ok = TRUE)
+          properties <- as_xml_attr(all_props %in% properties)
+          names(properties) <- all_props
+          properties <- properties[properties != "0"]
+        } else {
+          keep <- match.arg(names(properties), all_props, several.ok = TRUE)
+          properties <- properties[keep]
+          nms <- names(properties)
+          properties <- as_xml_attr(properties)
+          names(properties) <- nms
+        }
       }
 
-      properties <- as.character(as.numeric(all_props %in% properties))
-      names(properties) <- all_props
-
       if (!is.null(password))
         properties <- c(properties, password = hashPassword(password))
 
       self$worksheets[[sheet]]$sheetProtection <- xml_node_create(
         "sheetProtection",
         xml_attributes = c(
           sheet = "1",
-          properties[properties != "0"]
+          properties
         )
       )
 

diff --git a/man/wb_protect_worksheet.Rd b/man/wb_protect_worksheet.Rd
diff --git a/tests/testthat/test-protect-worksheet.R b/tests/testthat/test-protect-worksheet.R
@@ -12,3 +12,31 @@ test_that("Protection", {
   wb <- wb_protect_worksheet(wb, sheet = "s2", protect = FALSE)
   expect_equal(wb$worksheets[[2]]$sheetProtection, character())
 })
+
+test_that("logical vector works too", {
+
+  wb <- wb_workbook()$add_worksheet("S1")
+
+  # pre 0.7.1 style
+  wb$protect_worksheet(
+    "S1",
+    protect = TRUE,
+    properties = c("formatCells", "formatColumns", "insertColumns", "deleteColumns")
+  )
+
+  exp <- "<sheetProtection sheet=\"1\" formatCells=\"1\" formatColumns=\"1\" insertColumns=\"1\" deleteColumns=\"1\"/>"
+  got <- wb$worksheets[[1]]$sheetProtection
+  expect_equal(exp, got)
+
+  # post 0.7 style
+  wb$protect_worksheet(
+    "S1",
+    protect = TRUE,
+    properties = c(formatCells = FALSE, formatColumns = FALSE, insertColumns = TRUE, deleteColumns = TRUE)
+  )
+
+  exp <- "<sheetProtection sheet=\"1\" formatCells=\"0\" formatColumns=\"0\" insertColumns=\"1\" deleteColumns=\"1\"/>"
+  got <- wb$worksheets[[1]]$sheetProtection
+  expect_equal(exp, got)
+
+})