Export is_github_url

NAMESPACE

@@ -28,6 +28,7 @@ export(get_version_config)
 export(get_version_file)
 export(get_version_hub)
 export(is_github_repo_url)
+export(is_github_url)
 export(is_s3_base_fs)
 export(is_url)
 export(is_v3_config)

NEWS.md

@@ -5,6 +5,7 @@
 * Added utilities for working with URLs:
   - `is_url()`: checks whether a character string is a URL.
   - `is_valid_url()`: checks whether a URL is valid and reachable.
+  - `is_github_url()`: checks whether a URL is a `github.com` URL.
   - `is_github_repo_url()`: checks whether a URL is a GitHub repository URL.
   - `create_s3_url()`: creates an S3 URL from a bucket name and object path.
   - `is_s3_base_fs()`: checks whether an object of class `<SubTreeFileSystem>` is a base file system (i.e. the root of a cloud hub).

R/utils-url.R

@@ -138,7 +138,25 @@ convert_to_raw_github_url <- function(repo_url) {
     sanitize_url()
 }
 
-# Detect a github URL
+
+#' Detect a URL on github.com
+#'
+#' @param url character string of the URL to check.
+#'
+#' @returns Logical. `TRUE` if the URL on `github.com`, `FALSE` otherwise.
+#' @export
+#'
+#' @examples
+#' # Returns TRUE
+#' is_github_url("https://github.com/hubverse-org/example-simple-forecast-hub")
+#' is_github_url("https://github.com/hubverse-org/schemas/tree/main/v5.0.0")
+#' # Returns FALSE
+#' is_github_url("https://gitlab.com/hubverse-org/schemas/tree/main/v5.0.0")
+#' raw_url <- paste0(
+#'   "https://raw.githubusercontent.com/hubverse-org/",
+#'   "example-simple-forecast-hub/refs/heads/main/hub-config/tasks.json"
+#' )
+#' is_github_url(raw_url)
 is_github_url <- function(url) {
   grepl("^https?://(www\\.)?github\\.com/[^/]+/[^/]+", url)
 }

tests/testthat/test-utils-url.R

@@ -70,9 +70,16 @@ test_that("create_s3_url works", {
 
 test_that("GitHub utils work", {
   hub_url <- "https://github.com/hubverse-org/example-simple-forecast-hub"
-
   expect_true(is_github_url(hub_url))
+  file_url <- "https://github.com/hubverse-org/schemas/tree/main/v5.0.0"
+  expect_true(is_github_url(hub_url))
+
   expect_false(is_github_url("https://hubverse.io"))
+  raw_url <- paste0(
+    "https://raw.githubusercontent.com/hubverse-org/",
+    "example-simple-forecast-hub/refs/heads/main/hub-config/tasks.json"
+  )
+  expect_false(is_github_url(raw_url))
 
   expect_equal(
     convert_to_raw_github_url(hub_url),