new use_tidy_style() (#197)

Closes #72

* add use_tidy_style

* add warning (c/p from styler).

* add a test

* rename testthat file

* add styler reference

* add check_uncommitted_changed

* dispatch between style_pkg and style_dir

* adapt use_dev_version() style

* avoid EOF warning

* switch to usethis:::proj_path()

* adapt to review comments

* fiddle with tests...

remove capture_output for now as suggested by reviewer to see what happens.

* mask testthat call

* printing

* fix test to not include dplyr-dependency edge case in styler.

* skip tests on R < 3.2
because git2r::discover_repository() not working on R 3.1.

* remove print statements

* fix bug for non-packages

* capture output

* remove testthat mask

* adapt help file and test description for non-packages

* final tweaks

Author: lorenzwalthert

DESCRIPTION

@@ -33,6 +33,7 @@ Imports:
     rmarkdown,
     rprojroot,
     rstudioapi,
+    styler,
     whisker
 Suggests: 
     covr,

NAMESPACE

@@ -65,6 +65,7 @@ export(use_tidy_contributing)
 export(use_tidy_description)
 export(use_tidy_eval)
 export(use_tidy_issue_template)
+export(use_tidy_style)
 export(use_tidy_support)
 export(use_tidy_versions)
 export(use_travis)

R/dev-version.R

@@ -6,12 +6,7 @@
 #' @export
 use_dev_version <- function() {
   check_is_package("use_dev_version()")
-  if (uses_git() && git_uncommitted()) {
-    stop(
-      "Uncommited changes. Please commit to git before continuing",
-      call. = FALSE
-    )
-  }
+  check_uncommitted_changes()
 
   ver <- desc::desc_get_version(proj_get())
   if (length(unlist(ver)) > 3) {

R/git-utils.R

@@ -3,3 +3,12 @@ git_uncommitted <- function(path = ".") {
   st <- vapply(git2r::status(r), length, integer(1))
   any(st != 0)
 }
+
+check_uncommitted_changes <- function(path = proj_get()) {
+  if (uses_git(path) && git_uncommitted(path)) {
+    stop(
+      "Uncommited changes. Please commit to git before continuing",
+      call. = FALSE
+    )
+  }
+}

R/styler.R

@@ -0,0 +1,31 @@
+#' Style according to the tidyverse style guide
+#'
+#' Styles the source code of a package, project or directory according to the
+#' [tidyverse style guide](http://style.tidyverse.org) with the
+#' package [styler](http://styler.r-lib.org).
+#' @param strict Boolean indicating whether or not a strict version of styling
+#'   should be applied. See [styler::tidyverse_style()] for details.
+#' @section Warning:
+#' This function overwrites files (if styling results in a change of the
+#' code to be formatted). It is strongly suggested to only style files
+#' that are under version control or to create a backup copy.
+#' @return
+#' Invisibly returns a data frame that indicates for each file considered for
+#' styling whether or not it was actually changed.
+#' @export
+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)
+}

man/use_tidy_style.Rd

@@ -0,0 +1,26 @@
+context("use_tidy_style")
+
+test_that("styling the package works", {
+  skip_if(getRversion() < 3.2)
+  skip_if_no_git_config()
+  pkg <- scoped_temporary_package()
+  capture_output(use_r("bad_style"))
+  path_to_bad_style <- proj_path("R/bad_style.R")
+  write_utf8(path_to_bad_style, "a++2\n")
+  capture_output(use_tidy_style())
+  expect_identical(readLines(path_to_bad_style), "a + +2")
+  unlink(path_to_bad_style)
+})
+
+
+test_that("styling of non-packages works", {
+  skip_if(getRversion() < 3.2)
+  skip_if_no_git_config()
+  proj <- scoped_temporary_project()
+  path_to_bad_style <- proj_path("R/bad_style.R")
+  capture_output(use_r("bad_style"))
+  write_utf8(path_to_bad_style, "a++22\n")
+  capture_output(use_tidy_style())
+  expect_identical(readLines(path_to_bad_style), "a + +22")
+  unlink(path_to_bad_style)
+})