Adds "Export Active Project" menu item (#3256)

shadowofsilicon · retailcoder · commit 08683fc3ea79 · 2017-08-17T22:00:00.000-04:00
* Introduces ExportAllCommand with default hotkey Ctrl+Shift+E (VBE's own "Export [module]" command is Ctrl+E), to export all modules of the active project into a folder.

* Default hotkey for the RefactorEncapsulateField command now defaults to Ctrl+Shift+F (old default was Ctrl+Shift+E). E for Export, F for Field.
diff --git a/RetailCoder.VBE/Navigation/CodeExplorer/CodeExplorerViewModel.cs b/RetailCoder.VBE/Navigation/CodeExplorer/CodeExplorerViewModel.cs
@@ -16,6 +16,7 @@
 using Rubberduck.VBEditor;
 using Rubberduck.VBEditor.SafeComWrappers;
 using Rubberduck.VBEditor.SafeComWrappers.Abstract;
+using System.Windows;
 
 // ReSharper disable CanBeReplacedWithTryCastAndCheckForNull
 
@@ -60,6 +61,8 @@ public CodeExplorerViewModel(FolderHelper folderHelper, RubberduckParserState st
 
             ImportCommand = commands.OfType<ImportCommand>().SingleOrDefault();
             ExportCommand = commands.OfType<ExportCommand>().SingleOrDefault();
+            ExportAllCommand = commands.OfType<Rubberduck.UI.Command.ExportAllCommand>().SingleOrDefault();
+            
             _externalRemoveCommand = commands.OfType<RemoveCommand>().SingleOrDefault();
             if (_externalRemoveCommand != null)
             {
@@ -99,8 +102,10 @@ public CodeExplorerItemViewModel SelectedItem
                 OnPropertyChanged("CanExecuteIndenterCommand");
                 OnPropertyChanged("CanExecuteRenameCommand");
                 OnPropertyChanged("CanExecuteFindAllReferencesCommand");
+                OnPropertyChanged("CanExecuteExportAllCommand");
                 OnPropertyChanged("PanelTitle");
                 OnPropertyChanged("Description");
+
                 // ReSharper restore ExplicitCallerInfoArgument
             }
         }
@@ -463,13 +468,15 @@ private void SwitchNodeState(CodeExplorerItemViewModel node, bool expandedState)
 
         public CommandBase ImportCommand { get; }
         public CommandBase ExportCommand { get; }
+        public CommandBase ExportAllCommand { get; }
+
         public CommandBase RemoveCommand { get; }
 
         public CommandBase PrintCommand { get; }
 
         public CommandBase CommitCommand { get; }
         public CommandBase UndoCommand { get; }
-
+        
         private readonly CommandBase _externalRemoveCommand;
 
         // this is a special case--we have to reset SelectedItem to prevent a crash
@@ -482,6 +489,28 @@ private void ExecuteRemoveComand(object param)
             _externalRemoveCommand.Execute(param);
         }
 
+        private bool CanExecuteExportAllCommand => ExportAllCommand.CanExecute(SelectedItem);
+
+        public Visibility ExportVisibility
+        {
+            get
+            {
+                if (CanExecuteExportAllCommand == false)
+                { return Visibility.Visible; }
+                else { return Visibility.Collapsed; }
+            }
+        }
+
+        public Visibility ExportAllVisibility
+        {
+            get
+            {
+                if (CanExecuteExportAllCommand == true)
+                { return Visibility.Visible; }
+                else { return Visibility.Collapsed; }
+            }
+        }
+
         public void Dispose()
         {
             if (_state != null)
diff --git a/RetailCoder.VBE/Root/RubberduckModule.cs b/RetailCoder.VBE/Root/RubberduckModule.cs
@@ -596,7 +596,8 @@ private IMenuItem GetToolsParentMenu()
             var items = new List<IMenuItem> ()
             {
                 KernelInstance.Get<RegexAssistantCommandMenuItem>(),
-                KernelInstance.Get<ToDoExplorerCommandMenuItem>()
+                KernelInstance.Get<ToDoExplorerCommandMenuItem>(),
+                KernelInstance.Get<ExportAllCommandMenuItem>()
             };
 
 
diff --git a/RetailCoder.VBE/Rubberduck.csproj b/RetailCoder.VBE/Rubberduck.csproj
@@ -396,6 +396,7 @@
     <Compile Include="UI\CodeExplorer\Commands\CommitCommand.cs" />
     <Compile Include="UI\CodeExplorer\Commands\AddUserFormCommand.cs" />
     <Compile Include="UI\CodeExplorer\Commands\CopyResultsCommand.cs" />
+    <Compile Include="UI\Command\ExportAllCommand.cs" />
     <Compile Include="UI\CodeExplorer\Commands\OpenProjectPropertiesCommand.cs" />
     <Compile Include="UI\CodeExplorer\Commands\RenameCommand.cs" />
     <Compile Include="UI\CodeExplorer\Commands\FindAllReferencesCommand.cs" />
@@ -414,6 +415,7 @@
     <Compile Include="UI\Command\IndentCurrentProjectCommand.cs" />
     <Compile Include="UI\Command\MenuItems\CommandBars\ContextDescriptionLabelMenuItem.cs" />
     <Compile Include="UI\Command\MenuItems\IndentCurrentProjectCommandMenuItem.cs" />
+    <Compile Include="UI\Command\MenuItems\ExportAllCommandMenuItem.cs" />
     <Compile Include="UI\EnvironmentProvider.cs" />
     <Compile Include="UI\Inspections\AggregateInspectionResult.cs" />
     <Compile Include="UI\ModernFolderBrowser.cs" />
diff --git a/RetailCoder.VBE/Settings/HotkeySettings.cs b/RetailCoder.VBE/Settings/HotkeySettings.cs
@@ -12,7 +12,7 @@ public interface IHotkeySettings
 
     public class HotkeySettings : IHotkeySettings, IEquatable<HotkeySettings>
     {
-        private static readonly HotkeySetting[] Defaults = 
+        private static readonly HotkeySetting[] Defaults =
         {
             new HotkeySetting{Name=RubberduckHotkey.ParseAll.ToString(), IsEnabled=true, HasCtrlModifier = true, Key1="`" },
             new HotkeySetting{Name=RubberduckHotkey.IndentProcedure.ToString(), IsEnabled=true, HasCtrlModifier = true, Key1="P" },
@@ -25,7 +25,8 @@ public class HotkeySettings : IHotkeySettings, IEquatable<HotkeySettings>
             new HotkeySetting{Name=RubberduckHotkey.RefactorRename.ToString(), IsEnabled=true, HasCtrlModifier = true, HasShiftModifier = true, Key1="R" },
             new HotkeySetting{Name=RubberduckHotkey.RefactorExtractMethod.ToString(), IsEnabled=true, HasCtrlModifier = true, HasShiftModifier = true, Key1="M" },
             new HotkeySetting{Name=RubberduckHotkey.SourceControl.ToString(), IsEnabled=true, HasCtrlModifier = true, HasShiftModifier = true, Key1="D6" },
-            new HotkeySetting{Name=RubberduckHotkey.RefactorEncapsulateField.ToString(), IsEnabled=true, HasCtrlModifier = true, HasShiftModifier = true, Key1="E" }
+            new HotkeySetting{Name=RubberduckHotkey.RefactorEncapsulateField.ToString(), IsEnabled=true, HasCtrlModifier = true, HasShiftModifier = true, Key1="F" },
+            new HotkeySetting{Name=RubberduckHotkey.ExportActiveProject.ToString(), IsEnabled = true, HasCtrlModifier = true, HasShiftModifier = true, Key1="E" }
         };
 
         private HashSet<HotkeySetting> _settings;
diff --git a/RetailCoder.VBE/Settings/RubberduckHotkey.cs b/RetailCoder.VBE/Settings/RubberduckHotkey.cs
@@ -14,6 +14,7 @@ public enum RubberduckHotkey
         RefactorRename,
         RefactorExtractMethod,
         RefactorEncapsulateField,
-        SourceControl
+        SourceControl,
+        ExportActiveProject
     }
 }
diff --git a/RetailCoder.VBE/UI/CodeExplorer/CodeExplorerControl.xaml b/RetailCoder.VBE/UI/CodeExplorer/CodeExplorerControl.xaml
@@ -274,8 +274,8 @@
             <Setter Property="IsExpanded" Value="{Binding IsExpanded, Mode=TwoWay}"/>
             <Setter Property="IsSelected" Value="{Binding IsSelected, Mode=TwoWay}" />
             <Setter Property="HorizontalAlignment" Value="Left" />
-            <EventSetter Event="PreviewMouseRightButtonDown" Handler="OnPreviewMouseRightButtonDown" />
             <EventSetter Event="MouseDoubleClick" Handler="TreeView_OnMouseDoubleClick" />
+            <EventSetter Event="MouseRightButtonDown" Handler="TreeView_OnMouseRightButtonDown" />
             <Style.Triggers>
                 <Trigger Property="IsSelected" Value="True">
                     <Setter Property="BorderBrush" Value="#adc6e5"/>
@@ -425,7 +425,12 @@
                                   CommandParameter="{Binding SelectedItem}" />
                         <MenuItem Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=CodeExplorer_Export}"
                                   Command="{Binding ExportCommand}"
