Merge pull request #108 from ThinkR-open/extend

Extend

Author: statnmap

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: fusen
 Title: Build a Package from Rmarkdown File
-Version: 0.2.4.9000
+Version: 0.3.0
 Authors@R: c(
     person("Sebastien", "Rochette", , "sebastien@thinkr.fr", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0002-1565-9313")),

NEWS.md

@@ -1,4 +1,4 @@
-# fusen 0.2.4.9000
+# fusen 0.3.0
 
 ## Breaking changes
 
@@ -9,9 +9,11 @@
 
 ## Major changes
 
+* Check included now uses `devtools::check()` instead of `rcmdcheck()`
 * Avoid creating vignette with `inflate(vignette_name = NA)`
 * Decide whether or not to open vignette when inflate with `inflate(open_vignette = FALSE)`
 * Improve documentation included in flat templates to reflect changes in using dev_history file
+* Add Rstudio Addin to insert a new flat template
 * Add Rstudio Addin to insert chunks for new function (@ColinFay)
 * Deal with `\dontrun{}` in example chunks
 * Allow short names for chunks: dev, fun, ex, test

R/addins.R

@@ -0,0 +1,28 @@
+#' Addin to add a new template
+#' @noRd
+addin_add_template <- function() {
+  if (
+    requireNamespace("rstudioapi") &&
+    rstudioapi::isAvailable()
+  ) {
+    # This will allow to interactively have the function name
+    if (rstudioapi::hasFun("showPrompt")) {
+      template <- rstudioapi::showPrompt(
+        title = "Enter the flat template type",
+        message = "e.g. add = additional; min = minimal;",
+        default = "additional")
+    } else {
+      template <- readline("Enter the flat template type: ")
+    }
+    if (rstudioapi::hasFun("showPrompt")) {
+      flat_name <- rstudioapi::showPrompt(
+        title = "Choose the function name",
+        message = "Name is used to pre-fill the template",
+        default = "my_fun")
+    } else {
+      flat_name <- readline("Enter the function name: ")
+    }
+
+    add_flat_template(template = template, flat_name = flat_name)
+  }
+}

R/inflate.R

@@ -61,13 +61,13 @@ inflate <- function(pkg = ".", flat_file = file.path("dev", "flat_full.Rmd"),
                     overwrite = "ask", ...) {
 
   if (!is.null(list(...)[["name"]])) {
-    warning(paste0("The `name` argument to `inflate()` is deprecated since {fusen} version 0.2.5,",
+    warning(paste0("The `name` argument to `inflate()` is deprecated since {fusen} version 0.3.0,",
                    " and will be removed in a future version.",
                    "\nPlease use `vignette_name = '", list(...)[["name"]],"'` instead.\n"))
     vignette_name <- list(...)[["name"]]
   }
   if (!is.null(list(...)[["rmd"]])) {
-    warning(paste0("The `rmd` argument to `inflate()` is deprecated since {fusen} version 0.2.5,",
+    warning(paste0("The `rmd` argument to `inflate()` is deprecated since {fusen} version 0.3.0,",
                    " and will be removed in a future version.",
                    "\nPlease use `flat_file = '", list(...)[["rmd"]],"'` instead.\n"))
     flat_file <- list(...)[["rmd"]]

dev/dev_history.R

@@ -203,10 +203,13 @@ urlchecker::url_update()
 # check on other distributions
 # _rhub
 devtools::check_rhub()
+rhub::platforms()
 rhub::check_on_windows(check_args = "--force-multiarch")
-rhub::check_on_solaris()
-rhub::check(platform = "debian-clang-devel")
-rhub::check(platform = "fedora-clang-devel")
+rhub::check_on_solaris(show_status = FALSE)
+rhub::check(platform = "debian-clang-devel", show_status = FALSE)
+rhub::check(platform = "debian-gcc-devel", show_status = FALSE)
+rhub::check(platform = "fedora-clang-devel", show_status = FALSE)
+rhub::check(platform = "macos-m1-bigsur-release", show_status = FALSE)
 rhub::check_for_cran(show_status = FALSE)
 
 # Run locally in Docker

inst/rstudio/addins.dcf

@@ -3,3 +3,7 @@ Description: Create {fusen} chunks inside your Rmd
 Binding: add_fusen_chunks
 Interactive: false
 
+Name: Add {fusen} flat template
+Description: Create a new flat template file in your project
+Binding: addin_add_template
+Interactive: true

inst/tests-templates/dev-template-two-fun-same-title.Rmd

@@ -163,21 +163,12 @@ test_that("my_fun_rdname1 works properly and show error if needed", {
 ## fun_rdname2
 
 ```{r function-fun_rdname2}
-#' My fun_rdname2
-#'
-#' @param x Vector of Numeric values
-#' @inheritParams stats::median
-#'
 #' @rdname same_rdname
-#' @return
-#' Median of vector x
+#' @importFrom stats median
 #' @export
-#'
-#' @examples
-#' my_fun_rdname2(2:20)
 my_fun_rdname2 <- function(x, na.rm = TRUE) {
   if (!is.numeric(x)) {stop("x should be numeric")}
-  stats::median(x, na.rm = na.rm)
+  median(x, na.rm = na.rm)
 }
 ```
 

tests/testthat/test-inflate.R

@@ -495,7 +495,8 @@ usethis::with_project(dummypackage, {
       ),
       regexp = NA)
     # Check error
-    skip_on_os(os = c("windows", "solaris"))
+    # skip_on_os(os = c("windows", "solaris"))
+    skip_on_cran()
 
     # Could not find function "my_norox2"
     expect_error(rcmdcheck::rcmdcheck(dummypackage, quiet = TRUE,
@@ -555,6 +556,7 @@ for (pkgname in c("full", "teaching", "minimal")) {
         # Do not check inside check if on CRAN
         skip_on_os(os = c("windows", "solaris"))
 
+
         # If this check is run inside a not "--as-cran" check, then it wont work as expected
         check_out <- rcmdcheck::rcmdcheck(path_foosen, quiet = TRUE,
                              args = c("--no-manual"))
@@ -568,6 +570,7 @@ for (pkgname in c("full", "teaching", "minimal")) {
         #  ‘MASS’
         # print(" -- warnings --")
         # print(check_out[["warnings"]])
+        skip_on_cran()
         expect_true(length(check_out[["notes"]]) == 0)
       } else {
         print(" ==== Interactive ====")
@@ -699,6 +702,7 @@ usethis::with_project(dummypackage, {
       #  ‘MASS’
       # print(" -- warnings --")
       # print(check_out[["warnings"]])
+      skip_on_cran()
       expect_true(length(check_out[["notes"]]) == 0)
     } else {
       expect_error(
@@ -936,6 +940,12 @@ usethis::with_project(dummypackage, {
     r_lines <- readLines(my_rdname1_file)
     expect_true(any(grepl("my_fun_rdname1 <- function", r_lines)))
     expect_true(any(grepl("my_fun_rdname2 <- function", r_lines)))
+    expect_equal(r_lines[13:15],
+                 c("#' @examples" , "#' my_fun_rdname1(2:20)", "#' my_fun_rdname1(1:12)"))
+    expect_equal(r_lines[21:25],
+                 c("#' @rdname same_rdname" ,
+                   "#' @importFrom stats median", "#' @export",
+                   "#' @examples", "#' my_fun_rdname2(1:12)" ))
     # Same chunk name
     r_lines <- readLines(my_chunk1_file)
     expect_true(any(grepl("my_fun_chunk1 <- function", r_lines)))
@@ -947,6 +957,29 @@ usethis::with_project(dummypackage, {
     # @filename cleaned in R file
     expect_false(any(grepl("@filename", r_lines)))
 
+    # -- doc files --
+    my_median_file <- file.path(dummypackage, "man", "my_median.Rd")
+    expect_true(file.exists(my_median_file))
+    my_median2_file <- file.path(dummypackage, "man", "my_median2.Rd")
+    expect_true(file.exists(my_median2_file))
+    # chunk name
+    my_median_file <- file.path(dummypackage, "man", "my_fun_chunk1.Rd")
+    expect_true(file.exists(my_median_file))
+    my_median2_file <- file.path(dummypackage, "man", "my_fun_chunk2.Rd")
+    expect_true(file.exists(my_median2_file))
+    # rdname
+    my_median_file <- file.path(dummypackage, "man", "my_fun_rdname1.Rd")
+    expect_false(file.exists(my_median_file))
+    my_median2_file <- file.path(dummypackage, "man", "my_fun_rdname2.Rd")
+    expect_false(file.exists(my_median2_file))
+    my_median3_file <- file.path(dummypackage, "man", "same_rdname.Rd")
+    expect_true(file.exists(my_median3_file))
+    # filename
+    my_median_file <- file.path(dummypackage, "man", "my_fun_filename1.Rd")
+    expect_true(file.exists(my_median_file))
+    my_median2_file <- file.path(dummypackage, "man", "my_fun_filename2.Rd")
+    expect_true(file.exists(my_median2_file))
+
     # -- test files --
     my_median_file <- file.path(dummypackage, "tests", "testthat", "test-my_median.R")
     expect_true(file.exists(my_median_file))