Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add verbose argument #17

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add verbose argument #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0c7dd4e
Add verbose option
cpsievert Apr 23, 2015
662d48b
Merge branch 'master' of https://github.com/yihui/servr
cpsievert Apr 23, 2015
5a1cc74
forgot a couple cases
cpsievert Apr 23, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 35 additions & 16 deletions R/dynamic.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
#' @param command a command to build the Jekyll website; by default, it is
#' \command{jekyll build}, and you can use alternative commands, such as
#' \command{bundle exec jekyll build}
#' @param verbose when R markdown files are rebuilt, should output be displayed?
#' @inheritParams httd
#' @rdname dynamic_site
#' @note Apparently \code{jekyll()} and \code{rmdv1()} require the \pkg{knitr}
Expand Down Expand Up @@ -64,14 +65,15 @@
#' @export
jekyll = function(
dir = '.', input = c('.', '_source', '_posts'), output = c('.', '_posts', '_posts'),
script = c('Makefile', 'build.R'), serve = TRUE, command = 'jekyll build', ...
script = c('Makefile', 'build.R'), serve = TRUE, command = 'jekyll build',
verbose = TRUE, ...
) {
baseurl = jekyll_config(dir, 'baseurl', '')
destination = jekyll_config(dir, 'destination', '_site')
jekyll_build = function() {
if (system(command) != 0) stop('Failed to run: ', command)
}
build_all = function() knit_maybe(input, output, script, method = 'jekyll')
build_all = function() knit_maybe(input, output, script, method = 'jekyll', verbose = verbose)

if (!serve) {
in_dir(dir, {
Expand Down Expand Up @@ -213,15 +215,21 @@ dynamic_site = function(
res$start_server(app)
}

#' Determine if R Markdown files need to be re-built
#' Determine if R Markdown files need to be re-built and rebuild if necessary
#' @param input the input dirs
#' @param output the output dirs
#' @param script the R script, or an R function to build the R Markdown files
#' @param method if no \code{script} was provided, fall back to internal methods
#' to build R Markdown files, so I need to know if you are Jekyll, R Markdown
#' v2, or something else
#' @param in_session if files are rebuilt, should they be built in this R session?
#' Or a separate (child) session?
#' @param verbose if files are rebuilt, should output be displayed? This argument is
#' ignored if \code{script} is a function.
#' @value TRUE if rebuilt, FALSE otherwise
#' @noRd
knit_maybe = function(input, output, script, method = 'jekyll', in_session = FALSE) {
knit_maybe = function(input, output, script, method = 'jekyll',
in_session = FALSE, verbose = TRUE) {
# if the script is a Makefile, check `make -q` to see if we need to
# re-generate any files; if we do not, there is nothing to do, otherwise run
# make, and tell the client that the files have been updated
Expand All @@ -247,9 +255,9 @@ knit_maybe = function(input, output, script, method = 'jekyll', in_session = FAL
update <<- TRUE
# compile each posts in a separate R session
for (i in seq_len(nrow(r))) {
# run script if exists, passing input and output filenames to Rscript
# run script in a separate session, passing input and output filenames to Rscript
if (!in_session && file.exists(script)) {
rscript(shQuote(c(script, r[i, 1], r[i, 2])), r[i, 1])
rscript(shQuote(c(script, r[i, 1], r[i, 2])), r[i, 1], verbose = verbose)
next
}
if (in_session && is.function(script)) {
Expand All @@ -258,7 +266,7 @@ knit_maybe = function(input, output, script, method = 'jekyll', in_session = FAL
}
# otherwise run default code
build = getFromNamespace(paste('build', method, sep = '_'), 'servr')
build(r[i, 1], r[i, 2], in_session)
build(r[i, 1], r[i, 2], in_session = in_session, verbose = verbose)
}
if (any(i <- !file.exists(r[, 2])))
stop('Some output files were not successfully generated: ', paste(r[i, 2], collapse = ', '))
Expand All @@ -279,37 +287,48 @@ obsolete_out = function(input, output, pattern = '[.]Rmd$', outext = '.md') {
if (any(idx)) cbind(src[idx], out[idx])
}

build_jekyll = function(input, output, ...) {
build_jekyll = function(input, output, in_session = FALSE, verbose = TRUE, ...) {
# extract arguments in `...` and coerce to string
params = as.list(match.call())[-1]
idx = !names(params) %in% names(formals(build_jekyll))
dots = params[idx]
dotz = paste(names(dots), as.character(dots), sep = "=", collapse = ", ")
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose this bit is unnecessary, but if this is ever explicitly exposed to users, it could be useful to pass arguments to knitr::knit()

code = c(
sprintf(
c("knitr::opts_chunk$set(fig.path = 'figure/%s/', ",
"cache.path = 'cache/%s/')"),
gsub('^_|[.][a-zA-Z]+$', '', input)
),
"knitr::opts_knit$set(base.url = '/')",
"markdown = jekyll_config('.', 'markdown', 'kramdown')",
"if (markdown == 'kramdown') knitr::render_jekyll() else knitr::render_markdown()",
"knitr::opts_knit$set(base.url = jekyll_config('.', 'baseurl', '/'))",
sprintf(
"knitr::knit('%s', '%s', quiet = TRUE, encoding = 'UTF-8')",
input, output
"knitr::knit('%s', '%s', encoding = 'UTF-8', '%s')",
input, output, dotz
)
)
rscript(c(rbind('-e', shQuote(code))), input)
if (in_session) {
eval(parse(text = code), envir = globalenv())
} else {
rscript(c('-e', shQuote(code)), input = input, verbose = verbose)
}
}

build_rmd = function(input, output, template, in_session) {
build_rmd = function(input, output, template, in_session = FALSE, verbose = TRUE) {
owd = setwd(dirname(input)); on.exit(setwd(owd))
input = basename(input)
code = sprintf(template, input)
if (in_session) {
eval(parse(text = code), envir = globalenv())
} else {
rscript(c(rbind('-e', shQuote(code))), file.path(owd, input))
rscript(c(rbind('-e', shQuote(code))), file.path(owd, input), verbose = verbose)
}
}

build_rmdv2 = function(...) {
build_rmd(..., template = "rmarkdown::render('%s', encoding = 'UTF-8', quiet = TRUE)")
build_rmd(..., template = "rmarkdown::render('%s', encoding = 'UTF-8')")
}

build_rmdv1 = function(...) {
build_rmd(..., template = "knitr::knit2html('%s', encoding = 'UTF-8', quiet = TRUE)")
build_rmd(..., template = "knitr::knit2html('%s', encoding = 'UTF-8')")
}
8 changes: 6 additions & 2 deletions R/utils.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,13 @@ get_browser = function() {
browser
}

rscript = function(code, input) {
if (system2(file.path(R.home('bin'), 'Rscript'), code, stdout = NULL) != 0)
rscript = function(code, input, verbose = FALSE) {
r_bin <- file.path(R.home('bin'), 'Rscript')
if (verbose) {
message(paste(x = system2(r_bin, code, stdout = TRUE), "\n"))
} else if (system2(r_bin, code, stdout = NULL) != 0) {
stop('Failed to compile ', input, call. = FALSE)
}
}

in_dir = function(dir, expr) {
Expand Down