Implement type checkers from rlang standalone-types-check.R (#1820)

* Add rlang standalone files

* update rlang version

* Use rlang argument checkers

* rlang arg checkers in github-actions.R

* Simplify logic when url & name are NULL

* Add checks

* Bump standalone-types-check.R

* type-checking in utils-github.R and write.R

* Use check_character on df columns

* More checkers

* implement maybe_name()

* remove dev rlang from remotes

* change regex-based error expectation to snapshot test

Co-authored-by: Jennifer (Jenny) Bryan <[email protected]>

* Change expect_error() to expect_snapshot(error = TRUE)

* Add back check for length of lines

---------

Co-authored-by: Jennifer (Jenny) Bryan <[email protected]>

Author: ateucher

DESCRIPTION

@@ -33,7 +33,7 @@ Imports:
     lifecycle (>= 1.0.0),
     purrr,
     rappdirs,
-    rlang (>= 1.0.0),
+    rlang (>= 1.1.0),
     rprojroot (>= 1.2),
     rstudioapi,
     stats,

R/browse.R

@@ -57,7 +57,8 @@ NULL
 #' @export
 #' @rdname browse-this
 browse_package <- function(package = NULL) {
-  stopifnot(is.null(package) || is_string(package))
+  maybe_name(package)
+
   if (is.null(package)) {
     check_is_project()
   }
@@ -156,7 +157,7 @@ browse_cran <- function(package = NULL) {
 # 2. BugReports/URL fields of DESCRIPTION (active project or arbitrary
 #    installed package)
 github_url <- function(package = NULL) {
-  stopifnot(is.null(package) || is_string(package))
+  maybe_name(package)
 
   if (is.null(package)) {
     check_is_project()

R/course.R

@@ -410,7 +410,7 @@ tidy_unzip <- function(zipfile, cleanup = FALSE) {
 #' create_download_url("https://drive.google.com/open?id=123456789xxyyyzzz/view")
 #' @export
 create_download_url <- function(url) {
-  stopifnot(is_string(url))
+  check_name(url)
   stopifnot(grepl("^http[s]?://", url))
 
   switch(
@@ -469,7 +469,7 @@ hopeless_url <- function(url) {
 }
 
 normalize_url <- function(url) {
-  stopifnot(is.character(url))
+  check_name(url)
   has_scheme <- grepl("^http[s]?://", url)
 
   if (has_scheme) {
@@ -603,7 +603,7 @@ make_filename <- function(cd,
   ## https://tools.ietf.org/html/rfc6266
   cd <- cd[["filename"]]
   if (is.null(cd) || is.na(cd)) {
-    stopifnot(is_string(fallback))
+    check_name(fallback)
     return(path_sanitize(fallback))
   }
 

R/data.R

@@ -128,7 +128,7 @@ check_files_absent <- function(paths, overwrite) {
 #' use_data_raw("daisy")
 #' }
 use_data_raw <- function(name = "DATASET", open = rlang::is_interactive()) {
-  stopifnot(is_string(name))
+  check_name(name)
   r_path <- path("data-raw", asciify(name), ext = "R")
   use_directory("data-raw", ignore = TRUE)
 

R/git-default-branch.R

@@ -318,8 +318,8 @@ git_default_branch_rediscover <- function(current_local_default = NULL) {
 #' }
 git_default_branch_rename <- function(from = NULL, to = "main") {
   repo <- git_repo()
-  maybe_string(from)
-  check_string(to)
+  maybe_name(from)
+  check_name(to)
 
   if (!is.null(from) &&
       !gert::git_branch_exists(from, local = TRUE, repo = repo)) {
@@ -395,7 +395,7 @@ git_default_branch_rename <- function(from = NULL, to = "main") {
 }
 
 rediscover_default_branch <- function(old_name = NULL, report_on_source = TRUE) {
-  maybe_string(old_name)
+  maybe_name(old_name)
 
   # GitHub's official TODOs re: manually updating local environments
   # after a source repo renames the default branch:

R/git.R

@@ -243,9 +243,9 @@ check_protocol <- function(protocol) {
 #' use_git_remote(name = "upstream", url = upstream_url)
 #' }
 use_git_remote <- function(name = "origin", url, overwrite = FALSE) {
-  stopifnot(is_string(name))
-  stopifnot(is.null(url) || is_string(url))
-  stopifnot(is_true(overwrite) || is_false(overwrite))
+  check_name(name)
+  maybe_name(url)
+  check_bool(overwrite)
 
   remotes <- git_remotes()
   repo <- git_repo()

R/github-actions.R

@@ -70,13 +70,18 @@ use_github_action <- function(name = NULL,
                               open = FALSE,
                               badge = NULL) {
 
-  if (is.null(url) && is.null(name)) {
-    name <- choose_gha_workflow()
-  }
+  maybe_name(name)
+  maybe_name(ref)
+  maybe_name(url)
+  maybe_name(save_as)
+  maybe_name(readme)
+  check_bool(ignore)
+  check_bool(open)
+  check_bool(badge, allow_null = TRUE)
 
   if (is.null(url)) {
-    check_string(name)
-    maybe_string(ref)
+
+    name <- name %||% choose_gha_workflow()
 
     if (path_ext(name) == "") {
       name <- path_ext_set(name, "yaml")
@@ -89,10 +94,8 @@ use_github_action <- function(name = NULL,
     readme <- glue(
       "https://github.com/r-lib/actions/blob/{ref}/examples/README.md"
     )
-  } else {
-    check_string(url)
-    maybe_string(readme)
   }
+
   withr::defer(rstudio_git_tickle())
 
   use_dot_github(ignore = ignore)
@@ -104,7 +107,7 @@ use_github_action <- function(name = NULL,
       save_as <- path_file(url)
     }
   }
-  check_string(save_as)
+
   save_as <- path(".github", "workflows", save_as)
   create_directory(path_dir(proj_path(save_as)))
 

R/github-pages.R

@@ -49,8 +49,9 @@
 #' use_github_pages(branch = git_default_branch(), path = "/docs")
 #' }
 use_github_pages <- function(branch = "gh-pages", path = "/", cname = NA) {
-  stopifnot(is_string(branch), is_string(path))
-  stopifnot(is.na(cname) || is.null(cname) || is_string(cname))
+  check_name(branch)
+  check_name(path)
+  check_string(cname, allow_empty = FALSE, allow_na = TRUE, allow_null = TRUE)
   tr <- target_repo(github_get = TRUE, ok_configs = c("ours", "fork"))
   check_can_push(tr = tr, "to turn on GitHub Pages")
 

R/helpers.R

@@ -1,6 +1,6 @@
 use_dependency <- function(package, type, min_version = NULL) {
-  stopifnot(is_string(package))
-  stopifnot(is_string(type))
+  check_name(package)
+  check_name(type)
 
   if (package != "R") {
     check_installed(package)