Store keys in InlineCommentTextViewOptions

jcansdale · jcansdale · commit 3d7d1c543ab4 · 2018-05-15T21:17:53.000+01:00
Use InlineCommentTextViewOptions for typed editor option keys.
diff --git a/src/GitHub.InlineReviews/Commands/ToggleInlineCommentMarginCommand.cs b/src/GitHub.InlineReviews/Commands/ToggleInlineCommentMarginCommand.cs
@@ -27,19 +27,16 @@ public class ToggleInlineCommentMarginCommand : VsCommand, IToggleInlineCommentM
 
         readonly Lazy<IVsTextManager> textManager;
         readonly Lazy<IVsEditorAdaptersFactoryService> editorAdapter;
-        readonly Lazy<InlineCommentMarginEnabled> inlineCommentMarginEnabled;
         readonly Lazy<IUsageTracker> usageTracker;
 
         [ImportingConstructor]
         public ToggleInlineCommentMarginCommand(
             IGitHubServiceProvider serviceProvider,
             Lazy<IVsEditorAdaptersFactoryService> editorAdapter,
-            Lazy<InlineCommentMarginEnabled> inlineCommentMarginEnabled,
             Lazy<IUsageTracker> usageTracker) : base(CommandSet, CommandId)
         {
             textManager = new Lazy<IVsTextManager>(() => serviceProvider.GetService<SVsTextManager, IVsTextManager>());
             this.editorAdapter = editorAdapter;
-            this.inlineCommentMarginEnabled = inlineCommentMarginEnabled;
             this.usageTracker = usageTracker;
         }
 
@@ -52,8 +49,8 @@ public override Task Execute()
             {
                 var wpfTextView = editorAdapter.Value.GetWpfTextView(activeView);
                 var options = wpfTextView.Options;
-                var enabled = options.GetOptionValue(inlineCommentMarginEnabled.Value.Key);
-                options.SetOptionValue(inlineCommentMarginEnabled.Value.Key, !enabled);
+                var enabled = options.GetOptionValue(InlineCommentTextViewOptions.MarginEnabledId);
+                options.SetOptionValue(InlineCommentTextViewOptions.MarginEnabledId, !enabled);
             }
 
             return Task.CompletedTask;
diff --git a/src/GitHub.InlineReviews/GitHub.InlineReviews.csproj b/src/GitHub.InlineReviews/GitHub.InlineReviews.csproj
@@ -73,6 +73,7 @@
     <Compile Include="Commands\InlineCommentNavigationCommand.cs" />
     <Compile Include="Commands\PreviousInlineCommentCommand.cs" />
     <Compile Include="Commands\NextInlineCommentCommand.cs" />
+    <Compile Include="Margins\InlineCommentTextViewOptions.cs" />
     <Compile Include="Margins\PullRequestFileMargin.cs" />
     <Compile Include="Margins\PullRequestFileMarginProvider.cs" />
     <Compile Include="Glyph\GlyphData.cs" />
diff --git a/src/GitHub.InlineReviews/Margins/InlineCommentMargin.cs b/src/GitHub.InlineReviews/Margins/InlineCommentMargin.cs
@@ -4,7 +4,6 @@
 using System.Threading.Tasks;
 using GitHub.Models;
 using GitHub.Services;
-using GitHub.Settings;
 using GitHub.Extensions;
 using GitHub.InlineReviews.Tags;
 using GitHub.InlineReviews.Views;
@@ -24,7 +23,6 @@ public sealed class InlineCommentMargin : IWpfTextViewMargin
 
         readonly IWpfTextView textView;
         readonly IPullRequestSessionManager sessionManager;
-        readonly InlineCommentMarginEnabled inlineCommentMarginEnabled;
         readonly Grid marginGrid;
 
         GlyphMargin<InlineCommentTag> glyphMargin;
