Namespace prefix all almanac class names

NAMESPACE

@@ -1,22 +1,22 @@
 # Generated by roxygen2: do not edit by hand
 
-S3method(print,radjusted)
-S3method(print,rcustom)
-S3method(print,rintersect)
-S3method(print,rrule)
-S3method(print,rsetdiff)
-S3method(print,runion)
+S3method(print,almanac_radjusted)
+S3method(print,almanac_rcustom)
+S3method(print,almanac_rintersect)
+S3method(print,almanac_rrule)
+S3method(print,almanac_rsetdiff)
+S3method(print,almanac_runion)
+S3method(rschedule_events,almanac_radjusted)
+S3method(rschedule_events,almanac_rcustom)
+S3method(rschedule_events,almanac_rintersect)
+S3method(rschedule_events,almanac_rrule)
+S3method(rschedule_events,almanac_rschedule)
+S3method(rschedule_events,almanac_rsetdiff)
+S3method(rschedule_events,almanac_runion)
 S3method(rschedule_events,default)
-S3method(rschedule_events,radjusted)
-S3method(rschedule_events,rcustom)
-S3method(rschedule_events,rintersect)
-S3method(rschedule_events,rrule)
-S3method(rschedule_events,rschedule)
-S3method(rschedule_events,rsetdiff)
-S3method(rschedule_events,runion)
-S3method(rset_restore,rintersect)
-S3method(rset_restore,rsetdiff)
-S3method(rset_restore,runion)
+S3method(rset_restore,almanac_rintersect)
+S3method(rset_restore,almanac_rsetdiff)
+S3method(rset_restore,almanac_runion)
 S3method(vec_arith,almanac_stepper)
 S3method(vec_arith.Date,almanac_stepper)
 S3method(vec_arith.almanac_stepper,Date)

NEWS.md

@@ -1,5 +1,8 @@
 # almanac (development version)
 
+* All almanac class names are now prefixed with `almanac_*` to avoid potential
+  clashes with other packages.
+
 * The `recur_with_week_start()` argument `wday` has been renamed to `day`.
 
 * The following developer facing functions have been removed because they are

R/almanac-deprecated.R

