Tests for update collate

DESCRIPTION

@@ -3,7 +3,7 @@ Title: In-source documentation for R
 Description: A Doxygen-like in-source documentation system
     for Rd, collation, and NAMESPACE.
 URL: https://github.com/klutometis/roxygen
-Version: 4.0.2.9000
+Version: 4.0.2.9001
 License: GPL (>= 2)
 Authors@R: c(
     person("Hadley", "Wickham",, "[email protected]", c("aut", "cre", "cph")),

R/roclet-collate.R

@@ -10,8 +10,10 @@ register.preref.parsers(parse.value, 'include')
 #' (space separated) that should be loaded before the current file - these are
 #' typically necessary if you're using S4 or RC classes (because super classes
 #' must be defined before subclasses).  If there are no \code{@@include} tags
-#' Collate will be left blank, indicating that the order of loading does not
-#' matter.
+#' Collate will be left as is. Blank (ie Collate field absent) indicates that the
+#' order of loading does not matter.  Any manually entered filenames in the
+#' Collate field will be left untouched, unless there are \code{@@include} tags
+#' in the R files in which case they will be overwritten.
 #'
 #' This is not a roclet because roclets need the values of objects in a package,
 #' and those values can not be generated unless you've sourced the files,
@@ -35,6 +37,7 @@ update_collate <- function(base_path) {
   if (!is.null(collate)) {
     collate <- paste0("'", collate, "'", collapse = " ")
   }
+  else return()
 
   desc_path <- file.path(base_path, "DESCRIPTION")
   old <- read.description(desc_path)

tests/testthat/test-collate-no-includes.R

@@ -0,0 +1,27 @@
+context("Collation with no @includes")
+
+temp_copy_pkg <- function(pkg) {
+  file.copy(normalizePath(pkg), tempdir(), recursive = TRUE)
+  normalizePath(file.path(tempdir(), pkg))
+}
+
+test_that("Collate field unchanged when no @includes", {
+
+  # Make a temporary copy of the package template for this test,
+  # since if this test fails update_collate might have permanent side effects,
+  # namely changing the collate field in the DESCRIPTION file
+  # which would invalidate any future test runs
+  test_pkg <- temp_copy_pkg('testCollateNoIncludes')
+  on.exit(unlink(test_pkg, recursive = TRUE))
+
+  old_desc <- read.description(file.path(test_pkg, "DESCRIPTION"))
+  update_collate(test_pkg)
+  new_desc <- read.description(file.path(test_pkg, "DESCRIPTION"))
+
+  expect_named(old_desc,c("Package","Title","License","Description",
+                          "Author","Maintainer","Version","Collate"))
+  expect_named(new_desc,c("Package","Title","License","Description",
+                          "Author","Maintainer","Version","Collate"))
+  expect_identical(old_desc$Collate,new_desc$Collate)
+
+})

tests/testthat/testCollateNoIncludes/DESCRIPTION

@@ -0,0 +1,8 @@
+Package: testCollateNoIncludes
+Title: Test no change to Collate when there are no @includes
+License: GPL-2
+Description:
+Author: Geoff <[email protected]>
+Maintainer: Geoff <[email protected]>
+Version: 0.1
+Collate: b.r a.r

tests/testthat/testCollateNoIncludes/NAMESPACE

@@ -0,0 +1 @@
+exportPattern("^[^\\.]")

tests/testthat/testCollateNoIncludes/R/a.r

@@ -0,0 +1,4 @@
+# Manually edited the Collate field in the DESCRIPTION file so this *should*
+# run after b.r
+
+a <- 1

tests/testthat/testCollateNoIncludes/R/b.r

@@ -0,0 +1 @@
+a <- 2