chore(pkg-r): Use cli inline markup (#156)

* chore: use cli inline-markup

* chore: test in parallel

Author: gadenbuie

pkg-r/DESCRIPTION

@@ -41,6 +41,7 @@ Suggests:
 Remotes:
     posit-dev/shinychat/pkg-r
 Config/testthat/edition: 3
+Config/testthat/parallel: true
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.3

pkg-r/R/DataSource.R

@@ -19,7 +19,7 @@ DataSource <- R6::R6Class(
     #' @return A string describing the database type (e.g., "DuckDB", "SQLite")
     get_db_type = function() {
       cli::cli_abort(
-        "get_db_type() must be implemented by subclass",
+        "{.fn get_db_type} must be implemented by subclass",
         class = "not_implemented_error"
       )
     },
@@ -32,7 +32,7 @@ DataSource <- R6::R6Class(
     #' @return A string containing schema information formatted for LLM prompts
     get_schema = function(categorical_threshold = 20) {
       cli::cli_abort(
-        "get_schema() must be implemented by subclass",
+        "{.fn get_schema} must be implemented by subclass",
         class = "not_implemented_error"
       )
     },
@@ -44,7 +44,7 @@ DataSource <- R6::R6Class(
     #' @return A data frame containing query results
     execute_query = function(query) {
       cli::cli_abort(
-        "execute_query() must be implemented by subclass",
+        "{.fn execute_query} must be implemented by subclass",
         class = "not_implemented_error"
       )
     },
@@ -56,7 +56,7 @@ DataSource <- R6::R6Class(
     #' @return A data frame containing one row of results (or empty if no matches)
     test_query = function(query) {
       cli::cli_abort(
-        "test_query() must be implemented by subclass",
+        "{.fn test_query} must be implemented by subclass",
         class = "not_implemented_error"
       )
     },
@@ -67,7 +67,7 @@ DataSource <- R6::R6Class(
     #' @return A data frame containing all data from the table
     get_data = function() {
       cli::cli_abort(
-        "get_data() must be implemented by subclass",
+        "{.fn get_data} must be implemented by subclass",
         class = "not_implemented_error"
       )
     },
@@ -78,7 +78,7 @@ DataSource <- R6::R6Class(
     #' @return NULL (invisibly)
     cleanup = function() {
       cli::cli_abort(
-        "cleanup() must be implemented by subclass",
+        "{.fn cleanup} must be implemented by subclass",
         class = "not_implemented_error"
       )
     }
@@ -269,7 +269,9 @@ DBISource <- R6::R6Class(
     #' }
     initialize = function(conn, table_name) {
       if (!inherits(conn, "DBIConnection")) {
-        cli::cli_abort("`conn` must be a DBI connection")
+        cli::cli_abort(
+          "{.arg conn} must be a {.cls DBIConnection}, not {.obj_type_friendly {conn}}"
+        )
       }
 
       # Validate table_name type
@@ -279,15 +281,15 @@ DBISource <- R6::R6Class(
         # Character string - keep as is
       } else {
         cli::cli_abort(
-          "`table_name` must be a single character string or a DBI::Id object"
+          "{.arg table_name} must be a single character string or a {.fn DBI::Id} object"
         )
       }
 
       # Check if table exists
       if (!DBI::dbExistsTable(conn, table_name)) {
         cli::cli_abort(c(
-          "Table {DBI::dbQuoteIdentifier(x, table_name)} not found in database.",
-          "i" = "If you're using a table in a catalog or schema, pass a DBI::Id object to `table_name`"
+          "Table {.val {DBI::dbQuoteIdentifier(conn, table_name)}} not found in database",
+          "i" = "If you're using a table in a catalog or schema, pass a {.fn DBI::Id} object to {.arg table_name}"
         ))
       }
 
@@ -587,7 +589,9 @@ assemble_system_prompt <- function(
   prompt_template = NULL
 ) {
   if (!is_data_source(source)) {
-    cli::cli_abort("`source` must be a DataSource object")
+    cli::cli_abort(
+      "{.arg source} must be a {.cls DataSource} object, not {.obj_type_friendly {source}}"
+    )
   }
 
   prompt_text <- read_text(

pkg-r/R/QueryChat.R

@@ -470,7 +470,7 @@ QueryChat <- R6::R6Class(
     ) {
       if (is.null(session)) {
         cli::cli_abort(
-          "$server() must be called within a Shiny server function."
+          "{.fn $server} must be called within a Shiny server function"
         )
       }
 
@@ -706,10 +706,6 @@ normalize_data_source <- function(data_source, table_name) {
   }
 
   cli::cli_abort(
-    paste0(
-      "`data_source` must be a DataSource, data.frame, or DBIConnection. ",
-      "Got: ",
-      class(data_source)[1]
-    )
+    "{.arg data_source} must be a {.cls DataSource}, {.cls data.frame}, or {.cls DBIConnection}, not {.obj_type_friendly {data_source}}."
   )
 }

pkg-r/R/querychat_module.R

@@ -72,8 +72,9 @@ mod_server <- function(
         greeting
       } else {
         cli::cli_warn(c(
-          "No greeting provided to `QueryChat()`. Using the LLM `client` to generate one now.",
-          "i" = "For faster startup, lower cost, and determinism, consider providing a greeting to `QueryChat()` and `$generate_greeting()` to generate one beforehand."
+          "No {.arg greeting} provided to {.fn QueryChat}. Using the LLM {.arg client} to generate one now.",
+          "i" = "For faster startup, lower cost, and determinism, consider providing a {.arg greeting} to {.fn QueryChat}.",
+          "i" = "You can use your {.help querychat::QueryChat} object's {.fn $generate_greeting} method to generate a greeting."
         ))
         chat$stream_async(GREETING_PROMPT)
       }

pkg-r/R/querychat_tools.R

@@ -126,7 +126,7 @@ querychat_tool_details_option <- function() {
 
   if (!setting %in% valid_settings) {
     cli::cli_warn(c(
-      "Invalid value for {.code querychat.tool_details} or {.envvar QUERYCHAT_TOOL_DETAILS}: {.val {setting}}",
+      "Invalid value for {.code querychat.tool_details} option or {.envvar QUERYCHAT_TOOL_DETAILS} environment variable: {.val {setting}}",
       "i" = "Must be one of: {.or {.val {valid_settings}}}"
     ))
     return(NULL)

pkg-r/R/utils-check.R

@@ -34,9 +34,11 @@ check_sql_table_name <- function(
   # Then validate SQL table name pattern
   if (!grepl("^[a-zA-Z][a-zA-Z0-9_]*$", x)) {
     cli::cli_abort(
-      "{.arg {arg}} must be a valid SQL table name.",
-      "i" = "Table names must begin with a letter and contain only letters, numbers, and underscores.",
-      "x" = "You provided: {.val {x}}",
+      c(
+        "{.arg {arg}} must be a valid SQL table name",
+        "i" = "Table names must begin with a letter and contain only letters, numbers, and underscores",
+        "x" = "You provided: {.val {x}}"
+      ),
       call = call
     )
   }

pkg-r/R/utils-ellmer.R

@@ -37,7 +37,7 @@ as_querychat_client <- function(client = NULL) {
 
   if (!inherits(client, "Chat")) {
     cli::cli_abort(
-      "`client` must be an {ellmer} Chat object or a function that returns one."
+      "{.arg client} must be an {.pkg ellmer} {.cls Chat} object or a function that returns one"
     )
   }
 

pkg-r/tests/testthat/_snaps/DataSource.md

@@ -4,47 +4,47 @@
       base_source$get_db_type()
     Condition
       Error in `base_source$get_db_type()`:
-      ! get_db_type() must be implemented by subclass
+      ! `get_db_type()` must be implemented by subclass
 
 ---
 
     Code
       base_source$get_schema()
     Condition
       Error in `base_source$get_schema()`:
-      ! get_schema() must be implemented by subclass
+      ! `get_schema()` must be implemented by subclass
 
 ---
 
     Code
       base_source$execute_query("SELECT * FROM test")
     Condition
       Error in `base_source$execute_query()`:
-      ! execute_query() must be implemented by subclass
+      ! `execute_query()` must be implemented by subclass
 
 ---
 
     Code
       base_source$test_query("SELECT * FROM test LIMIT 1")
     Condition
       Error in `base_source$test_query()`:
-      ! test_query() must be implemented by subclass
+      ! `test_query()` must be implemented by subclass
 
 ---
 
     Code
       base_source$get_data()
     Condition
       Error in `base_source$get_data()`:
-      ! get_data() must be implemented by subclass
+      ! `get_data()` must be implemented by subclass
 
 ---
 
     Code
       base_source$cleanup()
     Condition
       Error in `base_source$cleanup()`:
-      ! cleanup() must be implemented by subclass
+      ! `cleanup()` must be implemented by subclass
 
 # DataFrameSource$new() / errors with non-data.frame input
 
@@ -76,22 +76,30 @@
       DataFrameSource$new(test_df, "123_invalid")
     Condition
       Error in `initialize()`:
-      ! `table_name` must be a valid SQL table name.
+      ! `table_name` must be a valid SQL table name
+      i Table names must begin with a letter and contain only letters, numbers, and underscores
+      x You provided: "123_invalid"
     Code
       DataFrameSource$new(test_df, "table-name")
     Condition
       Error in `initialize()`:
-      ! `table_name` must be a valid SQL table name.
+      ! `table_name` must be a valid SQL table name
+      i Table names must begin with a letter and contain only letters, numbers, and underscores
+      x You provided: "table-name"
     Code
       DataFrameSource$new(test_df, "table name")
     Condition
       Error in `initialize()`:
-      ! `table_name` must be a valid SQL table name.
+      ! `table_name` must be a valid SQL table name
+      i Table names must begin with a letter and contain only letters, numbers, and underscores
+      x You provided: "table name"
     Code
       DataFrameSource$new(test_df, "")
     Condition
       Error in `initialize()`:
-      ! `table_name` must be a valid SQL table name.
+      ! `table_name` must be a valid SQL table name
+      i Table names must begin with a letter and contain only letters, numbers, and underscores
+      x You provided: ""
     Code
       DataFrameSource$new(test_df, NULL)
     Condition
@@ -104,71 +112,70 @@
       DBISource$new(list(fake = "connection"), "test_table")
     Condition
       Error in `initialize()`:
-      ! `conn` must be a DBI connection
+      ! `conn` must be a <DBIConnection>, not a list
 
 ---
 
     Code
       DBISource$new(NULL, "test_table")
     Condition
       Error in `initialize()`:
-      ! `conn` must be a DBI connection
+      ! `conn` must be a <DBIConnection>, not NULL
 
 ---
 
     Code
       DBISource$new("not a connection", "test_table")
     Condition
       Error in `initialize()`:
-      ! `conn` must be a DBI connection
+      ! `conn` must be a <DBIConnection>, not a string
 
 # DBISource$new() / errors with invalid table_name types
 
     Code
       DBISource$new(db$conn, 123)
     Condition
       Error in `initialize()`:
-      ! `table_name` must be a single character string or a DBI::Id object
+      ! `table_name` must be a single character string or a `DBI::Id()` object
 
 ---
 
     Code
       DBISource$new(db$conn, c("table1", "table2"))
     Condition
       Error in `initialize()`:
-      ! `table_name` must be a single character string or a DBI::Id object
+      ! `table_name` must be a single character string or a `DBI::Id()` object
 
 ---
 
     Code
       DBISource$new(db$conn, list(name = "table"))
     Condition
       Error in `initialize()`:
-      ! `table_name` must be a single character string or a DBI::Id object
+      ! `table_name` must be a single character string or a `DBI::Id()` object
 
 # DBISource$new() / errors when table does not exist
 
     Code
       DBISource$new(db$conn, "non_existent_table")
     Condition
-      Error:
-      ! ! Could not evaluate cli `{}` expression: `DBI::dbQuoteIdent...`.
-      Caused by error in `h(simpleError(msg, call))`:
-      ! error in evaluating the argument 'conn' in selecting a method for function 'dbQuoteIdentifier': object 'x' not found
+      Error in `initialize()`:
+      ! Table "`non_existent_table`" not found in database
+      i If you're using a table in a catalog or schema, pass a `DBI::Id()` object to `table_name`
 
 # assemble_system_prompt() / errors with non-DataSource input
 
     Code
       assemble_system_prompt(list(not = "a data source"), data_description = "Test")
     Condition
       Error in `assemble_system_prompt()`:
-      ! `source` must be a DataSource object
+      ! `source` must be a <DataSource> object, not a list
 
 ---
 
     Code
       assemble_system_prompt(data.frame(x = 1:3), data_description = "Test")
     Condition
       Error in `assemble_system_prompt()`:
-      ! `source` must be a DataSource object
+      ! `source` must be a <DataSource> object, not a data frame
 

pkg-r/tests/testthat/_snaps/QueryChat.md

@@ -36,29 +36,29 @@
       qc$server()
     Condition
       Error in `qc$server()`:
-      ! $server() must be called within a Shiny server function.
+      ! `$server()` must be called within a Shiny server function
 
 # normalize_data_source() / errors with invalid data source types
 
     Code
       normalize_data_source("not_a_data_source", "table_name")
     Condition
       Error in `normalize_data_source()`:
-      ! `data_source` must be a DataSource, data.frame, or DBIConnection. Got: character
+      ! `data_source` must be a <DataSource>, <data.frame>, or <DBIConnection>, not a string.
 
 ---
 
     Code
       normalize_data_source(list(a = 1, b = 2), "table_name")
     Condition
       Error in `normalize_data_source()`:
-      ! `data_source` must be a DataSource, data.frame, or DBIConnection. Got: list
+      ! `data_source` must be a <DataSource>, <data.frame>, or <DBIConnection>, not a list.
 
 ---
 
     Code
       normalize_data_source(NULL, "table_name")
     Condition
       Error in `normalize_data_source()`:
-      ! `data_source` must be a DataSource, data.frame, or DBIConnection. Got: NULL
+      ! `data_source` must be a <DataSource>, <data.frame>, or <DBIConnection>, not NULL.