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

Jump to bottom

Allow full url in theme arg in install_theme (#270) #271

Merged
merged 7 commits into from
Mar 6, 2018
Merged

Allow full url in theme arg in install_theme (#270) #271

Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d198998
Allow full URL in theme arg in new_site and install_theme (#270)
gadenbuie Mar 6, 2018
5b52575
Unzip theme into tmpdir to respect force arg
gadenbuie Mar 6, 2018
0313491
Strip tmpdir from zipdir after finding expdir
gadenbuie Mar 6, 2018
d965687
Refactor zipdir/newdir in install_theme
gadenbuie Mar 6, 2018
b0034f1
Clean SHA and branch from theme install dir
gadenbuie Mar 6, 2018
66d18ed
Hard OR if branch is empty string
gadenbuie Mar 6, 2018
cf64322
Add contributor and news item for theme arg update
gadenbuie Mar 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 23 additions & 10 deletions R/hugo.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,14 @@ change_config = function(name, value) {
#' @param sample Whether to add sample content. Hugo creates an empty site by
#' default, but this function adds sample content by default).
#' @param theme A Hugo theme on Github (a chararacter string of the form
#' \code{user/repo}, and you can optionally sepecify a GIT branch or tag name
#' \code{user/repo}, and you can optionally specify a GIT branch or tag name
#' after \code{@@}, i.e. \code{theme} can be of the form
#' \code{user/repo@@branch}). If \code{theme = NA}, no themes will be
#' installed, and you have to manually install a theme.
#' \code{user/repo@@branch}). You can also specify a full URL to the zip file of
#' the theme. If \code{theme = NA}, no themes will be installed, and you have
#' to manually install a theme.
#' @param hostname Where to find the theme. Defaults to \code{github.com}; specify
#' if you wish to use an instance of GitHub Enterprise.
#' if you wish to use an instance of GitHub Enterprise. You can also specify the
#' full URL of the zip file in \code{theme}, in which case this argument is ignored.
#' @param theme_example Whether to copy the example in the \file{exampleSite}
#' directory if it exists in the theme. Not all themes provide example sites.
#' @param serve Whether to start a local server to serve the site.
Expand Down Expand Up @@ -142,19 +144,28 @@ install_theme = function(
theme, hostname = 'github.com', theme_example = FALSE, update_config = TRUE, force = FALSE
) {
r = '^([^/]+/[^/@]+)(@.+)?$'
if (!is.character(theme) || length(theme) != 1 || !grepl(r, theme)) {
warning("'theme' must be a character string of the form 'user/repo' or 'user/repo@branch'")
r_zip = "\\.zip$"
theme_is_url = grepl(r_zip, theme)
if (!is.character(theme) || length(theme) != 1 || (!grepl(r, theme) & !theme_is_url)) {
warning("'theme' must be a character string of the form 'user/repo' or 'user/repo@branch', or a full URL to the .zip file")
return(invisible())
}
branch = sub('^@', '', gsub(r, '\\2', theme))
if (branch == '') branch = 'master'
theme = gsub(r, '\\1', theme)
dir_create('themes')
in_dir('themes', {
url = sprintf('https://%s/%s/archive/%s.zip', hostname, theme, branch)
zipfile = sprintf('%s.zip', basename(theme))
if (theme_is_url) {
url = theme
zipfile = gsub(".+/(.+\\.zip)", "\\1", theme)
} else {
url = sprintf('https://%s/%s/archive/%s.zip', hostname, theme, branch)
zipfile = sprintf('%s.zip', basename(theme))
}
download2(url, zipfile, mode = 'wb')
files = utils::unzip(zipfile)
tmpdir = tempfile("", ".")
on.exit(in_dir('themes', unlink(tmpdir, recursive = TRUE)))
files = utils::unzip(zipfile, exdir = tmpdir)
zipdir = dirname(files)
zipdir = zipdir[which.min(nchar(zipdir))]
expdir = file.path(zipdir, 'exampleSite')
Expand All @@ -167,14 +178,16 @@ install_theme = function(
'and at least take a look at the config file config.toml of the example site, ',
'because not all Hugo themes work with any config files.'
)
newdir = gsub(sprintf('-%s$', branch), '', zipdir)
newdir = gsub(tmpdir, ".", zipdir)
newdir = gsub(sprintf('-%s$', branch), '', newdir)
Copy link
Member Author

Choose a reason for hiding this comment

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

@yihui Should I add an if (!theme_is_url) here so that it doesn't even try to change the filename if the zip file is given? The alternative would be to add some logic around the branch regex and then hope we get lucky at this stage ... so seems to me to be better to skip this if theme_is_url. I didn't do this because I was trying not to add a ton of logic and branching paths, but it's been nagging at me.

Copy link
Member

Choose a reason for hiding this comment

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

Conditioning on theme_is_url makes sense to me.

if (!force && dir_exists(newdir)) stop(
'The theme already exists. Try install_theme("', theme, '", force = TRUE) ',
'after you read the help page ?blogdown::install_theme.', call. = FALSE
)
unlink(newdir, recursive = TRUE)
file.rename(zipdir, newdir)
unlink(zipfile)
if (theme_is_url) theme = newdir
})
if (update_config) {
change_config('theme', sprintf('"%s"', basename(theme)))
Expand Down