Rename use_tidy_versions() to use_latest_dependencies()

Fixes #771

NAMESPACE

@@ -106,6 +106,7 @@ export(use_github_release)
 export(use_gitlab_ci)
 export(use_gpl3_license)
 export(use_jenkins)
+export(use_latest_dependencies)
 export(use_lgpl_license)
 export(use_lifecycle)
 export(use_lifecycle_badge)
@@ -149,7 +150,6 @@ export(use_tidy_release_test_env)
 export(use_tidy_style)
 export(use_tidy_support)
 export(use_tidy_thanks)
-export(use_tidy_versions)
 export(use_travis)
 export(use_travis_badge)
 export(use_tutorial)

NEWS.md

@@ -1,5 +1,8 @@
 # usethis (development version)
 
+* `use_tidy_version()` is now `use_latest_dependencies()` to better reflect 
+  it's usage (#771).
+
 * `create_package()` will now create a package in a symlink to a directory (#794).
 
 * `git_sitrep()` now reports project-specific user name and email, if set 

R/latest-dependencies.R

@@ -0,0 +1,39 @@
+#' Use "latest" versions of all dependencies
+#'
+#' Pins minimum version of dependencies to latest (as determined by "source)"
+#' Useful for tidyverse package, but should otherwise be used with extreme
+#' care.
+#'
+#' @keywords internal
+#' @export
+#' @param overwrite By default (`FALSE`), only dependencies without version
+#'   specifications will be modified. Set to `TRUE` to modify all dependencies.
+#' @param source Use "local" or "CRAN" package versions.
+use_latest_dependencies <- function(overwrite = FALSE, source = c("local", "CRAN")) {
+  deps <- desc::desc_get_deps(proj_get())
+  deps <- update_versions(deps, overwrite = overwrite, source = source)
+  desc::desc_set_deps(deps, file = proj_get())
+
+  invisible(TRUE)
+}
+
+update_versions <- function(deps, overwrite = FALSE, source = c("local", "CRAN")) {
+  baserec <- base_and_recommended()
+  to_change <- !deps$package %in% c("R", baserec)
+  if (!overwrite) {
+    to_change <- to_change & deps$version == "*"
+  }
+
+  packages <- deps$package[to_change]
+  versions <- switch(match.arg(source),
+    local = purrr::map_chr(packages, package_version),
+    CRAN = utils::available.packages()[packages, "Version"]
+  )
+  deps$version[to_change] <- paste0(">= ", versions)
+
+  deps
+}
+
+package_version <- function(x) {
+  as.character(utils::packageVersion(x))
+}

R/tidyverse.R

@@ -26,9 +26,6 @@
 #' guide](https://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.
@@ -132,40 +129,6 @@ use_tidy_description <- function() {
   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.
-#' @param source Use "local" or "CRAN" package versions.
-use_tidy_versions <- function(overwrite = FALSE, source = c("local", "CRAN")) {
-  deps <- desc::desc_get_deps(proj_get())
-  deps <- update_versions(deps, overwrite = overwrite, source = source)
-  desc::desc_set_deps(deps, file = proj_get())
-
-  invisible(TRUE)
-}
-
-update_versions <- function(deps, overwrite = FALSE, source = c("local", "CRAN")) {
-  baserec <- base_and_recommended()
-  to_change <- !deps$package %in% c("R", baserec)
-  if (!overwrite) {
-    to_change <- to_change & deps$version == "*"
-  }
-
-  packages <- deps$package[to_change]
-  versions <- switch(match.arg(source),
-    local = purrr::map_chr(packages, package_version),
-    CRAN = utils::available.packages()[packages, "Version"]
-  )
-  deps$version[to_change] <- paste0(">= ", versions)
-
-  deps
-}
-
-package_version <- function(x) {
-  as.character(utils::packageVersion(x))
-}
-
 #' @export
 #' @rdname tidyverse
 use_tidy_eval <- function() {
@@ -179,7 +142,6 @@ use_tidy_eval <- function() {
   return(invisible(new))
 }
 
-
 #' @export
 #' @rdname tidyverse
 use_tidy_contributing <- function() {

tests/testthat/test-latest-dependencies.R

@@ -0,0 +1,22 @@
+test_that("use_tidy_versions() specifies a version for dependencies", {
+  pkg <- scoped_temporary_package()
+  use_package("usethis")
+  use_package("desc")
+  use_package("withr", "Suggests")
+  use_package("gh", "Suggests")
+  use_latest_dependencies()
+  desc <- readLines(proj_path("DESCRIPTION"))
+  desc <- grep("usethis|desc|withr|gh", desc, value = TRUE)
+  expect_true(all(grepl("\\(>= [0-9.]+\\)", desc)))
+})
+
+test_that("use_tidy_versions() does nothing for a base package", {
+  ## if we ever depend on a recommended package, could beef up this test a bit
+  pkg <- scoped_temporary_package()
+  use_package("tools")
+  use_package("stats", "Suggests")
+  use_latest_dependencies()
+  desc <- readLines(proj_path("DESCRIPTION"))
+  desc <- grep("tools|stats", desc, value = TRUE)
+  expect_false(any(grepl("\\(>= [0-9.]+\\)", desc)))
+})

tests/testthat/test-use-tidy.R

@@ -12,29 +12,6 @@ test_that("use_tidy_description() alphabetises dependencies", {
   expect_gt(grep("withr", desc), grep("gh", desc))
 })
 
-test_that("use_tidy_versions() specifies a version for dependencies", {
-  pkg <- scoped_temporary_package()
-  use_package("usethis")
-  use_package("desc")
-  use_package("withr", "Suggests")
-  use_package("gh", "Suggests")
-  use_tidy_versions()
-  desc <- readLines(proj_path("DESCRIPTION"))
-  desc <- grep("usethis|desc|withr|gh", desc, value = TRUE)
-  expect_true(all(grepl("\\(>= [0-9.]+\\)", desc)))
-})
-
-test_that("use_tidy_versions() does nothing for a base package", {
-  ## if we ever depend on a recommended package, could beef up this test a bit
-  pkg <- scoped_temporary_package()
-  use_package("tools")
-  use_package("stats", "Suggests")
-  use_tidy_versions()
-  desc <- readLines(proj_path("DESCRIPTION"))
-  desc <- grep("tools|stats", desc, value = TRUE)
-  expect_false(any(grepl("\\(>= [0-9.]+\\)", desc)))
-})
-
 test_that("use_tidy_eval() inserts the template file and Imports rlang", {
   skip_if_not_installed("roxygen2")