-                                  CommandParameter="{Binding SelectedItem}" />
+                                  CommandParameter="{Binding SelectedItem}"
+                                  Visibility="{Binding ExportVisibility}" />
+                        <MenuItem Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=CodeExplorer_ExportAll}"
+                                  Command="{Binding ExportAllCommand}"
+                                  CommandParameter="{Binding SelectedItem}" 
+                                  Visibility="{Binding ExportAllVisibility}" />
                         <MenuItem Header="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=CodeExplorer_Remove}"
                                   Command="{Binding RemoveCommand}"
                                   CommandParameter="{Binding SelectedItem}" />
diff --git a/RetailCoder.VBE/UI/CodeExplorer/CodeExplorerControl.xaml.cs b/RetailCoder.VBE/UI/CodeExplorer/CodeExplorerControl.xaml.cs
@@ -22,11 +22,13 @@ private void TreeView_OnMouseDoubleClick(object sender, MouseButtonEventArgs e)
             {
                 ViewModel.NavigateCommand.Execute(ViewModel.SelectedItem);
             }
+            e.Handled = true;
         }
 
-        private void OnPreviewMouseRightButtonDown(object sender, MouseButtonEventArgs e)
+        private void TreeView_OnMouseRightButtonDown(object sender, MouseButtonEventArgs e)
         {
             ((TreeViewItem)sender).IsSelected = true;
+            e.Handled = true;
         }
     }
 }
