Supported multiple same named branches.

Author: kekyo

FSharp.GitReader/Primitive/RepositoryExtension.fs

@@ -26,6 +26,10 @@ module public RepositoryExtension =
             PrimitiveRepositoryFacade.GetBranchHeadReferenceAsync(
                 repository, branchName, unwrapCT ct) |> Async.AwaitTask
 
+        member repository.getBranchAllHeadReference(branchName: string, ?ct: CancellationToken) =
+            PrimitiveRepositoryFacade.GetBranchAllHeadReferenceAsync(
+                repository, branchName, unwrapCT ct) |> Async.AwaitTask
+
         member repository.getTagReference(tagName: string, ?ct: CancellationToken) =
             PrimitiveRepositoryFacade.GetTagReferenceAsync(
                 repository, tagName, unwrapCT ct) |> Async.AwaitTask

FSharp.GitReader/Structures/RepositoryExtension.fs

@@ -91,7 +91,7 @@ module public RepositoryExtension =
          (match repository.head with
           | null -> None
           | _ -> Some repository.head),
-         repository.branches,
+         repository.branchesAll,
          repository.tags)
 
     let (|Branch|) (branch: Branch) =

GitReader.Core/Primitive/PrimitiveRepositoryFacade.cs

@@ -88,6 +88,23 @@ remoteResults is { } rr ?
             throw new ArgumentException($"Could not find a branch: {branchName}");
     }
 
+    public static async Task<PrimitiveReference[]> GetBranchAllHeadReferenceAsync(
+        Repository repository,
+        string branchName,
+        CancellationToken ct)
+    {
+        var path = $"refs/heads/{branchName}";
+        var remotePath = $"refs/remotes/{branchName}";
+        var (results, remoteResults) = await Utilities.Join(
+            RepositoryAccessor.ReadHashAsync(repository, path, ct),
+            RepositoryAccessor.ReadHashAsync(repository, remotePath, ct));
+        return (results is { } r ?
+            [ new PrimitiveReference(branchName, path, r.Hash) ] : Utilities.Empty<PrimitiveReference>()).
+            Concat(remoteResults is { } rr ?
+                [ new PrimitiveReference(branchName, remotePath, rr.Hash) ] : Utilities.Empty<PrimitiveReference>()).
+            ToArray();
+    }
+
     public static async Task<PrimitiveTagReference> GetTagReferenceAsync(
         Repository repository,
         string tagName, CancellationToken ct)

GitReader.Core/Structures/StructuredRepository.cs

@@ -11,6 +11,8 @@
 using GitReader.IO;
 using System;
 using System.ComponentModel;
+using System.Linq;
+using System.Threading;
 
 namespace GitReader.Structures;
 
@@ -23,10 +25,12 @@ internal interface IRepositoryReference
 public sealed class StructuredRepository : Repository
 {
     internal Branch? head;
-    internal ReadOnlyDictionary<string, Branch> branches = null!;
+    internal ReadOnlyDictionary<string, Branch[]> branchesAll = null!;
     internal ReadOnlyDictionary<string, Tag> tags = null!;
     internal ReadOnlyArray<Stash> stashes = null!;
 
+    private ReadOnlyDictionary<string, Branch>? branches;
+
     internal StructuredRepository(
         string repositoryPath,
         IFileSystem fileSystem) :
@@ -37,10 +41,26 @@ internal StructuredRepository(
     public Branch? Head =>
         this.head;
 
-    public ReadOnlyDictionary<string, Branch> Branches =>
-        this.branches;
+    public ReadOnlyDictionary<string, Branch> Branches
+    {
+        get
+        {
+            if (this.branches == null)
+            {
+                // Ignored race condition.
+                this.branches = this.branchesAll.ToDictionary(
+                    entry => entry.Key, entry => entry.Value[0]);
+            }
+            return this.branches;
+        }
+    }
+
     public ReadOnlyDictionary<string, Tag> Tags =>
-        this.tags;    
+        this.tags;
+
+    public ReadOnlyDictionary<string, Branch[]> BranchesAll =>
+        this.branchesAll;
+
     public ReadOnlyArray<Stash> Stashes =>
         this.stashes;
-}
+}

GitReader.Core/Structures/StructuredRepositoryFacade.cs

