Merge branch 'master' into feature/inline-reviews-commentbubble

Author: jcansdale

src/GitHub.App/Factories/HostCacheFactory.cs

@@ -1,17 +1,22 @@
 using System;
 using System.ComponentModel.Composition;
 using System.IO;
+using System.Reactive.Linq;
 using Akavache;
 using GitHub.Primitives;
 using Rothko;
 using GitHub.Extensions;
+using System.Threading.Tasks;
 
 namespace GitHub.Factories
 {
     [Export(typeof(IHostCacheFactory))]
     [PartCreationPolicy(CreationPolicy.Shared)]
     public class HostCacheFactory : IHostCacheFactory
     {
+        const int CacheVersion = 1;
+        const string CacheVersionKey = "cacheVersion";
+
         readonly Lazy<IBlobCacheFactory> blobCacheFactory;
         readonly Lazy<IOperatingSystem> operatingSystem;
 
@@ -22,7 +27,7 @@ public HostCacheFactory(Lazy<IBlobCacheFactory> blobCacheFactory, Lazy<IOperatin
             this.operatingSystem = operatingSystem;
         }
 
-        public IBlobCache Create(HostAddress hostAddress)
+        public async Task<IBlobCache> Create(HostAddress hostAddress)
         {
             var environment = OperatingSystem.Environment;
             // For GitHub.com, the cache file name should be "api.github.com.cache.db"
@@ -34,7 +39,17 @@ public IBlobCache Create(HostAddress hostAddress)
 
             // CreateDirectory is a noop if the directory already exists.
             OperatingSystem.Directory.CreateDirectory(Path.GetDirectoryName(userAccountPath));
-            return BlobCacheFactory.CreateBlobCache(userAccountPath);
+
+            var cache = BlobCacheFactory.CreateBlobCache(userAccountPath);
+            var version = await cache.GetOrCreateObject<int>(CacheVersionKey, () => 0);
+
+            if (version != CacheVersion)
+            {
+                await cache.InvalidateAll();
+                await cache.InsertObject(CacheVersionKey, CacheVersion);
+            }
+
+            return cache;
         }
 
         IOperatingSystem OperatingSystem { get { return operatingSystem.Value; } }

src/GitHub.App/Factories/IHostCacheFactory.cs

@@ -1,11 +1,12 @@
 using Akavache;
 using GitHub.Primitives;
 using System;
+using System.Threading.Tasks;
 
 namespace GitHub.Factories
 {
     public interface IHostCacheFactory : IDisposable
     {
-        IBlobCache Create(HostAddress hostAddress);
+        Task<IBlobCache> Create(HostAddress hostAddress);
     }
 }

src/GitHub.App/Factories/RepositoryHostFactory.cs

@@ -44,7 +44,7 @@ public RepositoryHostFactory(
         public async Task<IRepositoryHost> Create(HostAddress hostAddress)
         {
             var apiClient = await apiClientFactory.Create(hostAddress);
-            var hostCache = hostCacheFactory.Create(hostAddress);
+            var hostCache = await hostCacheFactory.Create(hostAddress);
             var modelService = new ModelService(apiClient, hostCache, avatarProvider);
             var host = new RepositoryHost(apiClient, modelService, loginManager, loginCache, usage);
             hosts.Add(host);

src/GitHub.App/Services/GitClient.cs

@@ -296,7 +296,7 @@ public Task<string> ExtractFile(IRepository repository, string commitSha, string
             return Task.Factory.StartNew(() =>
             {
                 var commit = repository.Lookup<Commit>(commitSha);
-                if(commit == null)
+                if (commit == null)
                 {
                     throw new FileNotFoundException("Couldn't find '" + fileName + "' at commit " + commitSha + ".");
                 }

src/GitHub.Extensions/StringExtensions.cs

@@ -180,21 +180,6 @@ public static string Wrap(this string text, int maxLength = 72)
             return sb.ToString();
         }
 
-        public static bool EqualsIgnoringLineEndings(this string a, string b)
-        {
-            if (ReferenceEquals(a, b))
-                return true;
-
-            if (a == null || b == null)
-                return false;
-
-            // TODO: Write a non-allocating comparison.
-            a = a.Replace("\r\n", "\n");
-            b = b.Replace("\r\n", "\n");
-
-            return a == b;
-        }
-
         public static Uri ToUriSafe(this string url)
         {
             Uri uri;

src/GitHub.InlineReviews/Commands/InlineCommentNavigationCommand.cs

@@ -49,7 +49,7 @@ public override bool IsEnabled
             get
             {
                 var tags = GetTags(GetCurrentTextViews());
-                return tags.Count > 1;
+                return tags.Count > 0;
             }
         }
 

src/GitHub.InlineReviews/Glyph/GlyphData.cs

@@ -5,6 +5,10 @@
 
 namespace GitHub.InlineReviews.Glyph.Implementation
 {
+    /// <summary>
+    /// Information about the position of a glyph.
+    /// </summary>
+    /// <typeparam name="TGlyphTag">The type of glyph tag we're dealing with.</typeparam>
     internal class GlyphData<TGlyphTag>
     {
         double deltaY;

src/GitHub.InlineReviews/Glyph/GlyphMargin.cs

@@ -12,6 +12,10 @@
 
 namespace GitHub.InlineReviews.Glyph
 {
+    /// <summary>
+    /// Responsibe for updating the margin when tags change.
+    /// </summary>
+    /// <typeparam name="TGlyphTag">The type of glyph tag we're managing.</typeparam>
     public sealed class GlyphMargin<TGlyphTag> : IWpfTextViewMargin, ITextViewMargin, IDisposable where TGlyphTag: ITag
     {
         bool handleZoom;

src/GitHub.InlineReviews/Glyph/GlyphMarginVisualManager.cs

@@ -12,6 +12,10 @@
 
 namespace GitHub.InlineReviews.Glyph.Implementation
 {
+    /// <summary>
+    /// Manage the MarginVisual element.
+    /// </summary>
+    /// <typeparam name="TGlyphTag">The type of tag we're managing.</typeparam>
     internal class GlyphMarginVisualManager<TGlyphTag> where TGlyphTag: ITag
     {
         readonly IEditorFormatMap editorFormatMap;
@@ -52,8 +56,6 @@ public GlyphMarginVisualManager(IWpfTextView textView, IGlyphFactory<TGlyphTag>
             }
         }
 
-        public FrameworkElement MarginVisual => glyphMarginGrid;
-
         public void AddGlyph(TGlyphTag tag, SnapshotSpan span)
         {
             var textViewLines = textView.TextViewLines;
@@ -132,6 +134,7 @@ public void SetSnapshotAndUpdate(ITextSnapshot snapshot, IList<ITextViewLine> ne
                 glyphs = dictionary;
             }
         }
+
         static ITextViewLine GetStartingLine(IList<ITextViewLine> lines, Span span)
         {
             if (lines.Count > 0)
@@ -191,6 +194,8 @@ void UpdateBackgroundColor()
                 ImageThemingUtilities.SetImageBackgroundColor(glyphMarginGrid, backgroundColor);
             }
         }
+
+        public FrameworkElement MarginVisual => glyphMarginGrid;
     }
 }
 

src/GitHub.InlineReviews/Glyph/IGlyphFactory.cs

@@ -6,10 +6,24 @@
 
 namespace GitHub.InlineReviews.Glyph
 {
+    /// <summary>
+    /// A factory for a type of tag (or multiple subtypes).
+    /// </summary>
+    /// <typeparam name="TGlyphTag"></typeparam>
     public interface IGlyphFactory<TGlyphTag> where TGlyphTag : ITag
     {
+        /// <summary>
+        /// Create a glyph element for a particular line and tag.
+        /// </summary>
+        /// <param name="line">The line.</param>
+        /// <param name="tag">The tag.</param>
+        /// <returns></returns>
         UIElement GenerateGlyph(IWpfTextViewLine line, TGlyphTag tag);
 
+        /// <summary>
+        /// A list of tag subtypes this is a factory for.
+        /// </summary>
+        /// <returns></returns>
         IEnumerable<Type> GetTagTypes();
     }
 }