rename set-args to set-assert-args, add documentation.

Author: lorenzwalthert

DESCRIPTION

@@ -54,7 +54,7 @@ Collate:
     'rules-spacing.R'
     'serialize.R'
     'serialized_tests.R'
-    'set-args.R'
+    'set-assert-args.R'
     'style_guides.R'
     'styler.R'
     'token-create.R'

R/set-args.R

@@ -0,0 +1,73 @@
+#' Set the write_tree argument
+#'
+#' Sets the argument `write_tree` in [test_collection()] to be `TRUE` for R
+#' versions higher or equal to 3.2, and `FALSE` otherwise since the second-level
+#' dependency `DiagrammeR` from `data.table` is not available for R < 3.2.
+#' @param write_tree Whether or not to write tree.
+set_arg_write_tree <- function(write_tree) {
+  sufficient_version <- getRversion() >= 3.2
+  if (is.na(write_tree)) {
+    write_tree <- ifelse(sufficient_version, TRUE, FALSE)
+  } else if (!sufficient_version & write_tree) {
+    stop_insufficient_r_version()
+  }
+  write_tree
+}
+
+#' Set the file type argument
+#'
+#' Sets and asserts the file type argument to a standard format for further internal
+#' processing.
+#' @param filetype A character vector with file types to convert to the internal
+#'   standard format.
+#' @examples
+#' styler:::set_and_assert_arg_filetype("rMd")
+#' \dontrun{
+#' styler:::set_and_assert_arg_filetype("xyz")
+#' }
+set_and_assert_arg_filetype <- function(filetype) {
+  without_dot <- gsub("^\\.", "", tolower(filetype))
+  assert_filetype(without_dot)
+  paste0("\\.", without_dot)
+}
+
+#' Make sure all supplied file types are allowed
+#'
+#' @param lowercase_filetype A vector with file types to check, all lower case.
+assert_filetype <- function(lowercase_filetype) {
+  if (!all(lowercase_filetype %in% c("r", "rmd"))) {
+    stop(
+      "filetype must not contain other values than 'R'",
+      "or 'Rmd' (case is ignored).", call. = FALSE
+    )
+  }
+}
+
+
+#' Assert text to be of positive length and replace it with the empty
+#' string otherwise.
+#' @param text The input to style.
+assert_text <- function(text) {
+  if (length(text) < 1) {
+    text <- ""
+  }
+  text
+}
+
+
+#' Check token validity
+#'
+#' Check whether one or more tokens exist and have a unique token-text mapping
+#' @param tokens Tokens to check.
+assert_tokens <- function(tokens) {
+  invalid_tokens <- tokens[!(tokens %in% lookup_tokens()$token)]
+  if (length(invalid_tokens) > 0) {
+    stop(
+      "Token(s) ", paste0(invalid_tokens, collapse = ", "), " are invalid. ",
+      "You can lookup all valid tokens and their text ",
+      "with styler:::looup_tokens(). Make sure you supply the values of ",
+      "the column 'token', not 'text'."
+    )
+  }
+}
+

R/set-assert-args.R

@@ -285,19 +285,3 @@ specify_math_token_spacing <-
 tidyverse_math_token_spacing <- function() {
   specify_math_token_spacing(one = c("'+'", "'-'", "'*'", "'/'", "'^'"))
 }
-
-#' Check token validity
-#'
-#' Check whether one or more tokens exist and have a unique token-text mapping
-#' @param tokens Tokens to check.
-assert_tokens <- function(tokens) {
-  invalid_tokens <- tokens[!(tokens %in% lookup_tokens()$token)]
-  if (length(invalid_tokens) > 0) {
-    stop(
-      "Token(s) ", paste0(invalid_tokens, collapse = ", "), " are invalid. ",
-      "You can lookup all valid tokens and their text ",
-      "with styler:::looup_tokens(). Make sure you supply the values of ",
-      "the column 'token', not 'text'."
-    )
-  }
-}

R/style_guides.R

@@ -40,16 +40,6 @@ calls_sys <- function(sys_call, ...) {
   }
 }
 
-#' Assert text to be of positive length and replace it with the empty
-#' string otherwise.
-#' @param text The input to style.
-assert_text <- function(text) {
-  if (length(text) < 1) {
-    text <- ""
-  }
-  text
-}
-
 is_plain_r_file <- function(path) {
   grepl("\\.R$", path, ignore.case = TRUE)
 }
@@ -86,6 +76,11 @@ extend_if_comment <- function(pd, pos) {
   }
 }
 
+#' Map the file type to a corresponding regular expression
+#'
+#' @param filetype The file type to map to a regex.
+#' @examples
+#' styler:::map_filetype_to_pattern(c(".rMd", "R"))
 map_filetype_to_pattern <- function(filetype) {
-  paste0("(", paste(set_and_assert_filetype(filetype), collapse = "|"), ")$")
+  paste0("(", paste(set_and_assert_arg_filetype(filetype), collapse = "|"), ")$")
 }