Add ... to set functions

NEWS.md

@@ -1,5 +1,9 @@
 # almanac (development version)
 
+* `runion()`, `rintersect()`, and `rsetdiff()` have all gained `...` which
+  allows you to provide the relevant rschedules on creation of these rschedules.
+  This is now the preferred way to create these set-based rschedules (#91).
+
 * New `rcustom()` for creating an rschedule from manually defined event dates
   (#90).
 

R/rbundle-set.R

@@ -27,8 +27,12 @@
 #' For `rsetdiff()`, the event set is created "from left to right" and depends
 #' on the order that the rschedules were added to the bundle.
 #'
+#' @param ... `[rschedules]`
+#'
+#'   rschedule objects to add to the bundle.
+#'
 #' @return
-#' An empty rbundle.
+#' A runion, rintersect, or rsetdiff.
 #'
 #' @name rbundle-set
 #' @seealso [add_rschedule()]
@@ -43,31 +47,19 @@
 #'   recur_on_day_of_month(25)
 #'
 #' # On weekends OR the 25th of the month
-#' ru <- runion() %>%
-#'   add_rschedule(on_weekends) %>%
-#'   add_rschedule(on_25th)
-#'
+#' ru <- runion(on_weekends, on_25th)
 #' alma_events(ru)
 #'
 #' # On weekends AND the 25th of the month
-#' ri <- rintersect() %>%
-#'   add_rschedule(on_weekends) %>%
-#'   add_rschedule(on_25th)
-#'
+#' ri <- rintersect(on_weekends, on_25th)
 #' alma_events(ri)
 #'
 #' # On weekends AND NOT the 25th of the month
-#' rsd1 <- rsetdiff() %>%
-#'   add_rschedule(on_weekends) %>%
-#'   add_rschedule(on_25th)
-#'
+#' rsd1 <- rsetdiff(on_weekends, on_25th)
 #' alma_events(rsd1)
 #'
 #' # On the 25th of the month AND NOT the weekend
-#' rsd2 <- rsetdiff() %>%
-#'   add_rschedule(on_25th) %>%
-#'   add_rschedule(on_weekends)
-#'
+#' rsd2 <- rsetdiff(on_25th, on_weekends)
 #' alma_events(rsd2)
 NULL
 

R/rbundle.R

@@ -75,10 +75,6 @@ new_rbundle <- function(rschedules = list(),
                         class = character()) {
   vec_check_list(rschedules)
 
-  for (i in seq_along(rschedules)) {
-    check_rschedule(rschedules[[i]], arg = cli::format_inline("rschedules[[{i}]]"))
-  }
-
   check_date(rdates)
   check_no_missing(rdates)
   check_finite(rdates)

R/rintersect.R

@@ -1,7 +1,9 @@
 #' @rdname rbundle-set
 #' @export
-rintersect <- function() {
-  new_rintersect()
+rintersect <- function(...) {
+  rschedules <- list2(...)
+  list_check_all_rschedules(rschedules)
+  new_rintersect(rschedules = rschedules)
 }
 
 # ------------------------------------------------------------------------------

R/rschedule.R

@@ -96,3 +96,18 @@ check_rschedule <- function(x,
     call = call
   )
 }
+
+list_check_all_rschedules <- function(x,
+                                      ...,
+                                      arg = caller_arg(x),
+                                      call = caller_env()) {
+  for (i in seq_along(x)) {
+    check_rschedule(
+      x = x[[i]],
+      arg = cli::format_inline("{arg}[[{i}]]"),
+      call = call
+    )
+  }
+  invisible(NULL)
+}
+

R/rsetdiff.R

@@ -1,7 +1,9 @@
 #' @rdname rbundle-set
 #' @export
-rsetdiff <- function() {
-  new_rsetdiff()
+rsetdiff <- function(...) {
+  rschedules <- list2(...)
+  list_check_all_rschedules(rschedules)
+  new_rsetdiff(rschedules = rschedules)
 }
 
 # ------------------------------------------------------------------------------

R/runion.R

@@ -1,7 +1,9 @@
 #' @rdname rbundle-set
 #' @export
-runion <- function() {
-  new_runion()
+runion <- function(...) {
+  rschedules <- list2(...)
+  list_check_all_rschedules(rschedules)
+  new_runion(rschedules = rschedules)
 }
 
 # ------------------------------------------------------------------------------

tests/testthat/_snaps/rbundle.md

@@ -6,14 +6,6 @@
       Error in `new_rbundle()`:
       ! `rschedules` must be a list, not the number 1.
 
----
-
-    Code
-      new_rbundle(list(1))
-    Condition
-      Error in `new_rbundle()`:
-      ! `rschedules[[1]]` must be a <rschedule>, not the number 1.
-
 # validates rdates
 
     Code

tests/testthat/test-rbundle.R

@@ -5,9 +5,6 @@ test_that("validates rschedules", {
   expect_snapshot(error = TRUE, {
     new_rbundle(1)
   })
-  expect_snapshot(error = TRUE, {
-    new_rbundle(list(1))
-  })
 })
 
 test_that("validates rdates", {

tests/testthat/test-rintersect.R

@@ -9,6 +9,13 @@ test_that("can create an empty rintersect()", {
   expect_identical(x$exdates, new_date())
 })
 
+test_that("can add rschedules directly into an rintersect()", {
+  x <- yearly()
+  y <- daily()
+  z <- rintersect(x, y)
+  expect_identical(z$rschedules, list(x, y))
+})
+
 test_that("rintersect() generates informative output", {
   expect_snapshot({
     "# Empty rintersect"

tests/testthat/test-rsetdiff.R

@@ -9,6 +9,13 @@ test_that("can create an empty rsetdiff()", {
   expect_identical(x$exdates, new_date())
 })
 
+test_that("can add rschedules directly into an rsetdiff()", {
+  x <- yearly()
+  y <- daily()
+  z <- rsetdiff(x, y)
+  expect_identical(z$rschedules, list(x, y))
+})
+
 test_that("rsetdiff() generates informative output", {
   expect_snapshot({
     "# Empty rsetdiff"

tests/testthat/test-runion.R

@@ -9,6 +9,13 @@ test_that("can create an empty runion()", {
   expect_identical(x$exdates, new_date())
 })
 
+test_that("can add rschedules directly into an runion()", {
+  x <- yearly()
+  y <- daily()
+  z <- runion(x, y)
+  expect_identical(z$rschedules, list(x, y))
+})
+
 test_that("runion() generates informative output", {
   expect_snapshot({
     "# Empty runion"