Added comments; Improved some error handling

Author: asmey

FindMissingRows/Extensions.cs

@@ -0,0 +1,60 @@
+using System.Data;
+using System.Text;
+using System.Windows.Forms;
+
+public static class Extensions
+{
+    /// <summary>
+    /// Extension to the DataTable to add a "ToCSV" method.
+    /// </summary>
+    /// <param name="table"></param>
+    /// <returns>the table as a CSV string</returns>
+    public static string ToCSV(this DataTable table)
+    {
+        // reference: adapted from  http://stackoverflow.com/questions/888181/convert-datatable-to-csv-stream
+        var result = new StringBuilder();
+        for (int i = 0; i < table.Columns.Count; i++)
+        {
+            result.AppendFormat("\"{0}\"",table.Columns[i].ColumnName);
+            result.Append(i == table.Columns.Count - 1 ? "\n" : ",");
+        }
+
+        foreach (DataRow row in table.Rows)
+        {
+            for (int i = 0; i < table.Columns.Count; i++)
+            {
+                result.AppendFormat("\"{0}\"", row[i].ToString());
+                result.Append(i == table.Columns.Count - 1 ? "\n" : ",");
+            }
+        }
+
+        return result.ToString();
+    }
+
+    /// <summary>
+    /// Extension to the DataGrivView to add a "ToCSV" method.
+    /// </summary>
+    /// <param name="table"></param>
+    /// <returns>the table as a CSV string</returns>
+    public static string ToCSV(this DataGridView table)
+    {
+        // reference: adapted from  http://stackoverflow.com/questions/888181/convert-datatable-to-csv-stream
+        var result = new StringBuilder();
+        for (int i = 0; i < table.Columns.Count; i++)
+        {
+            result.AppendFormat("\"{0}\"", table.Columns[i].Name);
+            result.Append(i == table.Columns.Count - 1 ? "\n" : ",");
+        }
+
+        foreach (DataGridViewRow row in table.Rows)
+        {
+            for (int i = 0; i < row.Cells.Count; i++)
+            {
+                result.AppendFormat("\"{0}\"", row.Cells[i].FormattedValue);
+                result.Append(i == row.Cells.Count - 1 ? "\n" : ",");
+            }
+        }
+
+        return result.ToString();
+    }
+}

FindMissingRows/FilterDialog.cs

@@ -1,11 +1,4 @@
 using System;
-using System.Collections.Generic;
-using System.ComponentModel;
-using System.Data;
-using System.Drawing;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 using System.Windows.Forms;
 
 namespace FindMissingRows
@@ -21,20 +14,34 @@ public FilterDialog(object [] columnNames)
 
             filterColumn.Items.AddRange(columnNames);
 
+            // List of filter types to support
             filterTypeCb.Items.AddRange(new string [] {"Equals", "Begins", "Ends" });
+
+            // setup default filter type
             filterTypeCb.SelectedIndex = filterTypeCb.Items.IndexOf("Equals");
         }
 
+        /// <summary>
+        /// Apply the filter
+        /// </summary>
+        /// <param name="sender"></param>
+        /// <param name="e"></param>
         private void apply_Click(object sender, EventArgs e)
         {
             MainForm.Filter(FilterString);
         }
 
+        // close the filter form
         private void cancel_Click(object sender, EventArgs e)
         {
             Close();
         }
 
+        /// <summary>
+        /// Handle changes in the selected filter type
+        /// </summary>
+        /// <param name="sender"></param>
+        /// <param name="e"></param>
         private void filterColumn_SelectedIndexChanged(object sender, EventArgs e)
         {
             if (filterColumn.SelectedItem != null)
@@ -44,6 +51,9 @@ private void filterColumn_SelectedIndexChanged(object sender, EventArgs e)
             UpdateFilter();
         }
 
+        /// <summary>
+        /// Create the filter and apply it.
+        /// </summary>
         private void UpdateFilter()
         {
             if (string.IsNullOrWhiteSpace(columnNameBox.Text) && string.IsNullOrWhiteSpace(filterTextBox.Text))
@@ -74,11 +84,21 @@ private void UpdateFilter()
             filterExpressionBox.Text = FilterString;
         }
 
+        /// <summary>
+        /// handle manual changes to the filter
+        /// </summary>
+        /// <param name="sender"></param>
+        /// <param name="e"></param>
         private void filterText_TextChanged(object sender, EventArgs e)
         {
             UpdateFilter();
         }
 
+        /// <summary>
+        /// Handle the Clear button by setting no filter.
+        /// </summary>
+        /// <param name="sender"></param>
+        /// <param name="e"></param>
         private void clearButton_Click(object sender, EventArgs e)
         {
             filterColumn.SelectedItem = null;
@@ -87,6 +107,11 @@ private void clearButton_Click(object sender, EventArgs e)
             MainForm.Filter(FilterString);
         }
 
