major API change

- Remove relicts from flat approach
- Rename get_transformers to tidyverse_style
- Pass arguments to transformers via ... by default

Author: lorenzwalthert

API

@@ -2,10 +2,9 @@
 
 ## Exported functions
 
-get_transformers(flat = FALSE, ...)
-get_transformers_flat(strict = TRUE, start_comments_with_one_space = FALSE)
-get_transformers_nested(scope = "tokens", strict = TRUE, indent_by = 2, start_comments_with_one_space = FALSE)
-style_dir(path = ".", flat = FALSE, recursive = TRUE, transformers = get_transformers(flat = flat))
-style_file(path, flat = FALSE, transformers = get_transformers(flat = flat))
-style_pkg(pkg = ".", flat = FALSE, transformers = get_transformers(flat = flat))
-style_text(text, flat = FALSE, transformers = get_transformers(flat = flat))
+create_style_guide(filler, line_break, space, token, indention, use_raw_indention = FALSE)
+style_dir(path = ".", recursive = TRUE, ..., style = tidyverse_style, transformers = style(...))
+style_file(path, ..., style = tidyverse_style, transformers = style(...))
+style_pkg(pkg = ".", ..., style = tidyverse_style, transformers = style(...))
+style_text(text, ..., style = tidyverse_style, transformers = style(...))
+tidyverse_style(scope = "tokens", strict = TRUE, indent_by = 2, start_comments_with_one_space = FALSE)

DESCRIPTION