diff --git a/RetailCoder.VBE/UI/Command/ExportAllCommand.cs b/RetailCoder.VBE/UI/Command/ExportAllCommand.cs
@@ -0,0 +1,77 @@
+using System.IO;
+using System.Windows.Forms;
+using NLog;
+using Rubberduck.VBEditor.SafeComWrappers.Abstract;
+using Rubberduck.Navigation.CodeExplorer;
+using Rubberduck.UI.CodeExplorer.Commands;
+using Rubberduck.Settings;
+
+namespace Rubberduck.UI.Command
+{
+    [CodeExplorerCommand]
+    public class ExportAllCommand : CommandBase 
+    {
+        private readonly IVBE _vbe;
+        private IFolderBrowserFactory _factory;
+
+        public ExportAllCommand(IVBE vbe, IFolderBrowserFactory folderBrowserFactory) : base(LogManager.GetCurrentClassLogger())
+        {
+            _vbe = vbe;
+            _factory = folderBrowserFactory;
+        }
+
+        public override RubberduckHotkey Hotkey
+        {
+            get { return RubberduckHotkey.ExportActiveProject; }
+        }
+
+        protected override bool EvaluateCanExecute(object parameter)
+        {
+            if (!(parameter is CodeExplorerProjectViewModel) && parameter is CodeExplorerItemViewModel)
+            {
+                return false;
+            }
+
+            var projectNode = parameter as CodeExplorerProjectViewModel;
+
+            var project = parameter as IVBProject;
+
+            return Evaluate(projectNode?.Declaration.Project ?? project ?? _vbe.ActiveVBProject);
+
+        }
+
+        private bool Evaluate(IVBProject project)
+        {
+            return project != null && !project.IsWrappingNullReference && project.VBComponents.Count > 0;
+        }
+
+        protected override void OnExecute(object parameter)
+        {
+            var projectNode = parameter as CodeExplorerProjectViewModel;
+
+            var vbproject = parameter as IVBProject;
+
+            IVBProject project = projectNode?.Declaration.Project ?? vbproject ?? _vbe.ActiveVBProject;
+            
+            var desc = string.Format(RubberduckUI.ExportAllCommand_SaveAsDialog, project.Name);
+
+            // If .GetDirectoryName is passed an empty string for a RootFolder, 
+            // it defaults to the Documents library (Win 7+) or equivalent.
+            var path = string.Empty;
+            if (!string.IsNullOrWhiteSpace(project.FileName))
+            {
+                path = Path.GetDirectoryName(project.FileName);
+            }
+
+            using (var _folderBrowser = _factory.CreateFolderBrowser(desc, true, path))
+            {
+                var result = _folderBrowser.ShowDialog();
+
+                if (result == DialogResult.OK)
+                {
+                    project.ExportSourceFiles(_folderBrowser.SelectedPath);
+                }
+            }
+        }
+    }
+}
diff --git a/RetailCoder.VBE/UI/Command/MenuItems/ExportAllCommandMenuItem.cs b/RetailCoder.VBE/UI/Command/MenuItems/ExportAllCommandMenuItem.cs
@@ -0,0 +1,21 @@
+﻿using Rubberduck.Parsing.VBA;
+using Rubberduck.UI.Command.MenuItems.ParentMenus;
+
+namespace Rubberduck.UI.Command.MenuItems
+{
+    class ExportAllCommandMenuItem : CommandMenuItemBase
+    {
+        public ExportAllCommandMenuItem(CommandBase command) : base(command)
+        {
+        }
+
+        public override string Key => "ToolsMenu_ExportProject";
+
+        public override int DisplayOrder => (int)ToolsMenuItemDisplayOrder.ExportAll;
+
+        public override bool EvaluateCanExecute(RubberduckParserState state)
+        {
+            return Command.CanExecute(null);
+        }
+    }
+}
diff --git a/RetailCoder.VBE/UI/Command/MenuItems/ParentMenus/ToolsParentMenu.cs b/RetailCoder.VBE/UI/Command/MenuItems/ParentMenus/ToolsParentMenu.cs
@@ -17,5 +17,6 @@ public enum ToolsMenuItemDisplayOrder
         SourceControl,
         ToDoExplorer,
         RegexAssistant,
