Update style_pkg() to handle R and Rmd, update and add tests

Author: jonmcalder

R/ui.R

@@ -40,25 +40,47 @@ style_pkg <- function(pkg = ".",
                       ...,
                       style = tidyverse_style,
                       transformers = style(...),
-                      filetype = c("r"),
+                      filetype = "R",
                       exclude_files = "R/RcppExports.R") {
   pkg_root <- rprojroot::find_package_root_file(path = pkg)
-  changed <- withr::with_dir(pkg_root, prettify_local(transformers, exclude_files))
+  changed <- withr::with_dir(pkg_root,
+    prettify_local(transformers, filetype, exclude_files)
+  )
   invisible(changed)
 }
 
-prettify_local <- function(transformers, exclude_files) {
-  r_files <- dir(
-    path = "R", pattern = "[.][rR]$", recursive = TRUE, full.names = TRUE
-  )
+prettify_local <- function(transformers, filetype, exclude_files) {
 
-  r_files <- grep("/RcppExports[.]R$", r_files, invert = TRUE, value = TRUE)
-  test_files <- dir(
-    path = "tests/testthat", pattern = "[.][rR]$",
-    recursive = TRUE, full.names = TRUE
-  )
+  filetype <- set_and_assert_arg_filetype(filetype)
+  r_files <- test_files <- data_raw_files <- vignette_files <- readme <- NULL
 
-  files <- setdiff(c(r_files, test_files), exclude_files)
+  if ("\\.r" %in% filetype) {
+    r_files <- dir(
+      path = "R", pattern = "\\.r$", ignore.case = TRUE,
+      recursive = TRUE, full.names = TRUE
+    )
+    test_files <- dir(
+      path = "tests", pattern = "\\.r$", ignore.case = TRUE,
+      recursive = TRUE, full.names = TRUE
+    )
+    data_raw_files <- dir(
+      path = "data-raw", pattern = "\\.r$", ignore.case = TRUE,
+      recursive = TRUE, full.names = TRUE
+    )
+  }
+
+  if ("\\.rmd" %in% filetype) {
+    vignette_files <- dir(
+      path = "vignettes", pattern = "\\.rmd$", ignore.case = TRUE,
+      recursive = TRUE, full.names = TRUE
+    )
+    readme <- dir(pattern = "readme\\.rmd", ignore.case = TRUE)
+  }
+
+  files <- setdiff(
+    c(r_files, test_files, data_raw_files, vignette_files, readme),
+    exclude_files
+  )
 
   transform_files(files, transformers)
 }

man/style_pkg.Rd

@@ -0,0 +1,15 @@
+Package: xyzpackage
+Title: What the Package Does (one line, title case)
+Version: 0.0.0.9000
+Authors@R: person("First", "Last", email = "[email protected]", role = c("aut", "cre"))
+Description: What the package does (one paragraph).
+Depends: R (>= 3.3.2)
+License: What license is it under?
+Encoding: UTF-8
+LazyData: true
+Suggests: testthat
+LinkingTo: 
+    Rcpp
+Imports: 
+    Rcpp
+RoxygenNote: 6.0.1.9000

tests/testthat/public-api/xyzpackage-rmd/DESCRIPTION

@@ -0,0 +1,2 @@
+# Generated by roxygen2: do not edit by hand
+

tests/testthat/public-api/xyzpackage-rmd/NAMESPACE

@@ -0,0 +1,6 @@
+# Generated by using Rcpp::compileAttributes() -> do not edit by hand
+# Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393
+
+timesTwo <- function(x) {
+  .Call("_xyzpackage_timesTwo", PACKAGE = "xyzpackage", x)
+}

tests/testthat/public-api/xyzpackage-rmd/R/RcppExports.R

@@ -0,0 +1,3 @@
+hello_world <- function() {
+  print("hello, world")
+}

tests/testthat/public-api/xyzpackage-rmd/R/hello-world.R

@@ -0,0 +1,33 @@
+---
+output: github_document
+---
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+```{r setup, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>",
+  fig.path = "man/figures/README-"
+)
+```
+# styler
+
+The goal of styler is to ...
+
+## Installation
+
+You can install styler from github with:
+
+```{r gh-installation, eval = FALSE}
+# install.packages("devtools")
+devtools::install_github("jonmcalder/styler")
+```
+
+## Example
+
+This is a basic example which shows you how to solve a common problem:
+
+```{r example}
+## basic example code
+```

tests/testthat/public-api/xyzpackage-rmd/README.Rmd

@@ -0,0 +1,3 @@
+*.o
+*.so
+*.dll

tests/testthat/public-api/xyzpackage-rmd/src/.gitignore

@@ -0,0 +1,28 @@
+// Generated by using Rcpp::compileAttributes() -> do not edit by hand
+// Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393
+
+#include <Rcpp.h>
+
+using namespace Rcpp;
+
+// timesTwo
+NumericVector timesTwo(NumericVector x);
+RcppExport SEXP _xyzpackage_timesTwo(SEXP xSEXP) {
+BEGIN_RCPP
+    Rcpp::RObject rcpp_result_gen;
+    Rcpp::RNGScope rcpp_rngScope_gen;
+    Rcpp::traits::input_parameter< NumericVector >::type x(xSEXP);
+    rcpp_result_gen = Rcpp::wrap(timesTwo(x));
+    return rcpp_result_gen;
+END_RCPP
+}
+
+static const R_CallMethodDef CallEntries[] = {
+    {"_xyzpackage_timesTwo", (DL_FUNC) &_xyzpackage_timesTwo, 1},
+    {NULL, NULL, 0}
+};
+
+RcppExport void R_init_xyzpackage(DllInfo *dll) {
+    R_registerRoutines(dll, NULL, CallEntries, NULL, NULL);
+    R_useDynamicSymbols(dll, FALSE);
+}

tests/testthat/public-api/xyzpackage-rmd/src/RcppExports.cpp

@@ -0,0 +1,27 @@
+#include <Rcpp.h>
+using namespace Rcpp;
+
+// This is a simple example of exporting a C++ function to R. You can
+// source this function into an R session using the Rcpp::sourceCpp
+// function (or via the Source button on the editor toolbar). Learn
+// more about Rcpp at:
+//
+//   http://www.rcpp.org/
+//   http://adv-r.had.co.nz/Rcpp.html
+//   http://gallery.rcpp.org/
+//
+
+// [[Rcpp::export]]
+NumericVector timesTwo(NumericVector x) {
+  return x * 2;
+}
+
+
+// You can include R code blocks in C++ files processed with sourceCpp
+// (useful for testing and development). The R code will be automatically
+// run after the compilation.
+//
+
+/*** R
+timesTwo(42)
+*/