@@ -38,15 +36,13 @@ public InlineCommentMargin(
             IInlineCommentPeekService peekService,
             IEditorFormatMapService editorFormatMapService,
             IViewTagAggregatorFactoryService tagAggregatorFactory,
-            Lazy<IPullRequestSessionManager> sessionManager,
-            InlineCommentMarginEnabled inlineCommentMarginEnabled)
+            Lazy<IPullRequestSessionManager> sessionManager)
         {
             textView = wpfTextViewHost.TextView;
             this.sessionManager = sessionManager.Value;
-            this.inlineCommentMarginEnabled = inlineCommentMarginEnabled;
 
             // Default to not show comment margin
-            textView.Options.SetOptionValue(inlineCommentMarginEnabled.Key, false);
+            textView.Options.SetOptionValue(InlineCommentTextViewOptions.MarginEnabledId, false);
 
             marginGrid = new GlyphMarginGrid { Width = 17.0 };
             var glyphFactory = new InlineCommentGlyphFactory(peekService, textView);
@@ -64,7 +60,7 @@ public InlineCommentMargin(
                 .Subscribe(x => RefreshCurrentSession().Forget());
 
             visibleSubscription = marginGrid.WhenAnyValue(x => x.IsVisible)
-                .Subscribe(x => textView.Options.SetOptionValue(InlineCommentMarginVisible.OptionName, x));
+                .Subscribe(x => textView.Options.SetOptionValue(InlineCommentTextViewOptions.MarginVisibleId, x));
 
             textView.Options.OptionChanged += (s, e) => RefreshMarginVisibility();
         }
@@ -138,7 +134,7 @@ void RefreshMarginVisibility()
 
         bool IsMarginVisible()
         {
-            var enabled = textView.Options.GetOptionValue(inlineCommentMarginEnabled.Key);
+            var enabled = textView.Options.GetOptionValue(InlineCommentTextViewOptions.MarginEnabledId);
             return hasInfo || (enabled && hasChanges);
         }
     }
diff --git a/src/GitHub.InlineReviews/Margins/InlineCommentMarginEnabled.cs b/src/GitHub.InlineReviews/Margins/InlineCommentMarginEnabled.cs
@@ -1,18 +1,13 @@
-﻿using System;
-using System.ComponentModel.Composition;
-using Microsoft.VisualStudio.Utilities;
+﻿using System.ComponentModel.Composition;
 using Microsoft.VisualStudio.Text.Editor;
 
 namespace GitHub.InlineReviews.Margins
 {
-    [Export(typeof(InlineCommentMarginEnabled))]
-    [Export(typeof(EditorOptionDefinition)), Name(OptionName)]
+    [Export(typeof(EditorOptionDefinition))]
     public class InlineCommentMarginEnabled : ViewOptionDefinition<bool>
     {
-        const string OptionName = "TextViewHost/InlineCommentMarginEnabled";
-
         public override bool Default => false;
 
-        public override EditorOptionKey<bool> Key => new EditorOptionKey<bool>(OptionName);
+        public override EditorOptionKey<bool> Key => InlineCommentTextViewOptions.MarginEnabledId;
     }
 }
diff --git a/src/GitHub.InlineReviews/Margins/InlineCommentMarginProvider.cs b/src/GitHub.InlineReviews/Margins/InlineCommentMarginProvider.cs
@@ -6,7 +6,6 @@
 using Microsoft.VisualStudio.Text.Classification;
 using GitHub.InlineReviews.Services;
 using GitHub.Services;
-using GitHub.Settings;
 
 namespace GitHub.InlineReviews.Margins
 {
@@ -22,28 +21,24 @@ internal sealed class InlineCommentMarginProvider : IWpfTextViewMarginProvider
         readonly IViewTagAggregatorFactoryService tagAggregatorFactory;
         readonly IInlineCommentPeekService peekService;
         readonly Lazy<IPullRequestSessionManager> sessionManager;
-        readonly InlineCommentMarginEnabled inlineCommentMarginEnabled;
 
         [ImportingConstructor]
         public InlineCommentMarginProvider(
-            Lazy<IPullRequestSessionManager> sessionManager,
+            IGitHubServiceProvider serviceProvider,
             IEditorFormatMapService editorFormatMapService,
             IViewTagAggregatorFactoryService tagAggregatorFactory,
-            IInlineCommentPeekService peekService,
-            InlineCommentMarginEnabled inlineCommentMarginEnabled)
+            IInlineCommentPeekService peekService)
         {
             this.editorFormatMapService = editorFormatMapService;
             this.tagAggregatorFactory = tagAggregatorFactory;
             this.peekService = peekService;
-            this.sessionManager = sessionManager;
-            this.inlineCommentMarginEnabled = inlineCommentMarginEnabled;
+            sessionManager = new Lazy<IPullRequestSessionManager>(() => serviceProvider.GetService<IPullRequestSessionManager>());
         }
 
         public IWpfTextViewMargin CreateMargin(IWpfTextViewHost wpfTextViewHost, IWpfTextViewMargin parent)
         {
             return new InlineCommentMargin(
-                wpfTextViewHost, peekService, editorFormatMapService, tagAggregatorFactory, sessionManager,
-                inlineCommentMarginEnabled);
+                wpfTextViewHost, peekService, editorFormatMapService, tagAggregatorFactory, sessionManager);
         }
     }
 }
