Introduce renames in status

Renames in status require more detailed data than simply paths, in
order to collect old path, new path and similarity data.  Use
git_status_list to collect this data and use a new StatusEntry to
store it.

Author: Edward Thomson

LibGit2Sharp.Tests/IgnoreFixture.cs

@@ -16,15 +16,15 @@ public void TemporaryRulesShouldApplyUntilCleared()
             {
                 Touch(repo.Info.WorkingDirectory, "Foo.cs", "Bar");
 
-                Assert.True(repo.Index.RetrieveStatus().Untracked.Contains("Foo.cs"));
+                Assert.True(repo.Index.RetrieveStatus().Untracked.Select(s => s.FilePath).Contains("Foo.cs"));
 
                 repo.Ignore.AddTemporaryRules(new[] { "*.cs" });
 
-                Assert.False(repo.Index.RetrieveStatus().Untracked.Contains("Foo.cs"));
+                Assert.False(repo.Index.RetrieveStatus().Untracked.Select(s => s.FilePath).Contains("Foo.cs"));
 
                 repo.Ignore.ResetAllTemporaryRules();
 
-                Assert.True(repo.Index.RetrieveStatus().Untracked.Contains("Foo.cs"));
+                Assert.True(repo.Index.RetrieveStatus().Untracked.Select(s => s.FilePath).Contains("Foo.cs"));
             }
         }
 

LibGit2Sharp.Tests/ResetIndexFixture.cs

@@ -93,7 +93,7 @@ public void CanResetTheIndexToTheContentOfACommitWithCommittishAsArgument()
                     "deleted_unstaged_file.txt", "modified_staged_file.txt", "modified_unstaged_file.txt" };
 
                 Assert.Equal(expected.Length, newStatus.Where(IsStaged).Count());
-                Assert.Equal(expected, newStatus.Removed);
+                Assert.Equal(expected, newStatus.Removed.Select(s => s.FilePath));
             }
         }
 
@@ -111,7 +111,7 @@ public void CanResetTheIndexToTheContentOfACommitWithCommitAsArgument()
                     "deleted_unstaged_file.txt", "modified_staged_file.txt", "modified_unstaged_file.txt" };
 
                 Assert.Equal(expected.Length, newStatus.Where(IsStaged).Count());
-                Assert.Equal(expected, newStatus.Removed);
+                Assert.Equal(expected, newStatus.Removed.Select(s => s.FilePath));
             }
         }
 

LibGit2Sharp.Tests/StatusFixture.cs

@@ -75,37 +75,132 @@ public void CanRetrieveTheStatusOfTheWholeWorkingDirectory()
 
                 RepositoryStatus status = repo.Index.RetrieveStatus();
 
-                Assert.Equal(FileStatus.Staged, status[file]);
+                Assert.Equal(FileStatus.Staged, status[file].State);
 
                 Assert.NotNull(status);
                 Assert.Equal(6, status.Count());
                 Assert.True(status.IsDirty);
 
-                Assert.Equal("new_untracked_file.txt", status.Untracked.Single());
-                Assert.Equal("modified_unstaged_file.txt", status.Modified.Single());
-                Assert.Equal("deleted_unstaged_file.txt", status.Missing.Single());
-                Assert.Equal("new_tracked_file.txt", status.Added.Single());
-                Assert.Equal(file, status.Staged.Single());
-                Assert.Equal("deleted_staged_file.txt", status.Removed.Single());
+                Assert.Equal("new_untracked_file.txt", status.Untracked.Select(s => s.FilePath).Single());
+                Assert.Equal("modified_unstaged_file.txt", status.Modified.Select(s => s.FilePath).Single());
+                Assert.Equal("deleted_unstaged_file.txt", status.Missing.Select(s => s.FilePath).Single());
+                Assert.Equal("new_tracked_file.txt", status.Added.Select(s => s.FilePath).Single());
+                Assert.Equal(file, status.Staged.Select(s => s.FilePath).Single());
+                Assert.Equal("deleted_staged_file.txt", status.Removed.Select(s => s.FilePath).Single());
 
                 File.AppendAllText(Path.Combine(repo.Info.WorkingDirectory, file),
                                    "Tclem's favorite commit message: boom");
 
                 Assert.Equal(FileStatus.Staged | FileStatus.Modified, repo.Index.RetrieveStatus(file));
 
                 RepositoryStatus status2 = repo.Index.RetrieveStatus();
