Publicize Configuration.BuildSignature()

Author: dahlbyk

LibGit2Sharp/Configuration.cs

@@ -308,7 +308,29 @@ private static ConfigurationEntry<string> BuildConfigEntry(IntPtr entryPtr)
                                                   (ConfigurationLevel)entry.level);
         }
 
-        internal Signature BuildSignatureFromGlobalConfiguration(DateTimeOffset now, bool shouldThrowIfNotFound)
+        /// <summary>
+        /// Builds a <see cref="Signature"/> based on current configuration.
+        /// <para>
+        ///    Name is populated from the user.name setting, and is "unknown" if unspecified.
+        ///    Email is populated from the user.email setting, and is built from
+        ///    <see cref="Environment.UserName"/> and <see cref="Environment.UserDomainName"/> if unspecified.
+        /// </para>
+        /// <para>
+        ///    The same escalation logic than in git.git will be used when looking for the key in the config files:
+        ///       - local: the Git file in the current repository
+        ///       - global: the Git file specific to the current interactive user (usually in `$HOME/.gitconfig`)
+        ///       - xdg: another Git file specific to the current interactive user (usually in `$HOME/.config/git/config`)
+        ///       - system: the system-wide Git file
+        /// </para>
+        /// </summary>
+        /// <param name="now">The timestamp to use for the <see cref="Signature"/>.</param>
+        /// <returns>The signature.</returns>
+        public virtual Signature BuildSignature(DateTimeOffset now)
+        {
+            return BuildSignature(now, false);
+        }
+
+        internal Signature BuildSignature(DateTimeOffset now, bool shouldThrowIfNotFound)
         {
             var name = Get<string>("user.name");
             var email = Get<string>("user.email");

LibGit2Sharp/NoteCollectionExtensions.cs

@@ -18,7 +18,7 @@ public static class NoteCollectionExtensions
         /// <returns>The note which was just saved.</returns>
         public static Note Add(this NoteCollection collection, ObjectId targetId, string message, string @namespace)
         {
-            Signature author = collection.repo.Config.BuildSignatureFromGlobalConfiguration(DateTimeOffset.Now, true);
+            Signature author = collection.repo.Config.BuildSignature(DateTimeOffset.Now, true);
 
             return collection.Add(targetId, message, author, author, @namespace);
         }
@@ -32,7 +32,7 @@ public static Note Add(this NoteCollection collection, ObjectId targetId, string
         /// <param name="namespace">The namespace on which the note will be removed. It can be either a canonical namespace or an abbreviated namespace ('refs/notes/myNamespace' or just 'myNamespace').</param>
         public static void Remove(this NoteCollection collection, ObjectId targetId, string @namespace)
         {
-            Signature author = collection.repo.Config.BuildSignatureFromGlobalConfiguration(DateTimeOffset.Now, true);
+            Signature author = collection.repo.Config.BuildSignature(DateTimeOffset.Now, true);
 
             collection.Remove(targetId, author, author, @namespace);
         }

LibGit2Sharp/ReflogCollection.cs

@@ -126,7 +126,7 @@ internal virtual void Append(ObjectId target, string reflogMessage, Signature co
         /// <param name="reflogMessage">the message associated with the new <see cref="ReflogEntry"/>.</param>
         internal void Append(ObjectId target, string reflogMessage)
         {
-            Signature author = repo.Config.BuildSignatureFromGlobalConfiguration(DateTimeOffset.Now, false);
+            Signature author = repo.Config.BuildSignature(DateTimeOffset.Now, false);
             Append(target, reflogMessage, author);
         }
     }

LibGit2Sharp/RepositoryExtensions.cs

@@ -212,7 +212,7 @@ private static Commit LookUpCommit(IRepository repository, string committish)
         /// <returns>The generated <see cref="LibGit2Sharp.Commit"/>.</returns>
         public static Commit Commit(this IRepository repository, string message, bool amendPreviousCommit = false)
         {
-            Signature author = repository.Config.BuildSignatureFromGlobalConfiguration(DateTimeOffset.Now, true);
+            Signature author = repository.Config.BuildSignature(DateTimeOffset.Now, true);
 
             return repository.Commit(message, author, amendPreviousCommit);
         }
@@ -230,7 +230,7 @@ public static Commit Commit(this IRepository repository, string message, bool am
         /// <returns>The generated <see cref="LibGit2Sharp.Commit"/>.</returns>
         public static Commit Commit(this IRepository repository, string message, Signature author, bool amendPreviousCommit = false)
         {
-            Signature committer = repository.Config.BuildSignatureFromGlobalConfiguration(DateTimeOffset.Now, true);
+            Signature committer = repository.Config.BuildSignature(DateTimeOffset.Now, true);
 
             return repository.Commit(message, author, committer, amendPreviousCommit);
         }