163 since format is printed, we may want to improve how formats are p…

…rinted, currently it is (#164)

#163

close #163 

Improve the print method to display `<NA>` when the value is `NA` and
surround strings with `"` to highlight the fact that they are character
and allow to better visualize with spaces.

thank you for the review

NEWS.md

@@ -2,7 +2,8 @@
 
 * Rules specified under the `all_datasets` keyword in a format list will apply to every data set of the reformatted object unless specified otherwise.
 * New `verbose` argument in the `reformat` method. When applied to `list` the value of this augment can be controlled with the `dunlin.reformat.verbose` option or the `R_DUNLIN_REFORMAT_VERBOSE` environment variable.
-
+* Improve the output when printing `rule` objects.
+
 # dunlin 0.1.6
 
 * `render_safe` now renders placeholder using in priority values corresponding to the key matching exactly the placeholder, case included.

R/rules.R

@@ -48,16 +48,21 @@ rule <- function(..., .lst = list(...), .string_as_fct = TRUE, .na_last = TRUE,
 #'
 print.rule <- function(x, ...) {
   cat("Mapping of:\n")
-  nms <- names(x)
+  nms <- unique(names(x))
   if (length(x) == 0) {
     cat("Empty mapping.\n")
   } else {
-    for (i in seq_len(length(x))) {
-      cat(nms[i], " <- ", if (length(x[[i]]) > 1) sprintf("[%s]", toString(x[[i]])) else x[[i]], "\n")
+    for (i in nms) {
+      ori_nms <- unlist(x[names(x) %in% i])
+      ori_nms <- ifelse(is.na(ori_nms), "<NA>", stringr::str_c("\"", ori_nms, "\""))
+      ori_nms <- toString(ori_nms)
+      cat(i, " <- ", ori_nms, "\n")
     }
   }
   .to_NA <- attr(x, ".to_NA")
-  if (!is.null(.to_NA)) cat("NA <- ", toString(.to_NA), "\n")
+  if (!is.null(.to_NA)) {
+    cat("Convert to <NA>:", toString(stringr::str_c("\"", .to_NA, "\"")), "\n")
+  }
   cat("Convert to factor:", attr(x, ".string_as_fct"), "\n")
   cat("Drop unused level:", attr(x, ".drop"), "\n")
   cat("NA-replacing level in last position:", attr(x, ".na_last"), "\n")

tests/testthat/_snaps/rules.md

@@ -4,9 +4,24 @@
       rule(a = "1", b = NA)
     Output
       Mapping of:
-      a  <-  1 
-      b  <-  NA 
-      NA <-   
+      a  <-  "1" 
+      b  <-  <NA> 
+      Convert to <NA>: "" 
+      Convert to factor: TRUE 
+      Drop unused level: FALSE 
+      NA-replacing level in last position: TRUE 
+
+# rule with multiple matching printed correctly
+
+    Code
+      rule(a = "1", b = c(NA, "b"), x = c("first", "second"), .to_NA = c("",
+        "missing"))
+    Output
+      Mapping of:
+      a  <-  "1" 
+      b  <-  <NA>, "b" 
+      x  <-  "first", "second" 
+      Convert to <NA>: "", "missing" 
       Convert to factor: TRUE 
       Drop unused level: FALSE 
       NA-replacing level in last position: TRUE 

tests/testthat/test-rules.R

@@ -38,10 +38,16 @@ test_that("rule fails for values that is not character/logical/numeric", {
   )
 })
 
+# print ----
+
 test_that("rule printed correctly", {
   expect_snapshot(rule(a = "1", b = NA))
 })
 
+test_that("rule with multiple matching printed correctly", {
+  expect_snapshot(rule(a = "1", b = c(NA, "b"), x = c("first", "second"), .to_NA = c("", "missing")))
+})
+
 # list2rules ----
 
 test_that("list2rules works as expected", {