-                Assert.Equal(FileStatus.Staged | FileStatus.Modified, status2[file]);
+                Assert.Equal(FileStatus.Staged | FileStatus.Modified, status2[file].State);
 
                 Assert.NotNull(status2);
                 Assert.Equal(6, status2.Count());
                 Assert.True(status2.IsDirty);
 
-                Assert.Equal("new_untracked_file.txt", status2.Untracked.Single());
-                Assert.Equal(new[] { file, "modified_unstaged_file.txt" }, status2.Modified);
-                Assert.Equal("deleted_unstaged_file.txt", status2.Missing.Single());
-                Assert.Equal("new_tracked_file.txt", status2.Added.Single());
-                Assert.Equal(file, status2.Staged.Single());
-                Assert.Equal("deleted_staged_file.txt", status2.Removed.Single());
+                Assert.Equal("new_untracked_file.txt", status2.Untracked.Select(s => s.FilePath).Single());
+                Assert.Equal(new[] { file, "modified_unstaged_file.txt" }, status2.Modified.Select(s => s.FilePath));
+                Assert.Equal("deleted_unstaged_file.txt", status2.Missing.Select(s => s.FilePath).Single());
+                Assert.Equal("new_tracked_file.txt", status2.Added.Select(s => s.FilePath).Single());
+                Assert.Equal(file, status2.Staged.Select(s => s.FilePath).Single());
+                Assert.Equal("deleted_staged_file.txt", status2.Removed.Select(s => s.FilePath).Single());
+            }
+        }
+
+        [Fact]
+        public void CanRetrieveTheStatusOfRenamedFilesInWorkdir()
+        {
+            string path = CloneStandardTestRepo();
+            using (var repo = new Repository(path))
+            {
+                Touch(repo.Info.WorkingDirectory, "old_name.txt",
+                    "This is a file with enough data to trigger similarity matching.\r\n" +
+                    "This is a file with enough data to trigger similarity matching.\r\n" +
+                    "This is a file with enough data to trigger similarity matching.\r\n" +
+                    "This is a file with enough data to trigger similarity matching.\r\n");
+
+                repo.Index.Stage("old_name.txt");
+
+                File.Move(Path.Combine(repo.Info.WorkingDirectory, "old_name.txt"),
+                    Path.Combine(repo.Info.WorkingDirectory, "rename_target.txt"));
+
+                RepositoryStatus status = repo.Index.RetrieveStatus(
+                    new StatusOptions()
+                    {
+                        DetectRenamesInIndex = true,
+                        DetectRenamesInWorkdir = true
+                    });
+
+                Assert.Equal(FileStatus.Added | FileStatus.RenamedInWorkdir, status["rename_target.txt"].State);
+                Assert.Equal(100, status["rename_target.txt"].IndexToWorkdirRenameDetails.Similarity);
+            }
+        }
+
+        [Fact]
+        public void CanRetrieveTheStatusOfRenamedFilesInIndex()
+        {
+            string path = CloneStandardTestRepo();
+            using (var repo = new Repository(path))
+            {
+                File.Move(
+                    Path.Combine(repo.Info.WorkingDirectory, "1.txt"),
+                    Path.Combine(repo.Info.WorkingDirectory, "rename_target.txt"));
+
+                repo.Index.Stage("1.txt");
+                repo.Index.Stage("rename_target.txt");
+
+                RepositoryStatus status = repo.Index.RetrieveStatus();
+
+                Assert.Equal(FileStatus.RenamedInIndex, status["rename_target.txt"].State);
+                Assert.Equal(100, status["rename_target.txt"].HeadToIndexRenameDetails.Similarity);
+            }
+        }
+
+        [Fact]
+        public void CanDetectedVariousKindsOfRenaming()
+        {
+            string path = InitNewRepository();
+            using (var repo = new Repository(path))
+            {
+                Touch(repo.Info.WorkingDirectory, "file.txt",
+                    "This is a file with enough data to trigger similarity matching.\r\n" +
+                    "This is a file with enough data to trigger similarity matching.\r\n" +
+                    "This is a file with enough data to trigger similarity matching.\r\n" +
+                    "This is a file with enough data to trigger similarity matching.\r\n");
+
+                repo.Index.Stage("file.txt");
+                repo.Commit("Initial commit", Constants.Signature, Constants.Signature);
+
+                File.Move(Path.Combine(repo.Info.WorkingDirectory, "file.txt"),
+                    Path.Combine(repo.Info.WorkingDirectory, "renamed.txt"));
+
+                var opts = new StatusOptions
+                {
+                    DetectRenamesInIndex = true,
+                    DetectRenamesInWorkdir = true
+                };
+
+                RepositoryStatus status = repo.Index.RetrieveStatus(opts);
+
+                // This passes as expected
+                Assert.Equal(FileStatus.RenamedInWorkdir, status.Single().State);
+
+                repo.Index.Stage("file.txt");
+                repo.Index.Stage("renamed.txt");
+
+                status = repo.Index.RetrieveStatus(opts);
+
+                Assert.Equal(FileStatus.RenamedInIndex, status.Single().State);
+
+                File.Move(Path.Combine(repo.Info.WorkingDirectory, "renamed.txt"),
+                    Path.Combine(repo.Info.WorkingDirectory, "renamed_again.txt"));
+
+                status = repo.Index.RetrieveStatus(opts);
+
+                Assert.Equal(FileStatus.RenamedInWorkdir | FileStatus.RenamedInIndex,
+                    status.Single().State);
             }
         }
 
