Add support for enabling individual experimental features

Hosch250 · Hosch250 · commit 5e3e6469bf37 · 2017-12-22T12:03:50.000-06:00
diff --git a/RetailCoder.VBE/Navigation/CodeExplorer/CodeExplorerViewModel.cs b/RetailCoder.VBE/Navigation/CodeExplorer/CodeExplorerViewModel.cs
@@ -558,7 +558,7 @@ private void ExecuteRemoveComand(object param)
 
         public Visibility ExportAllVisibility => CanExecuteExportAllCommand ? Visibility.Visible : Visibility.Collapsed;
 
-        public bool EnableExperimentalFeatures => _generalSettings.EnableExperimentalFeatures;
+        public bool EnableSourceControl => _generalSettings.EnableExperimentalFeatures.Any(a => a.Key == RubberduckUI.GeneralSettings_EnableSourceControl);
 
         public Visibility TreeViewVisibility => Projects == null || Projects.Count == 0 ? Visibility.Collapsed : Visibility.Visible;
 
diff --git a/RetailCoder.VBE/Root/RubberduckIoCInstaller.cs b/RetailCoder.VBE/Root/RubberduckIoCInstaller.cs
@@ -44,7 +44,6 @@
 using Rubberduck.VBEditor.SafeComWrappers.Office.Core.Abstract;
 using Component = Castle.MicroKernel.Registration.Component;
 using Rubberduck.UI.CodeMetrics;
-using Rubberduck.Navigation.CodeMetrics;
 using Rubberduck.Parsing.Common;
 
 namespace Rubberduck.Root
