rename border_size to border_width

Author: thomasp85

DESCRIPTION

@@ -22,6 +22,7 @@ Imports:
     grDevices,
     grid,
     jpeg,
+    lifecycle,
     png,
     rlang (>= 1.1.0),
     S7,

NAMESPACE

@@ -62,6 +62,7 @@ export(style_set)
 export(trbl)
 import(grid)
 import(rlang)
+importFrom(lifecycle,deprecated)
 importFrom(vctrs,vec_cast)
 importFrom(vctrs,vec_ptype2)
 useDynLib(marquee, .registration = TRUE)

NEWS.md

@@ -1,6 +1,7 @@
 # marquee (development version)
 
 * Better vectorisation of style_set and classic_style
+* Renamed `border_size` to `border_width` for consistency
 
 # marquee 1.1.1
 

R/classic_style.R

@@ -77,7 +77,7 @@ classic_style <- function(
       hr = style(
         padding = trbl(0, 0, rem(1 / 8)),
         border = "#eeeeee",
-        border_size = trbl(0, 0, rem(1 / 16))
+        border_width = trbl(0, 0, rem(1 / 16))
       ),
       h1 = style(
         family = header_font,
@@ -87,7 +87,7 @@ classic_style <- function(
         margin = trbl(em(1), NULL, NULL, NULL),
         padding = trbl(0, 0, em(0.3)),
         border = "#eeeeee",
-        border_size = trbl(0, 0, rem(1 / 16))
+        border_width = trbl(0, 0, rem(1 / 16))
       ),
       h2 = style(
         family = header_font,
@@ -97,7 +97,7 @@ classic_style <- function(
         margin = trbl(em(1), NULL, NULL, NULL),
         padding = trbl(0, 0, em(0.3)),
         border = "#eeeeee",
-        border_size = trbl(0, 0, rem(1 / 16))
+        border_width = trbl(0, 0, rem(1 / 16))
       ),
       h3 = style(
         family = header_font,
@@ -143,7 +143,7 @@ classic_style <- function(
           trbl(em(0.2), em(1), em(0.2), 0)
         },
         border = "#dddddd",
-        border_size = if (ltr) {
+        border_width = if (ltr) {
           trbl(0, 0, 0, rem(0.25))
         } else {
           trbl(0, rem(0.25), 0, 0)

R/geom_marquee.R

@@ -59,7 +59,7 @@
 #'   "body",
 #'   padding = skip_inherit(trbl(4)),
 #'   border = "black",
-#'   border_size = skip_inherit(trbl(1)),
+#'   border_width = skip_inherit(trbl(1)),
 #'   border_radius = 3
 #' )
 #' p + geom_marquee(aes(label = rownames(mtcars), fill = gear), style = label_style)

R/grob.R

@@ -262,8 +262,8 @@ marquee_grob <- function(
     function(x) !(is.character(x) && is.na(x[1])),
     logical(1)
   )
-  has_top <- !is.na(parsed$border) & parsed$border_size_top != 0
-  has_bottom <- !is.na(parsed$border) & parsed$border_size_bottom != 0
+  has_top <- !is.na(parsed$border) & parsed$border_width_top != 0
+  has_bottom <- !is.na(parsed$border) & parsed$border_width_bottom != 0
   for (root in blocks$start[blocks$indent == 1]) {
     block_tree <- collect_children(
       root,
@@ -868,10 +868,10 @@ makeContext.marquee_grob <- function(x) {
     logical(1)
   ) |
     (!is.na(x$text$border) &
-      (x$text$border_size_bottom > 0 |
-        x$text$border_size_top > 0 |
-        x$text$border_size_left > 0 |
-        x$text$border_size_right > 0))
+      (x$text$border_width_bottom > 0 |
+        x$text$border_width_top > 0 |
+        x$text$border_width_left > 0 |
+        x$text$border_width_right > 0))
 
   ## Handle block backgrounds
   block_bg <- has_deco[x$blocks$start]
@@ -886,10 +886,10 @@ makeContext.marquee_grob <- function(x) {
     fill = x$text$background[x$blocks$start[block_bg]],
     col = x$text$border[x$blocks$start[block_bg]],
     r = x$text$border_radius[x$blocks$start[block_bg]],
-    left = x$text$border_size_left[x$blocks$start[block_bg]],
-    right = x$text$border_size_right[x$blocks$start[block_bg]],
-    top = x$text$border_size_top[x$blocks$start[block_bg]],
-    bottom = x$text$border_size_bottom[x$blocks$start[block_bg]]
+    left = x$text$border_width_left[x$blocks$start[block_bg]],
+    right = x$text$border_width_right[x$blocks$start[block_bg]],
+    top = x$text$border_width_top[x$blocks$start[block_bg]],
+    bottom = x$text$border_width_bottom[x$blocks$start[block_bg]]
   )
 
   ## Handle span backgrounds
@@ -946,10 +946,10 @@ makeContext.marquee_grob <- function(x) {
     fill = c(block_rects$fill, x$text$background[span_rects[, 1]]),
     col = c(block_rects$col, x$text$border[span_rects[, 1]]),
     r = c(block_rects$r, x$text$border_radius[span_rects[, 1]]),
-    left = c(block_rects$left, x$text$border_size_left[span_rects[, 1]]),
-    right = c(block_rects$right, x$text$border_size_right[span_rects[, 1]]),
-    top = c(block_rects$top, x$text$border_size_top[span_rects[, 1]]),
-    bottom = c(block_rects$bottom, x$text$border_size_bottom[span_rects[, 1]])
+    left = c(block_rects$left, x$text$border_width_left[span_rects[, 1]]),
+    right = c(block_rects$right, x$text$border_width_right[span_rects[, 1]]),
+    top = c(block_rects$top, x$text$border_width_top[span_rects[, 1]]),
+    bottom = c(block_rects$bottom, x$text$border_width_bottom[span_rects[, 1]])
   )
 
   ## Extract position of underline and strikethrough
@@ -1384,12 +1384,12 @@ has_identical_background <- function(a, b, style) {
         identical(style$border[a], style$border[b]) &&
         (is.na(style$border[a]) ||
           (identical(
-            style$border_size_bottom[a],
-            style$border_size_bottom[b]
+            style$border_width_bottom[a],
+            style$border_width_bottom[b]
           ) &&
-            identical(style$border_size_top[a], style$border_size_top[b]) &&
-            identical(style$border_size_left[a], style$border_size_left[b]) &&
-            identical(style$border_size_right[a], style$border_size_right[b])))
+            identical(style$border_width_top[a], style$border_width_top[b]) &&
+            identical(style$border_width_left[a], style$border_width_left[b]) &&
+            identical(style$border_width_right[a], style$border_width_right[b])))
     },
     a = a,
     b = b

R/guide_marquee.R

@@ -78,7 +78,7 @@
 #' # prefixed with `lab_`.
 #' st <- classic_style()
 #' st <- modify_style(st, tag = "lab_f", background = NULL, color = "black")
-#' st <- modify_style(st, tag = "lab_r", border_size = trbl(1),
+#' st <- modify_style(st, tag = "lab_r", border_width = trbl(1),
 #'                    color = "black", background = NA)
 #' base + guides(colour = guide_marquee(style = st))
 #'

R/marquee-package.R

@@ -2,8 +2,9 @@
 "_PACKAGE"
 
 ## usethis namespace: start
-#' @useDynLib marquee, .registration = TRUE
-#' @import rlang
 #' @import grid
+#' @import rlang
+#' @importFrom lifecycle deprecated
+#' @useDynLib marquee, .registration = TRUE
 ## usethis namespace: end
 NULL

R/style.R

@@ -52,7 +52,7 @@
 #' made with `grid::linearGradient()`/`grid::radialGradient()`/`grid::pattern()`
 #' @param border The color of the background stroke. The background includes
 #' the padding but not the margin
-#' @param border_size The line width of the background stroke, given as a call
+#' @param border_width The line width of the background stroke, given as a call
 #' to [trbl()]
 #' @param border_radius The corner radius of the background, given in points
 #' @param outline The color of the outline stroke.
@@ -75,6 +75,9 @@
 #' consequtive blocks of text are laid out left-to-right or right-to-left. It
 #' also affects to which side indentation is applied as well as the meaning of
 #' `"auto"`, and `"justified-auto"` aligment.
+#' @param border_size `r lifecycle::badge('deprecated')` Use `border_width`
+#' instead
+#'
 #'
 #' @return A `marquee_style` object
 #'
@@ -104,7 +107,7 @@ style <- function(
   padding = NULL,
   background = NULL,
   border = NULL,
-  border_size = NULL,
+  border_width = NULL,
   border_radius = NULL,
   outline = NULL,
   outline_width = NULL,
@@ -115,7 +118,8 @@ style <- function(
   strikethrough = NULL,
   baseline = NULL,
   img_asp = NULL,
-  text_direction = NULL
+  text_direction = NULL,
+  border_size = deprecated()
 ) {
   check_string(family, allow_null = TRUE)
 
@@ -204,11 +208,16 @@ style <- function(
     border[] <- NA_character_
   }
 
-  if (is.null(border_size)) {
-    border_size <- trbl()
+  if (lifecycle::is_present(border_size)) {
+    lifecycle::deprecate_soft("1.1.2", "style(border_size)", "style(border_width)")
+    border_width <- border_size
+  }
+
+  if (is.null(border_width)) {
+    border_width <- trbl()
   }
-  if (!is_trbl(border_size)) {
-    stop_input_type(border_size, "a marquee_trbl object", allow_null = TRUE)
+  if (!is_trbl(border_width)) {
+    stop_input_type(border_width, "a marquee_trbl object", allow_null = TRUE)
   }
 
   if (is.unit(border_radius)) {
@@ -277,10 +286,10 @@ style <- function(
       padding_bottom = padding[[3]],
       padding_left = padding[[4]],
       border = border,
-      border_size_top = border_size[[1]],
-      border_size_right = border_size[[2]],
-      border_size_bottom = border_size[[3]],
-      border_size_left = border_size[[4]],
+      border_width_top = border_width[[1]],
+      border_width_right = border_width[[2]],
+      border_width_bottom = border_width[[3]],
+      border_width_left = border_width[[4]],
       border_radius = border_radius,
       outline = outline,
       outline_width = outline_width,
@@ -383,7 +392,7 @@ base_style <- function(
   padding = trbl(0),
   background = NA,
   border = NA,
-  border_size = trbl(0),
+  border_width = trbl(0),
   border_radius = 0,
   outline = NA,
   outline_width = 1,
@@ -394,8 +403,13 @@ base_style <- function(
   strikethrough = FALSE,
   baseline = 0,
   img_asp = 1.65,
-  text_direction = "auto"
+  text_direction = "auto",
+  border_size = deprecated()
 ) {
+  if (lifecycle::is_present(border_size)) {
+    lifecycle::deprecate_soft("1.1.2", "base_style(border_size)", "base_style(border_width)")
+    border_width <- border_size
+  }
   style(
     family = family,
     weight = weight,
@@ -413,7 +427,7 @@ base_style <- function(
     padding = padding,
     background = background,
     border = border,
-    border_size = border_size,
+    border_width = border_width,
     border_radius = border_radius,
     outline = outline,
     outline_width = outline_width,

R/style_set.R

@@ -102,7 +102,7 @@ modify_style.marquee_style_set <- function(x, tag, ...) {
   opts$tag <- NULL
 
   args <- names(opts)
-  expand <- args %in% c("margin", "padding", "border_size")
+  expand <- args %in% c("margin", "padding", "border_width")
   if (any(expand)) {
     args <- c(
       args[!expand],
@@ -150,7 +150,7 @@ modify_style.marquee_style_set <- function(x, tag, ...) {
 modify_style.marquee_style <- function(x, tag, ...) {
   opts <- list2(...)
   args <- names(opts)
-  expand <- args %in% c("margin", "padding", "border_size")
+  expand <- args %in% c("margin", "padding", "border_width")
   if (any(expand)) {
     args <- c(
       args[!expand],