@@ -260,7 +260,7 @@ check_rset <- function(x,
                        call = caller_env()) {
   check_inherits(
     x = x,
-    what = "rset",
+    what = "almanac_rset",
     allow_null = allow_null,
     arg = arg,
     call = call
@@ -273,7 +273,7 @@ rset_restore <- function(x, to) {
 }
 
 #' @export
-rset_restore.rintersect <- function(x, to) {
+rset_restore.almanac_rintersect <- function(x, to) {
   new_rintersect(
     rschedules = x$rschedules,
     rdates = x$rdates,
@@ -282,7 +282,7 @@ rset_restore.rintersect <- function(x, to) {
 }
 
 #' @export
-rset_restore.runion <- function(x, to) {
+rset_restore.almanac_runion <- function(x, to) {
   new_runion(
     rschedules = x$rschedules,
     rdates = x$rdates,
@@ -291,7 +291,7 @@ rset_restore.runion <- function(x, to) {
 }
 
 #' @export
-rset_restore.rsetdiff <- function(x, to) {
+rset_restore.almanac_rsetdiff <- function(x, to) {
   new_rsetdiff(
     rschedules = x$rschedules,
     rdates = x$rdates,

R/radjusted.R

@@ -63,7 +63,7 @@ radjusted <- function(rschedule, adjust_on, adjustment) {
 # ------------------------------------------------------------------------------
 
 #' @export
-print.radjusted <- function(x, ...) {
+print.almanac_radjusted <- function(x, ...) {
   cli::cli_text("<radjusted>")
 
   cli_indented()
@@ -82,7 +82,7 @@ print.radjusted <- function(x, ...) {
 # ------------------------------------------------------------------------------
 
 #' @export
-rschedule_events.radjusted <- function(x) {
+rschedule_events.almanac_radjusted <- function(x) {
   x$cache$get_events()
 }
 
@@ -104,7 +104,7 @@ new_radjusted <- function(rschedule, adjust_on, adjustment) {
     adjust_on = adjust_on,
     adjustment = adjustment,
     cache = cache,
-    class = "radjusted"
+    class = "almanac_radjusted"
   )
 }
 

R/rcustom.R

@@ -41,11 +41,11 @@ rcustom <- function(events) {
 
 new_rcustom <- function(events, ..., class = character()) {
   check_date(events)
-  new_rschedule(events = events, ..., class = c(class, "rcustom"))
+  new_rschedule(events = events, ..., class = c(class, "almanac_rcustom"))
 }
 
 #' @export
-print.rcustom <- function(x, ...) {
+print.almanac_rcustom <- function(x, ...) {
   events <- rcustom_events(x)
   events <- as.character(events)
 
@@ -63,7 +63,7 @@ print.rcustom <- function(x, ...) {
 }
 
 #' @export
-rschedule_events.rcustom <- function(x) {
+rschedule_events.almanac_rcustom <- function(x) {
   rcustom_events(x)
 }
 

R/rrule-print.R

@@ -1,5 +1,5 @@
 #' @export
-print.rrule <- function(x, ...) {
+print.almanac_rrule <- function(x, ...) {
   cli::cli_text("<rrule>")
   cli::cli_ul(format_body(x))
   invisible(x)

R/rrule.R

@@ -108,7 +108,7 @@ yearly <- function(since = "1900-01-01", until = "2100-01-01") {
 # ------------------------------------------------------------------------------
 
 #' @export
-rschedule_events.rrule <- function(x) {
+rschedule_events.almanac_rrule <- function(x) {
   x$cache$get_events()
 }
 
@@ -172,14 +172,14 @@ new_rrule <- function(since = as.Date("1900-01-01"),
   new_rschedule(
     rules = rules,
     cache = cache,
-    class = "rrule"
+    class = "almanac_rrule"
   )
 }
 
 # ------------------------------------------------------------------------------
 
 is_rrule <- function(x) {
-  inherits(x, "rrule")
+  inherits(x, "almanac_rrule")
 }
 
 all_are_rrules <- function(x) {
@@ -193,7 +193,7 @@ check_rrule <- function(x,
                         call = caller_env()) {
   check_inherits(
     x = x,
-    what = "rrule",
+    what = "almanac_rrule",
     allow_null = allow_null,
     arg = arg,
     call = call

R/rschedule.R

@@ -55,7 +55,7 @@ new_rschedule <- function(..., class) {
     abort("`...` must have named elements.")
   }
 
-  structure(data, class = c(class, "rschedule"))
+  structure(data, class = c(class, "almanac_rschedule"))
 }
 
 # ------------------------------------------------------------------------------
@@ -73,14 +73,14 @@ rschedule_events.default <- function(x) {
 }
 
 #' @export
-rschedule_events.rschedule <- function(x) {
-  cli::cli_abort("<rschedule> subclasses must provide their own `rschedule_events()` method.")
+rschedule_events.almanac_rschedule <- function(x) {
+  cli::cli_abort("<almanac_rschedule> subclasses must provide their own `rschedule_events()` method.")
 }
 
 # ------------------------------------------------------------------------------
 
 is_rschedule <- function(x) {
-  inherits(x, "rschedule")
+  inherits(x, "almanac_rschedule")
 }
 
 check_rschedule <- function(x,
@@ -90,7 +90,7 @@ check_rschedule <- function(x,
                             call = caller_env()) {
   check_inherits(
     x = x,
-    what = "rschedule",
+    what = "almanac_rschedule",
     allow_null = allow_null,
     arg = arg,
     call = call

R/rset.R

@@ -81,7 +81,7 @@ new_runion <- function(rschedules = list(),
     exdates = exdates,
     cache = cache,
     ...,
-    class = c(class, "runion")
+    class = c(class, "almanac_runion")
   )
 }
 
@@ -110,7 +110,7 @@ new_rintersect <- function(rschedules = list(),
     exdates = exdates,
     cache = cache,
     ...,
-    class = c(class, "rintersect")
+    class = c(class, "almanac_rintersect")
   )
 }
 
@@ -139,7 +139,7 @@ new_rsetdiff <- function(rschedules = list(),
     exdates = exdates,
     cache = cache,
     ...,
-    class = c(class, "rsetdiff")
+    class = c(class, "almanac_rsetdiff")
   )
 }
 
@@ -166,41 +166,41 @@ new_rset <- function(rschedules = list(),
     rdates = rdates,
     exdates = exdates,
     ...,
-    class = c(class, "rset")
+    class = c(class, "almanac_rset")
   )
 }
 
 # ------------------------------------------------------------------------------
 
 #' @export
-rschedule_events.runion <- function(x) {
+rschedule_events.almanac_runion <- function(x) {
   x$cache$get_events()
 }
 
 #' @export
-rschedule_events.rintersect <- function(x) {
+rschedule_events.almanac_rintersect <- function(x) {
   x$cache$get_events()
 }
 
 #' @export
-rschedule_events.rsetdiff <- function(x) {
+rschedule_events.almanac_rsetdiff <- function(x) {
   x$cache$get_events()
 }
 
 # ------------------------------------------------------------------------------
 
 #' @export
-print.runion <- function(x, ...) {
+print.almanac_runion <- function(x, ...) {
   print_rset(x, "runion")
 }
 
 #' @export
-print.rintersect <- function(x, ...) {
+print.almanac_rintersect <- function(x, ...) {
   print_rset(x, "rintersect")
 }
 
 #' @export
-print.rsetdiff <- function(x, ...) {
+print.almanac_rsetdiff <- function(x, ...) {
   print_rset(x, "rsetdiff")
 }
 

tests/testthat/_snaps/radjusted.md

@@ -4,15 +4,15 @@
       radjusted(1, daily(), adj_none)
     Condition
       Error in `new_radjusted()`:
-      ! `rschedule` must be a <rschedule>, not the number 1.
+      ! `rschedule` must be a <almanac_rschedule>, not the number 1.
 
 # adjust_on is checked
 
     Code
       radjusted(daily(), 1, adj_none)
     Condition
       Error in `new_radjusted()`:
-      ! `adjust_on` must be a <rschedule>, not the number 1.
+      ! `adjust_on` must be a <almanac_rschedule>, not the number 1.
 
 # adjustment is checked
 

tests/testthat/_snaps/rrule.md

@@ -46,13 +46,13 @@
       check_rrule(1)
     Condition
       Error:
-      ! `1` must be a <rrule>, not the number 1.
+      ! `1` must be a <almanac_rrule>, not the number 1.
 
 ---
 
     Code
       check_rrule(1, allow_null = TRUE)
     Condition
       Error:
-      ! `1` must be a <rrule> or `NULL`, not the number 1.
+      ! `1` must be a <almanac_rrule> or `NULL`, not the number 1.
 

tests/testthat/_snaps/rschedule.md

@@ -28,5 +28,5 @@
       rschedule_events(x)
     Condition
       Error in `rschedule_events()`:
-      ! <rschedule> subclasses must provide their own `rschedule_events()` method.
+      ! <almanac_rschedule> subclasses must provide their own `rschedule_events()` method.
 

tests/testthat/_snaps/stepper.md

@@ -21,7 +21,7 @@
       new_stepper(rschedule = 1)
     Condition
       Error in `new_stepper()`:
-      ! `rschedule` must be a <rschedule>, not the number 1.
+      ! `rschedule` must be a <almanac_rschedule>, not the number 1.
 
 # default method error is thrown
 

tests/testthat/test-radjusted.R

@@ -1,7 +1,7 @@
 
 test_that("can create an radjusted rschedule", {
   x <- radjusted(daily(), daily(), adj_none)
-  expect_s3_class(x, c("radjusted", "rschedule"))
+  expect_s3_class(x, c("almanac_radjusted", "almanac_rschedule"))
 })
 
 test_that("radjusted adjusts dates", {

tests/testthat/test-rrule.R

@@ -1,8 +1,8 @@
 test_that("can construct a base recurrence rule", {
-  expect_s3_class(daily(), "rrule")
-  expect_s3_class(weekly(), "rrule")
-  expect_s3_class(monthly(), "rrule")
-  expect_s3_class(yearly(), "rrule")
+  expect_s3_class(daily(), "almanac_rrule")
+  expect_s3_class(weekly(), "almanac_rrule")
+  expect_s3_class(monthly(), "almanac_rrule")
+  expect_s3_class(yearly(), "almanac_rrule")
 })
 
 test_that("can use a character `since` date", {

tests/testthat/test-rschedule.R

@@ -19,7 +19,7 @@ test_that("class is required", {
 
 test_that("can create rschedule subclasses", {
   x <- new_rschedule(x = 1, class = "foobar")
-  expect_identical(x, structure(list(x = 1), class = c("foobar", "rschedule")))
+  expect_identical(x, structure(list(x = 1), class = c("foobar", "almanac_rschedule")))
 })
 
 # ------------------------------------------------------------------------------