Introduce Remote.IsValidName(string)

someoneigna · someoneigna · commit d4a7489045a9 · 2014-04-24T22:46:28.000-03:00
Deprecate RemoteCollection.IsValidName(string). Update test CanTellIfARemoteNameIsValid(string, bool). Fixes libgit2#679
diff --git a/LibGit2Sharp.Tests/RemoteFixture.cs b/LibGit2Sharp.Tests/RemoteFixture.cs
@@ -153,7 +153,7 @@ public void CanTellIfARemoteNameIsValid(string refname, bool expectedResult)
         {
             using (var repo = new Repository(BareTestRepoPath))
             {
-                Assert.Equal(expectedResult, repo.Network.Remotes.IsValidName(refname));
+                Assert.Equal(expectedResult, Remote.IsValidName(refname));
             }
         }
 
diff --git a/LibGit2Sharp/Remote.cs b/LibGit2Sharp/Remote.cs
@@ -95,6 +95,16 @@ internal string FetchSpecTransformToSource(string reference)
             }
         }
 
+        /// <summary>
+        /// Determines if the proposed remote name is well-formed.
+        /// </summary>
+        /// <param name="name">The name to be checked.</param>
+        /// <returns>true is the name is valid; false otherwise.</returns>
+        public static bool IsValidName(string name)
+        {
+            return Proxy.git_remote_is_valid_name(name);
+        }
+
         /// <summary>
         /// Determines whether the specified <see cref="Object"/> is equal to the current <see cref="Remote"/>.
         /// </summary>
diff --git a/LibGit2Sharp/RemoteCollection.cs b/LibGit2Sharp/RemoteCollection.cs
@@ -131,9 +131,10 @@ public virtual Remote Add(string name, string url, string fetchRefSpec)
         /// </summary>
         /// <param name="name">The name to be checked.</param>
         /// <returns>true is the name is valid; false otherwise.</returns>
+        [Obsolete("This method will be removed in the next release. Please use Remote.IsValidName(string) instead.")]
         public virtual bool IsValidName(string name)
         {
-            return Proxy.git_remote_is_valid_name(name);
+            return Remote.IsValidName(name);
         }
 
         private string DebuggerDisplay

Original file line number	Diff line number	Diff line change
`@@ -153,7 +153,7 @@ public void CanTellIfARemoteNameIsValid(string refname, bool expectedResult)`
`153`	`153`	`{`
`154`	`154`	`using (var repo = new Repository(BareTestRepoPath))`
`155`	`155`	`{`
`156`		`- Assert.Equal(expectedResult, repo.Network.Remotes.IsValidName(refname));`
	`156`	`+ Assert.Equal(expectedResult, Remote.IsValidName(refname));`
`157`	`157`	`}`
`158`	`158`	`}`
`159`	`159`
Original file line number	Diff line number	Diff line change
`@@ -131,9 +131,10 @@ public virtual Remote Add(string name, string url, string fetchRefSpec)`
`131`	`131`	`/// </summary>`
`132`	`132`	`/// <param name="name">The name to be checked.</param>`
`133`	`133`	`/// <returns>true is the name is valid; false otherwise.</returns>`
	`134`	`+ [Obsolete("This method will be removed in the next release. Please use Remote.IsValidName(string) instead.")]`
`134`	`135`	`public virtual bool IsValidName(string name)`
`135`	`136`	`{`
`136`		`- return Proxy.git_remote_is_valid_name(name);`
	`137`	`+ return Remote.IsValidName(name);`
`137`	`138`	`}`
`138`	`139`
`139`	`140`	`private string DebuggerDisplay`