Improved code efficiency

Author: Ashley Davies

FileMasta/Data/Bookmark.cs

@@ -7,15 +7,15 @@
 
 namespace FileMasta.Data
 {
-    public class Database
+    public class DataCache
     {
         /// <summary>
-        /// Contains the web file elements in the database
+        /// Contains the array of files in the database
         /// </summary>
         private readonly List<WebFile> _dbFiles = new List<WebFile>();
 
         /// <summary>
-        /// Contains the users saved files url
+        /// Contains the users saved files
         /// </summary>
         private readonly List<string> _savedFiles = new List<string>();
 
@@ -27,7 +27,7 @@ public class Database
         /// <summary>
         /// Initialize the database instance
         /// </summary>
-        public Database()
+        public DataCache()
         {
             if (!HttpExtensions.IsFileSizeEqual(DataHelper.DatabaseFilePath, AppExtensions.DatabaseUrl))
                 HttpExtensions.DownloadFile(AppExtensions.DatabaseUrl, DataHelper.DatabaseFilePath);
@@ -96,22 +96,29 @@ public long GetTotalNoFiles()
             return _metadata.TotalNoFiles;
         }
 
+        private static readonly object Searching = new object();
+
         /// <summary>
-        /// Get the first file object that equals to the specified url
+        /// Find the first file object that matches the specified url
         /// </summary>
         /// <param name="fileUrl"></param>
         /// <returns></returns>
         public WebFile GetFile(string fileUrl)
         {
-            lock (SearchLock)
+            lock (Searching)
             {
                 return (from webFile in _dbFiles
                     where webFile.Url.Equals(fileUrl)
                     select webFile).First();
             }
         }
 
-        private static readonly object SearchLock = new object();
+        public enum Sort
+        {
+            Name,
+            Size,
+            Date
+        }
 
         /// <summary>
         /// Search files from the database
@@ -125,9 +132,9 @@ where webFile.Url.Equals(fileUrl)
         /// <returns>Returns a list of matching files with the specified parameters</returns>
         public List<WebFile> Search(Sort sort, string name, string[] type, long minSize, DateTime minDateModified, DateTime maxDateModified)
         {
-            lock (SearchLock)
+            lock (Searching)
             {
-                Sort(sort);
+                SortFiles(sort);
                 return (from webFile in _dbFiles
                     where StringExtensions.ContainsAll(Uri.UnescapeDataString(webFile.Url.ToLower()),
                               StringExtensions.GetWords(name.ToLower())) &&
@@ -144,19 +151,19 @@ where StringExtensions.ContainsAll(Uri.UnescapeDataString(webFile.Url.ToLower())
         /// </summary>
         /// <param name="sortBy">Sort Name, Date or Size</param>
         /// <param name="sortReverse">Reverse the sort order</param>
-        private void Sort(Sort sortBy, bool sortReverse = false)
+        private void SortFiles(Sort sortBy, bool sortReverse = false)
         {
             if (!sortReverse)
             {
                 _dbFiles.Sort(delegate (WebFile x, WebFile y)
                 {
                     switch (sortBy)
                     {
-                        case Data.Sort.Name:
+                        case Sort.Name:
                             return string.Compare(x.Name, y.Name, StringComparison.Ordinal);
-                        case Data.Sort.Date:
+                        case Sort.Date:
                             return x.LastModified.CompareTo(y.LastModified);
-                        case Data.Sort.Size:
+                        case Sort.Size:
                             return x.Size.CompareTo(y.Size);
                         default:
                             return string.Compare(x.Name, y.Name, StringComparison.Ordinal);
@@ -169,11 +176,11 @@ private void Sort(Sort sortBy, bool sortReverse = false)
                 {
                     switch (sortBy)
                     {
-                        case Data.Sort.Name:
+                        case Sort.Name:
                             return string.Compare(y.Name, x.Name, StringComparison.Ordinal);
-                        case Data.Sort.Date:
+                        case Sort.Date:
                             return y.LastModified.CompareTo(x.LastModified);
-                        case Data.Sort.Size:
+                        case Sort.Size:
                             return y.Size.CompareTo(x.Size);
                         default:
                             return string.Compare(y.Name, x.Name, StringComparison.Ordinal);
@@ -188,7 +195,7 @@ private void Sort(Sort sortBy, bool sortReverse = false)
         /// <returns>Returns a list of matching files with the specified parameters</returns>
         public List<WebFile> SavedFiles()
         {
-            lock (SearchLock)
+            lock (Searching)
             {
                 return (from webFile in _savedFiles
                     let file = GetFile(webFile)
@@ -199,53 +206,58 @@ public List<WebFile> SavedFiles()
         /// <summary>
         /// Save the specified file to users the saved list
         /// </summary>
-        /// <param name="fileUrl">URL to add</param>
-        public void AddToSaved(string fileUrl)
+        /// <param name="url">URL to add</param>
+        public void SaveFile(string url)
         {
-            _savedFiles.Add(fileUrl);
+            _savedFiles.Add(url);
         }
 
         /// <summary>
         /// Remove the specified file from the users saved list
         /// </summary>
-        /// <param name="fileUrl">URL to remove</param>
-        public void RemoveFromSaved(string fileUrl)
+        /// <param name="url">URL to remove</param>
+        public void UnsaveFile(string url)
         {
-            _savedFiles.Remove(fileUrl);
+            _savedFiles.Remove(url);
         }
 
         /// <summary>
         /// Check if user has saved the specified file
         /// </summary>
-        /// <param name="fileUrl">URL of the File</param>
+        /// <param name="url">URL of the File</param>
         /// <returns>True if exists</returns>
-        public bool IsFileSaved(string fileUrl)
+        public bool IsFileSaved(string url)
         {
             foreach (var file in _savedFiles)
-                if (file == fileUrl)
+                if (file == url)
                     return true;
             return false;
         }
 
         /// <summary>
         /// Remove all saved file urls
         /// </summary>
-        public void ClearSaved()
+        public void WipeSaved()
         {
             _savedFiles.Clear();
         }
 
         /// <summary>
-        /// Save/update saved files to a local file
+        /// Save/update users saved files to a local file
         /// </summary>
-        public void UpdateSavedFile()
+        public void CreateSavedFile()
         {
-            if (_savedFiles.Count == 0) { DataHelper.RemoveSavedFile(); return; }
+            if (_savedFiles.Count == 0) { DeleteSavedFile(); return; }
             using (var fs = File.OpenWrite(DataHelper.SavedFilePath))
             using (var bs = new BufferedStream(fs))
             using (var sw = new StreamWriter(bs))
                 foreach (var fileUrl in _savedFiles)
                     sw.WriteLine(fileUrl);
         }
+        
+        public void DeleteSavedFile()
+        {
+            if (File.Exists(DataHelper.SavedFilePath)) File.Delete(DataHelper.SavedFilePath);
+        }
     }
 }

FileMasta/Data/Database.cs FileMasta/Data/DataCache.csFileMasta/Data/Database.cs renamed to FileMasta/Data/DataCache.cs

@@ -17,11 +17,6 @@ public static WebFile CreateFile(string fileUrl)
             return new WebFile(Path.GetFileName(fileUrl), FtpExtensions.GetFileSize(fileUrl), FtpExtensions.GetFileLastModified(fileUrl), fileUrl);
         }
 
-        public static void RemoveSavedFile()
-        {
-            if (File.Exists(SavedFilePath)) File.Delete(SavedFilePath);
-        }
-
         /// <summary>
         /// Retrieve list of keywords from database
         /// </summary>

FileMasta/Data/DataHelper.cs

@@ -92,13 +92,11 @@
     <Reference Include="System.Xml" />
   </ItemGroup>
   <ItemGroup>
-    <Compile Include="Data\Bookmark.cs" />
-    <Compile Include="Data\Database.cs" />
+    <Compile Include="Data\DataCache.cs" />
     <Compile Include="Data\DataHelper.cs" />
-    <Compile Include="Data\Sort.cs" />
     <Compile Include="Extensions\FtpExtensions.cs" />
     <Compile Include="Extensions\HttpExtensions.cs" />
-    <Compile Include="Utils\Engines.cs" />
+    <Compile Include="Utilities\Engines.cs" />
     <Compile Include="Forms\AboutDialog.cs">
       <SubType>Form</SubType>
     </Compile>
@@ -145,7 +143,7 @@
     <Compile Include="Extensions\LocalExtensions.cs" />
     <Compile Include="Extensions\AppExtensions.cs" />
     <Compile Include="Extensions\StringExtensions.cs" />
-    <Compile Include="Utils\Update.cs" />
+    <Compile Include="Utilities\Update.cs" />
     <EmbeddedResource Include="Forms\AboutDialog.resx">
       <DependentUpon>AboutDialog.cs</DependentUpon>
     </EmbeddedResource>