fix: deprecate Remote::push_url*() in favor of Remote::with_push*().

Author: Byron

gix/src/remote/build.rs

@@ -2,7 +2,9 @@ use crate::{bstr::BStr, remote, Remote};
 
 /// Builder methods
 impl Remote<'_> {
-    /// Set the `url` to be used when fetching data from a remote.
+    /// Override the `url` to be used when fetching data from a remote.
+    ///
+    /// Note that this URL is typically set during instantiation with [`crate::Repository::remote_at()`].
     pub fn with_url<Url, E>(self, url: Url) -> Result<Self, remote::init::Error>
     where
         Url: TryInto<gix_url::Url, Error = E>,
@@ -16,6 +18,8 @@ impl Remote<'_> {
 
     /// Set the `url` to be used when fetching data from a remote, without applying rewrite rules in case these could be faulty,
     /// eliminating one failure mode.
+    ///
+    /// Note that this URL is typically set during instantiation with [`crate::Repository::remote_at_without_url_rewrite()`].
     pub fn with_url_without_url_rewrite<Url, E>(self, url: Url) -> Result<Self, remote::init::Error>
     where
         Url: TryInto<gix_url::Url, Error = E>,
@@ -28,7 +32,17 @@ impl Remote<'_> {
     }
 
     /// Set the `url` to be used when pushing data to a remote.
+    #[deprecated = "Use `with_push_url()` instead"]
     pub fn push_url<Url, E>(self, url: Url) -> Result<Self, remote::init::Error>
+    where
+        Url: TryInto<gix_url::Url, Error = E>,
+        gix_url::parse::Error: From<E>,
+    {
+        self.with_push_url(url)
+    }
+
+    /// Set the `url` to be used when pushing data to a remote.
+    pub fn with_push_url<Url, E>(self, url: Url) -> Result<Self, remote::init::Error>
     where
         Url: TryInto<gix_url::Url, Error = E>,
         gix_url::parse::Error: From<E>,
@@ -41,7 +55,18 @@ impl Remote<'_> {
 
     /// Set the `url` to be used when pushing data to a remote, without applying rewrite rules in case these could be faulty,
     /// eliminating one failure mode.
+    #[deprecated = "Use `with_push_url_without_rewrite()` instead"]
     pub fn push_url_without_url_rewrite<Url, E>(self, url: Url) -> Result<Self, remote::init::Error>
+    where
+        Url: TryInto<gix_url::Url, Error = E>,
+        gix_url::parse::Error: From<E>,
+    {
+        self.with_push_url_without_url_rewrite(url)
+    }
+
+    /// Set the `url` to be used when pushing data to a remote, without applying rewrite rules in case these could be faulty,
+    /// eliminating one failure mode.
+    pub fn with_push_url_without_url_rewrite<Url, E>(self, url: Url) -> Result<Self, remote::init::Error>
     where
         Url: TryInto<gix_url::Url, Error = E>,
         gix_url::parse::Error: From<E>,

gix/tests/gix/remote/save.rs

@@ -63,7 +63,7 @@ mod save_as_to {
         let repo = basic_repo()?;
         let mut remote = repo
             .remote_at("https://example.com/path")?
-            .push_url("https://ein.hub/path")?
+            .with_push_url("https://ein.hub/path")?
             .with_fetch_tags(gix::remote::fetch::Tags::All)
             .with_refspecs(
                 [

gix/tests/gix/repository/remote.rs

@@ -13,7 +13,7 @@ mod remote_at {
         assert_eq!(remote.url(Direction::Fetch).unwrap().to_bstring(), fetch_url);
         assert_eq!(remote.url(Direction::Push).unwrap().to_bstring(), fetch_url);
 
-        let mut remote = remote.push_url("[email protected]:./relative")?;
+        let mut remote = remote.with_push_url("[email protected]:./relative")?;
         assert_eq!(
             remote.url(Direction::Push).unwrap().to_bstring(),
             "[email protected]:./relative"
@@ -75,7 +75,7 @@ mod remote_at {
 
         let remote = repo
             .remote_at("https://github.com/foobar/gitoxide".to_owned())?
-            .push_url("file://dev/null".to_owned())?;
+            .with_push_url("file://dev/null".to_owned())?;
         assert_eq!(remote.url(Direction::Fetch).unwrap().to_bstring(), rewritten_fetch_url);
         assert_eq!(
             remote.url(Direction::Push).unwrap().to_bstring(),
@@ -117,7 +117,7 @@ mod remote_at {
 
         let remote = repo
             .remote_at_without_url_rewrite("https://github.com/foobar/gitoxide".to_owned())?
-            .push_url_without_url_rewrite("file://dev/null".to_owned())?;
+            .with_push_url_without_url_rewrite("file://dev/null".to_owned())?;
         assert_eq!(remote.url(Direction::Fetch).unwrap().to_bstring(), fetch_url);
         assert_eq!(
             remote.url(Direction::Push).unwrap().to_bstring(),
@@ -127,7 +127,7 @@ mod remote_at {
 
         let remote = remote
             .with_url_without_url_rewrite("https://github.com/foobaz/gitoxide".to_owned())?
-            .push_url_without_url_rewrite("file://dev/null".to_owned())?;
+            .with_push_url_without_url_rewrite("file://dev/null".to_owned())?;
         assert_eq!(
             remote.url(Direction::Fetch).unwrap().to_bstring(),
             "https://github.com/foobaz/gitoxide"