export: mf_col_widths (#374)

`junco` uses `mf_col_widths`. To use a public, stable API and avoid
relying on unexported internal symbols, can we consider exporting
`mf_col_widths` in the next release?

I have added a test for it.

See -> johnsonandjohnson/junco#317

---------

Co-authored-by: Copilot <copilot@github.com>

Author: munoztd0

NAMESPACE

@@ -5,6 +5,7 @@ export("main_footer<-")
 export("main_title<-")
 export("mf_aligns<-")
 export("mf_cinfo<-")
+export("mf_col_widths<-")
 export("mf_colgap<-")
 export("mf_display<-")
 export("mf_fontspec<-")
@@ -59,6 +60,7 @@ export(make_row_df)
 export(matrix_form)
 export(mf_aligns)
 export(mf_cinfo)
+export(mf_col_widths)
 export(mf_colgap)
 export(mf_display)
 export(mf_fontspec)

NEWS.md

@@ -1,5 +1,7 @@
 ## formatters 0.5.12.9002
 
+* Export `mf_col_widths` accessor (`getter` and `setter`).
+
 ## formatters 0.5.12
 * Added `"default"` format label which behaves like `"xx"` in `format_value` but indicates formatting behavior can be inherited from parent structures in upstream code.
 * `round_type = "sas"` no longer displays a negative sign when negative values are rounded to zero.

R/matrix_form.R

@@ -625,10 +625,14 @@ mf_col_paths <- function(mf) {
   }
 }
 
+#' @export
+#' @rdname mpf_accessors
 mf_col_widths <- function(mf) {
   mf$col_widths
 }
 
+#' @export
+#' @rdname mpf_accessors
 `mf_col_widths<-` <- function(mf, value) {
   if (!is.null(value) && length(value) != NCOL(mf_strings(mf))) {
     stop(

man/mpf_accessors.Rd

@@ -0,0 +1,12 @@
+test_that("mf_col_widths getter and setter are available and work", {
+  mf <- basic_matrix_form(mtcars)
+
+  # getter returns numeric vector
+  cw <- mf_col_widths(mf)
+  expect_true(is.numeric(cw))
+
+  # setter updates widths
+  new <- rep(10L, NCOL(mf_strings(mf)))
+  mf_col_widths(mf) <- new
+  expect_equal(mf_col_widths(mf), new)
+})