str_ilike()

DESCRIPTION

@@ -40,4 +40,4 @@ Config/testthat/edition: 3
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1

NAMESPACE

@@ -30,6 +30,7 @@ export(str_flatten)
 export(str_flatten_comma)
 export(str_glue)
 export(str_glue_data)
+export(str_ilike)
 export(str_interp)
 export(str_length)
 export(str_like)

NEWS.md

@@ -1,5 +1,10 @@
 # stringr (development version)
 
+* Introduce `str_ilike()` that follows the conventions of the SQL ILIKE 
+  operator. The  `ignore_case` argument from  `str_like()` is deprecated, with
+  `str_like()` now always case sensitive to better follow the conventions of 
+  the SQL LIKE operator (@edward-burn, #543).
+
 # stringr 1.5.1
 
 * Some minor documentation improvements.

R/detect.R

@@ -119,30 +119,69 @@ str_ends <- function(string, pattern, negate = FALSE) {
 #' * `_` matches a single character (like `.`).
 #' * `%` matches any number of characters (like `.*`).
 #' * `\%` and `\_` match literal `%` and `_`.
-#' * The match is case insensitive by default.
+#' * The match is case sensitive.
 #'
 #' @inheritParams str_detect
 #' @param pattern A character vector containing a SQL "like" pattern.
 #'   See above for details.
-#' @param ignore_case Ignore case of matches? Defaults to `TRUE` to match
-#'   the SQL `LIKE` operator.
+#' @param ignore_case `r lifecycle::badge("deprecated")`
 #' @return A logical vector the same length as `string`.
 #' @export
 #' @examples
 #' fruit <- c("apple", "banana", "pear", "pineapple")
 #' str_like(fruit, "app")
 #' str_like(fruit, "app%")
+#' str_like(fruit, "APP%")
 #' str_like(fruit, "ba_ana")
-#' str_like(fruit, "%APPLE")
-str_like <- function(string, pattern, ignore_case = TRUE) {
+#' str_like(fruit, "%apple")
+str_like <- function(string, pattern, ignore_case = deprecated()) {
+  check_lengths(string, pattern)
+  check_character(pattern)
+  if (inherits(pattern, "stringr_pattern")) {
+    cli::cli_abort("{.arg pattern} must be a plain string, not a stringr modifier.")
+  }
+  if (lifecycle::is_present(ignore_case)) {
+    lifecycle::deprecate_warn(when = "1.5.2",
+                              what = "str_like(ignore_case)",
+                              details = "str_like() is always case sensitive. Use
+                              str_ilike() for case insensitive string matching.")
+  }
+
+  pattern <- regex(like_to_regex(pattern), ignore_case = FALSE)
+  stri_detect_regex(string, pattern, opts_regex = opts(pattern))
+}
+
+#' Detect a pattern in the same way as `SQL`'s `ILIKE` operator
+#'
+#' @description
+#' `str_ilike()` follows the conventions of the SQL `ILIKE` operator:
+#'
+#' * Must match the entire string.
+#' * `_` matches a single character (like `.`).
+#' * `%` matches any number of characters (like `.*`).
+#' * `\%` and `\_` match literal `%` and `_`.
+#' * The match is case insensitive.
+#'
+#' @inheritParams str_detect
+#' @param pattern A character vector containing a SQL "like" pattern.
+#'   See above for details.
+#' @return A logical vector the same length as `string`.
+#' @export
+#' @examples
+#' fruit <- c("apple", "banana", "pear", "pineapple")
+#' str_ilike(fruit, "app")
+#' str_ilike(fruit, "app%")
+#' str_ilike(fruit, "APP%")
+#' str_ilike(fruit, "ba_ana")
+#' str_ilike(fruit, "%apple")
+str_ilike <- function(string, pattern) {
   check_lengths(string, pattern)
   check_character(pattern)
   if (inherits(pattern, "stringr_pattern")) {
     cli::cli_abort("{.arg pattern} must be a plain string, not a stringr modifier.")
   }
-  check_bool(ignore_case)
 
-  pattern <- regex(like_to_regex(pattern), ignore_case = ignore_case)
+  pattern <- regex(like_to_regex(pattern), ignore_case = TRUE)
   stri_detect_regex(string, pattern, opts_regex = opts(pattern))
 }
 

_pkgdown.yml

@@ -68,6 +68,7 @@ reference:
   - invert_match
   - str_conv
   - str_like
+  - str_ilike
   - str_replace_na
   - str_view
   - word

tests/testthat/_snaps/detect.md

@@ -47,3 +47,22 @@
       Error in `str_like()`:
       ! `pattern` must be a plain string, not a stringr modifier.
 
+# ignore_case is deprecated
+
+    Code
+      str_like("abc", "ab%", ignore_case = TRUE)
+    Condition
+      Warning:
+      The `ignore_case` argument of `str_like()` is deprecated as of stringr 1.5.2.
+      i str_like() is always case sensitive. Use str_ilike() for case insensitive string matching.
+    Output
+      [1] TRUE
+
+# str_ilike works
+
+    Code
+      str_ilike("abc", regex("x"))
+    Condition
+      Error in `str_ilike()`:
+      ! `pattern` must be a plain string, not a stringr modifier.
+

tests/testthat/test-detect.R

@@ -57,9 +57,20 @@ test_that("functions use tidyverse recycling rules", {
 
 test_that("str_like works", {
   expect_true(str_like("abc", "ab%"))
+  expect_false(str_like("abc", "AB%"))
   expect_snapshot(str_like("abc", regex("x")), error = TRUE)
 })
 
+test_that("ignore_case is deprecated", {
+expect_snapshot(str_like("abc", "ab%", ignore_case = TRUE))
+})
+
+test_that("str_ilike works", {
+  expect_true(str_ilike("abc", "ab%"))
+  expect_true(str_ilike("abc", "AB%"))
+  expect_snapshot(str_ilike("abc", regex("x")), error = TRUE)
+})
+
 test_that("like_to_regex generates expected regexps",{
   expect_equal(like_to_regex("ab%"), "^ab.*$")
   expect_equal(like_to_regex("ab_"), "^ab.$")