Using a custom comparer to order entries

Author: StanleyGoldman

src/GitHub.Api/OutputProcessors/StatusOutputProcessor.cs

@@ -191,7 +191,7 @@ private void ReturnStatus()
                 return;
 
             gitStatus.Entries = gitStatus.Entries
-                                         .OrderBy(entry => entry.Path)
+                                         .OrderBy(entry => entry.Path, StatusOutputPathComparer.Instance)
                                          .ToList();
 
             RaiseOnEntry(gitStatus);
@@ -214,5 +214,41 @@ private void HandleUnexpected(string line)
         {
             Logger.Error("Unexpected Input:\"{0}\"", line);
         }
+
+        class StatusOutputPathComparer : IComparer<string>
+        {
+            internal static StatusOutputPathComparer Instance => new StatusOutputPathComparer();
+
+            public int Compare(string x, string y)
+            {
+                Guard.ArgumentNotNull(x, nameof(x));
+                Guard.ArgumentNotNull(y, nameof(y));
+
+                var metaString = ".meta";
+                var xIsMeta = x.EndsWith(metaString);
+                var yIsMeta = y.EndsWith(metaString);
+
+                if (xIsMeta || yIsMeta)
+                {
+                    var compareX = !xIsMeta ? x : x.Substring(0, x.Length - 5);
+                    var compareY = !yIsMeta ? y : y.Substring(0, y.Length - 5);
+
+                    var comparisonResult = StringComparer.InvariantCultureIgnoreCase.Compare(compareX, compareY);
+                    if (comparisonResult != 0)
+                    {
+                        return comparisonResult;
+                    }
+
+                    if (xIsMeta)
+                    {
+                        return 1;
+                    }
+
+                    return -1;
+                }
+
+                return StringComparer.InvariantCultureIgnoreCase.Compare(x, y);
+            }
+        }
     }
 }

src/tests/UnitTests/IO/StatusOutputProcessorTests.cs

@@ -245,6 +245,64 @@ public void ShouldParseCleanWorkingTreeTracked()
             });
         }
 
+        [Test]
+        public void ShouldSortOutputCorrectly()
+        {
+            var output = new[]
+            {
+                "## master",
+                "?? GitHub.Unity.dll",
+                "?? GitHub.Unity.dll.mdb",
+                "?? GitHub.Unity.dll.mdb.meta",
+                "?? GitHub.Unity.dll.meta",
+                null
+            };
+
+            AssertProcessOutput(output, new GitStatus
+            {
+                LocalBranch = "master",
+                Entries = new List<GitStatusEntry>
+                {
+                    new GitStatusEntry(@"GitHub.Unity.dll", TestRootPath + @"\GitHub.Unity.dll", null, GitFileStatus.Untracked),
+                    new GitStatusEntry(@"GitHub.Unity.dll.meta", TestRootPath + @"\GitHub.Unity.dll.meta", null, GitFileStatus.Untracked),
+                    new GitStatusEntry(@"GitHub.Unity.dll.mdb", TestRootPath + @"\GitHub.Unity.dll.mdb", null, GitFileStatus.Untracked),
+                    new GitStatusEntry(@"GitHub.Unity.dll.mdb.meta", TestRootPath + @"\GitHub.Unity.dll.mdb.meta", null, GitFileStatus.Untracked),
+                }
+            });
+        }
+
+        [Test]
+        public void ShouldSortOutputCorrectly2()
+        {
+            var output = new[]
+            {
+                "## master",
+                "?? Assets/Assets.Test.dll",
+                "?? Assets/Assets.Test.dll.meta",
+                "?? Plugins/GitHub.Unity.dll",
+                "?? Plugins/GitHub.Unity.dll.mdb",
+                "?? Plugins/GitHub.Unity.dll.mdb.meta",
+                "?? Plugins/GitHub.Unity.dll.meta",
+                "?? blah.txt",
+                null
+            };
+
+            AssertProcessOutput(output, new GitStatus
+            {
+                LocalBranch = "master",
+                Entries = new List<GitStatusEntry>
+                {
+                    new GitStatusEntry(@"Assets/Assets.Test.dll", TestRootPath + @"\Assets/Assets.Test.dll", null, GitFileStatus.Untracked),
+                    new GitStatusEntry(@"Assets/Assets.Test.dll.meta", TestRootPath + @"\Assets/Assets.Test.dll.meta", null, GitFileStatus.Untracked),
+                    new GitStatusEntry(@"blah.txt", TestRootPath + @"\blah.txt", null, GitFileStatus.Untracked),
+                    new GitStatusEntry(@"Plugins/GitHub.Unity.dll", TestRootPath + @"\Plugins/GitHub.Unity.dll", null, GitFileStatus.Untracked),
+                    new GitStatusEntry(@"Plugins/GitHub.Unity.dll.meta", TestRootPath + @"\Plugins/GitHub.Unity.dll.meta", null, GitFileStatus.Untracked),
+                    new GitStatusEntry(@"Plugins/GitHub.Unity.dll.mdb", TestRootPath + @"\Plugins/GitHub.Unity.dll.mdb", null, GitFileStatus.Untracked),
+                    new GitStatusEntry(@"Plugins/GitHub.Unity.dll.mdb.meta", TestRootPath + @"\Plugins/GitHub.Unity.dll.mdb.meta", null, GitFileStatus.Untracked),
+                }
+            });
+        }
+
         private void AssertProcessOutput(IEnumerable<string> lines, GitStatus expected)
         {
             var gitObjectFactory = SubstituteFactory.CreateGitObjectFactory(TestRootPath);
@@ -262,4 +320,4 @@ private void AssertProcessOutput(IEnumerable<string> lines, GitStatus expected)
             result.Value.AssertEqual(expected);
         }
     }
-}
+}