Merge pull request #147 from filipeRmlh/feature/allowing_to_checkout_commit

love-linger · web-flow · commit e00bc4e63029 · 2024-05-26T13:37:59.000+08:00
Feature/allowing to checkout commit
diff --git a/src/Commands/Checkout.cs b/src/Commands/Checkout.cs
@@ -62,6 +62,14 @@ public bool FileWithRevision(string file, string revision)
             return Exec();
         }
 
+        public bool Commit(string commitId, Action<string> onProgress)
+        {
+            Args = $"checkout --detach --progress {commitId}";
+            TraitErrorAsOutput = true;
+            _outputHandler = onProgress;
+            return Exec();
+        }
+
         public bool Files(List<string> files)
         {
             StringBuilder builder = new StringBuilder();
diff --git a/src/Commands/QueryBranches.cs b/src/Commands/QueryBranches.cs
@@ -51,7 +51,12 @@ protected override void OnReadline(string line)
             var refName = parts[0];
             if (refName.EndsWith("/HEAD", StringComparison.Ordinal))
                 return;
-
+            
+            if (refName.StartsWith("(HEAD detached at"))
+            {
+                branch.isHead = true;
+            }
+            
             if (refName.StartsWith(PREFIX_LOCAL, StringComparison.Ordinal))
             {
                 branch.Name = refName.Substring(PREFIX_LOCAL.Length);
diff --git a/src/Commands/QueryCommits.cs b/src/Commands/QueryCommits.cs
@@ -146,6 +146,15 @@ private bool ParseDecorators(List<Models.Decorator> decorators, string data)
                         Name = d.Substring(19).Trim(),
                     });
                 }
+                else if (d.Equals("HEAD"))
+                {
+                    isHeadOfCurrent = true;
+                    decorators.Add(new Models.Decorator()
+                    {
+                        Type = Models.DecoratorType.CurrentCommitHead,
+                        Name = d.Trim(),
+                    });
+                }
                 else if (d.StartsWith("refs/heads/", StringComparison.Ordinal))
                 {
                     decorators.Add(new Models.Decorator()
diff --git a/src/Converters/DecoratorTypeConverters.cs b/src/Converters/DecoratorTypeConverters.cs
@@ -38,6 +38,9 @@ public static class DecoratorTypeConverters
             });
 
         public static readonly FuncValueConverter<Models.DecoratorType, FontWeight> ToFontWeight =
-            new FuncValueConverter<Models.DecoratorType, FontWeight>(v => v == Models.DecoratorType.CurrentBranchHead ? FontWeight.Bold : FontWeight.Regular);
+            new FuncValueConverter<Models.DecoratorType, FontWeight>(v => 
+                v is Models.DecoratorType.CurrentBranchHead or Models.DecoratorType.CurrentCommitHead 
+                    ? FontWeight.Bold : FontWeight.Regular
+            );
     }
 }
diff --git a/src/Models/Branch.cs b/src/Models/Branch.cs
@@ -10,5 +10,6 @@ public class Branch
         public string Upstream { get; set; }
         public string UpstreamTrackStatus { get; set; }
         public string Remote { get; set; }
+        public bool isHead { get; set; }
     }
 }
diff --git a/src/Models/Commit.cs b/src/Models/Commit.cs
@@ -32,7 +32,7 @@ public bool IsCommitterVisible
 
         public bool IsCurrentHead
         {
-            get => Decorators.Find(x => x.Type == DecoratorType.CurrentBranchHead) != null;
+            get => Decorators.Find(x => x.Type is DecoratorType.CurrentBranchHead or DecoratorType.CurrentCommitHead) != null;
         }
 
         public string FullMessage
diff --git a/src/Models/Decorator.cs b/src/Models/Decorator.cs
@@ -7,6 +7,7 @@ public enum DecoratorType
         None,
         CurrentBranchHead,
         LocalBranchHead,
+        CurrentCommitHead,
         RemoteBranchHead,
         Tag,
     }
diff --git a/src/Resources/Locales/en_US.axaml b/src/Resources/Locales/en_US.axaml
@@ -54,7 +54,11 @@
   <x:String x:Key="Text.ChangeDisplayMode.List" xml:space="preserve">Show as List</x:String>
   <x:String x:Key="Text.ChangeDisplayMode.Tree" xml:space="preserve">Show as Tree</x:String>
   <x:String x:Key="Text.Checkout" xml:space="preserve">Checkout Branch</x:String>