@@ -157,7 +156,14 @@ private void RegisterConfiguration(IWindsorContainer container, Assembly[] assem
             foreach (var assembly in assembliesToRegister)
             {
                 var assemblyTypes = assembly.DefinedTypes
-                    .Where(w => _initialSettings.EnableExperimentalFeatures || !Attribute.IsDefined(w, typeof(ExperimentalAttribute)));
+                    .Where(w =>
+                    {
+                        var attribute = w.CustomAttributes.FirstOrDefault(f => f.AttributeType == typeof(ExperimentalAttribute));
+                        var ctorArg = attribute?.ConstructorArguments.Any() == true ? (string) attribute.ConstructorArguments.First().Value : string.Empty;
+
+                        return attribute == null ||
+                               _initialSettings.EnableExperimentalFeatures.Any(a => a.Key == ctorArg && a.IsEnabled);
+                    });
 
                 container.Register(Classes.From(assemblyTypes)
                     .InSameNamespaceAs<Configuration>()
@@ -190,7 +196,14 @@ private void ApplyDefaultInterfaceConvention(IWindsorContainer container, Assemb
             foreach (var assembly in assembliesToRegister)
             {
                 var assemblyTypes = assembly.DefinedTypes
-                    .Where(w => _initialSettings.EnableExperimentalFeatures || !Attribute.IsDefined(w, typeof(ExperimentalAttribute)));
+                    .Where(w =>
+                    {
+                        var attribute = w.CustomAttributes.FirstOrDefault(f => f.AttributeType == typeof(ExperimentalAttribute));
+                        var ctorArg = attribute?.ConstructorArguments.Any() == true ? (string)attribute.ConstructorArguments.First().Value : string.Empty;
+
+                        return attribute == null ||
+                               _initialSettings.EnableExperimentalFeatures.Any(a => a.Key == ctorArg && a.IsEnabled);
+                    });
 
                 assemblyTypes.Any(t => t.Name == nameof(IMessageBox));
                 
@@ -212,7 +225,14 @@ private void RegisterFactories(IWindsorContainer container, Assembly[] assemblie
             foreach (var assembly in assembliesToRegister)
             {
                 var assemblyTypes = assembly.DefinedTypes
-                    .Where(w => _initialSettings.EnableExperimentalFeatures || !Attribute.IsDefined(w, typeof(ExperimentalAttribute)));
+                    .Where(w =>
+                    {
+                        var attribute = w.CustomAttributes.FirstOrDefault(f => f.AttributeType == typeof(ExperimentalAttribute));
+                        var ctorArg = attribute?.ConstructorArguments.Any() == true ? (string)attribute.ConstructorArguments.First().Value : string.Empty;
+
+                        return attribute == null ||
+                               _initialSettings.EnableExperimentalFeatures.Any(a => a.Key == ctorArg && a.IsEnabled);
+                    });
 
                 container.Register(Types.From(assemblyTypes)
                     .Where(type => type.IsInterface && type.Name.EndsWith("Factory"))
@@ -236,7 +256,14 @@ private void RegisterQuickFixes(IWindsorContainer container, Assembly[] assembli
             foreach (var assembly in assembliesToRegister)
             {
                 var assemblyTypes = assembly.DefinedTypes
-                    .Where(w => _initialSettings.EnableExperimentalFeatures || !Attribute.IsDefined(w, typeof(ExperimentalAttribute)));
+                    .Where(w =>
+                    {
+                        var attribute = w.CustomAttributes.FirstOrDefault(f => f.AttributeType == typeof(ExperimentalAttribute));
+                        var ctorArg = attribute?.ConstructorArguments.Any() == true ? (string)attribute.ConstructorArguments.First().Value : string.Empty;
+
+                        return attribute == null ||
+                               _initialSettings.EnableExperimentalFeatures.Any(a => a.Key == ctorArg && a.IsEnabled);
+                    });
 
                 container.Register(Classes.From(assemblyTypes)
                     .BasedOn<IQuickFix>()
@@ -251,7 +278,14 @@ private void RegisterInspections(IWindsorContainer container, Assembly[] assembl
             foreach (var assembly in assembliesToRegister)
             {
                 var assemblyTypes = assembly.DefinedTypes
-                    .Where(w => _initialSettings.EnableExperimentalFeatures || !Attribute.IsDefined(w, typeof(ExperimentalAttribute)));
+                    .Where(w =>
+                    {
+                        var attribute = w.CustomAttributes.FirstOrDefault(f => f.AttributeType == typeof(ExperimentalAttribute));
+                        var ctorArg = attribute?.ConstructorArguments.Any() == true ? (string)attribute.ConstructorArguments.First().Value : string.Empty;
+
+                        return attribute == null ||
+                               _initialSettings.EnableExperimentalFeatures.Any(a => a.Key == ctorArg && a.IsEnabled && a.IsEnabled);
+                    });
 
                 container.Register(Classes.From(assemblyTypes)
                     .BasedOn<IInspection>()
@@ -265,8 +299,15 @@ private void RegisterParseTreeInspections(IWindsorContainer container, Assembly[
             foreach (var assembly in assembliesToRegister)
             {
                 var assemblyTypes = assembly.DefinedTypes
-                    .Where(w => _initialSettings.EnableExperimentalFeatures || !Attribute.IsDefined(w, typeof(ExperimentalAttribute)));
-                
+                    .Where(w =>
+                    {
+                        var attribute = w.CustomAttributes.FirstOrDefault(f => f.AttributeType == typeof(ExperimentalAttribute));
+                        var ctorArg = attribute?.ConstructorArguments.Any() == true ? (string)attribute.ConstructorArguments.First().Value : string.Empty;
+
+                        return attribute == null ||
+                               _initialSettings.EnableExperimentalFeatures.Any(a => a.Key == ctorArg && a.IsEnabled);
+                    });
+
                 container.Register(Classes.From(assemblyTypes)
                     .BasedOn<IParseTreeInspection>()
                     .WithService.Base()
@@ -514,7 +555,7 @@ private Type[] ToolsMenuItems()
                 typeof(ExportAllCommandMenuItem)
             };
 
-            if (_initialSettings.EnableExperimentalFeatures)
+            if (_initialSettings.EnableExperimentalFeatures.Any(a => a.Key == nameof(RubberduckUI.GeneralSettings_EnableSourceControl) && a.IsEnabled))
             {
                 items.Add(typeof(SourceControlCommandMenuItem));
             }
@@ -581,7 +622,7 @@ private void RegisterCommands(IWindsorContainer container)
 
         private void RegisterCommandsWithPresenters(IWindsorContainer container)
         {
-            if (_initialSettings.EnableExperimentalFeatures)
+            if (_initialSettings.EnableExperimentalFeatures.Any(a => a.Key == nameof(RubberduckUI.GeneralSettings_EnableSourceControl) && a.IsEnabled))
             {
                 container.Register(Component.For<CommandBase>()
                     .ImplementedBy<SourceControlCommand>()
@@ -811,7 +852,7 @@ private void RegisterCustomDeclarationLoadersToParser(IWindsorContainer containe
                 .LifestyleSingleton());
         }
 
-        private IEnumerable<Assembly> AssembliesToRegister()
+        public static IEnumerable<Assembly> AssembliesToRegister()
         {
             var assemblies = new[]
                 {
@@ -824,7 +865,7 @@ private IEnumerable<Assembly> AssembliesToRegister()
             return assemblies;
         }
 
-        private IEnumerable<Assembly> FindPlugins()
+        private static IEnumerable<Assembly> FindPlugins()
         {
             var assemblies = new List<Assembly>();
             var basePath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
diff --git a/RetailCoder.VBE/Rubberduck.csproj b/RetailCoder.VBE/Rubberduck.csproj
@@ -367,6 +367,7 @@
     <Compile Include="RubberduckGuid.cs" />
     <Compile Include="RubberduckProgId.cs" />
     <Compile Include="Settings\CodeInspectionConfigProvider.cs" />
+    <Compile Include="Settings\ExperimentalFeatures.cs" />
     <Compile Include="Settings\GeneralConfigProvider.cs" />
     <Compile Include="Settings\HotkeySettings.cs" />
     <Compile Include="Settings\HotkeyConfigProvider.cs" />
diff --git a/RetailCoder.VBE/Settings/ExperimentalFeatures.cs b/RetailCoder.VBE/Settings/ExperimentalFeatures.cs
@@ -0,0 +1,39 @@
+﻿using System.Xml.Serialization;
+using Rubberduck.UI;
+
+namespace Rubberduck.Settings
+{
+    public class ExperimentalFeatures : ViewModelBase
+    {
+        private bool _isEnabled;
+        public bool IsEnabled
+        {
+            get { return _isEnabled; }
+            set
+            {
+                _isEnabled = value;
+                OnPropertyChanged();
+            }
+        }
+
+        private string _key;
+        public string Key
+        {
+            get { return _key; }
+            set
+            {
+                _key = value;
+                OnPropertyChanged();
+                OnPropertyChanged(nameof(DisplayValue));
+            }
+        }
+
+        [XmlIgnore]
+        public string DisplayValue => Key == null ? string.Empty : RubberduckUI.ResourceManager.GetString(Key);
+
+        public override string ToString()
+        {
+            return Key;
+        }
+    }
+}
diff --git a/RetailCoder.VBE/Settings/GeneralSettings.cs b/RetailCoder.VBE/Settings/GeneralSettings.cs
@@ -1,4 +1,6 @@
 ﻿using System;
+using System.Collections.Generic;
+using System.Linq;
 using NLog;
 using System.Xml.Serialization;
 using Rubberduck.Common;
@@ -14,7 +16,7 @@ public interface IGeneralSettings
         bool IsAutoSaveEnabled { get; set; }
         int AutoSavePeriod { get; set; }
         int MinimumLogLevel { get; set; }
-        bool EnableExperimentalFeatures { get; set; }
+        List<ExperimentalFeatures> EnableExperimentalFeatures { get; set; }
     }
 
     [XmlType(AnonymousType = true)]
@@ -48,7 +50,7 @@ public int MinimumLogLevel
             }
         }
 
-        public bool EnableExperimentalFeatures { get; set; }
+        public List<ExperimentalFeatures> EnableExperimentalFeatures { get; set; }
 
         public GeneralSettings()
         {
@@ -59,7 +61,7 @@ public GeneralSettings()
             IsAutoSaveEnabled = false;
             AutoSavePeriod = 10;
             MinimumLogLevel = LogLevel.Off.Ordinal;
-            EnableExperimentalFeatures = false;
+            EnableExperimentalFeatures = new List<ExperimentalFeatures>();
         }
 
         public bool Equals(GeneralSettings other)
@@ -72,7 +74,8 @@ public bool Equals(GeneralSettings other)
                    IsAutoSaveEnabled == other.IsAutoSaveEnabled &&
                    AutoSavePeriod == other.AutoSavePeriod &&
                    MinimumLogLevel == other.MinimumLogLevel &&
-                   EnableExperimentalFeatures == other.EnableExperimentalFeatures;
+                   EnableExperimentalFeatures.All(a => other.EnableExperimentalFeatures.Contains(a)) &&
+                   EnableExperimentalFeatures.Count == other.EnableExperimentalFeatures.Count;
         }
     }
 }
diff --git a/RetailCoder.VBE/UI/CodeExplorer/CodeExplorerControl.xaml b/RetailCoder.VBE/UI/CodeExplorer/CodeExplorerControl.xaml
@@ -271,7 +271,7 @@
                                     </Image>
                                 </MenuItem.Icon>
                             </MenuItem>
-                            <MenuItem Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=SourceControlPanel_Caption}" Visibility="{Binding EnableExperimentalFeatures, Converter={StaticResource BoolToVisibility}}" >
+                            <MenuItem Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=SourceControlPanel_Caption}" Visibility="{Binding EnableSourceControl, Converter={StaticResource BoolToVisibility}}" >
                                 <MenuItem Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=CodeExplorer_Commit}"
                                       Command="{Binding CommitCommand}"
                                       CommandParameter="{Binding SelectedItem}" />
diff --git a/RetailCoder.VBE/UI/Command/MenuItems/SourceControlCommandMenuItem.cs b/RetailCoder.VBE/UI/Command/MenuItems/SourceControlCommandMenuItem.cs
@@ -1,7 +1,9 @@
-﻿using Rubberduck.UI.Command.MenuItems.ParentMenus;
+﻿using Rubberduck.Parsing.Common;
+using Rubberduck.UI.Command.MenuItems.ParentMenus;
 
 namespace Rubberduck.UI.Command.MenuItems
 {
+    [Experimental(nameof(RubberduckUI.GeneralSettings_EnableSourceControl))]
     public class SourceControlCommandMenuItem : CommandMenuItemBase
     {
         public SourceControlCommandMenuItem(CommandBase command) 
diff --git a/RetailCoder.VBE/UI/RubberduckUI.Designer.cs b/RetailCoder.VBE/UI/RubberduckUI.Designer.cs
diff --git a/RetailCoder.VBE/UI/RubberduckUI.resx b/RetailCoder.VBE/UI/RubberduckUI.resx
@@ -2052,14 +2052,14 @@ Would you like to import them to Rubberduck?</value>
     <value>Method '{0}' is an implementation of event '{1}.{2}'.  Rename event '{2}' instead?</value>
     <comment>0: Selected target Identifier; 1: Event Parent; 2: Event name</comment>
   </data>
-  <data name="GeneralSettings_EnableExperimentalFeatures" xml:space="preserve">
-    <value>Enable experimental features. Requires a restart to take effect.</value>
+  <data name="GeneralSettings_EnableSourceControl" xml:space="preserve">
+    <value>Enable Source Control.</value>
   </data>
   <data name="GeneralSettings_ExperimentalFeaturesWarning" xml:space="preserve">
     <value>Only enable these if you know what you're doing. Enabling and/or using features from this section may result in things breaking unexpectedly and irrevocable data loss.</value>
   </data>
   <data name="GeneralSettings_ExperimentalFeatures" xml:space="preserve">
-    <value>Experimental Features:</value>
+    <value>Experimental Features (Requires a restart to take effect):</value>
   </data>
   <data name="ToolsMenu_ExportProject" xml:space="preserve">
     <value>Export Active Project...</value>
diff --git a/RetailCoder.VBE/UI/Settings/GeneralSettings.xaml b/RetailCoder.VBE/UI/Settings/GeneralSettings.xaml
@@ -214,9 +214,17 @@
                             <AccessText TextWrapping="Wrap" Text="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=GeneralSettings_ExperimentalFeaturesWarning}"/>
                         </Label.Content>
                     </Label>
-                    <CheckBox Margin="5,0,0,5" Content="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=GeneralSettings_EnableExperimentalFeatures}"
-                           IsChecked="{Binding SourceControlEnabled}" />
-
+                    <ListView ItemsSource="{Binding ExperimentalFeatures}"
+                          HorizontalAlignment="Stretch"
+                          BorderThickness="0">
+                        <ListView.ItemTemplate>
+                            <DataTemplate>
+                                <StackPanel Orientation="Horizontal">
+                                    <CheckBox IsChecked="{Binding IsEnabled}" Content="{Binding DisplayValue}" />
+                                </StackPanel>
+                            </DataTemplate>
+                        </ListView.ItemTemplate>
+                    </ListView>
                 </StackPanel>
             </Grid>
         </ScrollViewer>
diff --git a/RetailCoder.VBE/UI/Settings/GeneralSettingsViewModel.cs b/RetailCoder.VBE/UI/Settings/GeneralSettingsViewModel.cs
@@ -1,8 +1,12 @@
-﻿using System.Collections.ObjectModel;
+﻿using System;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
 using System.Linq;
 using Rubberduck.Settings;
 using Rubberduck.Common;
 using NLog;
+using Rubberduck.Parsing.Common;
+using Rubberduck.Root;
 using Rubberduck.SettingsProvider;
 using Rubberduck.UI.Command;
 
@@ -38,6 +42,8 @@ public GeneralSettingsViewModel(Configuration config, IOperatingSystem operating
             ImportButtonCommand = new DelegateCommand(LogManager.GetCurrentClassLogger(), _ => ImportSettings());
         }
 
+        public List<ExperimentalFeatures> ExperimentalFeatures { get; set; }
+
         public ObservableCollection<DisplayLanguageSetting> Languages { get; set; } 
 
         private DisplayLanguageSetting _selectedLanguage;
@@ -196,7 +202,7 @@ private Rubberduck.Settings.GeneralSettings GetCurrentGeneralSettings()
                 IsAutoSaveEnabled = AutoSaveEnabled,
                 AutoSavePeriod = AutoSavePeriod,
                 MinimumLogLevel = SelectedLogLevel.Ordinal,
-                EnableExperimentalFeatures = SourceControlEnabled
+                EnableExperimentalFeatures = ExperimentalFeatures
             };
         }
 
@@ -210,7 +216,14 @@ private void TransferSettingsToView(IGeneralSettings general, IHotkeySettings ho
             AutoSaveEnabled = general.IsAutoSaveEnabled;
             AutoSavePeriod = general.AutoSavePeriod;
             SelectedLogLevel = LogLevels.First(l => l.Ordinal == general.MinimumLogLevel);
-            SourceControlEnabled = general.EnableExperimentalFeatures;
+            
+            ExperimentalFeatures = RubberduckIoCInstaller.AssembliesToRegister()
+                .SelectMany(s => s.DefinedTypes)
+                .Where(w => Attribute.IsDefined(w, typeof(ExperimentalAttribute)))
+                .SelectMany(s => s.CustomAttributes.Where(a => a.ConstructorArguments.Any()).Select(a => (string)a.ConstructorArguments.First().Value))
+                .Distinct()
+                .Select(s => new ExperimentalFeatures { IsEnabled = general.EnableExperimentalFeatures.SingleOrDefault(d => d.Key == s)?.IsEnabled ?? false, Key = s })
+                .ToList();
         }
 
         private void ImportSettings()
diff --git a/Rubberduck.Parsing/Common/ExperimentalAttribute.cs b/Rubberduck.Parsing/Common/ExperimentalAttribute.cs
@@ -5,5 +5,12 @@ namespace Rubberduck.Parsing.Common
     [AttributeUsage(AttributeTargets.Class)]
     public class ExperimentalAttribute : Attribute
     {
+        public ExperimentalAttribute() : this(string.Empty)
+        {
+        }
+
+        public ExperimentalAttribute(string resource)
+        {
+        }
     }
 }
diff --git a/RubberduckTests/CodeExplorer/CodeExplorerTests.cs b/RubberduckTests/CodeExplorer/CodeExplorerTests.cs
diff --git a/RubberduckTests/IoCContainer/IoCRegistrationTests.cs b/RubberduckTests/IoCContainer/IoCRegistrationTests.cs
diff --git a/RubberduckTests/IoCContainer/IoCResolvingTests.cs b/RubberduckTests/IoCContainer/IoCResolvingTests.cs

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,6 @@`
`1`	`1`	`using System;`
	`2`	`+using System.Collections.Generic;`
	`3`	`+using System.Linq;`
`2`	`4`	`using NLog;`
`3`	`5`	`using System.Xml.Serialization;`
`4`	`6`	`using Rubberduck.Common;`
`@@ -14,7 +16,7 @@ public interface IGeneralSettings`
`14`	`16`	`bool IsAutoSaveEnabled { get; set; }`
`15`	`17`	`int AutoSavePeriod { get; set; }`
`16`	`18`	`int MinimumLogLevel { get; set; }`
`17`		`- bool EnableExperimentalFeatures { get; set; }`
	`19`	`+ List<ExperimentalFeatures> EnableExperimentalFeatures { get; set; }`
`18`	`20`	`}`
`19`	`21`
`20`	`22`	`[XmlType(AnonymousType = true)]`
`@@ -48,7 +50,7 @@ public int MinimumLogLevel`
`48`	`50`	`}`
`49`	`51`	`}`
`50`	`52`
`51`		`- public bool EnableExperimentalFeatures { get; set; }`
	`53`	`+ public List<ExperimentalFeatures> EnableExperimentalFeatures { get; set; }`
`52`	`54`
`53`	`55`	`public GeneralSettings()`
`54`	`56`	`{`
`@@ -59,7 +61,7 @@ public GeneralSettings()`
`59`	`61`	`IsAutoSaveEnabled = false;`
`60`	`62`	`AutoSavePeriod = 10;`
`61`	`63`	`MinimumLogLevel = LogLevel.Off.Ordinal;`
`62`		`- EnableExperimentalFeatures = false;`
	`64`	`+ EnableExperimentalFeatures = new List<ExperimentalFeatures>();`
`63`	`65`	`}`
`64`	`66`
`65`	`67`	`public bool Equals(GeneralSettings other)`
`@@ -72,7 +74,8 @@ public bool Equals(GeneralSettings other)`
`72`	`74`	`IsAutoSaveEnabled == other.IsAutoSaveEnabled &&`
`73`	`75`	`AutoSavePeriod == other.AutoSavePeriod &&`
`74`	`76`	`MinimumLogLevel == other.MinimumLogLevel &&`
`75`		`- EnableExperimentalFeatures == other.EnableExperimentalFeatures;`
	`77`	`+ EnableExperimentalFeatures.All(a => other.EnableExperimentalFeatures.Contains(a)) &&`
	`78`	`+ EnableExperimentalFeatures.Count == other.EnableExperimentalFeatures.Count;`
`76`	`79`	`}`
`77`	`80`	`}`
`78`	`81`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,9 @@`
`1`		`-using Rubberduck.UI.Command.MenuItems.ParentMenus;`
	`1`	`+using Rubberduck.Parsing.Common;`
	`2`	`+using Rubberduck.UI.Command.MenuItems.ParentMenus;`
`2`	`3`
`3`	`4`	`namespace Rubberduck.UI.Command.MenuItems`
`4`	`5`	`{`
	`6`	`+ [Experimental(nameof(RubberduckUI.GeneralSettings_EnableSourceControl))]`
`5`	`7`	`public class SourceControlCommandMenuItem : CommandMenuItemBase`
`6`	`8`	`{`
`7`	`9`	`public SourceControlCommandMenuItem(CommandBase command)`