More explicit message when caching a google font (#141)

* More explicit message when caching a google font

* Only message for real caches

* Also record path

* Show download message when no cache is present

* Tweak transform

* Update NEWS.md

---------

Co-authored-by: Carson <cpsievert1@gmail.com>

NEWS.md

@@ -1,5 +1,7 @@
 # sass (development version)
 
+- More informative output when `font_google()` downloads google font files (for `font_google(local=TRUE)`).
+
 # sass 0.4.9
 
 - Closed #138: font_google(local = TRUE) now uses woff2 (instead of woff) for a font file type. (#139) 

R/fonts.R

@@ -414,6 +414,7 @@ font_dep_google_local <- function(x) {
   dir.create(tmpdir, recursive = TRUE)
   css_file <- file.path(tmpdir, "font.css")
 
+  has_cache <- is_cache_object(x$cache)
   x$cache <- resolve_cache(x$cache)
 
   css_key <- hash_with_user_agent(x$href)
@@ -429,6 +430,7 @@ font_dep_google_local <- function(x) {
 
   # If need be, download the font file(s) that the CSS imports,
   # and modify the CSS to point to the local files
+  needs_download_message <- TRUE
   Map(function(url, nm) {
     key <- hash_with_user_agent(nm)
     f <- file.path(tmpdir, nm)
@@ -441,7 +443,17 @@ font_dep_google_local <- function(x) {
       x$cache$remove(css_key)
       return(font_dep_google_local(x))
     }
-    download_file(url, f)
+
+    if (needs_download_message) {
+      needs_download_message <<- FALSE
+      download_msg <- paste0("Downloading google font ", x$family)
+      if (has_cache) {
+        download_msg <- paste0(download_msg, " to local cache (", x$cache$dir(), ")")
+      }
+      rlang::inform(download_msg)
+    }
+
+    download_file(url, f, quiet = TRUE)
     x$cache$set_file(key, f)
     css <<- sub(url, nm, css, fixed = TRUE)
   }, urls, basenames)
@@ -466,7 +478,8 @@ read_gfont_url <- function(url, file) {
 
   download_file(
     utils::URLencode(url), file,
-    headers = c("User-Agent" = gfont_user_agent())
+    headers = c("User-Agent" = gfont_user_agent()),
+    quiet = TRUE
   )
   readLines(file)
 }
@@ -493,7 +506,8 @@ extract_group <- function(x, pattern, which = 1) {
 # similar to thematic:::download_file, but also translates headers to curl
 #' @importFrom stats na.omit
 #' @importFrom utils download.file packageVersion
-download_file <- function(url, dest, headers = NULL, ...) {
+download_file <- function(url, dest, headers = NULL, quiet = FALSE, ...) {
+
   if (is_installed("curl")) {
     if (!curl::has_internet()) {
       warning(
@@ -505,11 +519,11 @@ download_file <- function(url, dest, headers = NULL, ...) {
       )
     }
     handle <- curl::handle_setheaders(curl::new_handle(), .list = headers)
-    return(curl::curl_download(url, dest, handle = handle, quiet = FALSE, ...))
+    return(curl::curl_download(url, dest, handle = handle, quiet = quiet, ...))
   }
 
   if (capabilities("libcurl")) {
-    return(download.file(url, dest, method = "libcurl", headers = headers, ...))
+    return(download.file(url, dest, method = "libcurl", headers = headers, quiet = quiet, ...))
   }
 
   stop(

tests/testthat/_snaps/font-objects.md

@@ -187,6 +187,18 @@
 
 # font_google(local = TRUE) basically works
 
+    Code
+      tagz <- renderTags(tags$style(sass(scss)))
+    Message
+      Downloading google font Pacifico to local cache (<temp-cache>)
+
+---
+
+    Code
+      tagz <- renderTags(tags$style(sass(scss)))
+
+---
+
     Code
       tagz$html
     Output

tests/testthat/test-font-objects.R

@@ -62,12 +62,15 @@ test_that("font_google(local = TRUE) basically works", {
   )
 
   # 1st time rendering font should add files to cache
-  tagz <- renderTags(tags$style(sass(scss)))
+  expect_snapshot(
+    tagz <- renderTags(tags$style(sass(scss))),
+    transform = function(x) gsub("\\(.*\\)", "(<temp-cache>)", x)
+  )
   size <- cache$size()
   expect_true(size > 0)
 
   # 2md time should result in cache hit
-  tagz <- renderTags(tags$style(sass(scss)))
+  expect_snapshot(tagz <- renderTags(tags$style(sass(scss))))
   expect_true(size == cache$size())
 
   # Make sure the markup structure and files are as expected