Make arrow optional (#166)

* Make arrow optional * fixed spelling --------- Co-authored-by: andrewjbe <56839927+andrewjbe@users.noreply.github.com>
openjusticeok · May 23, 2024 · 08b9163 · 08b9163
1 parent e1b577f
commit 08b9163
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 6 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: ojodb
 Title: Analyze Data from the Open Justice Oklahoma Database
-Version: 2.8.0
+Version: 2.8.1
 Authors@R: c(
   person(
     given = "Brancen",
@@ -26,7 +26,6 @@ Authors@R: c(
   ))
 Description: {ojodb} provides convenient functions to query court data from the Open Justice Oklahoma database.
 Imports:
-  arrow,
   cli,
   dbplyr,
   DBI,
@@ -45,6 +44,7 @@ Imports:
   utils,
   withr
 Suggests:
+  arrow,
   attachment,
   badger,
   covr,

diff --git a/NEWS.md b/NEWS.md
@@ -1,9 +1,14 @@
+# ojodb 2.8.1 (2024-05-23)
+
+## Dependency Fix
+- Makes `{arrow}` and optional dependency and checks whether it is available when `source = "gcs"` is used in `ojo_tbl`.
+
 # ojodb 2.8.0 (2024-05-20)
 
 ## New Features
 - Adds initial support for Arrow.
 
-## Package Maintanance
+## Package Maintenance
 - Uses `{lifecycle}` for function development status.
 
 # ojodb 2.7.0 (2023-09-01)

diff --git a/R/ojo_tbl.R b/R/ojo_tbl.R
@@ -37,6 +37,17 @@ ojo_tbl <- function(
     }
     data <- tbl_from_database(.con, schema, table)
   } else if (.source == "gcs") {
+
+    # Abort if {arrow} isn't available
+    if (!rlang::is_installed("arrow")) {
+      rlang::abort(".source == \"gcs\" requires {arrow} with GCS support.")
+    }
+
+    gcs_available <- arrow::arrow_with_gcs()
+    if (!gcs_available) {
+      rlang::abort(stringr::str_glue("Arrow wasn't compiled with GCS support."))
+    }
+
     # Temp fix for schema
     if (schema == "public") {
       schema <- "oscn"

diff --git a/README.md b/README.md
@@ -8,16 +8,16 @@
 
 # ojodb <img src="man/figures/logo.png" align="right" height="139" />
 
-`{ojodb}` is a package that helps
+`{ojodb}` is a package that assists
 <a href="https://openjustice.okpolicy.org/" target="_blank">Open Justice
-Oklahoma</a> analysts access and analyze court, jail, prison, and
+Oklahoma</a> analysts to access and analyze court, jail, prison, and
 other data collected from various sources.
 
 The pkgdown website for the ojodb package can be found
 <a href="https://openjusticeok.github.io/ojodb/"
 target="_blank">here</a>.
 
-## Installation 
+## Installation
 
 Install the devtools package if you don’t have it yet, then install the
 ojodb package from GitHub with:

diff --git a/inst/WORDLIST b/inst/WORDLIST
@@ -37,3 +37,7 @@ tibble
 tidyverse
 timespan
 webscraping
+gcs
+GCS
+PRs
+tbl