+        /// <summary>
+        /// Handle a selection change of the filter type
+        /// </summary>
+        /// <param name="sender"></param>
+        /// <param name="e"></param>
         private void filterTypeCb_SelectedIndexChanged(object sender, EventArgs e)
         {
             UpdateFilter();

FindMissingRows/FindMissingRows.csproj

@@ -50,6 +50,7 @@
     <Reference Include="System.Xml" />
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="Extensions.cs" />
     <Compile Include="FilterDialog.cs">
       <SubType>Form</SubType>
     </Compile>

FindMissingRows/Form1.Designer.cs

@@ -3,7 +3,6 @@
 using System.Text;
 using System.Windows.Forms;
 using Microsoft.VisualBasic.FileIO;
-using System.Collections.Generic;
 
 namespace FindMissingRows
 {
@@ -35,6 +34,11 @@ public Form1()
             filterButton.Enabled = false;
         }
 
+        /// <summary>
+        /// Select the file to use for the member list
+        /// </summary>
+        /// <param name="sender"></param>
+        /// <param name="e"></param>
         private void SelectMemberList_Click(object sender, EventArgs e)
         {
             openFileDialog1.Filter = "CSV files (*.csv)|*.csv";
@@ -48,6 +52,11 @@ private void SelectMemberList_Click(object sender, EventArgs e)
             m_memberListInit = true;
         }
 
+        /// <summary>
+        /// Select the file to use for the compare list
+        /// </summary>
+        /// <param name="sender"></param>
+        /// <param name="e"></param>
         private void SelectListToCompare_Click(object sender, EventArgs e)
         {
             openFileDialog1.Filter = "CSV files (*.csv)|*.csv";
@@ -61,7 +70,12 @@ private void SelectListToCompare_Click(object sender, EventArgs e)
             m_compareListInit = true;
         }
 
-
+        /// <summary>
+        /// Read in a CSV file into data table and load combo box with column names from the new file
+        /// </summary>
+        /// <param name="csv_file_path">name of file to read in</param>
+        /// <param name="tableName">Title to give table</param>
+        /// <param name="comboBox">comboBox that will be reloaded with column names from file</param>
         private void FillDataTableFromCSVFile(string csv_file_path, string tableName, ref ComboBox comboBox)
         {
             // always start with a new table so that know the schema is correct
@@ -110,6 +124,11 @@ private void FillDataTableFromCSVFile(string csv_file_path, string tableName, re
             return;
         }
 
+        /// <summary>
+        /// Compare the two files and show the missing rows
+        /// </summary>
+        /// <param name="sender"></param>
+        /// <param name="e"></param>
         private void findMissingItems_Click(object sender, EventArgs e)
         {
             if (!m_compareListInit)
@@ -159,8 +178,19 @@ private void findMissingItems_Click(object sender, EventArgs e)
             // add index to compare list table
             DataColumn[] keys = new DataColumn[1];
             keys[0] = dtCompare.Columns[compareColName];
-            dtCompare.PrimaryKey = keys;
+            try
+            {
+                dtCompare.PrimaryKey = keys;
 
+            }
+            catch (Exception ex)
+            {
+                StringBuilder builder = new StringBuilder();
+                builder.AppendFormat("The file: {0}\n\nColumn: '{1}', must have unique values.\n\n", openFileDialog1.FileName, compareColName);
+                builder.AppendFormat("Error: {0}", ex.Message);
+                MessageBox.Show(builder.ToString());
+                return;
+            }
             // find missing items in compare
             foreach (DataRow row in dtMembers.Rows)
             {
@@ -194,6 +224,11 @@ private void exit_Click(object sender, EventArgs e)
             Close();
         }
 
+        /// <summary>
+        /// Save missing rows to a CSV file
+        /// </summary>
+        /// <param name="sender"></param>
+        /// <param name="e"></param>
         private void save_Click(object sender, EventArgs e)
         {
             SaveFileDialog saveDlg = new SaveFileDialog();
@@ -203,30 +238,10 @@ private void save_Click(object sender, EventArgs e)
             if (res != DialogResult.OK)
                 return;
 
-            StringBuilder output = new StringBuilder();
-
-            // output column headers row
-            int cnt = 1;
-            foreach (DataGridViewColumn col in dataGridView1.Columns)
-            {
-                output.AppendFormat("\"{0}\"", col.Name);
-                if (cnt++ < m_missingTable.Columns.Count)
-                    output.AppendFormat(",");
-            }
-            output.AppendLine();
-
-            cnt = 1;
-            foreach (DataGridViewRow row in dataGridView1.Rows)
+            using (System.IO.StreamWriter file = new System.IO.StreamWriter(saveDlg.FileName))
             {
-                for (int i = 0; i < row.Cells.Count;  i++)
-                {
-                    output.AppendFormat("\"{0}\"", row.Cells[i].FormattedValue);
-                    if (i < row.Cells.Count - 1)
-                        output.AppendFormat(",");
-                }
-                output.AppendLine();
+                file.Write(dataGridView1.ToCSV());
             }
-            System.IO.File.WriteAllText(saveDlg.FileName, output.ToString());
         }
 
         private void filterButton_Click(object sender, EventArgs e)
@@ -263,7 +278,7 @@ public void Filter(string filter)
             }
             catch (Exception ex)
             {
-                MessageBox.Show("Bad filter: " + ex.ToString());
+                MessageBox.Show("Bad filter: " + ex.Message);
             }
             resultSummary.Text = string.Format("{0} members missing out of {1}, {2} rows visible with filter", 
                 m_missingTable.Rows.Count, 

FindMissingRows/Form1.cs

@@ -32,5 +32,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers 
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("1.0.0.0")]
-[assembly: AssemblyFileVersion("1.0.0.0")]
+[assembly: AssemblyVersion("1.0.*")]
+//[assembly: AssemblyFileVersion("1.0.0.*")]