@@ -154,7 +249,7 @@ public void RetrievingTheStatusOfARepositoryReturnNativeFilePaths()
 
                 Assert.Equal(relFilePath, statusEntry.FilePath);
 
-                Assert.Equal(statusEntry.FilePath, repoStatus.Added.Single());
+                Assert.Equal(statusEntry.FilePath, repoStatus.Added.Select(s => s.FilePath).Single());
             }
         }
 
@@ -169,15 +264,15 @@ public void RetrievingTheStatusOfAnEmptyRepositoryHonorsTheGitIgnoreDirectives()
                 Touch(repo.Info.WorkingDirectory, relativePath, "I'm going to be ignored!");
 
                 RepositoryStatus status = repo.Index.RetrieveStatus();
-                Assert.Equal(new[] { relativePath }, status.Untracked);
+                Assert.Equal(new[] { relativePath }, status.Untracked.Select(s => s.FilePath));
 
                 Touch(repo.Info.WorkingDirectory, ".gitignore", "*.txt" + Environment.NewLine);
 
                 RepositoryStatus newStatus = repo.Index.RetrieveStatus();
-                Assert.Equal(".gitignore", newStatus.Untracked.Single());
+                Assert.Equal(".gitignore", newStatus.Untracked.Select(s => s.FilePath).Single());
 
                 Assert.Equal(FileStatus.Ignored, repo.Index.RetrieveStatus(relativePath));
-                Assert.Equal(new[] { relativePath }, newStatus.Ignored);
+                Assert.Equal(new[] { relativePath }, newStatus.Ignored.Select(s => s.FilePath));
             }
         }
 
@@ -223,7 +318,7 @@ public void RetrievingTheStatusOfTheRepositoryHonorsTheGitIgnoreDirectives()
 
                 RepositoryStatus status = repo.Index.RetrieveStatus();
 
-                Assert.Equal(new[]{relativePath, "new_untracked_file.txt"}, status.Untracked);
+                Assert.Equal(new[] { relativePath, "new_untracked_file.txt" }, status.Untracked.Select(s => s.FilePath));
 
                 Touch(repo.Info.WorkingDirectory, ".gitignore", "*.txt" + Environment.NewLine);
 
@@ -263,10 +358,10 @@ public void RetrievingTheStatusOfTheRepositoryHonorsTheGitIgnoreDirectives()
                  */
 
                 RepositoryStatus newStatus = repo.Index.RetrieveStatus();
-                Assert.Equal(".gitignore", newStatus.Untracked.Single());
+                Assert.Equal(".gitignore", newStatus.Untracked.Select(s => s.FilePath).Single());
 
                 Assert.Equal(FileStatus.Ignored, repo.Index.RetrieveStatus(relativePath));
-                Assert.Equal(new[] { relativePath, "new_untracked_file.txt" }, newStatus.Ignored);
+                Assert.Equal(new[] { relativePath, "new_untracked_file.txt" }, newStatus.Ignored.Select(s => s.FilePath));
             }
         }
 
@@ -354,7 +449,7 @@ public void RetrievingTheStatusOfTheRepositoryHonorsTheGitIgnoreDirectivesThroug
                 Assert.Equal(FileStatus.Ignored, repo.Index.RetrieveStatus("bin/what-about-me.txt"));
 
                 RepositoryStatus newStatus = repo.Index.RetrieveStatus();
-                Assert.Equal(new[] { "bin" + dirSep }, newStatus.Ignored);
+                Assert.Equal(new[] { "bin" + dirSep }, newStatus.Ignored.Select(s => s.FilePath));
 
                 var sb = new StringBuilder();
                 sb.AppendLine("bin/*");
