Merge pull request #940 from github/release/2.3

Release 2.3

Author: shana

src/GitHub.App/SampleData/LocalRepositoryModelDesigner.cs

@@ -5,6 +5,7 @@
 using GitHub.Primitives;
 using GitHub.UI;
 using NullGuard;
+using GitHub.Exports;
 
 namespace GitHub.App.SampleData
 {
@@ -22,7 +23,7 @@ public class LocalRepositoryModelDesigner : ILocalRepositoryModel
         public event PropertyChangedEventHandler PropertyChanged;
 #pragma warning restore CS0067
 
-        public Task<UriString> GenerateUrl(string path = null, int startLine = -1, int endLine = -1)
+        public Task<UriString> GenerateUrl(LinkType linkType, string path = null, int startLine = -1, int endLine = -1)
         {
             throw new NotImplementedException();
         }

src/GitHub.Exports/Exports/ExportMetadata.cs

@@ -44,6 +44,15 @@ public enum MenuType
         OpenPullRequests
     }
 
+    /// <summary>
+    /// Defines the type of repository link to navigate to
+    /// </summary>
+    public enum LinkType
+    {
+        Blob,
+        Blame
+    }
+
     /// <summary>
     /// A MEF export attribute that defines an export of type <see cref="IViewModel"/> with
     /// <see cref="UIViewType"/> metadata.

src/GitHub.Exports/Models/ILocalRepositoryModel.cs

@@ -1,4 +1,5 @@
-using GitHub.Primitives;
+using GitHub.Exports;
+using GitHub.Primitives;
 using System.ComponentModel;
 using System.Threading.Tasks;
 
@@ -32,6 +33,6 @@ public interface ILocalRepositoryModel : IRepositoryModel, INotifyPropertyChange
         /// <param name="startLine">A specific line, or (if specifying the <paramref name="endLine"/> as well) the start of a range</param>
         /// <param name="endLine">The end of a line range on the specified file.</param>
         /// <returns>An UriString with the generated url, or null if the repository has no remote server configured or if it can't be found locally</returns>
-        Task<UriString> GenerateUrl(string path = null, int startLine = -1, int endLine = -1);
+        Task<UriString> GenerateUrl(LinkType linkType, string path = null, int startLine = -1, int endLine = -1);
     }
 }

src/GitHub.Exports/Models/LocalRepositoryModel.cs

@@ -8,6 +8,7 @@
 using GitHub.Services;
 using GitHub.Extensions;
 using System.Threading.Tasks;
