Merge pull request #1 from Grumgog/refactor-Scrap-mod

(refactor): ScrapMod class code refactoring

ScrapModLoader/ModsLauncher.cs

@@ -32,7 +32,7 @@ namespace ScrapModLoader
                 {
                     String[] files = Directory.GetFiles(folder, "*.sm", SearchOption.AllDirectories);
                     foreach (String file in files)
-                        Mods.Add(new ScrapMod(file));
+                        Mods.Add(ScrapMod.LoadFromFile(file));
                 }
             }
         }

ScrapModLoader/ScrapMod.cs

@@ -2,7 +2,6 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Windows.Media.Imaging;
-using System.Xml;
 
 using Ionic.Zip;
 
@@ -12,41 +11,33 @@ namespace ScrapModLoader
 {
     public class ScrapMod
     {
-        public String Name { get; private set; }
+        public String Name { get; private set; } = String.Empty;
-        public String Description { get; private set; }
-        public String ModPath { get; private set; }
-        public BitmapImage Icon { get; private set; }
-        public Boolean Checked { get; set; }
-        public String Category { get; private set; }
-        public String Version { get; private set; }
-        public String RequiredLauncher { get; private set; }
-        public List<String> SupportedGameVersions { get; private set; }
-        public String SupportedGameVersionsDisplay { 
-            get
-            {
-                String result = String.Empty;
-                foreach (String version in SupportedGameVersions)
-                    result += version + ", ";
-                return result.TrimEnd(',', ' ');
-            } 
-        }
-        public List<String> Authors { get; private set; }
-        public Dictionary<String, List<String>> Credits { get; private set; }
 
-        public ScrapMod(String path)
+        public String Description { get; private set; } = String.Empty;
+
+        public String ModPath { get; private set; } = String.Empty;
+
+        public BitmapImage Icon { get; private set; } = new BitmapImage();
+
+        public Boolean Checked { get; set; } = false;
+
+        public String Category { get; private set; } = String.Empty;
+
+        public String Version { get; private set; } = String.Empty;
+
+        public String RequiredLauncher { get; private set; } = String.Empty;
+
+        public List<String> SupportedGameVersions { get; private set; } = new List<String>();
+
+        public String SupportedGameVersionsDisplay => String.Join(", ", SupportedGameVersions);
+
+        public List<String> Authors { get; private set; } = new List<String>();
+
+        public Dictionary<String, List<String>> Credits { get; private set; } = new Dictionary<String, List<String>>();
+
+        private ScrapMod()
         {
-            ModPath = path;
+
-            Name = String.Empty;
-            Description = String.Empty;
-            Icon = new BitmapImage();
-            Checked = false;
-            Category = String.Empty;
-            Version = String.Empty;
-            RequiredLauncher = String.Empty;
-            SupportedGameVersions = new List<String>();
-            Authors = new List<String>();
-            Credits = new Dictionary<String, List<String>>();
-            LoadFromFile(path);
         }
 
 
@@ -108,61 +99,46 @@ namespace ScrapModLoader
             }
         }
 
-        private void LoadFromFile(String path)
+        public static ScrapMod LoadFromFile(String path)
         {
-            using (ZipFile zipFile = ZipFile.Read(path))
+            using ZipFile zipFile = ZipFile.Read(path);
+
+            Byte[] iconBuffer = Utils.ExtractFromZip(zipFile, "icon.png");
+            Byte[] confBuffer = Utils.ExtractFromZip(zipFile, "config.toml");
+
+            ScrapMod mod = new ScrapMod()
             {
-                Byte[] iconBuffer = ExtractFromZip(zipFile, "icon.png");
+                ModPath = path,
-                Byte[] confBuffer = ExtractFromZip(zipFile, "config.toml");
+                Icon = Utils.LoadImage(iconBuffer)
-                LoadIcon(iconBuffer);
+            };
-                LoadConfig(confBuffer);
+
-            }
+            LoadConfig(mod, confBuffer);
+
+            return mod;
         }
 
