Merge pull request #3452 from ThunderFrame/next

Adds export/clipboard button to ToDo Explorer

Author: retailcoder

RetailCoder.VBE/ToDoItems/ToDoItem.cs

@@ -1,4 +1,5 @@
-using Rubberduck.Parsing.Symbols;
+using Rubberduck.Common;
+using Rubberduck.Parsing.Symbols;
 using Rubberduck.UI;
 using Rubberduck.UI.Controls;
 using Rubberduck.VBEditor;
@@ -9,7 +10,7 @@ namespace Rubberduck.ToDoItems
     /// Represents a Todo comment and the necessary information to display and navigate to that comment.
     /// This is a binding item. Changing it's properties changes how it is displayed.
     /// </summary>
-    public class ToDoItem : INavigateSource
+    public class ToDoItem : INavigateSource, IExportable
     {
         private readonly string _description;
         public string Description { get { return _description; } }
@@ -31,5 +32,23 @@ public NavigateCodeEventArgs GetNavigationArgs()
         {
             return new NavigateCodeEventArgs(_selection);
         }
+
+        public object[] ToArray()
+        {
+            var module = _selection.QualifiedName;
+            return new object[] { _type, Description, module.ProjectName, module.ComponentName, _selection.Selection.StartLine, _selection.Selection.StartColumn };
+        }
+
+        public string ToClipboardString()
+        {
+            var module = _selection.QualifiedName;
+            return string.Format(
+                RubberduckUI.ToDoExplorerToDoItemFormat,
+                _type,
+                _description,
+                module.ProjectName,
+                module.ComponentName,
+                _selection.Selection.StartLine);
+        }
     }
 }

RetailCoder.VBE/UI/RubberduckUI.Designer.cs

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <root>
   <!-- 
     Microsoft ResX Schema 
@@ -59,7 +59,7 @@
             : using a System.ComponentModel.TypeConverter
             : and then encoded with base64 encoding.
     -->
-  <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" id="root">
+  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
     <xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
     <xsd:element name="root" msdata:IsDataSet="true">
       <xsd:complexType>
@@ -2106,4 +2106,20 @@ Would you like to import them to Rubberduck?</value>
   <data name="RubberduckMenu_Refresh" xml:space="preserve">
     <value>Refresh</value>
   </data>
-</root>
+  <data name="ToDoExplorer_NumberOfIssuesFound_Plural" xml:space="preserve">
+    <value>Rubberduck ToDo Items - {0}
+{1} items found.</value>
+    <comment>{0}=timestamp; {1}=number</comment>
+  </data>
+  <data name="ToDoExplorer_NumberOfIssuesFound_Singular" xml:space="preserve">
+    <value>Rubberduck ToDo Items - {0}
+{1} items found.</value>
+    <comment>{0}=timestamp; {1}=number</comment>
+  </data>
+  <data name="ToDoExplorerToDoItemFormat" xml:space="preserve">
+    <value>{0}: {1} - {2}.{3} line {4}.</value>
+  </data>
+  <data name="ToDoExplorer_CopyToolTip" xml:space="preserve">
+    <value>Copy to clipboard</value>
+  </data>
+</root>

RetailCoder.VBE/UI/RubberduckUI.resx

@@ -510,6 +510,12 @@
                                   controls:MenuItemGroup.GroupName="ToDoExplorer_GroupingStyle" />
                     </MenuItem>
                 </Menu>
+                <Button Command="{Binding CopyResultsCommand}">
+                    <Image Height="16" Source="../../Resources/document-copy.png" />
+                    <Button.ToolTip>
+                        <TextBlock Text="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=ToDoExplorer_CopyToolTip}" />
+                    </Button.ToolTip>
+                </Button>
                 <Button ToolTip="{Resx ResxName=Rubberduck.UI.RubberduckUI, Key=Settings}" Command="{Binding OpenTodoSettings}" BorderThickness="0" Background="Transparent">
                     <Image Source="{StaticResource SettingsImage}" />
                 </Button>

RetailCoder.VBE/UI/ToDoItems/ToDoExplorerControl.xaml

@@ -1,7 +1,9 @@
 using System;
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
+using System.Globalization;
 using System.Linq;
+using System.Windows;
 using NLog;
 using Rubberduck.Parsing.VBA;
 using Rubberduck.Settings;
@@ -155,6 +157,54 @@ public CommandBase RemoveCommand
             }
         }
 
+        private CommandBase _copyResultsCommand;
+        public CommandBase CopyResultsCommand
+        {
+            get
+            {
+                if (_copyResultsCommand != null)
+                {
+                    return _copyResultsCommand;
+                }
+                return _copyResultsCommand = new DelegateCommand(LogManager.GetCurrentClassLogger(), _ =>
+                {
+                    const string xmlSpreadsheetDataFormat = "XML Spreadsheet";
+                    if (_items == null)
+                    {
+                        return;
+                    }
+                    ColumnInfo[] columnInfos = { new ColumnInfo("Type"), new ColumnInfo("Description"), new ColumnInfo("Project"), new ColumnInfo("Component"), new ColumnInfo("Line", hAlignment.Right), new ColumnInfo("Column", hAlignment.Right) };
+
+                    var resultArray = _items.OfType<IExportable>().Select(result => result.ToArray()).ToArray();
+
+                    var resource = _items.Count == 1
+                        ? RubberduckUI.ToDoExplorer_NumberOfIssuesFound_Singular
+                        : RubberduckUI.ToDoExplorer_NumberOfIssuesFound_Plural;
+
+                    var title = string.Format(resource, DateTime.Now.ToString(CultureInfo.InvariantCulture), _items.Count);
+
+                    var textResults = title + Environment.NewLine + string.Join("", _items.OfType<IExportable>().Select(result => result.ToClipboardString() + Environment.NewLine).ToArray());
+                    var csvResults = ExportFormatter.Csv(resultArray, title, columnInfos);
+                    var htmlResults = ExportFormatter.HtmlClipboardFragment(resultArray, title, columnInfos);
+                    var rtfResults = ExportFormatter.RTF(resultArray, title);
+
+                    // todo: verify that this disposing this stream breaks the xmlSpreadsheetDataFormat
+                    var stream = ExportFormatter.XmlSpreadsheetNew(resultArray, title, columnInfos);
+
+                    IClipboardWriter _clipboard = new ClipboardWriter();
+                    //Add the formats from richest formatting to least formatting
+                    _clipboard.AppendStream(DataFormats.GetDataFormat(xmlSpreadsheetDataFormat).Name, stream);
+                    _clipboard.AppendString(DataFormats.Rtf, rtfResults);
+                    _clipboard.AppendString(DataFormats.Html, htmlResults);
+                    _clipboard.AppendString(DataFormats.CommaSeparatedValue, csvResults);
+                    _clipboard.AppendString(DataFormats.UnicodeText, textResults);
+
+                    _clipboard.Flush();
+
+                });
+            }
+        }
+
         private CommandBase _openTodoSettings;
         public CommandBase OpenTodoSettings
         {