is_valid_repository()

Author: jwodder

CHANGELOG.md

@@ -16,6 +16,7 @@ v0.6.0 (in development)
 - Added `GHRepo::as_str()` method
 - **Breaking**: The `GHRepo::is_valid_owner()` and `GHRepo::is_valid_name()`
   methods are now regular functions
+- Added `is_valid_repository()` function
 
 v0.5.0 (2023-04-27)
 -------------------

src/lib.rs

@@ -678,3 +678,18 @@ pub fn is_valid_owner(s: &str) -> bool {
 pub fn is_valid_name(s: &str) -> bool {
     matches!(split_name(s), Some((_, "")))
 }
+
+/// Test whether a string is a valid repository specifier/full name of the form
+/// `{owner}/{name}`.
+///
+/// # Example
+///
+/// ```
+/// # use ghrepo::is_valid_repository;
+/// assert!(is_valid_repository("octocat/my-repo"));
+/// assert!(!is_valid_repository("octocat/my-repo.git"));
+/// assert!(!is_valid_repository("my-repo"));
+/// ```
+pub fn is_valid_repository(s: &str) -> bool {
+    matches!(split_owner_name(s), Some((_, _, "")))
+}

tests/valid.rs

@@ -1,5 +1,5 @@
 #![allow(clippy::items_after_test_module)]
-use ghrepo::{is_valid_name, is_valid_owner};
+use ghrepo::{is_valid_name, is_valid_owner, is_valid_repository};
 use rstest::rstest;
 
 #[rstest]
@@ -37,6 +37,7 @@ fn test_good_owner(#[case] owner: &str) {
 #[case("steven.universe")]
 #[case("steven-universe@beachcity.dv")]
 #[case("steven-univerß")]
+#[case("steven/universe")]
 #[case("")]
 #[case("none")]
 #[case("NONE")]
@@ -90,6 +91,22 @@ fn test_good_name(#[case] name: &str) {
 #[case("steven.git")]
 #[case("steven.GIT")]
 #[case("steven.Git")]
+#[case("steven/universe")]
 fn test_bad_name(#[case] name: &str) {
     assert!(!is_valid_name(name));
 }
+
+#[rstest]
+#[case("steven/universe")]
+fn test_good_repository(#[case] spec: &str) {
+    assert!(is_valid_repository(spec));
+}
+
+#[rstest]
+#[case("steven/universe.git")]
+#[case("steven/universe/main")]
+#[case("https://github.com/steven/universe")]
+#[case("steven")]
+fn test_bad_repository(#[case] spec: &str) {
+    assert!(!is_valid_repository(spec));
+}