+  <x:String x:Key="Text.Checkout.Commit" xml:space="preserve">Checkout Commit</x:String>
+  <x:String x:Key="Text.Checkout.Commit.Warning" xml:space="preserve">Warning: By doing a commit checkout, your Head will be detached</x:String>
   <x:String x:Key="Text.Checkout.Target" xml:space="preserve">Branch :</x:String>
+  <x:String x:Key="Text.Checkout.CommitTarget.Sha" xml:space="preserve">Commit SHA :</x:String>
+  <x:String x:Key="Text.Checkout.CommitTarget.ShortSha" xml:space="preserve">Commit Short SHA :</x:String>
   <x:String x:Key="Text.Checkout.LocalChanges" xml:space="preserve">Local Changes :</x:String>
   <x:String x:Key="Text.Checkout.LocalChanges.StashAndReply" xml:space="preserve">Stash &amp; Reapply</x:String>
   <x:String x:Key="Text.Checkout.LocalChanges.Discard" xml:space="preserve">Discard</x:String>
@@ -74,6 +78,7 @@
   <x:String x:Key="Text.Close" xml:space="preserve">CLOSE</x:String>
   <x:String x:Key="Text.CommitCM.CherryPick" xml:space="preserve">Cherry-Pick This Commit</x:String>
   <x:String x:Key="Text.CommitCM.CopySHA" xml:space="preserve">Copy SHA</x:String>
+  <x:String x:Key="Text.CommitCM.Checkout" xml:space="preserve">Checkout commit${0}</x:String>
   <x:String x:Key="Text.CommitCM.Rebase" xml:space="preserve">Rebase${0}$to Here</x:String>
   <x:String x:Key="Text.CommitCM.Reset" xml:space="preserve">Reset${0}$to Here</x:String>
   <x:String x:Key="Text.CommitCM.Revert" xml:space="preserve">Revert Commit</x:String>
diff --git a/src/SourceGit.csproj b/src/SourceGit.csproj
@@ -44,4 +44,11 @@
     <TrimmerRootAssembly Include="SourceGit" />
     <TrimmerRootAssembly Include="Avalonia.Themes.Fluent" />
   </ItemGroup>
+
+  <ItemGroup>
+    <Compile Update="Views\CheckoutCommit.axaml.cs">
+      <DependentUpon>CheckoutCommit.axaml</DependentUpon>
+      <SubType>Code</SubType>
+    </Compile>
+  </ItemGroup>
 </Project>