-        private Byte[] ExtractFromZip(ZipFile zip, String entry_path)
-        {
-            ZipEntry? entry = zip[entry_path];
-            if (entry == null)
-                throw new FileFormatException($"No '{entry_path}' in {Name} found");
 
-            Byte[] buffer = new Byte[entry.UncompressedSize];
-            using (MemoryStream zipStream = new MemoryStream(buffer))
-                entry.Extract(zipStream);
 
-            return buffer;
+        private static void LoadConfig(ScrapMod mod, Byte[] buffer)
-        }
+        {
+            using MemoryStream sourceStream = new MemoryStream(buffer);
+            using StreamReader reader = new StreamReader(sourceStream);
 
-        private void LoadIcon(Byte[] buffer)
-        {
-            using (MemoryStream sourceStream = new MemoryStream(buffer))
-            {
-                Icon.BeginInit();
-                Icon.CacheOption = BitmapCacheOption.OnLoad;
-                Icon.StreamSource = sourceStream;
-                Icon.EndInit();
-            }
-        }
-
-        private void LoadConfig(Byte[] buffer)
-        {
-            using (MemoryStream sourceStream = new MemoryStream(buffer))
-            using (StreamReader reader = new StreamReader(sourceStream))
-            {
             TomlTable config = TOML.Parse(reader);
 
             CheckConfig(config);
 
-                Name = config["title"];
+            mod.Name = config["title"];
-                Description = config["description"];
+            mod.Description = config["description"];
-                Category = config["category"];
+            mod.Category = config["category"];
-                Version = config["version"];
+            mod.Version = config["version"];
-                RequiredLauncher = config["requiredLauncher"];
+            mod.RequiredLauncher = config["requiredLauncher"];
 
             foreach (TomlNode version in config["supportedGameVersions"])
-                    SupportedGameVersions.Add(version);
+                mod.SupportedGameVersions.Add(version);
 
             foreach (TomlNode author in config["authors"])
-                    Authors.Add(author["name"]);
+                mod.Authors.Add(author["name"]);
 
             foreach (TomlNode credit in config["credits"])
             {
@@ -171,8 +147,7 @@ namespace ScrapModLoader
                 foreach (TomlNode entry in credit["credits"])
                     entries.Add(entry["name"]);
 
-                    Credits.Add(credit["group"], entries);
+                mod.Credits.Add(credit["group"], entries);
-                }
             }
         }
 

ScrapModLoader/Utils.cs

@@ -1,11 +1,16 @@
 using System;
 using System.Collections.Generic;
 using System.Collections.Specialized;
+using System.IO;
+using System.Windows.Media.Imaging;
 
-namespace ScrapModLoader
+using Ionic.Zip;
+
+
+namespace ScrapModLoader;
+
+internal static class Utils
 {
-    internal static class Utils
-    {
     public static String GetFolderDialog()
     {
         using System.Windows.Forms.FolderBrowserDialog? dialog = new System.Windows.Forms.FolderBrowserDialog();
@@ -23,5 +28,32 @@ namespace ScrapModLoader
         }
         return list;
     }
+
+    public static Byte[] ExtractFromZip(ZipFile zip, String entry_path)
+    {
+        ZipEntry? entry = zip[entry_path];
+        if (entry == null)
+            throw new FileFormatException($"No '{entry_path}' in {zip.Name} found");
+
+        Byte[] buffer = new Byte[entry.UncompressedSize];
+        using (MemoryStream zipStream = new MemoryStream(buffer))
+            entry.Extract(zipStream);
+
+        return buffer;
+    }
+
+    public static BitmapImage LoadImage(Byte[] buffer)
+    {
+        using MemoryStream sourceStream = new MemoryStream(buffer);
+
+        BitmapImage? image = new BitmapImage();
+
+        image.BeginInit();
+        image.CacheOption = BitmapCacheOption.OnLoad;
+        image.StreamSource = sourceStream;
+        image.EndInit();
+
+        return image;
     }
 }
+