+using GitHub.Exports;
 
 namespace GitHub.Models
 {
@@ -57,11 +58,12 @@ public void Refresh()
         /// Generates a http(s) url to the repository in the remote server, optionally
         /// pointing to a specific file and specific line range in it.
         /// </summary>
+        /// <param name="linkType">Type of link to generate</param>
         /// <param name="path">The file to generate an url to. Optional.</param>
         /// <param name="startLine">A specific line, or (if specifying the <paramref name="endLine"/> as well) the start of a range</param>
         /// <param name="endLine">The end of a line range on the specified file.</param>
         /// <returns>An UriString with the generated url, or null if the repository has no remote server configured or if it can't be found locally</returns>
-        public async Task<UriString> GenerateUrl(string path = null, int startLine = -1, int endLine = -1)
+        public async Task<UriString> GenerateUrl(LinkType linkType, string path = null, int startLine = -1, int endLine = -1)
         {
             if (CloneUrl == null)
                 return null;
@@ -97,22 +99,24 @@ public async Task<UriString> GenerateUrl(string path = null, int startLine = -1,
                 endLine = -1;
             }
 
-            return new UriString(GenerateUrl(CloneUrl.ToRepositoryUrl().AbsoluteUri, sha, path, startLine, endLine));
+            return new UriString(GenerateUrl(linkType, CloneUrl.ToRepositoryUrl().AbsoluteUri, sha, path, startLine, endLine));
         }
 
         const string CommitFormat = "{0}/commit/{1}";
         const string BlobFormat = "{0}/blob/{1}/{2}";
+        const string BlameFormat = "{0}/blame/{1}/{2}";
         const string StartLineFormat = "{0}#L{1}";
         const string EndLineFormat = "{0}-L{1}";
-        static string GenerateUrl(string basePath, string sha, string path, int startLine = -1, int endLine = -1)
+        static string GenerateUrl(LinkType linkType, string basePath, string sha, string path, int startLine = -1, int endLine = -1)
         {
             if (sha == null)
                 return basePath;
 
             if (String.IsNullOrEmpty(path))
                 return String.Format(CultureInfo.InvariantCulture, CommitFormat, basePath, sha);
 
-            var ret = String.Format(CultureInfo.InvariantCulture, BlobFormat, basePath, sha, path.Replace(@"\", "/"));
+            var ret = String.Format(CultureInfo.InvariantCulture, GetLinkFormat(linkType), basePath, sha, path.Replace(@"\", "/"));
+
             if (startLine < 0)
                 return ret;
             ret = String.Format(CultureInfo.InvariantCulture, StartLineFormat, ret, startLine);
@@ -121,6 +125,26 @@ static string GenerateUrl(string basePath, string sha, string path, int startLin
             return String.Format(CultureInfo.InvariantCulture, EndLineFormat, ret, endLine);
         }
 
+        /// <summary>
+        /// Selects the proper format for the link type, defaults to the blob url when link type is not selected.
+        /// </summary>
+        /// <param name="linkType">Type of link to generate</param>
+        /// <returns>The string format of the selected link type</returns>
+        static string GetLinkFormat(LinkType linkType)
+        {
+            switch (linkType)
+            {
+                case LinkType.Blame:
+                    return BlameFormat;
+
+                case LinkType.Blob:
+                    return BlobFormat;
+
+                default:
+                    return BlobFormat;
+            }
+        }
+
         /// <summary>
         /// Gets the local path of the repository.
         /// </summary>

src/GitHub.VisualStudio/GitHub.VisualStudio.csproj

@@ -303,6 +303,7 @@
     <Compile Include="AssemblyResolverPackage.cs" />
     <Compile Include="Helpers\VisualTreeExtensions.cs" />
     <Compile Include="IServiceProviderPackage.cs" />
+    <Compile Include="Menus\BlameLink.cs" />
     <Compile Include="Menus\MenuBase.cs" />
     <Compile Include="Menus\CreateGist.cs" />
     <Compile Include="Helpers\SharedDictionaryManager.cs" />

src/GitHub.VisualStudio/GitHub.VisualStudio.vsct

@@ -159,6 +159,17 @@
           <ButtonText>Copy link to clipboard</ButtonText>
         </Strings>
       </Button>
+
+      <Button guid="guidContextMenuSet" id="idBlameCommand" type="Button">
+        <Icon guid="guidImages" id="link_external" />
+        <CommandFlag>IconIsMoniker</CommandFlag>
+        <CommandFlag>DefaultInvisible</CommandFlag>
+        <CommandFlag>DynamicVisibility</CommandFlag>
+        <Strings>
+          <ButtonText>Blame</ButtonText>
+        </Strings>
+      </Button>
+      
     </Buttons>
 
   </Commands>
@@ -195,6 +206,11 @@
       <Parent guid="guidContextMenuSet" id="idGitHubContextSubMenuGroup"/>
     </CommandPlacement>
 
+    <CommandPlacement guid="guidContextMenuSet" id="idBlameCommand" priority="0x103">
+      <Parent guid="guidContextMenuSet" id="idGitHubContextSubMenuGroup"/>
+    </CommandPlacement>
+
+
     <!-- Standard toolbar commands -->
     <CommandPlacement guid="guidGitHubToolbarCmdSet" id="backCommand" priority="0x100">
       <Parent guid="guidGitHubToolbarCmdSet" id="idGitHubToolbarMenuGroup"/>
@@ -275,6 +291,8 @@
       <IDSymbol name="openLinkCommand" value="0x100" />
       <IDSymbol name="copyLinkCommand" value="0x101"/>
       <IDSymbol name="idCreateGistCommand" value="0x0400" />
+      <IDSymbol name="idBlameCommand" value="0x0500" />
+
     </GuidSymbol>
 
     <GuidSymbol name="GUID_XAML_EDITOR" value="{4C87B692-1202-46AA-B64C-EF01FAEC53DA}">

src/GitHub.VisualStudio/Menus/BlameLink.cs

@@ -0,0 +1,35 @@
+using GitHub.Exports;
+using GitHub.Services;
+using GitHub.VisualStudio.UI;
+using NullGuard;
+using System;
+using System.Windows;
+
+namespace GitHub.VisualStudio.Menus
+{
+    public class BlameLink : LinkMenuBase, IDynamicMenuHandler
+    {
+        public BlameLink(IGitHubServiceProvider serviceProvider)
+            : base(serviceProvider)
+        {
+        }
+
+        public Guid Guid => GuidList.guidContextMenuSet;
+        public int CmdId => PkgCmdIDList.blameCommand;
+
+        public async void Activate([AllowNull]object data = null)
+        {
+            var isgithub = await IsGitHubRepo();
+            if (!isgithub)
+                return;
+
+            var link = await GenerateLink(LinkType.Blame);
+            if (link == null)
+                return;
+            var browser = ServiceProvider.TryGetService<IVisualStudioBrowser>();
+            browser?.OpenUrl(link.ToUri());
+
+            await UsageTracker.IncrementOpenInGitHubCount();
+        }
+    }
+}

src/GitHub.VisualStudio/Menus/CopyLink.cs

@@ -1,4 +1,5 @@
-using GitHub.Services;
+using GitHub.Exports;
+using GitHub.Services;
 using GitHub.VisualStudio.UI;
 using NullGuard;
 using System;
@@ -23,7 +24,7 @@ public async void Activate([AllowNull]object data = null)
             if (!isgithub)
                 return;
 
-            var link = await GenerateLink();
+            var link = await GenerateLink(LinkType.Blob);
             if (link == null)
                 return;
             try
@@ -39,11 +40,5 @@ public async void Activate([AllowNull]object data = null)
                 ns?.ShowMessage(Resources.Error_FailedToCopyToClipboard);
             }
         }
-
-        public bool CanShow()
-        {
-            var githubRepoCheckTask = IsCurrentFileInGitHubRepository();
-            return githubRepoCheckTask.Wait(250) ? githubRepoCheckTask.Result : false;
-        }
     }
 }

src/GitHub.VisualStudio/Menus/LinkMenuBase.cs

@@ -1,4 +1,5 @@
-using GitHub.Primitives;
+using GitHub.Exports;
+using GitHub.Primitives;
 using GitHub.Services;
 using System;
 using System.Threading.Tasks;
@@ -30,13 +31,19 @@ protected async Task<bool> IsCurrentFileInGitHubRepository()
                 IsFileDescendantOfDirectory(activeDocument.Name, ActiveRepo.LocalPath);
         }
 
-        protected Task<UriString> GenerateLink()
+        protected Task<UriString> GenerateLink(LinkType linkType)
         {
             var repo = ActiveRepo;
             var activeDocument = ServiceProvider.TryGetService<IActiveDocumentSnapshot>();
             if (activeDocument == null)
                 return null;
-            return repo.GenerateUrl(activeDocument.Name, activeDocument.StartLine, activeDocument.EndLine);
+            return repo.GenerateUrl(linkType, activeDocument.Name, activeDocument.StartLine, activeDocument.EndLine);
+        }
+
+        public bool CanShow()
+        {
+            var githubRepoCheckTask = IsCurrentFileInGitHubRepository();
+            return githubRepoCheckTask.Wait(250) ? githubRepoCheckTask.Result : false;
         }
 
         // Taken from http://stackoverflow.com/a/26012991/6448

src/GitHub.VisualStudio/Menus/MenuProvider.cs

@@ -50,7 +50,8 @@ public MenuProvider(IGitHubServiceProvider serviceProvider)
             {
                 new CopyLink(serviceProvider),
                 new CreateGist(serviceProvider),
-                new OpenLink(serviceProvider)
+                new OpenLink(serviceProvider),
+                new BlameLink(serviceProvider)
             };
         }
     }