diff --git a/src/GitHub.InlineReviews/Margins/InlineCommentMarginVisible.cs b/src/GitHub.InlineReviews/Margins/InlineCommentMarginVisible.cs
@@ -1,18 +1,13 @@
-﻿using System;
-using System.ComponentModel.Composition;
-using Microsoft.VisualStudio.Utilities;
+﻿using System.ComponentModel.Composition;
 using Microsoft.VisualStudio.Text.Editor;
 
 namespace GitHub.InlineReviews.Margins
 {
     [Export(typeof(EditorOptionDefinition))]
-    [Name(OptionName)]
     public class InlineCommentMarginVisible : ViewOptionDefinition<bool>
     {
-        public const string OptionName = "TextViewHost/InlineCommentMarginVisible";
-
         public override bool Default => false;
 
-        public override EditorOptionKey<bool> Key => new EditorOptionKey<bool>(OptionName);
+        public override EditorOptionKey<bool> Key => InlineCommentTextViewOptions.MarginVisibleId;
     }
 }
diff --git a/src/GitHub.InlineReviews/Margins/InlineCommentTextViewOptions.cs b/src/GitHub.InlineReviews/Margins/InlineCommentTextViewOptions.cs
@@ -0,0 +1,11 @@
+﻿using Microsoft.VisualStudio.Text.Editor;
+
+namespace GitHub.InlineReviews.Margins
+{
+    public static class InlineCommentTextViewOptions
+    {
+        public static EditorOptionKey<bool> MarginVisibleId = new EditorOptionKey<bool>("TextViewHost/InlineCommentMarginVisible");
+
+        public static EditorOptionKey<bool> MarginEnabledId = new EditorOptionKey<bool>("TextViewHost/InlineCommentMarginEnabled");
+    }
+}
diff --git a/src/GitHub.InlineReviews/Margins/PullRequestFileMargin.cs b/src/GitHub.InlineReviews/Margins/PullRequestFileMargin.cs
@@ -38,7 +38,6 @@ public PullRequestFileMargin(
             IToggleInlineCommentMarginCommand toggleInlineCommentMarginCommand,
             IGoToSolutionOrPullRequestFileCommand goToSolutionOrPullRequestFileCommand,
             IPullRequestSessionManager sessionManager,
-            InlineCommentMarginEnabled inlineCommentMarginEnabled,
             Lazy<IUsageTracker> usageTracker)
         {
             this.textView = textView;
@@ -54,7 +53,7 @@ public PullRequestFileMargin(
 
             optionChangedSubscription = Observable.FromEventPattern(textView.Options, nameof(textView.Options.OptionChanged)).Subscribe(_ =>
             {
-                viewModel.MarginEnabled = textView.Options.GetOptionValue(inlineCommentMarginEnabled.Key);
+                viewModel.MarginEnabled = textView.Options.GetOptionValue(InlineCommentTextViewOptions.MarginEnabledId);
             });
 
             currentSessionSubscription = sessionManager.WhenAnyValue(x => x.CurrentSession)
diff --git a/src/GitHub.InlineReviews/Margins/PullRequestFileMarginProvider.cs b/src/GitHub.InlineReviews/Margins/PullRequestFileMarginProvider.cs
@@ -23,7 +23,6 @@ internal sealed class PullRequestFileMarginProvider : IWpfTextViewMarginProvider
         readonly IToggleInlineCommentMarginCommand enableInlineCommentsCommand;
         readonly IGoToSolutionOrPullRequestFileCommand goToSolutionOrPullRequestFileCommand;
         readonly IPackageSettings packageSettings;
-        readonly InlineCommentMarginEnabled inlineCommentMarginEnabled;
         readonly Lazy<IUsageTracker> usageTracker;
 
         [ImportingConstructor]
@@ -32,14 +31,12 @@ public PullRequestFileMarginProvider(
             IGoToSolutionOrPullRequestFileCommand goToSolutionOrPullRequestFileCommand,
             IPullRequestSessionManager sessionManager,
             IPackageSettings packageSettings,
-            InlineCommentMarginEnabled inlineCommentMarginEnabled,
             Lazy<IUsageTracker> usageTracker)
         {
             this.enableInlineCommentsCommand = enableInlineCommentsCommand;
             this.goToSolutionOrPullRequestFileCommand = goToSolutionOrPullRequestFileCommand;
             this.sessionManager = sessionManager;
             this.packageSettings = packageSettings;
-            this.inlineCommentMarginEnabled = inlineCommentMarginEnabled;
             this.usageTracker = usageTracker;
         }
 
@@ -66,8 +63,7 @@ public IWpfTextViewMargin CreateMargin(IWpfTextViewHost wpfTextViewHost, IWpfTex
             }
 
             return new PullRequestFileMargin(
-                wpfTextViewHost.TextView, enableInlineCommentsCommand, goToSolutionOrPullRequestFileCommand,
-                sessionManager, inlineCommentMarginEnabled, usageTracker);
+                wpfTextViewHost.TextView, enableInlineCommentsCommand, goToSolutionOrPullRequestFileCommand, sessionManager, usageTracker);
         }
 
         bool IsDiffView(ITextView textView) => textView.Roles.Contains("DIFF");
