Merge pull request #270 from carpentries/add-engine-customisation

update to allow for custom/pinned engines

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: sandpaper
 Title: Create and Curate Carpentries Lessons
-Version: 0.3.5
+Version: 0.3.6
 Authors@R: c(
     person(given = "Zhian N.",
            family = "Kamvar",

NEWS.md

@@ -1,3 +1,14 @@
+# sandpaper 0.3.6
+
+MISC
+----
+
+* custom sandpaper and varnish engines will be properly linked to the footer
+  of the lesson pages via this version and varnish 0.1.8.
+* testthat tests have been updated.
+* a diagram in the vingettes has been updated to reflect the parallel roles of
+  sandpaper and pegboard to a lesson.
+
 # sandpaper 0.3.5
 
 BUG FIX

R/set_dropdown.R

@@ -61,10 +61,12 @@ set_dropdown <- function(path = ".", order = NULL, write = FALSE, folder) {
   invisible()
 }
 
+#' Set individual keys in a configuration file
 #' @param pairs a named character vector with keys as the names and the new 
 #'  values as the contents
+#' @inheritParams set_dropdown
+#'
 #' @export
-#' @rdname set_dropdown
 set_config <- function(pairs = NULL, path = ".", write = FALSE) {
   keys <- names(pairs)
   values <- pairs

R/utils-varnish.R

@@ -1,9 +1,32 @@
 varnish_vars <- function() {
   ver <- function(pak) glue::glue(" ({packageVersion(pak)})")
+  cfg <- function(pkg) {
+    desc <- packageDescription(pkg)
+    url <- desc[["RemoteUrl"]]
+    ref <- desc[["RemoteRef"]] %||% "HEAD" # if there is no ref, default to HEAD
+    vsn <- desc[["Version"]]
+    if (!is.null(url) && ref == vsn) {
+      user <- "carpentries"
+      repo <- pkg
+    } else {
+      user <- desc[["RemoteUsername"]]
+      repo <- desc[["RemoteRepo"]]
+    }
+    if (is.null(user) || is.null(repo)) {
+      return(NULL)
+    }
+    if (ref == "HEAD" && !is.null(desc[["RemoteSha"]])) {
+      ref <- desc[["RemoteSha"]]
+    }
+    res <- paste0(user, "/", repo, "/tree/", ref)
+    return(res)
+  }
   list(
     sandpaper_version = ver("sandpaper"),
+    sandpaper_cfg     = cfg("sandpaper"),
     pegboard_version  = ver("pegboard"),
-    varnish_version   = ver("varnish")
+    varnish_version   = ver("varnish"),
+    varnish_cfg       = cfg("varnish")
   )
 }
 

_pkgdown.yml

@@ -34,6 +34,7 @@ reference:
    - validate_lesson
    - get_drafts
    - get_config
+   - set_dropdown
    - get_episodes
    - set_episodes
    - get_syllabus