Merge pull request #227 from retailcoder/source_control

Source control API is solid.

Author: rubberduck203

RetailCoder.VBE/Interop/Branches.cs

@@ -9,23 +9,20 @@
 
 namespace Rubberduck.Interop
 {
-    [ComVisible(true)]
-    [Guid("24015981-B6A1-4416-983F-83D4AE51BDEA")]
-    public interface IBranches : IEnumerable{}
-
     [ComVisible(true)]
     [Guid("423A3B28-376B-4F96-A2E0-96E354965048")]
     [ProgId("Rubberduck.Branches")]
     [ClassInterface(ClassInterfaceType.None)]
     [System.ComponentModel.Description("Collection of string representation of branches in a repository.")]
-    public class Branches : IBranches
+    public class Branches : IEnumerable
     {
         private IEnumerable<string> branches;
         internal Branches(IEnumerable<string> branches)
         {
             this.branches = branches;
         }
 
+        [DispId(-4)]
         public IEnumerator GetEnumerator()
         {
             return branches.GetEnumerator();

RetailCoder.VBE/Interop/FileStatusEntries.cs

@@ -10,23 +10,20 @@
 
 namespace Rubberduck.Interop
 {
-    [ComVisible(true)]
-    [Guid("E7769AE2-7C28-425D-B833-544AD54D0534")]
-    public interface IFileStatusEntries : IEnumerable { }
-
     [ComVisible(true)]
     [Guid("E68A88BB-E15C-40D8-8D18-CAF7637312B5")]
     [ProgId("Rubberduck.FileStatusEntries")]
     [ClassInterface(ClassInterfaceType.None)]
     [System.ComponentModel.Description("Collection of IFileEntries representing the status of the repository files.")]
-    public class FileStatusEntries : IFileStatusEntries
+    public class FileStatusEntries : IEnumerable
     {
         private IEnumerable<IFileStatusEntry> entries;
         public FileStatusEntries(IEnumerable<IFileStatusEntry> entries)
         {
             this.entries = entries;
         }
 
+        [DispId(-4)]
         public IEnumerator GetEnumerator()
         {
             return entries.GetEnumerator();

RetailCoder.VBE/Interop/GitProvider.cs

@@ -27,13 +27,12 @@ public GitProvider(VBProject project, IRepository repository)
         public GitProvider(VBProject project, IRepository repository, string userName, string passWord)
             : base(project, repository, userName, passWord){}
 
-        private IBranches branches;
-        public new IBranches Branches
+        public new IEnumerable Branches
         {
             get { return new Branches(base.Branches); }
         }
 
-        public new IFileStatusEntries Status()
+        public new IEnumerable Status()
         {
             return new FileStatusEntries(base.Status());
         }

RetailCoder.VBE/Interop/ISourceControlProvider.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
@@ -19,7 +20,7 @@ public interface ISourceControlProvider
         string CurrentBranch { get; }
 
         [DispId(2)]
-        IBranches Branches { get; }
+        IEnumerable Branches { get; }
 
         [DispId(3)]
         IRepository Clone(string remotePathOrUrl, string workingDirectory);
@@ -64,6 +65,6 @@ public interface ISourceControlProvider
         void RemoveFile(string filePath);
 
         [DispId(17)]
-        IFileStatusEntries Status();
+        IEnumerable Status();
     }
 }

RetailCoder.VBE/Rubberduck.csproj

@@ -105,6 +105,7 @@
     <Compile Include="Interop\ISourceControlProvider.cs" />
     <Compile Include="Interop\SourceControlClassFactory.cs" />
     <Compile Include="SourceControl\FileStatus.cs" />
+    <Compile Include="SourceControl\FileStatusEntry.cs" />
     <Compile Include="UI\CodeExplorer\CodeExplorerNavigateArgs.cs" />
     <Compile Include="UI\Refactorings\ExtractMethod\ExtractedDeclarationUsage.cs" />
     <Compile Include="UI\Refactorings\ExtractMethod\ExtractedParameter.cs" />

RetailCoder.VBE/SourceControl/FileStatus.cs

@@ -2,39 +2,104 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
+using System.Threading.Tasks;
 using System.Runtime.InteropServices;
-using System.ComponentModel;
 
 namespace Rubberduck.SourceControl
 {
+    //This file was taken from the [Lib2GitSharp project][1] so this enum could be exposed to COM interop.
+    //Otherwise, this file remains unchanged.
+    //
+    //[1]:https://github.com/libgit2/libgit2sharp/
+    //
+    //The MIT License
+    //Copyright (c) LibGit2Sharp contributors
+    //
+    //Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), 
+    //to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, 
+    //and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+    //The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+    //
+    //THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
+    //FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
+    //WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+    /// <summary>
+    /// Calculated status of a filepath in the working directory.
+    /// </summary>
+    [Flags]
     [ComVisible(true)]
-    [Guid("577CB2D3-A84B-44FF-94EF-F4FC78363D74")]
-    public interface IFileStatusEntry
+    [Guid("4DDA743E-E3A7-440A-A030-92DF616B2C7B")]
+    public enum FileStatus
     {
-        [DispId(0)]
-        string FilePath { get; }
+        /// <summary>
+        /// The file doesn't exist.
+        /// </summary>
+        Nonexistent = (1 << 31),
 
-        //todo: find a way to make this com visible, even if you have to borrow the source code and cast (int) between them.
-        [DispId(1)]
-        LibGit2Sharp.FileStatus FileStatus { get; }
-    }
+        /// <summary>
+        /// The file hasn't been modified.
+        /// </summary>
+        Unaltered = 0, /* GIT_STATUS_CURRENT */
 
-    [ComVisible(true)]
-    [Guid("13AA3AF6-1397-4017-9E97-CBAD6A65FAFA")]
-    [ProgId("Rubberduck.FileStatus")]
-    [ClassInterface(ClassInterfaceType.AutoDual)]
-    public class FileStatusEntry : IFileStatusEntry
-    {
-        public string FilePath { get; private set; }
-        public LibGit2Sharp.FileStatus FileStatus { get; private set; }
+        /// <summary>
+        /// New file has been added to the Index. It's unknown from the Head.
+        /// </summary>
+        Added = (1 << 0), /* GIT_STATUS_INDEX_NEW */
+
+        /// <summary>
+        /// New version of a file has been added to the Index. A previous version exists in the Head.
+        /// </summary>
+        Staged = (1 << 1), /* GIT_STATUS_INDEX_MODIFIED */
+
+        /// <summary>
+        /// The deletion of a file has been promoted from the working directory to the Index. A previous version exists in the Head.
+        /// </summary>
+        Removed = (1 << 2), /* GIT_STATUS_INDEX_DELETED */
+
+        /// <summary>
+        /// The renaming of a file has been promoted from the working directory to the Index. A previous version exists in the Head.
+        /// </summary>
+        RenamedInIndex = (1 << 3), /* GIT_STATUS_INDEX_RENAMED */
+
+        /// <summary>
+        /// A change in type for a file has been promoted from the working directory to the Index. A previous version exists in the Head.
+        /// </summary>
+        StagedTypeChange = (1 << 4), /* GIT_STATUS_INDEX_TYPECHANGE */
+
+        /// <summary>
+        /// New file in the working directory, unknown from the Index and the Head.
+        /// </summary>
+        Untracked = (1 << 7), /* GIT_STATUS_WT_NEW */
+
+        /// <summary>
+        /// The file has been updated in the working directory. A previous version exists in the Index.
+        /// </summary>
+        Modified = (1 << 8), /* GIT_STATUS_WT_MODIFIED */
+
+        /// <summary>
+        /// The file has been deleted from the working directory. A previous version exists in the Index.
+        /// </summary>
+        Missing = (1 << 9), /* GIT_STATUS_WT_DELETED */
+
+        /// <summary>
+        /// The file type has been changed in the working directory. A previous version exists in the Index.
+        /// </summary>
+        TypeChanged = (1 << 10), /* GIT_STATUS_WT_TYPECHANGE */
+
+        /// <summary>
+        /// The file has been renamed in the working directory.  The previous version at the previous name exists in the Index.
+        /// </summary>
+        RenamedInWorkDir = (1 << 11), /* GIT_STATUS_WT_RENAMED */
 
-        public FileStatusEntry(string filePath, LibGit2Sharp.FileStatus fileStatus)
-        {
-            this.FilePath = filePath;
-            this.FileStatus = fileStatus;
-        }
+        /// <summary>
+        /// The file is unreadable in the working directory.
+        /// </summary>
+        Unreadable = (1 << 12), /* GIT_STATUS_WT_UNREADABLE */
 
-        public FileStatusEntry(LibGit2Sharp.StatusEntry status)
-            : this(status.FilePath, status.State) { }
+        /// <summary>
+        /// The file is <see cref="Untracked"/> but its name and/or path matches an exclude pattern in a <c>gitignore</c> file.
+        /// </summary>
+        Ignored = (1 << 14), /* GIT_STATUS_IGNORED */
     }
 }

RetailCoder.VBE/SourceControl/FileStatusEntry.cs

@@ -0,0 +1,51 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Runtime.InteropServices;
+using System.ComponentModel;
+
+namespace Rubberduck.SourceControl
+{
+    [ComVisible(true)]
+    [Guid("577CB2D3-A84B-44FF-94EF-F4FC78363D74")]
+    public interface IFileStatusEntry
+    {
+        [DispId(0)]
+        string FilePath { get; }
+
+        //todo: find a way to make this com visible, even if you have to borrow the source code and cast (int) between them.
+        [DispId(1)]
+        FileStatus FileStatus { get; }
+    }
+
+    [ComVisible(true)]
+    [Guid("13AA3AF6-1397-4017-9E97-CBAD6A65FAFA")]
+    [ProgId("Rubberduck.FileStatus")]
+    [ClassInterface(ClassInterfaceType.AutoDual)]
+    public class FileStatusEntry : IFileStatusEntry
+    {
+        public string FilePath { get; private set; }
+        public FileStatus FileStatus { get; private set; }
+
+        private FileStatusEntry(string filePath)
+        {
+            this.FilePath = filePath;
+        }
+
+        public FileStatusEntry(string filePath, LibGit2Sharp.FileStatus fileStatus)
+            :this(filePath)
+        {
+            this.FileStatus = (SourceControl.FileStatus)fileStatus;
+        }
+
+        public FileStatusEntry(string filePath, SourceControl.FileStatus fileStatus)
+            :this(filePath)
+        {
+            this.FileStatus = fileStatus;
+        }
+
+        public FileStatusEntry(LibGit2Sharp.StatusEntry status)
+            : this(status.FilePath, status.State) { }
+    }
+}