@@ -366,8 +461,8 @@ public void RetrievingTheStatusOfTheRepositoryHonorsTheGitIgnoreDirectivesThroug
 
                 newStatus = repo.Index.RetrieveStatus();
 
-                Assert.Equal(new[] { "bin" + dirSep + "look-ma.txt" }, newStatus.Ignored);
-                Assert.True(newStatus.Untracked.Contains("bin" + dirSep + "what-about-me.txt" ));
+                Assert.Equal(new[] { "bin" + dirSep + "look-ma.txt" }, newStatus.Ignored.Select(s => s.FilePath));
+                Assert.True(newStatus.Untracked.Select(s => s.FilePath).Contains("bin" + dirSep + "what-about-me.txt"));
             }
         }
     }

LibGit2Sharp/Core/GitStatusEntry.cs

@@ -0,0 +1,30 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Runtime.InteropServices;
+using System.Text;
+
+namespace LibGit2Sharp.Core
+{
+    /// <summary>
+    /// A status entry from libgit2.
+    /// </summary>
+    [StructLayout(LayoutKind.Sequential)]
+    internal class GitStatusEntry
+    {
+        /// <summary>
+        /// Calculated status of a filepath in the working directory considering the current <see cref = "Repository.Index" /> and the <see cref="Repository.Head" />.
+        /// </summary>
+        public FileStatus Status;
+
+        /// <summary>
+        /// The difference between the <see cref="Repository.Head" /> and <see cref = "Repository.Index" />.
+        /// </summary>
+        public IntPtr HeadToIndexPtr;
+
+        /// <summary>
+        /// The difference between the <see cref = "Repository.Index" /> and the working directory.
+        /// </summary>
+        public IntPtr IndexToWorkdirPtr;
+    }
+}

LibGit2Sharp/Core/GitStatusOptions.cs

@@ -0,0 +1,53 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Runtime.InteropServices;
+using System.Text;
+
+namespace LibGit2Sharp.Core
+{
+    [StructLayout(LayoutKind.Sequential)]
+    internal class GitStatusOptions : IDisposable
+    {
+        public uint Version = 1;
+
+        public GitStatusShow Show;
+        public GitStatusOptionFlags Flags;
+
+        GitStrArrayIn PathSpec;
+
+        public void Dispose()
+        {
+            if (PathSpec == null)
+            {
+                return;
+            }
+
+            PathSpec.Dispose();
+        }
+    }
+
+    internal enum GitStatusShow
+    {
+        IndexAndWorkdir = 0,
+        IndexOnly = 1,
+        WorkdirOnly = 2,
+    }
+
+    [Flags]
+    internal enum GitStatusOptionFlags
+    {
+        IncludeUntracked = (1 << 0),
+        IncludeIgnored = (1 << 1),
+        IncludeUnmodified = (1 << 2),
+        ExcludeSubmodules = (1 << 3),
+        RecurseUntrackedDirs = (1 << 4),
+        DisablePathspecMatch = (1 << 5),
+        RecurseIgnoredDirs = (1 << 6),
+        RenamesHeadToIndex = (1 << 7),
+        RenamesIndexToWorkdir = (1 << 8),
+        SortCaseSensitively = (1 << 9),
+        SortCaseInsensitively = (1 << 10),
+        RenamesFromRewrites = (1 << 11),
+    }
+}

LibGit2Sharp/Core/Handles/StatusEntrySafeHandle.cs

@@ -0,0 +1,27 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Runtime.InteropServices;
+using System.Text;
+
+namespace LibGit2Sharp.Core.Handles
+{
+    internal class StatusEntrySafeHandle : NotOwnedSafeHandleBase
+    {
+        public StatusEntrySafeHandle()
+            : base()
+        {
+        }
+
+        public StatusEntrySafeHandle(IntPtr handle)
+            : base()
+        {
+            this.SetHandle(handle);
+        }
+
+        public GitStatusEntry MarshalAsGitStatusEntry()
+        {
+            return (GitStatusEntry)Marshal.PtrToStructure(handle, typeof(GitStatusEntry));
+        }
+    }
+}

LibGit2Sharp/Core/Handles/StatusListSafeHandle.cs

@@ -0,0 +1,16 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+
+namespace LibGit2Sharp.Core.Handles
+{
+    internal class StatusListSafeHandle : SafeHandleBase
+    {
+        protected override bool ReleaseHandleImpl()
+        {
+            Proxy.git_status_list_free(handle);
+            return true;
+        }
+    }
+}