feat: add functions to convert content lists to data frames (#470)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: toph-allen

NAMESPACE

@@ -5,9 +5,11 @@ S3method("[",connect_tag_tree)
 S3method("[[",connect_tag_tree)
 S3method(api_build,op_base_connect)
 S3method(api_build,op_head)
+S3method(as.data.frame,connect_content_list)
 S3method(as.data.frame,connect_integration_list)
 S3method(as.data.frame,connect_list_hits)
 S3method(as.data.frame,tbl_connect)
+S3method(as_tibble,connect_content_list)
 S3method(as_tibble,connect_integration_list)
 S3method(as_tibble,connect_list_hits)
 S3method(connect_vars,op_base)

R/content.R

@@ -1522,7 +1522,7 @@ get_content_packages <- function(content) {
 #'   usually not what you want.
 #'
 #' @return
-#' A list of [Content] objects.
+#' A list of [Content] objects, of class "connect_content_list"
 #'
 #' @details
 #' Please see https://docs.posit.co/connect/api/#get-/v1/search/content for more
@@ -1566,9 +1566,12 @@ search_content <- function(
     limit = limit
   )
 
-  purrr::map(res, function(x) {
+  content_list <- purrr::map(res, function(x) {
     Content$new(client, x)
   })
+
+  class(content_list) <- c("connect_content_list", class(content_list))
+  content_list
 }
 
 .search_content <- function(
@@ -1591,3 +1594,45 @@ search_content <- function(
 
   client$GET(path, query = query)
 }
+
+#' Convert content list to a data frame
+#'
+#' @description
+#' Converts a list returned by [search_content()] into a data frame.
+#'
+#' @param x A `connect_content_list` object (from [search_content()]).
+#' @param row.names Passed to [base::as.data.frame()].
+#' @param optional Passed to [base::as.data.frame()].
+#' @param ... Passed to [base::as.data.frame()].
+#'
+#' @return A `data.frame` with one row per content item.
+#' @export
+as.data.frame.connect_content_list <- function(
+  x,
+  row.names = NULL, # nolint
+  optional = FALSE,
+  ...
+) {
+  content_tbl <- as_tibble(x)
+  as.data.frame(
+    content_tbl,
+    row.names = row.names,
+    optional = optional,
+    ...
+  )
+}
+
+#' Convert integration list to a tibble
+#'
+#' @description
+#' Converts a list returned by [search_content()] to a tibble.
+#'
+#' @param x A `connect_content_list` object.
+#' @param ... Unused.
+#'
+#' @return A tibble with one row per content item.
+#' @export
+as_tibble.connect_content_list <- function(x, ...) {
+  content_data <- purrr::map(x, "content")
+  parse_connectapi_typed(content_data, connectapi_ptypes$content)
+}

man/as.data.frame.connect_content_list.Rd

@@ -536,6 +536,58 @@ with_mock_dir("2025.09.0", {
       )
     )
   })
+
+  test_that("search_content() can be converted to a data frame correctly", {
+    content_df <- search_content(client, q = "sea bream") |>
+      as_tibble()
+    expect_named(
+      content_df,
+      c(
+        "guid",
+        "name",
+        "title",
+        "description",
+        "access_type",
+        "connection_timeout",
+        "read_timeout",
+        "init_timeout",
+        "idle_timeout",
+        "max_processes",
+        "min_processes",
+        "max_conns_per_process",
+        "load_factor",
+        "created_time",
+        "last_deployed_time",
+        "bundle_id",
+        "app_mode",
+        "content_category",
+        "parameterized",
+        "cluster_name",
+        "image_name",
+        "r_version",
+        "py_version",
+        "quarto_version",
+        "run_as",
+        "run_as_current_user",
+        "owner_guid",
+        "content_url",
+        "dashboard_url",
+        "app_role",
+        "vanity_url",
+        "id",
+        "owner",
+        "tags"
+      )
+    )
+    expect_equal(
+      content_df$title,
+      c("sea bream report", "sea bream dashboard")
+    )
+    expect_equal(
+      content_df$guid,
+      c("c9f68287", "53032a0e")
+    )
+  })
 })
 
 test_that("content search errors on Connect < 2024.04.0", {