fix: error if slice_sample() receives unknown or unsupported args

NEWS.md

@@ -4,6 +4,11 @@
 
 * Added support for `stringr::str_replace_na()` (#153).
 
+## Bug fixes
+
+* `slice_sample()` now errors when unknown or unsupported arguments are 
+  passed (thanks @fkohrt for the report).
+
 # tidypolars 0.12.0
 
 `tidypolars` requires `polars` >= 0.21.0.

R/slice.R

@@ -80,7 +80,10 @@ slice_head.RPolarsLazyFrame <- slice_head.RPolarsDataFrame
 #' @rdname slice_tail.RPolarsDataFrame
 #' @export
 
-slice_sample.RPolarsDataFrame <- function(.data, ..., n = NULL, prop = NULL, replace = FALSE, by = NULL) {
+slice_sample.RPolarsDataFrame <- function(.data, ..., n = NULL, prop = NULL, by = NULL, replace = FALSE) {
+  check_unsupported_arg("weight_by", ...)
+  check_dots_empty0(...)
+
   grps <- get_grps(.data, rlang::enquo(by), env = rlang::current_env())
   mo <- attributes(.data)$maintain_grp_order
   is_grouped <- !is.null(grps)

R/utils.R

@@ -4,7 +4,7 @@ get_dots <- function(...) {
   eval(substitute(alist(...)))
 }
 
-safe_deparse <- function (x, ...) {
+safe_deparse <- function(x, ...) {
   if (is.null(x)) {
     return(NULL)
   }
@@ -110,3 +110,13 @@ select_by_name_or_position <- function(expr, name, position, default, env) {
     default
   }
 }
+
+check_unsupported_arg <- function(arg_name, ...) {
+  dots <- enquos(...)
+  if (arg_name %in% names(dots)) {
+    abort(
+      paste("Argument", arg_name, "is not supported by tidypolars yet."),
+      call = caller_env()
+    )
+  }
+}

tests/testthat/_snaps/slice.md

@@ -22,3 +22,21 @@
       Error in `slice_sample()`:
       ! Cannot take more rows than the total number of rows when `replace = FALSE`.
 
+# slice_sample errors on unknown args
+
+    Code
+      slice_sample(pl_mtcars, weight_by = cyl > 5, n = 5)
+    Condition
+      Error in `slice_sample()`:
+      ! Argument weight_by is not supported by tidypolars yet.
+
+---
+
+    Code
+      slice_sample(pl_mtcars, foo = 1, n = 5)
+    Condition
+      Error in `slice_sample()`:
+      ! `...` must be empty.
+      x Problematic argument:
+      * foo = 1
+

tests/testthat/test-slice-lazy.R

@@ -216,4 +216,19 @@ test_that("slice_sample works with grouped data", {
   )
 })
 
+test_that("slice_sample errors on unknown args", {
+  pl_mtcars <- as_polars_lf(mtcars)
+  skip_if_not(inherits(pl_mtcars, "RPolarsDataFrame"))
+  expect_snapshot_lazy(
+    pl_mtcars |>
+      slice_sample(weight_by = cyl > 5, n = 5),
+    error = TRUE
+  )
+  expect_snapshot_lazy(
+    pl_mtcars |>
+      slice_sample(foo = 1, n = 5),
+    error = TRUE
+  )
+})
+
 Sys.setenv('TIDYPOLARS_TEST' = FALSE)

tests/testthat/test-slice.R

@@ -211,3 +211,18 @@ test_that("slice_sample works with grouped data", {
     NULL
   )
 })
+
+test_that("slice_sample errors on unknown args", {
+  pl_mtcars <- as_polars_df(mtcars)
+  skip_if_not(inherits(pl_mtcars, "RPolarsDataFrame"))
+  expect_snapshot(
+    pl_mtcars |>
+      slice_sample(weight_by = cyl > 5, n = 5),
+    error = TRUE
+  )
+  expect_snapshot(
+    pl_mtcars |>
+      slice_sample(foo = 1, n = 5),
+    error = TRUE
+  )
+})