refactor: Organize scripts/htmlDependencies into functions

Author: gadenbuie

scripts/_functions_deps.R

@@ -0,0 +1,298 @@
+assert_npm_is_installed <- function() {
+  if (Sys.which("npm")[["npm"]] == "") {
+    cli::cli_abort(c(
+      "{.strong {npm}} is required to install JavaScript dependenceis.",
+      i = "Please install {.url https://nodejs.org}."
+    ))
+  }
+
+  cli::cli_alert_success("{.strong npm} is installed")
+  invisible(TRUE)
+}
+
+pkg_source_version <- function(pkg) {
+  desc <- suppressWarnings(utils::packageDescription(pkg))
+  if (!inherits(desc, "packageDescription")) {
+    return("[not installed]")
+  }
+  version <- desc[["Version"]]
+  if (is.null(desc[["GithubRepo"]])) {
+    return(version)
+  }
+
+  sprintf(
+    "%s (%s/%s@%s)",
+    version,
+    desc[["GithubUsername"]],
+    desc[["GithubRepo"]],
+    desc[["GithubSHA1"]]
+  )
+}
+
+write_json <- function(
+	file,
+	x,
+	...,
+	pretty = TRUE,
+	auto_unbox = TRUE,
+  generated_by = "scripts/htmlDependencies.R"
+) {
+	jsonlite::write_json(
+		c(
+			list(
+        "note!" = sprintf("Generated by %s: do not edit by hand", generated_by)
+      ),
+      x
+		),
+		file,
+		...,
+		pretty = pretty,
+		auto_unbox = auto_unbox
+	)
+}
+
+copy_from_pkg <- function(pkg_name, pkg_dir, local_dir, version_dir = path_dir(local_dir)) {
+  # `version_dir` is "equal to" or "contains" `local_dir`
+  stopifnot(path_has_parent(local_dir, version_dir))
+  if (dir_exists(version_dir)) dir_delete(version_dir)
+  dir_create(local_dir)
+
+  stopifnot(local_dir != ".")
+
+  # Copy other folder into local parent folder
+  dir_copy(
+    system.file(pkg_dir, package = pkg_name),
+    dirname(local_dir)
+  )
+  # Rename folder to local folder name
+  if (basename(local_dir) != basename(pkg_dir)) {
+    file.rename(
+      path(dirname(local_dir), basename(pkg_dir)),
+      local_dir
+    )
+  }
+  # Save pkg version info
+  write_json(
+    path(version_dir, "_version.json"),
+    list(
+      package = pkg_name,
+      version = pkg_source_version(pkg_name)
+    )
+  )
+
+  invisible(local_dir)
+}
+
+delete_non_minified <- function(dir) {
+  file_delete(
+    dir_ls(
+      dir,
+      type = "file",
+      recurse = TRUE,
+      regexp = "\\.(min\\.|css)",
+      invert = TRUE
+    )
+  )
+}
+
+write_deps_ionrangeslider <- function(theme, www_shared) {
+	ion_dep <- shiny:::ionRangeSliderDependencyCSS(theme)
+	ion_dep_css <- path(ion_dep$src$file, ion_dep$stylesheet)
+
+	# Preset="shiny" additional ionRangeSlider rules
+	ion_preset_rules <- system.file("builtin", "bs5", "shiny", "ionrangeslider", "_rules.scss", package = "bslib")
+
+  ion_preset_compiled <-
+		sass::sass_partial(
+			readLines(ion_preset_rules),
+			theme,
+			write_attachments = FALSE,
+			cache = FALSE
+		)
+
+  # Append preset styles to the base ionRangeSlider CSS
+	cat(
+		c("\n\n/* shiny preset styles */\n\n", ion_preset_compiled),
+		file = ion_dep_css,
+		sep = "\n",
+		append = TRUE
+	)
+
+  if (inherits(ion_dep, "html_dependency")) {
+		ion_dep <- list(ion_dep)
+	}
+
+  # Save to temp folder
+	temp_ion_dep_dir <- withr::local_tempdir("shiny-ion-range-slider")
+
+	withr::with_options(
+		list(htmltools.dir.version = FALSE),
+		ignore <- lapply(ion_dep, htmltools::copyDependencyToDir, temp_ion_dep_dir)
+	)
+
+	# Overwrite css file
+	ion_dep_dir <- path(www_shared, "ionrangeslider")
+	ion_dep_css <- path(ion_dep_dir, "css", "ion.rangeSlider.css")
+
+  file_move(
+		path(temp_ion_dep_dir, "ionRangeSlider", "ionRangeSlider.min.css"),
+		ion_dep_css
+	)
+
+	invisible(ion_dep_css)
+}
+
+write_bootstrap_bslib_deps <- function(theme, www_shared) {
+	deps <- bslib::bs_theme_dependencies(theme)
+
+	withr::with_options(
+		list(htmltools.dir.version = FALSE),
+    for (dep in deps) {
+			if (dep$name %in% c("bslib-component-css", "bslib-component-js")) {
+				next
+			}
+			copyDependencyToDir(dep, www_shared)
+    }
+	)
+
+	write_json(
+		path(www_shared, "bootstrap/_version.json"),
+		list(
+			shiny_version = pkg_source_version("shiny"),
+			bslib_version = pkg_source_version("bslib"),
+			htmltools_version = pkg_source_version("htmltools"),
+			bootstrap_version = bs_version_full(bslib::theme_version(theme))
+		)
+	)
+
+	message("Reduce font files")
+  path_bootstrap <- path(www_shared, "bootstrap")
+
+  font_css_text <- paste(readLines(path(path_bootstrap, "font.css")), collapse = "\n")
+
+  woff_files <- dir_ls(path(path_bootstrap, "fonts"), regexp = "[.]woff")
+
+  for (woff_file in woff_files) {
+    font_file_name <- path_file(woff_file)
+    if (!grepl(font_file_name, font_css_text, fixed = TRUE)) {
+      file_delete(woff_file)
+    }
+  }
+
+  invisible()
+}
+
+extract_css_path <- function(dep) {
+  stopifnot(inherits(dep, "html_dependency"))
+  path(dep$src$file, dep$stylesheet)
+}
+
+write_shiny_css <- function(theme, www_shared) {
+  shiny_css_dep <- shiny:::shinyDependencyCSS(theme)
+  shiny_css_bslib <- extract_css_path(shiny_css_dep)
+  shiny_css_shared <- path(www_shared, "shiny.min.css")
+  writeLines(
+    c(
+      readLines(shiny_css_shared, n = 1), # keep header of original minified css
+      readLines(shiny_css_bslib)
+    ),
+    con = shiny_css_shared
+  )
+
+  invisible(shiny_css_shared)
+}
+
+write_selectize_css <- function(theme, www_shared) {
+	selectize_css_dep <- shiny:::selectizeDependencyFunc(theme)
+	selectize_css_bslib <- extract_css_path(selectize_css_dep)
+	selectize_shared <- path(www_shared, "selectize", "css")
+
+  file_delete(path(selectize_shared, "selectize.bootstrap3.css"))
+
+  file_copy(
+		selectize_css_bslib,
+		path(selectize_shared, "selectize.min.css"),
+		overwrite = TRUE
+	)
+
+  invisible(path(selectize_shared, "selectize.min.css"))
+}
+
+write_datepicker_css <- function(theme, www_shared) {
+	datepicker_css_dep <- shiny:::datePickerCSS(theme)
+	datepicker_css_bslib <- extract_css_path(datepicker_css_dep)
+	datepicker_shared <- path(www_shared, "datepicker", "css")
+
+  file_copy(
+		datepicker_css_bslib,
+		path(datepicker_shared, "bootstrap-datepicker3.min.css"),
+		overwrite = TRUE
+	)
+
+	invisible(path(datepicker_shared, "bootstrap-datepicker3.min.css"))
+}
+
+delete_from_www_shared <- function(www_shared, ...) {
+  files <- path(www_shared, c(...))
+
+  dirs <- files[is_dir(files)]
+  files <- files[!is_dir(files)]
+
+  dir_delete(dirs)
+  file_delete(files)
+}
+
+write_require_js <- function(requirejs_version, www_shared) {
+	requirejs <- path(www_shared, "requirejs")
+	dir_create(requirejs)
+
+	download.file(
+		paste0("https://cdnjs.cloudflare.com/ajax/libs/require.js/", requirejs_version, "/require.min.js"),
+		path(requirejs, "require.min.js"),
+		quiet = TRUE
+	)
+
+	shims <- path_root("scripts", "define-shims.js")
+
+	cat(
+		"\n\n",
+		paste(readLines(shims), collapse = "\n"),
+		file = path(requirejs, "require.min.js"),
+		append = TRUE
+	)
+
+  invisible(path(requirejs, "require.min.js"))
+}
+
+write_versions_py <- function(bootstrap, requirejs) {
+  versions["shiny_html_deps"] <- as.character(packageVersion("shiny"))
+  versions["bslib"] <- as.character(packageVersion("bslib"))
+  versions["htmltools"] <- as.character(packageVersion("htmltools"))
+  versions["bootstrap"] <- bs_version_full(bootstrap)
+  versions["requirejs"] <- requirejs
+
+  path_versions_py <- path_root("shiny", "_versions.py")
+
+	version_vars <- paste0(names(versions), " = ", "\"", versions, "\"\n", collapse = "")
+	version_all <- paste0(
+		collapse = "",
+		"__all__ = (\n",
+		paste0("    \"", names(versions), "\",\n", collapse = ""),
+		")\n"
+	)
+
+	cat(
+		file = path_versions_py,
+		version_vars,
+		"\n",
+		version_all,
+		sep = ""
+	)
+
+  invisible(path_versions_py)
+}
+
+npm_install_dependencies <- function() {
+  withr::local_dir(path_root("js"))
+  invisible(system("npm install && npm run build", intern = TRUE, ignore.stderr = TRUE))
+}

scripts/_functions_setup.R

@@ -33,3 +33,8 @@ pak_install <- function(...) {
 
   invisible(pkgs)
 }
+
+bs_version_full <- function(version) {
+  bs_v <- bslib::versions()
+  names(bs_v)[bs_v == version]
+}