diff --git a/src/ViewModels/BranchTreeNode.cs b/src/ViewModels/BranchTreeNode.cs
@@ -11,6 +11,7 @@ namespace SourceGit.ViewModels
 {
     public enum BranchTreeNodeType
     {
+        DetachedHead,
         Remote,
         Folder,
         Branch,
@@ -51,6 +52,11 @@ public bool IsBranch
         {
             get => Type == BranchTreeNodeType.Branch;
         }
+        
+        public bool IsDetachedHead
+        {
+            get => Type == BranchTreeNodeType.DetachedHead;
+        }
 
         public bool IsCurrent
         {
@@ -213,11 +219,11 @@ private void MakeBranchNode(Models.Branch branch, List<BranchTreeNode> roots, Di
                     start = sepIdx + 1;
                     sepIdx = branch.Name.IndexOf('/', start);
                 }
-
+                
                 lastFolder.Children.Add(new BranchTreeNode()
                 {
                     Name = Path.GetFileName(branch.Name),
-                    Type = BranchTreeNodeType.Branch,
+                    Type = branch.isHead ? BranchTreeNodeType.DetachedHead : BranchTreeNodeType.Branch,
                     Backend = branch,
                     IsExpanded = false,
                     IsFiltered = isFiltered,
@@ -228,14 +234,16 @@ private void SortNodes(List<BranchTreeNode> nodes)
             {
                 nodes.Sort((l, r) =>
                 {
-                    if (l.Type == r.Type)
+                    if (l.Type == BranchTreeNodeType.DetachedHead)
                     {
-                        return l.Name.CompareTo(r.Name);
+                        return -1;
                     }
-                    else
+                    if (l.Type == r.Type)
                     {
-                        return (int)l.Type - (int)r.Type;
+                        return l.Name.CompareTo(r.Name);
                     }
+                   
+                    return (int)l.Type - (int)r.Type;
                 });
 
                 foreach (var node in nodes)
diff --git a/src/ViewModels/CheckoutCommit.cs b/src/ViewModels/CheckoutCommit.cs
@@ -0,0 +1,87 @@
+﻿using System.Threading.Tasks;
+
+namespace SourceGit.ViewModels
+{
+    public class CheckoutCommit: Popup
+    {
+        public string Commit
+        {
+            get;
+            private set;
+        }
+        
+        public bool HasLocalChanges
+        {
+            get => _repo.WorkingCopyChangesCount > 0;
+        }
+
+        public bool AutoStash
+        {
+            get => _autoStash;
+            set => SetProperty(ref _autoStash, value);
+        }
+
+        public CheckoutCommit(Repository repo, string commit)
+        {
+            _repo = repo;
+            Commit = commit;
+            View = new Views.CheckoutCommit() { DataContext = this };
+        }
+
+        public override Task<bool> Sure()
+        {
+            _repo.SetWatcherEnabled(false);
+            ProgressDescription = $"Checkout Commit '{Commit}' ...";
+            
+            return Task.Run(() =>
+            {
+                var needPopStash = false;
+                if (HasLocalChanges)
+                {
+                    if (AutoStash)
+                    {
+                        SetProgressDescription("Adding untracked changes ...");
+                        var succ = new Commands.Add(_repo.FullPath).Exec();
+                        if (succ)
+                        {
+                            SetProgressDescription("Stash local changes ...");
+                            succ = new Commands.Stash(_repo.FullPath).Push("CHECKOUT_AUTO_STASH");
+                        }
+
+                        if (!succ)
+                        {
+                            CallUIThread(() => _repo.SetWatcherEnabled(true));
+                            return false;
+                        }
+
+                        needPopStash = true;
+                    }
+                    else
+                    {
+                        SetProgressDescription("Discard local changes ...");
+                        Commands.Discard.All(_repo.FullPath);
+                    }
+                }
+
+                SetProgressDescription("Checkout commit ...");
+                var rs = new Commands.Checkout(_repo.FullPath).Commit(Commit, SetProgressDescription);
+
+                if (needPopStash)
+                {
+                    SetProgressDescription("Re-apply local changes...");
+                    rs = new Commands.Stash(_repo.FullPath).Apply("stash@{0}");
+                    if (rs)
+                    {
+                        rs = new Commands.Stash(_repo.FullPath).Drop("stash@{0}");
+                    }
+                }
+
+                CallUIThread(() => _repo.SetWatcherEnabled(true));
+                return rs;
+            });
+        }
+
+        private readonly Repository _repo = null;
+        private bool _autoStash = true;
+    }
+}
diff --git a/src/ViewModels/Histories.cs b/src/ViewModels/Histories.cs
@@ -1,9 +1,11 @@
 ﻿using System;
 using System.Collections;
 using System.Collections.Generic;
+using System.Globalization;
 using System.Threading.Tasks;
 
 using Avalonia.Controls;
+using Avalonia.Data.Converters;
 using Avalonia.Platform.Storage;
 using Avalonia.Threading;
 
@@ -234,6 +236,20 @@ public ContextMenu MakeContextMenu()
                     e.Handled = true;
                 };
                 menu.Items.Add(reset);
+
+                var checkoutCommit = new MenuItem();
+
+                var shortSha = Converters.StringConverters.ToShortSHA
+                    .Convert(commit.SHA, typeof(string), null, CultureInfo.CurrentCulture);
+                
+                checkoutCommit.Header = new Views.NameHighlightedTextBlock("CommitCM.Checkout", shortSha);
+                checkoutCommit.Icon = App.CreateMenuIcon("Icons.Check");
+                checkoutCommit.Click += (o, e) =>
+                {
+                    _repo.CheckoutCommit(commit.SHA);
+                    e.Handled = true;
+                };
+                menu.Items.Add(checkoutCommit);
             }
             else
             {
diff --git a/src/ViewModels/Repository.cs b/src/ViewModels/Repository.cs
@@ -722,6 +722,14 @@ public void CheckoutLocalBranch(string branch)
                 PopupHost.ShowAndStartPopup(new Checkout(this, branch));
         }
 
+        public void CheckoutCommit(string commit)
+        {
+            if (!PopupHost.CanCreatePopup())
+                return;
+            
+            PopupHost.ShowPopup(new CheckoutCommit(this, commit));
+        }
+        
         public void DeleteMultipleBranches(List<Models.Branch> branches, bool isLocal)
         {
             if (PopupHost.CanCreatePopup())
diff --git a/src/Views/CheckoutCommit.axaml b/src/Views/CheckoutCommit.axaml
@@ -0,0 +1,45 @@
+<UserControl xmlns="https://github.com/avaloniaui"
+             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+             xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
+             xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
+             xmlns:vm="using:SourceGit.ViewModels"
+             xmlns:c="clr-namespace:SourceGit.Converters"
+             mc:Ignorable="d" d:DesignWidth="800" d:DesignHeight="450"
+             x:Class="SourceGit.Views.CheckoutCommit"
+             x:DataType="vm:CheckoutCommit">
+  <StackPanel Orientation="Vertical" Margin="8,0">
+    <TextBlock FontSize="18"
+               Classes="bold"
+               Text="{DynamicResource Text.Checkout.Commit}"/>
+    
+      <TextBlock FontSize="14"
+         TextWrapping="Wrap"
+         Classes="italic"
+         Text="{DynamicResource Text.Checkout.Commit.Warning}"/>
+    
+    <TextBlock TextWrapping="Wrap" Margin="0,16,0,0">
+      <TextBlock Classes="bold"  Grid.Row="0" Grid.Column="0"
+           Text="{DynamicResource Text.Checkout.CommitTarget.Sha}"/>
+        <TextBlock TextWrapping="Wrap" Text="{Binding Commit}"/>
+        (<TextBlock Classes="italic" TextWrapping="Wrap" Text="{Binding Commit, Converter={x:Static c:StringConverters.ToShortSHA}}"/>)
+    </TextBlock>
+    
+    <StackPanel Margin="0, 26, 0, 0" Grid.Row="1" Grid.Column="1" Orientation="Vertical" IsVisible="{Binding HasLocalChanges}">
+      <TextBlock Grid.Row="1" Grid.Column="0"
+                 HorizontalAlignment="Left" VerticalAlignment="Center"
+                 Margin="0,0,8,0"
+                 Text="{DynamicResource Text.Checkout.LocalChanges}"/>
+    
+      <StackPanel Margin="0, 13, 0, 0" Grid.Row="1" Grid.Column="1" Orientation="Horizontal">
+        <RadioButton Content="{DynamicResource Text.Checkout.LocalChanges.StashAndReply}"
+                     GroupName="LocalChanges"
+                     IsChecked="{Binding AutoStash, Mode=TwoWay}"/>
+        <RadioButton Content="{DynamicResource Text.Checkout.LocalChanges.Discard}"
+                     GroupName="LocalChanges"
+                     Margin="8,0,0,0"/>
+      </StackPanel>
+    </StackPanel>
+    
+    
+  </StackPanel>
+</UserControl>
diff --git a/src/Views/CheckoutCommit.axaml.cs b/src/Views/CheckoutCommit.axaml.cs
@@ -0,0 +1,13 @@
+using Avalonia.Controls;
+
+namespace SourceGit.Views
+{
+    public partial class CheckoutCommit : UserControl
+    {
+        public bool HasLocalChanges;
+        public CheckoutCommit()
+        {
+            InitializeComponent();
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,14 @@ public bool FileWithRevision(string file, string revision)`
`62`	`62`	`return Exec();`
`63`	`63`	`}`
`64`	`64`
	`65`	`+ public bool Commit(string commitId, Action<string> onProgress)`
	`66`	`+ {`
	`67`	`+ Args = $"checkout --detach --progress {commitId}";`
	`68`	`+ TraitErrorAsOutput = true;`
	`69`	`+ _outputHandler = onProgress;`
	`70`	`+ return Exec();`
	`71`	`+ }`
	`72`	`+`
`65`	`73`	`public bool Files(List<string> files)`
`66`	`74`	`{`
`67`	`75`	`StringBuilder builder = new StringBuilder();`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,9 @@ public static class DecoratorTypeConverters`
`38`	`38`	`});`
`39`	`39`
`40`	`40`	`public static readonly FuncValueConverter<Models.DecoratorType, FontWeight> ToFontWeight =`
`41`		`- new FuncValueConverter<Models.DecoratorType, FontWeight>(v => v == Models.DecoratorType.CurrentBranchHead ? FontWeight.Bold : FontWeight.Regular);`
	`41`	`+ new FuncValueConverter<Models.DecoratorType, FontWeight>(v =>`
	`42`	`+ v is Models.DecoratorType.CurrentBranchHead or Models.DecoratorType.CurrentCommitHead`
	`43`	`+ ? FontWeight.Bold : FontWeight.Regular`
	`44`	`+ );`
`42`	`45`	`}`
`43`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,5 +10,6 @@ public class Branch`
`10`	`10`	`public string Upstream { get; set; }`
`11`	`11`	`public string UpstreamTrackStatus { get; set; }`
`12`	`12`	`public string Remote { get; set; }`
	`13`	`+ public bool isHead { get; set; }`
`13`	`14`	`}`
`14`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ public bool IsCommitterVisible`
`32`	`32`
`33`	`33`	`public bool IsCurrentHead`
`34`	`34`	`{`
`35`		`- get => Decorators.Find(x => x.Type == DecoratorType.CurrentBranchHead) != null;`
	`35`	`+ get => Decorators.Find(x => x.Type is DecoratorType.CurrentBranchHead or DecoratorType.CurrentCommitHead) != null;`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`public string FullMessage`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@ public enum DecoratorType`
`7`	`7`	`None,`
`8`	`8`	`CurrentBranchHead,`
`9`	`9`	`LocalBranchHead,`
	`10`	`+ CurrentCommitHead,`
`10`	`11`	`RemoteBranchHead,`
`11`	`12`	`Tag,`
`12`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ namespace SourceGit.ViewModels`
`11`	`11`	`{`
`12`	`12`	`public enum BranchTreeNodeType`
`13`	`13`	`{`
	`14`	`+ DetachedHead,`
`14`	`15`	`Remote,`
`15`	`16`	`Folder,`
`16`	`17`	`Branch,`
`@@ -51,6 +52,11 @@ public bool IsBranch`
`51`	`52`	`{`
`52`	`53`	`get => Type == BranchTreeNodeType.Branch;`
`53`	`54`	`}`
	`55`	`+`
	`56`	`+ public bool IsDetachedHead`
	`57`	`+ {`
	`58`	`+ get => Type == BranchTreeNodeType.DetachedHead;`
	`59`	`+ }`
`54`	`60`
`55`	`61`	`public bool IsCurrent`
`56`	`62`	`{`
`@@ -213,11 +219,11 @@ private void MakeBranchNode(Models.Branch branch, List<BranchTreeNode> roots, Di`
`213`	`219`	`start = sepIdx + 1;`
`214`	`220`	`sepIdx = branch.Name.IndexOf('/', start);`
`215`	`221`	`}`
`216`		`-`
	`222`	`+`
`217`	`223`	`lastFolder.Children.Add(new BranchTreeNode()`
`218`	`224`	`{`
`219`	`225`	`Name = Path.GetFileName(branch.Name),`
`220`		`- Type = BranchTreeNodeType.Branch,`
	`226`	`+ Type = branch.isHead ? BranchTreeNodeType.DetachedHead : BranchTreeNodeType.Branch,`
`221`	`227`	`Backend = branch,`
`222`	`228`	`IsExpanded = false,`
`223`	`229`	`IsFiltered = isFiltered,`
`@@ -228,14 +234,16 @@ private void SortNodes(List<BranchTreeNode> nodes)`
`228`	`234`	`{`
`229`	`235`	`nodes.Sort((l, r) =>`
`230`	`236`	`{`
`231`		`- if (l.Type == r.Type)`
	`237`	`+ if (l.Type == BranchTreeNodeType.DetachedHead)`
`232`	`238`	`{`
`233`		`- return l.Name.CompareTo(r.Name);`
	`239`	`+ return -1;`
`234`	`240`	`}`
`235`		`- else`
	`241`	`+ if (l.Type == r.Type)`
`236`	`242`	`{`
`237`		`- return (int)l.Type - (int)r.Type;`
	`243`	`+ return l.Name.CompareTo(r.Name);`
`238`	`244`	`}`
	`245`	`+`
	`246`	`+ return (int)l.Type - (int)r.Type;`
`239`	`247`	`});`
`240`	`248`
`241`	`249`	`foreach (var node in nodes)`