Implement invalid_remove() (#241)

Author: DavisVaughan

NAMESPACE

@@ -324,6 +324,7 @@ S3method(invalid_detect,clock_year_day)
 S3method(invalid_detect,clock_year_month_day)
 S3method(invalid_detect,clock_year_month_weekday)
 S3method(invalid_detect,clock_year_quarter_day)
+S3method(invalid_remove,clock_calendar)
 S3method(invalid_resolve,clock_calendar)
 S3method(invalid_resolve,clock_iso_year_week_day)
 S3method(invalid_resolve,clock_year_day)
@@ -622,6 +623,7 @@ export(get_year)
 export(invalid_any)
 export(invalid_count)
 export(invalid_detect)
+export(invalid_remove)
 export(invalid_resolve)
 export(is_duration)
 export(is_iso_year_week_day)

NEWS.md

@@ -1,5 +1,8 @@
 # clock (development version)
 
+* New `invalid_remove()` for removing invalid dates. This is just a wrapper
+  around `x[!invalid_detect(x)]`, but works nicely with the pipe (#229).
+
 # clock 0.3.1
 
 * Parsing into a date-time type that is coarser than the original string is now

R/invalid.R

@@ -64,6 +64,8 @@
 #' - `invalid_count()`: Returns a single integer containing the number of
 #'   invalid dates.
 #'
+#' - `invalid_remove()`: Returns `x` with invalid dates removed.
+#'
 #' - `invalid_resolve()`: Returns `x` with invalid dates resolved using the
 #'   `invalid` strategy.
 #'
@@ -90,6 +92,9 @@
 #' # But `"previous-day"` here does not!
 #' x_previous_day[1] < x_previous_day[2]
 #'
+#' # Remove invalid dates entirely
+#' invalid_remove(x)
+#'
 #' y <- year_quarter_day(2019, 1, 90:92)
 #' y
 #'
@@ -139,6 +144,19 @@ invalid_count.clock_calendar <- function(x) {
 
 # ------------------------------------------------------------------------------
 
+#' @rdname clock-invalid
+#' @export
+invalid_remove <- function(x) {
+  UseMethod("invalid_remove")
+}
+
+#' @export
+invalid_remove.clock_calendar <- function(x) {
+  x[!invalid_detect(x)]
+}
+
+# ------------------------------------------------------------------------------
+
 #' @rdname clock-invalid
 #' @export
 invalid_resolve <- function(x, ..., invalid = NULL) {

man/clock-invalid.Rd

@@ -0,0 +1,4 @@
+# errors on unsupported types
+
+    no applicable method for 'invalid_remove' applied to an object of class "c('double', 'numeric')"
+

tests/testthat/_snaps/invalid.md

@@ -0,0 +1,14 @@
+# ------------------------------------------------------------------------------
+# invalid_remove()
+
+test_that("can remove invalid dates from calendar types", {
+  x <- year_month_day(2020, 2, 28:30)
+  expect_identical(invalid_remove(x), x[1:2])
+
+  x <- year_day(2019, 365:366)
+  expect_identical(invalid_remove(x), x[1L])
+})
+
+test_that("errors on unsupported types", {
+  expect_snapshot_error(invalid_remove(1))
+})