forked from r-lib/usethis
/
tidyverse.R
352 lines (311 loc) · 10.3 KB
/
tidyverse.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
#' Helpers for tidyverse development
#'
#' These helpers follow tidyverse conventions which are generally a little
#' stricter than the defaults, reflecting the need for greater rigor in
#' commonly used packages.
#'
#' @details
#'
#' * `use_tidy_ci()`: sets up [Travis CI](https://travis-ci.org) and
#' [Codecov](https://codecov.io), ensuring that the package works on all
#' versions of R starting at 3.1.
#'
#' * `use_tidy_description()`: puts fields in standard order and alphabetises
#' dependencies.
#'
#' * `use_tidy_eval()`: imports a standard set of helpers to facilitate
#' programming with the tidy eval toolkit.
#'
#' * `use_tidy_style()`: styles source code according to the [tidyverse style
#' guide](http://style.tidyverse.org). This function will overwrite files! See
#' below for usage advice.
#'
#' * `use_tidy_versions()`: pins all dependencies to require at least
#' the currently installed version.
#'
#' * `use_tidy_contributing()`: adds standard tidyverse contributing guidelines.
#'
#' * `use_tidy_issue_template()`: adds a standard tidyverse issue template.
#'
#' * `use_tidy_support()`: adds a standard description of support resources for
#' the tidyverse.
#'
#' * `use_tidy_coc()`: equivalent to `use_code_of_conduct()`, but puts the
#' document in a `.github/` subdirectory.
#'
#' * `use_tidy_github()`: convenience wrapper that calls
#' `use_tidy_contributing()`, `use_tidy_issue_template()`, `use_tidy_support()`,
#' `use_tidy_coc()`.
#'
#' @section `use_tidy_style()`:
#' Uses the [styler package](http://styler.r-lib.org) package to style all code
#' in a package, project, or directory, according to the [tidyverse style
#' guide](http://style.tidyverse.org).
#'
#' **Warning:** This function will overwrite files! It is strongly suggested to
#' only style files that are under version control or to first create a backup
#' copy.
#'
#' Invisibly returns a data frame with one row per file, that indicates whether
#' styling caused a change.
#'
#' @param strict Boolean indicating whether or not a strict version of styling
#' should be applied. See [styler::tidyverse_style()] for details.
#'
#' @name tidyverse
NULL
#' @export
#' @rdname tidyverse
#' @inheritParams use_travis
use_tidy_ci <- function(browse = interactive()) {
check_uses_github()
new_travis <- use_template(
"tidy-travis.yml",
".travis.yml",
ignore = TRUE
)
use_template("codecov.yml", ignore = TRUE)
use_dependency("R", "Depends", ">= 3.1")
use_dependency("covr", "Suggests")
use_travis_badge()
use_codecov_badge()
if (new_travis) {
travis_activate(browse)
}
invisible(TRUE)
}
#' @export
#' @rdname tidyverse
use_tidy_description <- function() {
desc <- desc::description$new(file = proj_get())
tidy_desc(desc)
desc$write()
invisible(TRUE)
}
#' @export
#' @rdname tidyverse
#' @param overwrite By default (`FALSE`), only dependencies without version
#' specifications will be modified. Set to `TRUE` to modify all dependencies.
use_tidy_versions <- function(overwrite = FALSE) {
deps <- desc::desc_get_deps(proj_get())
baserec <- base_and_recommended()
to_change <- !deps$package %in% c("R", baserec)
if (!overwrite) {
to_change <- to_change & deps$version == "*"
}
deps$version[to_change] <- vapply(deps$package[to_change], dep_version, character(1))
desc::desc_set_deps(deps, file = proj_get())
invisible(TRUE)
}
is_installed <- function(x) {
length(find.package(x, quiet = TRUE)) > 0
}
dep_version <- function(x) {
if (is_installed(x)) paste0(">= ", utils::packageVersion(x)) else "*"
}
#' @export
#' @rdname tidyverse
use_tidy_eval <- function() {
check_is_package("use_tidy_eval()")
use_dependency("roxygen2", "Suggests")
use_dependency("rlang", "Imports", ">= 0.1.2")
new <- use_template("tidy-eval.R", "R/utils-tidy-eval.R")
todo("Run {code('devtools::document()')}")
return(invisible(new))
}
#' @export
#' @rdname tidyverse
use_tidy_contributing <- function() {
check_uses_github()
use_directory(".github", ignore = TRUE)
use_template(
"tidy-contributing.md",
".github/CONTRIBUTING.md",
data = list(package = project_name())
)
}
#' @export
#' @rdname tidyverse
use_tidy_issue_template <- function() {
check_uses_github()
use_directory(".github", ignore = TRUE)
use_template(
"tidy-issue.md",
".github/ISSUE_TEMPLATE.md"
)
}
#' @export
#' @rdname tidyverse
use_tidy_support <- function() {
check_uses_github()
use_directory(".github", ignore = TRUE)
use_template(
"tidy-support.md",
".github/SUPPORT.md",
data = list(package = project_name())
)
}
#' @export
#' @rdname tidyverse
use_tidy_coc <- function() {
check_uses_github()
use_code_of_conduct(path = ".github")
}
#' @export
#' @rdname tidyverse
use_tidy_github <- function() {
use_tidy_contributing()
use_tidy_issue_template()
use_tidy_support()
use_tidy_coc()
}
#' @export
#' @rdname tidyverse
use_tidy_style <- function(strict = TRUE) {
check_installed("styler")
check_uncommitted_changes()
if (is_package()) {
styled <- styler::style_pkg(
proj_get(),
style = styler::tidyverse_style,
strict = strict
)
} else {
styled <- styler::style_dir(
proj_get(),
style = styler::tidyverse_style,
strict = strict
)
}
cat_line()
done("Styled project according to the tidyverse style guide")
invisible(styled)
}
#' Identify contributors via GitHub activity
#'
#' Derives a list of GitHub usernames, based on who has opened issues or pull
#' requests. Used to populate the acknowledgment section of package release blog
#' posts at <https://www.tidyverse.org/articles/>. All arguments can potentially
#' be determined from the active project, if the project follows standard
#' practices around the GitHub remote and GitHub releases. Unexported helper
#' functions, `releases()` and `ref_df()` can be useful interactively to get a
#' quick look at release tag names and a data frame about refs (defaulting to
#' releases), respectively.
#'
#' @param repo_spec GitHub repo specification in this form: `owner/repo`.
#' Default is to infer from Git remotes of active project.
#' @param from,to GitHub ref (i.e., a SHA, tag, or release) or a timestamp in
#' ISO 8601 format, specifying the start or end of the interval of interest.
#' Examples: "08a560d", "v1.3.0", "2018-02-24T00:13:45Z", "2018-05-01". `NULL`
#' means there is no bound on that end of the interval.
#'
#' @return A character vector of GitHub usernames, invisibly.
#' @export
#'
#' @examples
#' \dontrun{
#' ## active project, interval = since the last release
#' use_tidy_thanks()
#'
#' ## active project, interval = since a specific datetime
#' use_tidy_thanks(from = "2018-02-24T00:13:45Z")
#'
#' ## r-lib/usethis, inteval = since a certain date
#' use_tidy_thanks("r-lib/usethis", from = "2018-05-01")
#'
#' ## r-lib/usethis, up to a specific release
#' use_tidy_thanks("r-lib/usethis", from = NULL, to = "v1.3.0")
#'
#' ## r-lib/usethis, since a specific commit, up to a specific date
#' use_tidy_thanks("r-lib/usethis", from = "08a560d", to = "2018-05-14")
#' }
use_tidy_thanks <- function(repo_spec = github_repo_spec(),
from = releases(repo_spec)[[1]],
to = NULL) {
from_timestamp <- as_timestamp(from, repo_spec) %||% "2008-01-01"
to_timestamp <- as_timestamp(to, repo_spec)
res <- gh::gh(
"/repos/:owner/:repo/issues",
owner = spec_owner(repo_spec), repo = spec_repo(repo_spec),
since = from_timestamp,
state = "all",
filter = "all",
.limit = Inf
)
if (identical(res[[1]], "")) {
message("No matching issues/PRs found.")
return(invisible())
}
creation_time <- function(x) {
as.POSIXct(pluck_chr(x, "created_at"))
}
res <- res[creation_time(res) >= as.POSIXct(from_timestamp)]
if (!is.null(to_timestamp)) {
res <- res[creation_time(res) <= as.POSIXct(to_timestamp)]
}
if (length(res) == 0) {
message("No matching issues/PRs found.")
return(invisible())
}
contributors <- sort(unique(pluck_chr(res, c("user", "login"))))
todo("{length(contributors)} contributors identified")
code_block(
collapse(
glue("[@{contributors}](https://github.com/{contributors})"),
sep = ", ", last = ", and "
)
)
invisible(contributors)
}
## if x appears to be a timestamp, pass it through
## otherwise, assume it's a ref and look up its timestamp
as_timestamp <- function(x = NULL, repo_spec = github_repo_spec()) {
if (is.null(x)) return(NULL)
as_POSIXct <- try(as.POSIXct(x), silent = TRUE)
if (inherits(as_POSIXct, "POSIXct")) return(x)
message("Resolving timestamp for ref ", value(x))
ref_df(x, repo_spec)$timestamp
}
## returns a data frame on GitHub refs, defaulting to all releases
ref_df <- function(refs = NULL, repo_spec = github_repo_spec()) {
refs <- refs %||% releases(repo_spec)
if (is.null(refs)) return(NULL)
get_thing <- function(thing) {
gh::gh(
"/repos/:owner/:repo/commits/:thing",
owner = spec_owner(repo_spec), repo = spec_repo(repo_spec), thing = thing
)
}
res <- lapply(refs, get_thing)
data.frame(
ref = refs,
sha = substr(pluck_chr(res, "sha"), 1, 7),
timestamp = pluck_chr(res, c("commit", "committer", "date")),
stringsAsFactors = FALSE
)
}
## returns character vector of release tag names
releases <- function(repo_spec = github_repo_spec()) {
res <- gh::gh(
"/repos/:owner/:repo/releases",
owner = spec_owner(repo_spec),
repo = spec_repo(repo_spec)
)
if (identical(res[[1]], "")) return(NULL)
pluck_chr(res, "tag_name")
}
## approaches based on available.packages() and/or installed.packages() present
## several edge cases, requirements, and gotchas
## for this application, hard-wiring seems to be "good enough"
base_and_recommended <- function() {
# base_pkgs <- as.vector(installed.packages(priority = "base")[, "Package"])
# av <- available.packages()
# keep <- av[ , "Priority", drop = TRUE] %in% "recommended"
# rec_pkgs <- unname(av[keep, "Package", drop = TRUE])
# dput(sort(unique(c(base_pkgs, rec_pkgs))))
c("base", "boot", "class", "cluster", "codetools", "compiler",
"datasets", "foreign", "graphics", "grDevices", "grid", "KernSmooth",
"lattice", "MASS", "Matrix", "methods", "mgcv", "nlme", "nnet",
"parallel", "rpart", "spatial", "splines", "stats", "stats4",
"survival", "tcltk", "tools", "utils")
}