+        ExportAll,
     }
 }
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
@@ -2061,4 +2061,17 @@ Would you like to import them to Rubberduck?</value>
   <data name="GeneralSettings_ExperimentalFeatures" xml:space="preserve">
     <value>Experimental Features:</value>
   </data>
+  <data name="ToolsMenu_ExportProject" xml:space="preserve">
+    <value>Export Active Project...</value>
+  </data>
+  <data name="ExportAllCommand_SaveAsDialog" xml:space="preserve">
+    <value>Choose a folder to export the source of {0} to:</value>
+    <comment>{0} VBProject.Name</comment>
+  </data>
+  <data name="CodeExplorer_ExportAll" xml:space="preserve">
+    <value>Export Project...</value>
+  </data>
+  <data name="HotkeyDescription_ExportActiveProject" xml:space="preserve">
+    <value>Export Active Project</value>
+  </data>
 </root>
diff --git a/RubberduckTests/CodeExplorer/CodeExplorerTests.cs b/RubberduckTests/CodeExplorer/CodeExplorerTests.cs
diff --git a/RubberduckTests/Commands/ExportAllCommandTests.cs b/RubberduckTests/Commands/ExportAllCommandTests.cs
diff --git a/RubberduckTests/RubberduckTests.csproj b/RubberduckTests/RubberduckTests.csproj
diff --git a/RubberduckTests/Settings/HotkeySettingsTests.cs b/RubberduckTests/Settings/HotkeySettingsTests.cs

Original file line number	Diff line number	Diff line change
`@@ -596,7 +596,8 @@ private IMenuItem GetToolsParentMenu()`
`596`	`596`	`var items = new List<IMenuItem> ()`
`597`	`597`	`{`
`598`	`598`	`KernelInstance.Get<RegexAssistantCommandMenuItem>(),`
`599`		`- KernelInstance.Get<ToDoExplorerCommandMenuItem>()`
	`599`	`+ KernelInstance.Get<ToDoExplorerCommandMenuItem>(),`
	`600`	`+ KernelInstance.Get<ExportAllCommandMenuItem>()`
`600`	`601`	`};`
`601`	`602`
`602`	`603`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ public enum RubberduckHotkey`
`14`	`14`	`RefactorRename,`
`15`	`15`	`RefactorExtractMethod,`
`16`	`16`	`RefactorEncapsulateField,`
`17`		`- SourceControl`
	`17`	`+ SourceControl,`
	`18`	`+ ExportActiveProject`
`18`	`19`	`}`
`19`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,11 +22,13 @@ private void TreeView_OnMouseDoubleClick(object sender, MouseButtonEventArgs e)`
`22`	`22`	`{`
`23`	`23`	`ViewModel.NavigateCommand.Execute(ViewModel.SelectedItem);`
`24`	`24`	`}`
	`25`	`+ e.Handled = true;`
`25`	`26`	`}`
`26`	`27`
`27`		`- private void OnPreviewMouseRightButtonDown(object sender, MouseButtonEventArgs e)`
	`28`	`+ private void TreeView_OnMouseRightButtonDown(object sender, MouseButtonEventArgs e)`
`28`	`29`	`{`
`29`	`30`	`((TreeViewItem)sender).IsSelected = true;`
	`31`	`+ e.Handled = true;`
`30`	`32`	`}`
`31`	`33`	`}`
`32`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,5 +17,6 @@ public enum ToolsMenuItemDisplayOrder`
`17`	`17`	`SourceControl,`
`18`	`18`	`ToDoExplorer,`
`19`	`19`	`RegexAssistant,`
	`20`	`+ ExportAll,`
`20`	`21`	`}`
`21`	`22`	`}`