@@ -73,7 +73,7 @@ public static RepositoryReferenceExtracted GetRelatedRepository(
 
     //////////////////////////////////////////////////////////////////////////
 
-    private static async Task<ReadOnlyDictionary<string, Branch>> GetStructuredBranchesAsync(
+    private static async Task<ReadOnlyDictionary<string, Branch[]>> GetStructuredBranchesAsync(
         StructuredRepository repository,
         WeakReference rwr,
         CancellationToken ct)
@@ -89,7 +89,8 @@ private static async Task<ReadOnlyDictionary<string, Branch>> GetStructuredBranc
         return references.
             Select(r => new Branch(rwr, r.Name, r.Target, false)).
             Concat(remoteReferences.Select(r => new Branch(rwr, r.Name, r.Target, true))).
-            ToDictionary(b => b.Name);
+            GroupBy(b => b.Name).
+            ToDictionary(g => g.Key, g => g.ToArray());
     }
 
     private static async Task<ReadOnlyDictionary<string, Tag>> GetStructuredTagsAsync(
@@ -135,8 +136,8 @@ private static async Task<ReadOnlyDictionary<string, Tag>> GetStructuredTagsAsyn
 
         return tags.
             Where(tag => tag != null).
-            DistinctBy(tag => tag!.Name).
-            ToDictionary(tag => tag!.Name, tag => tag!);
+            DistinctBy(tag => tag.Name).
+            ToDictionary(tag => tag.Name);
     }
 
     private static async Task<Stash[]> GetStructuredStashesAsync(
@@ -188,14 +189,14 @@ private static async Task<StructuredRepository> InternalOpenStructuredAsync(
 
             // Read all other requirements.
             var rwr = new WeakReference(repository);
-            var (head, branches, tags, stashes) = await Utilities.Join(
+            var (head, branchesAll, tags, stashes) = await Utilities.Join(
                 GetCurrentHeadAsync(repository, rwr, ct),
                 GetStructuredBranchesAsync(repository, rwr, ct),
                 GetStructuredTagsAsync(repository, rwr, ct),
                 GetStructuredStashesAsync(repository, rwr, ct));
 
             repository.head = head;
-            repository.branches = branches;
+            repository.branchesAll = branchesAll;
             repository.tags = tags;
             repository.stashes = stashes;
 

GitReader/Primitive/RepositoryExtension.cs

@@ -27,6 +27,11 @@ public static Task<PrimitiveReference> GetBranchHeadReferenceAsync(
         string branchName, CancellationToken ct = default) =>
         PrimitiveRepositoryFacade.GetBranchHeadReferenceAsync(repository, branchName, ct);
 
+    public static Task<PrimitiveReference[]> GetBranchAllHeadReferenceAsync(
+        this PrimitiveRepository repository,
+        string branchName, CancellationToken ct = default) =>
+        PrimitiveRepositoryFacade.GetBranchAllHeadReferenceAsync(repository, branchName, ct);
+
     public static Task<PrimitiveTagReference> GetTagReferenceAsync(
         this PrimitiveRepository repository,
         string tagName, CancellationToken ct = default) =>

GitReader/Structures/RepositoryExtension.cs

@@ -95,16 +95,31 @@ public static void Deconstruct(
         out string gitPath,
         out ReadOnlyDictionary<string, string> remoteUrls,
         out Branch? head,
-        out ReadOnlyDictionary<string, Branch> branches,
+        out ReadOnlyDictionary<string, Branch[]> branchesAll,
         out ReadOnlyDictionary<string, Tag> tags)
     {
         gitPath = repository.GitPath;
         remoteUrls = repository.RemoteUrls;
         head = repository.head;
-        branches = repository.branches;
+        branchesAll = repository.branchesAll;
         tags = repository.tags;
     }
 
+    public static void Deconstruct(
+        this StructuredRepository repository,
+        out string gitPath,
+        out ReadOnlyDictionary<string, string> remoteUrls,
+        out Branch? head,
+        out ReadOnlyDictionary<string, Branch> branches,
+        out ReadOnlyDictionary<string, Tag> tags)
+    {
+        gitPath = repository.GitPath;
+        remoteUrls = repository.RemoteUrls;
+        head = repository.head;
+        branches = repository.Branches;
+        tags = repository.Tags;
+    }
+
     public static void Deconstruct(
         this Branch branch,
         out string name,

README.md

@@ -68,7 +68,7 @@ It primarily fits the purpose of easily extracting commit information from a Git
 
 ### Target .NET platforms
 
-* .NET 8.0 to 5.0
+* .NET 9.0 to 5.0
 * .NET Core 3.1 to 2.0
 * .NET Standard 2.1 to 1.6
 * .NET Framework 4.8.1 to 3.5
@@ -78,7 +78,7 @@ It primarily fits the purpose of easily extracting commit information from a Git
 F# 5.0 or upper, it contains F# friendly signature definition.
 (Asynchronous operations with `Async` type, elimination of null values with `Option`, etc.)
 
-* .NET 8.0 to 5.0
+* .NET 9.0 to 5.0
 * .NET Core 3.1 to 2.0
 * .NET Standard 2.1, 2.0
 * .NET Framework 4.8.1 to 4.6.1
@@ -173,6 +173,9 @@ Console.WriteLine($"Subject: {commit.Subject}");
 Console.WriteLine($"Body: {commit.Body}");
 ```
 
+Use `BranchesAll` instead of `Branches` when there may be branches with the same name but different references.
+Using `Branches` will give you only the first branch available from all branches of the same name.
+
 ### Get a tag
 
 ```csharp

README_ja.md

@@ -69,7 +69,7 @@ if (repository.Head is { } head)
 
 ### 対応する.NETプラットフォーム
 
-* .NET 8.0 to 5.0
+* .NET 9.0 to 5.0
 * .NET Core 3.1 to 2.0
 * .NET Standard 2.1 to 1.6
 * .NET Framework 4.8.1 to 3.5
@@ -79,7 +79,7 @@ if (repository.Head is { } head)
 F# 5.0以上が対象で、F#フレンドリーなシグネチャ定義が含まれています。
 (`Async`型による非同期操作、`Option`によるnull値排除など)
 
-* .NET 8.0 to 5.0
+* .NET 9.0 to 5.0
 * .NET Core 3.1 to 2.0
 * .NET Standard 2.1, 2.0
 * .NET Framework 4.8.1 to 4.6.1
@@ -171,6 +171,9 @@ Console.WriteLine($"Subject: {commit.Subject}");
 Console.WriteLine($"Body: {commit.Body}");
 ```
 
+同じ名前を持つ、異なる参照のブランチが存在する可能性がある場合は、`Branches` の代わりに `BranchesAll` を使います。
+`Branches` を使うと、同名の全てのブランチから得られる最初のブランチのみが得られます。
+
 ### 指定されたタグの情報を取得
 
 ```csharp