git-ref-format: rename namespace functions

The namespace functions can read confusingly:
* `namespaced` - the naming sounds like it is namespacing the input,
when in fact it is ensuring that the input is namespaced.
* `add_namespace` - can be read as adding the namespace to the end of
a ref, when in fact it is placed at the beginning.

Change the naming, respectively, to:
* `to_namespaced` - this uses the conversion naming convention
detailed here[0].
* `with_namespace` - reads as plainly namespacing the ref string.

[0]: https://rust-lang.github.io/api-guidelines/naming.html#ad-hoc-conversions-follow-as_-to_-into_-conventions-c-conv

Signed-off-by: Fintan Halpenny <fintan.halpenny@gmail.com>
This commit is contained in:
Fintan Halpenny
2022-10-13 09:21:53 +01:00
parent 8d65feb80d
commit daffac4101
5 changed files with 14 additions and 14 deletions
+8 -8
View File
@@ -158,7 +158,7 @@ fn namespaced() {
assert_eq!(
"refs/namespaces/foo/refs/heads/main",
refname!("refs/namespaces/foo/refs/heads/main")
.namespaced()
.to_namespaced()
.unwrap()
.as_str()
)
@@ -166,13 +166,13 @@ fn namespaced() {
#[test]
fn not_namespaced() {
assert!(name::REFS_HEADS_MAIN.namespaced().is_none())
assert!(name::REFS_HEADS_MAIN.to_namespaced().is_none())
}
#[test]
fn not_namespaced_because_not_qualified() {
assert!(refname!("refs/namespaces/foo/banana")
.namespaced()
.to_namespaced()
.is_none())
}
@@ -181,7 +181,7 @@ fn strip_namespace() {
assert_eq!(
"refs/rad/id",
refname!("refs/namespaces/xyz/refs/rad/id")
.namespaced()
.to_namespaced()
.unwrap()
.strip_namespace()
.as_str()
@@ -191,9 +191,9 @@ fn strip_namespace() {
#[test]
fn strip_nested_namespaces() {
let full = refname!("refs/namespaces/a/refs/namespaces/b/refs/heads/main");
let namespaced = full.namespaced().unwrap();
let namespaced = full.to_namespaced().unwrap();
let strip_first = namespaced.strip_namespace();
let nested = strip_first.namespaced().unwrap();
let nested = strip_first.to_namespaced().unwrap();
let strip_second = nested.strip_namespace();
assert_eq!("a", namespaced.namespace().as_str());
@@ -203,13 +203,13 @@ fn strip_nested_namespaces() {
}
#[test]
fn add_namespace() {
fn with_namespace() {
assert_eq!(
"refs/namespaces/foo/refs/heads/main",
name::REFS_HEADS_MAIN
.qualified()
.unwrap()
.add_namespace(refname!("foo").head())
.with_namespace(refname!("foo").head())
.as_str()
)
}