use bslib to load brand.yml files (#241)

* use bslib to load brand.yml files

* check for bslib and other suggested packages

also rename *ggplot to *ggplot2

* artifacts

Author: gordonwoodhull

DESCRIPTION

@@ -17,7 +17,7 @@ URL: https://github.com/quarto-dev/quarto-r,
 BugReports: https://github.com/quarto-dev/quarto-r/issues
 Depends: 
     R (>= 3.6)
-Imports: 
+Imports:
     cli,
     jsonlite,
     later,
@@ -29,6 +29,7 @@ Imports:
     utils,
     yaml
 Suggests: 
+    bslib,
     callr,
     curl,
     dplyr,

NAMESPACE

@@ -19,12 +19,12 @@ export(quarto_update_extension)
 export(quarto_use_template)
 export(quarto_version)
 export(theme_brand_flextable)
-export(theme_brand_ggplot)
+export(theme_brand_ggplot2)
 export(theme_brand_gt)
 export(theme_brand_plotly)
 export(theme_brand_thematic)
 export(theme_colors_flextable)
-export(theme_colors_ggplot)
+export(theme_colors_ggplot2)
 export(theme_colors_gt)
 export(theme_colors_plotly)
 export(theme_colors_thematic)

R/theme.R

@@ -14,6 +14,10 @@
 #'
 #' @export
 theme_colors_flextable <- function(bg, fg) {
+  rlang::check_installed(
+    "flextable",
+    "flextable is required for theme_colors_flextable"
+  )
   (function(x) {
     if (!inherits(x, "flextable")) {
       stop("theme_colors_flextable only supports flextable objects.")
@@ -28,18 +32,24 @@ theme_colors_flextable <- function(bg, fg) {
 #'
 #' @export
 theme_brand_flextable <- function(brand_yml) {
-  brand <- yaml::yaml.load_file(brand_yml)
+  rlang::check_installed(
+    "bslib",
+    "bslib is required for brand support in R",
+    version = "0.9.0"
+  )
+  brand <- attr(bslib::bs_theme(brand = brand_yml), "brand")
   theme_colors_flextable(brand$color$background, brand$color$foreground)
 }
 
 
 #' @rdname theme_helpers
 #'
 #' @export
-theme_colors_ggplot <- function(bg, fg) {
-  if (!requireNamespace("ggplot2", quietly = TRUE)) {
-    return(NULL)
-  }
+theme_colors_ggplot2 <- function(bg, fg) {
+  rlang::check_installed(
+    "ggplot2",
+    "ggplot2 is required for theme_colors_ggplot2"
+  )
   ggplot2::`%+%`(
     ggplot2::theme_minimal(base_size = 11),
     ggplot2::theme(
@@ -61,16 +71,25 @@ theme_colors_ggplot <- function(bg, fg) {
 #' @rdname theme_helpers
 #'
 #' @export
-theme_brand_ggplot <- function(brand_yml) {
-  brand <- yaml::yaml.load_file(brand_yml)
-  theme_colors_ggplot(brand$color$background, brand$color$foreground)
+theme_brand_ggplot2 <- function(brand_yml) {
+  rlang::check_installed(
+    "bslib",
+    "bslib is required for brand support in R",
+    version = "0.9.0"
+  )
+  brand <- attr(bslib::bs_theme(brand = brand_yml), "brand")
+  theme_colors_ggplot2(brand$color$background, brand$color$foreground)
 }
 
 
 #' @rdname theme_helpers
 #'
 #' @export
 theme_colors_gt <- function(bg, fg) {
+  rlang::check_installed(
+    "gt",
+    "gt is required for theme_colors_gt"
+  )
   (function(table) {
     table |>
       gt::tab_options(
@@ -84,14 +103,23 @@ theme_colors_gt <- function(bg, fg) {
 #'
 #' @export
 theme_brand_gt <- function(brand_yml) {
-  brand <- yaml::yaml.load_file(brand_yml)
+  rlang::check_installed(
+    "bslib",
+    "bslib is required for brand support in R",
+    version = "0.9.0"
+  )
+  brand <- attr(bslib::bs_theme(brand = brand_yml), "brand")
   theme_colors_gt(brand$color$background, brand$color$foreground)
 }
 
 #' @rdname theme_helpers
 #'
 #' @export
 theme_colors_plotly <- function(bg, fg) {
+  rlang::check_installed(
+    "plotly",
+    "plotly is required for theme_colors_plotly"
+  )
   (function(plot) {
     plot |>
       plotly::layout(
@@ -106,7 +134,12 @@ theme_colors_plotly <- function(bg, fg) {
 #'
 #' @export
 theme_brand_plotly <- function(brand_yml) {
-  brand <- yaml::yaml.load_file(brand_yml)
+  rlang::check_installed(
+    "bslib",
+    "bslib is required for brand support in R",
+    version = "0.9.0"
+  )
+  brand <- attr(bslib::bs_theme(brand = brand_yml), "brand")
   theme_colors_plotly(brand$color$background, brand$color$foreground)
 }
 
@@ -115,6 +148,10 @@ theme_brand_plotly <- function(brand_yml) {
 #'
 #' @export
 theme_colors_thematic <- function(bg, fg) {
+  rlang::check_installed(
+    "thematic",
+    "thematic is required for theme_colors_thematic"
+  )
   (function() {
     thematic::thematic_rmd(
       bg = bg,
@@ -127,6 +164,11 @@ theme_colors_thematic <- function(bg, fg) {
 #'
 #' @export
 theme_brand_thematic <- function(brand_yml) {
-  brand <- yaml::yaml.load_file(brand_yml)
+  rlang::check_installed(
+    "bslib",
+    "bslib is required for brand support in R",
+    version = "0.9.0"
+  )
+  brand <- attr(bslib::bs_theme(brand = brand_yml), "brand")
   theme_colors_thematic(brand$color$background, brand$color$foreground)
 }

man/quarto_publish_doc.Rd

@@ -14,8 +14,8 @@ test_that("render ggiraph", {
   .render(test_path("theme/ggiraph.qmd"))
 })
 
-test_that("render ggplot", {
-  .render(test_path("theme/ggplot.qmd"))
+test_that("render ggplot2", {
+  .render(test_path("theme/ggplot2.qmd"))
 })
 
 test_that("render gt", {

man/theme_helpers.Rd

@@ -12,8 +12,8 @@ library(quarto)
 library(ggplot2)
 library(ggiraph)
 
-united_theme <- theme_brand_ggplot("united-brand.yml")
-slate_theme <- theme_brand_ggplot("slate-brand.yml")
+united_theme <- theme_brand_ggplot2("united-brand.yml")
+slate_theme <- theme_brand_ggplot2("slate-brand.yml")
 ```
 
 ```{r}

tests/testthat/test-theme.R

@@ -12,8 +12,8 @@ brand:
 library(quarto)
 library(ggplot2)
 
-united_theme <- theme_brand_ggplot("united-brand.yml")
-slate_theme <- theme_brand_ggplot("slate-brand.yml")
+united_theme <- theme_brand_ggplot2("united-brand.yml")
+slate_theme <- theme_brand_ggplot2("slate-brand.yml")
 ```
 
 ```{r}

tests/testthat/theme/ggiraph.qmd

@@ -56,7 +56,7 @@ library(quarto)
 library(ggplot2)
 library(ggiraph)
 
-blue_mauve_theme = theme_colors_ggplot("#111038", "#E0B0FF")
+blue_mauve_theme = theme_colors_ggplot2("#111038", "#E0B0FF")
 
 cars <- ggplot(mtcars, aes(mpg, wt)) +
   geom_point_interactive(aes(colour = factor(cyl), tooltip = rownames(mtcars))) +
@@ -76,7 +76,7 @@ Demonstrates a ggplot2 plot with near-black background and green-grey foreground
 library(quarto)
 library(ggplot2)
 
-black_greyn <- theme_colors_ggplot("#050411", "#8faf8e")
+black_greyn <- theme_colors_ggplot2("#050411", "#8faf8e")
 
 cars <- ggplot(mtcars, aes(mpg, wt)) +
   geom_point(aes(colour = factor(cyl))) +