diff --git a/src/GitHub.InlineReviews/Tags/InlineCommentTagger.cs b/src/GitHub.InlineReviews/Tags/InlineCommentTagger.cs
@@ -175,7 +175,7 @@ async Task InitializeLiveFile()
                     Observable.FromEventPattern<EditorOptionChangedEventArgs>(options, nameof(options.OptionChanged))
                     .Select(_ => Unit.Default)
                     .StartWith(Unit.Default)
-                    .Select(x => options.GetOptionValue<bool>(InlineCommentMarginVisible.OptionName))
+                    .Select(x => options.GetOptionValue(InlineCommentTextViewOptions.MarginVisibleId))
                     .DistinctUntilChanged()
                     .Subscribe(VisibleChanged);
             }
diff --git a/test/GitHub.InlineReviews.UnitTests/Tags/InlineCommentTaggerTests.cs b/test/GitHub.InlineReviews.UnitTests/Tags/InlineCommentTaggerTests.cs
@@ -3,7 +3,6 @@
 using System.Linq;
 using System.Reactive.Subjects;
 using System.Threading.Tasks;
-using GitHub.InlineReviews.Services;
 using GitHub.InlineReviews.Tags;
 using GitHub.Models;
 using GitHub.Services;
@@ -354,7 +353,7 @@ public void ShouldNotRaiseTagsChangedOnLeftHandSideLinesChanged()
             static ITextView CreateTextView(bool inlineCommentMarginVisible = true)
             {
                 var textView = Substitute.For<ITextView>();
-                textView.Options.GetOptionValue<bool>(InlineCommentMarginVisible.OptionName).Returns(inlineCommentMarginVisible);
+                textView.Options.GetOptionValue(InlineCommentTextViewOptions.MarginVisibleId).Returns(inlineCommentMarginVisible);
                 return textView;
             }
 

Original file line number	Diff line number	Diff line change
`@@ -1,18 +1,13 @@`
`1`		`-using System;`
`2`		`-using System.ComponentModel.Composition;`
`3`		`-using Microsoft.VisualStudio.Utilities;`
	`1`	`+using System.ComponentModel.Composition;`
`4`	`2`	`using Microsoft.VisualStudio.Text.Editor;`
`5`	`3`
`6`	`4`	`namespace GitHub.InlineReviews.Margins`
`7`	`5`	`{`
`8`		`- [Export(typeof(InlineCommentMarginEnabled))]`
`9`		`- [Export(typeof(EditorOptionDefinition)), Name(OptionName)]`
	`6`	`+ [Export(typeof(EditorOptionDefinition))]`
`10`	`7`	`public class InlineCommentMarginEnabled : ViewOptionDefinition<bool>`
`11`	`8`	`{`
`12`		`- const string OptionName = "TextViewHost/InlineCommentMarginEnabled";`
`13`		`-`
`14`	`9`	`public override bool Default => false;`
`15`	`10`
`16`		`- public override EditorOptionKey<bool> Key => new EditorOptionKey<bool>(OptionName);`
	`11`	`+ public override EditorOptionKey<bool> Key => InlineCommentTextViewOptions.MarginEnabledId;`