@@ -35,7 +35,6 @@ Roxygen: list(markdown = TRUE, roclets = c("rd", "namespace", "collate", "pkgapi
 RoxygenNote: 6.0.1.9000
 VignetteBuilder: knitr
 Collate: 
-    'get_transformers.R'
     'modify_pd.R'
     'nested.R'
     'nested_to_tree.R'
@@ -49,6 +48,7 @@ Collate:
     'rules-spacing.R'
     'serialize.R'
     'serialized_tests.R'
+    'style_guides.R'
     'styler.R'
     'transform.R'
     'unindent.R'

NAMESPACE

@@ -1,9 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
 export(create_style_guide)
-export(get_transformers)
-export(get_transformers_flat)
-export(get_transformers_nested)
 export(style_dir)
 export(style_file)
 export(style_pkg)
@@ -23,4 +20,5 @@ importFrom(purrr,pmap)
 importFrom(purrr,pwalk)
 importFrom(purrr,reduce)
 importFrom(purrr,when)
+importFrom(utils,tail)
 importFrom(utils,write.table)

R/parsed.R

@@ -83,6 +83,7 @@ verify_roundtrip <- function(pd_flat, text) {
 #' @param pd_flat A parse table.
 #' @return A parse table with two three columns: lag_newlines, newlines and
 #'   spaces.
+#' @importFrom utils tail
 create_filler <- function(pd_flat) {
 
   pd_flat$line3 <- lead(pd_flat$line1, default = tail(pd_flat$line2, 1))

R/get_transformers.R renamed to R/style_guides.R

@@ -1,67 +1,13 @@
 #' The tidyverse style
-#' @param ... ...
-#' @export
-tidyverse_style <- function(...) {
-  get_transformers_nested(...)
-}
-
-#' Get the transformer functions for styling
-#'
-#' @param flat Whether the transformer functions for flat or nested styling
-#'   should be returned.
-#' @return A list of transformer functions that operate on flat parse tables.
-#' @param ... Parameters passed to
-#'   * [get_transformers_flat()] if `flat = TRUE` or
-#'   * [get_transformers_nested()] if `flat = FALSE`.
-#' @export
-get_transformers <- function(flat = FALSE, ...) {
-  if (flat) {
-    get_transformers_flat(...)
-  } else {
-    get_transformers_nested(...)
-  }
-}
-
-#' Get the transformer functions for flat styling
-#'
-#' @param strict A logical value indicating whether a set of strict
-#'   or not so strict transformer functions should be returned.
-#' @param start_comments_with_one_space Whether or not comments should start
-#'   with only one space (see [start_comments_with_space()]).
-#' @return A list of transformer functions that operate on flat parse
-#'   tables.
-#' @export
-#' @family obtain transformers
-#' @importFrom purrr partial
-get_transformers_flat <- function(strict = TRUE,
-                                  start_comments_with_one_space = FALSE) {
-  c(
-    fix_quotes,
-    remove_space_before_closing_paren,
-    if (strict) remove_space_before_opening_paren,
-    add_space_after_for_if_while,
-    add_space_before_brace,
-    if (strict) set_space_around_op else add_space_around_op,
-    if (strict) set_space_after_comma else add_space_after_comma,
-    remove_space_before_comma,
-    remove_space_after_opening_paren,
-    remove_space_after_excl,
-    remove_space_before_dollar,
-    partial(start_comments_with_space,
-            force_one = start_comments_with_one_space),
-    NULL)
-}
-
-#' Get the transformer functions for nested styling
-#'
-#' Similar to [get_transformers_flat()], but additionally, returns some
-#'   functions needed due the fact that styling is done in a nested way.
 #' @param scope The extent of manipulation. Can range from "none" (least
 #'   invasive) to "token" (most invasive). See 'Details'. This argument is a
 #'   vector of length one.
 #' @param indent_by How many spaces of indention should be inserted after
 #'   operators such as '('.
-#' @inheritParams get_transformers_flat
+#' @param strict A logical value indicating whether a set of strict
+#'   or not so strict transformer functions should be returned.
+#' @param start_comments_with_one_space Whether or not comments should start
+#'   with only one space (see [start_comments_with_space()]).
 #' @details The following options for `scope` are available.
 #'
 #' * "none": Performs no transformation at all.
@@ -78,11 +24,10 @@ get_transformers_flat <- function(strict = TRUE,
 #' @family obtain transformers
 #' @importFrom purrr partial
 #' @export
-get_transformers_nested <- function(
-  scope = "tokens",
-  strict = TRUE,
-  indent_by = 2,
-  start_comments_with_one_space = FALSE) {
+tidyverse_style <- function(scope = "tokens",
+                            strict = TRUE,
+                            indent_by = 2,
+                            start_comments_with_one_space = FALSE) {
 
   scope <- character_to_ordered(
     scope,
@@ -96,7 +41,21 @@ get_transformers_nested <- function(
       partial(indent_op, indent_by = indent_by),
       partial(indent_eq_sub, indent_by = indent_by),
       partial(indent_without_paren, indent_by = indent_by),
-      get_transformers_flat(strict, start_comments_with_one_space),
+
+      fix_quotes,
+      remove_space_before_closing_paren,
+      if (strict) remove_space_before_opening_paren,
+      add_space_after_for_if_while,
+      add_space_before_brace,
+      if (strict) set_space_around_op else add_space_around_op,
+      if (strict) set_space_after_comma else add_space_after_comma,
+      remove_space_before_comma,
+      remove_space_after_opening_paren,
+      remove_space_after_excl,
+      remove_space_before_dollar,
+      partial(start_comments_with_space,
+              force_one = start_comments_with_one_space),
+
       remove_space_after_unary_pm_nested,
       set_space_before_comments,
       set_space_between_levels
@@ -139,6 +98,23 @@ get_transformers_nested <- function(
   )
 }
 
+#' Create a style guide
+#'
+#' This is a helper function to create a style guide, which is technically
+#' speaking a named list of groups of transformer functions where each
+#' transformer function corresponds to one styling rule. The output of this
+#' function can be used as an argument for \code{style} in top level functions
+#' like [style_text()] and friends.
+#' @param filler A filler function that initializes various variables on each
+#'   level of nesting.
+#' @param line_break A list of transformer functiosn that manipulate line_break
+#'   information.
+#' @param space A list of transformer functions that manipulate spacing
+#'   information.
+#' @param token A list of transformer functions that manipulate token text.
+#' @param indention A list of transformer functions that manipulate indention.
+#' @param use_raw_indention Boolean indicating wheter or not the raw indention
+#'   should be used.
 #' @export
 create_style_guide <- function(filler,
                                line_break,

R/transform.R

@@ -8,8 +8,8 @@
 #' @return A logical value that indicates whether or not any file was changed is
 #'   returned invisibly. If files were changed, the user is informed to
 #'   carefully inspect the changes via a message sent to the console.
-transform_files <- function(files, transformers, flat) {
-  transformer <- make_transformer(transformers, flat = flat)
+transform_files <- function(files, transformers) {
+  transformer <- make_transformer(transformers)
 
   changed <- utf8::transform_lines_enc(files, transformer)
   if (any(changed)) {
@@ -24,49 +24,7 @@ transform_files <- function(files, transformers, flat) {
 #'  that should be transformed.
 #' @param transformers A list of transformer functions that operate on flat
 #'   parse tables.
-#' @param flat Whether to do the styling with a flat approach or with a nested
-#'   approach.
-#' @family make transformers
-make_transformer <- function(transformers, flat) {
-  if (flat) {
-    make_transformer_flat(transformers = transformers)
-  } else {
-    make_transformer_nested(transformers = transformers)
-  }
-}
-
-#' A Closure to return transformer function
-#'
-#' Returns a closure that turns `text` into a flat parse table and applies
-#'   `transformers`  on it.
-#' @inheritParams make_transformer
-#' @family make transformers
-make_transformer_flat <- function(transformers) {
-  function(text) {
-    text <- gsub(" +$", "", text)
-    text <- gsub("\t", "        ", text)
-
-    pd_flat <- compute_parse_data_flat_enhanced(text)
-
-    # May strip empty lines before EOF
-    text <- verify_roundtrip(pd_flat, text)
-
-    transformed_pd_flat <- Reduce(function(x, fun) fun(x),
-                                  transformers,
-                                  init = pd_flat)
-
-    new_text <- serialize_parse_data_flat(transformed_pd_flat)
-    new_text
-  }
-}
-
-#' Closure to return transformer function
-#'
-#' Returns a closure that turns `text` into a nested parse table and applies
-#'   `transformers`  on it.
-#' @inheritParams make_transformer
-#' @family make transformers
-make_transformer_nested <- function(transformers) {
+make_transformer <- function(transformers) {
   function(text) {
     if (is.null(transformers$space)) return(text)
     transformed_text <- parse_transform_serialize(text, transformers)
@@ -75,7 +33,6 @@ make_transformer_nested <- function(transformers) {
   }
 }
 
-
 #' Parse, transform and serialize text
 #'
 #' Wrapper function for the common three operations.

R/ws.R

@@ -10,42 +10,43 @@ NULL
 #' (code and tests).
 #' Carefully examine the results after running this function!
 #'
-#' @param pkg Path to a (subdirectory of an) R package
-#' @param ... Passed on to [get_transformers()]
-#' @inheritParams style_text
+#' @param pkg Path to a (subdirectory of an) R package.
+#' @param ... Passed on to the `style` function.
+#' @param style The unquoted name of a style guide to use. Will not be used
+#'   further except to construct the argument `transformers`.
+#' @param transformers A set of transformer functions.
 #' @export
 #' @family stylers
 style_pkg <- function(pkg = ".",
                       ...,
                       style = tidyverse_style,
                       transformers = style(...)) {
   pkg_root <- rprojroot::find_package_root_file(path = pkg)
-  withr::with_dir(pkg_root, prettify_local(transformers, flat = FALSE))
+  withr::with_dir(pkg_root, prettify_local(transformers))
 }
 
-prettify_local <- function(transformers, flat) {
+prettify_local <- function(transformers) {
   r_files <- dir(path = "R", pattern = "[.][rR]$", recursive = TRUE, full.names = TRUE)
   r_files <- grep("/RcppExports[.]R$", r_files, invert = TRUE, value = TRUE)
   test_files <- dir(path = "tests/testthat", pattern = "[.][rR]$", recursive = TRUE, full.names = TRUE)
   files <- c(r_files, test_files)
 
-  transform_files(files, transformers, flat)
+  transform_files(files, transformers)
 }
 
 
 #' Style a string
 #'
 #' Styles a character vector
 #' @param text A character vector with text to style.
-#' @param transformers A list with functions to be applied to the parsed data.
-#' @param flat Whether to do the styling with a flat approach or with a nested
-#'   approach.
+#' @inheritParams style_pkg
 #' @family stylers
 #' @export
 style_text <- function(text,
-  flat = FALSE,
-  transformers = get_transformers(flat = flat)) {
-  transformer <- make_transformer(transformers, flat = flat)
+                       ...,
+                       style = tidyverse_style,
+                       transformers = style(...)) {
+  transformer <- make_transformer(transformers)
   transformer(text)
 }
 
@@ -56,28 +57,26 @@ style_text <- function(text,
 #' @param path Path to a directory with files to transform.
 #' @param recursive A logical value indicating whether or not files in subdirectories
 #'   of `path` should be styled as well.
-#' @inheritParams style_text
+#' @inheritParams style_pkg
 #' @family stylers
 #' @export
 style_dir <- function(path = ".",
-  flat = FALSE,
-  recursive = TRUE,
-  transformers = get_transformers(flat = flat)) {
-  withr::with_dir(path, prettify_any(transformers,
-      recursive = recursive,
-      flat = flat))
+                      recursive = TRUE,
+                      ...,
+                      style = tidyverse_style,
+                      transformers = style(...)) {
+  withr::with_dir(path, prettify_any(transformers, recursive = recursive))
 }
 
 #' Prettify R code in current working directory
 #'
 #' This is a helper function for style_dir.
-#' @inheritParams style_dir
+#' @inheritParams style_pkg
 #' @param recursive A logical value indicating whether or not files in subdirectories
 #'   should be styled as well.
-#' @keywords internal
-prettify_any <- function(transformers, recursive, flat) {
+prettify_any <- function(transformers, recursive) {
   files <- dir(path = ".", pattern = "[.][rR]$", recursive = recursive, full.names = TRUE)
-  transform_files(files, transformers, flat = flat)
+  transform_files(files, transformers)
 
 }
 
@@ -86,32 +85,31 @@ prettify_any <- function(transformers, recursive, flat) {
 #' Performs various substitutions in the `.R` file specified.
 #'   Carefully examine the results after running this function!
 #' @param path A path to a file to style.
-#' @inheritParams style_text
+#' @inheritParams style_pkg
 #' @family stylers
 #' @export
 style_file <- function(path,
-                       flat = FALSE,
-                       transformers = get_transformers(flat = flat)) {
+                       ...,
+                       style = tidyverse_style,
+                       transformers = style(...)) {
   withr::with_dir(dirname(path),
-                 prettify_one(transformers, flat, basename(path)))
+                 prettify_one(transformers, basename(path)))
 }
 
 #' Prettify one R file
 #'
 #' This is a helper function for style_dir.
 #' @inheritParams style_dir
 #' @param path The path to a file that should be styled.
-prettify_one <- function(transformers, flat, path) {
+prettify_one <- function(transformers, path) {
   if (!grepl("\\.[Rr]$", path)) stop(path, " is not a .R file")
-  transform_files(path, transformers, flat = flat)
+  transform_files(path, transformers)
 }
 
 #' Style the active file
 #'
 #' Helper function fot RStudio Add-in.
 style_active_file <- function() {
   file <- rstudioapi::getActiveDocumentContext()$path
-  style_file(file,
-             flat = FALSE,
-             transformers = get_transformers(flat = FALSE))
+  style_file(file, transformers = tidyverse_style)
 }