`17`	`12`	`}`
`18`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,6 @@`
`6`	`6`	`using Microsoft.VisualStudio.Text.Classification;`
`7`	`7`	`using GitHub.InlineReviews.Services;`
`8`	`8`	`using GitHub.Services;`
`9`		`-using GitHub.Settings;`
`10`	`9`
`11`	`10`	`namespace GitHub.InlineReviews.Margins`
`12`	`11`	`{`
`@@ -22,28 +21,24 @@ internal sealed class InlineCommentMarginProvider : IWpfTextViewMarginProvider`
`22`	`21`	`readonly IViewTagAggregatorFactoryService tagAggregatorFactory;`
`23`	`22`	`readonly IInlineCommentPeekService peekService;`
`24`	`23`	`readonly Lazy<IPullRequestSessionManager> sessionManager;`
`25`		`- readonly InlineCommentMarginEnabled inlineCommentMarginEnabled;`
`26`	`24`
`27`	`25`	`[ImportingConstructor]`
`28`	`26`	`public InlineCommentMarginProvider(`
`29`		`- Lazy<IPullRequestSessionManager> sessionManager,`
	`27`	`+ IGitHubServiceProvider serviceProvider,`
`30`	`28`	`IEditorFormatMapService editorFormatMapService,`
`31`	`29`	`IViewTagAggregatorFactoryService tagAggregatorFactory,`
`32`		`- IInlineCommentPeekService peekService,`
`33`		`- InlineCommentMarginEnabled inlineCommentMarginEnabled)`
	`30`	`+ IInlineCommentPeekService peekService)`
`34`	`31`	`{`
`35`	`32`	`this.editorFormatMapService = editorFormatMapService;`
`36`	`33`	`this.tagAggregatorFactory = tagAggregatorFactory;`
`37`	`34`	`this.peekService = peekService;`
`38`		`- this.sessionManager = sessionManager;`
`39`		`- this.inlineCommentMarginEnabled = inlineCommentMarginEnabled;`
	`35`	`+ sessionManager = new Lazy<IPullRequestSessionManager>(() => serviceProvider.GetService<IPullRequestSessionManager>());`
`40`	`36`	`}`
`41`	`37`
`42`	`38`	`public IWpfTextViewMargin CreateMargin(IWpfTextViewHost wpfTextViewHost, IWpfTextViewMargin parent)`
`43`	`39`	`{`
`44`	`40`	`return new InlineCommentMargin(`
`45`		`- wpfTextViewHost, peekService, editorFormatMapService, tagAggregatorFactory, sessionManager,`
`46`		`- inlineCommentMarginEnabled);`
	`41`	`+ wpfTextViewHost, peekService, editorFormatMapService, tagAggregatorFactory, sessionManager);`
`47`	`42`	`}`
`48`	`43`	`}`
`49`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,6 @@ public PullRequestFileMargin(`
`38`	`38`	`IToggleInlineCommentMarginCommand toggleInlineCommentMarginCommand,`
`39`	`39`	`IGoToSolutionOrPullRequestFileCommand goToSolutionOrPullRequestFileCommand,`
`40`	`40`	`IPullRequestSessionManager sessionManager,`
`41`		`- InlineCommentMarginEnabled inlineCommentMarginEnabled,`
`42`	`41`	`Lazy<IUsageTracker> usageTracker)`
`43`	`42`	`{`
`44`	`43`	`this.textView = textView;`
`@@ -54,7 +53,7 @@ public PullRequestFileMargin(`
`54`	`53`
`55`	`54`	`optionChangedSubscription = Observable.FromEventPattern(textView.Options, nameof(textView.Options.OptionChanged)).Subscribe(_ =>`
`56`	`55`	`{`
`57`		`- viewModel.MarginEnabled = textView.Options.GetOptionValue(inlineCommentMarginEnabled.Key);`
	`56`	`+ viewModel.MarginEnabled = textView.Options.GetOptionValue(InlineCommentTextViewOptions.MarginEnabledId);`
`58`	`57`	`});`
`59`	`58`
`60`	`59`	`currentSessionSubscription = sessionManager.WhenAnyValue(x => x.CurrentSession)`
Original file line number	Diff line number	Diff line change
`@@ -175,7 +175,7 @@ async Task InitializeLiveFile()`
`175`	`175`	`Observable.FromEventPattern<EditorOptionChangedEventArgs>(options, nameof(options.OptionChanged))`
`176`	`176`	`.Select(_ => Unit.Default)`
`177`	`177`	`.StartWith(Unit.Default)`
`178`		`- .Select(x => options.GetOptionValue<bool>(InlineCommentMarginVisible.OptionName))`
	`178`	`+ .Select(x => options.GetOptionValue(InlineCommentTextViewOptions.MarginVisibleId))`
`179`	`179`	`.DistinctUntilChanged()`
`180`	`180`	`.Subscribe(VisibleChanged);`
`181`	`181`	`}`