Create SerializableComponent: Better, unified API for serializable objects

Author: marticliment

src/UniGetUI.PAckageEngine.Interfaces/IInstallationOptions.cs

@@ -20,14 +20,14 @@ public interface IInstallationOptions
         public IPackage Package { get; }
 
         /// <summary>
-        /// Loads and applies the options from the given SerializableInstallationOptions_v1 object to the current object.
+        /// Loads and applies the options from the given SerializableInstallationOptions object to the current object.
         /// </summary>
-        public void FromSerializable(SerializableInstallationOptions_v1 options);
+        public void FromSerializable(SerializableInstallationOptions options);
 
         /// <summary>
-        /// Returns a SerializableInstallationOptions_v1 object containing the options of the current instance.
+        /// Returns a SerializableInstallationOptions object containing the options of the current instance.
         /// </summary>
-        public SerializableInstallationOptions_v1 AsSerializable();
+        public SerializableInstallationOptions AsSerializable();
 
         /// <summary>
         /// Saves the current options to disk, asynchronously.

src/UniGetUI.PackageEngine.PackageManagerClasses/Packages/Classes/InstallationOptions.cs

@@ -95,9 +95,9 @@ public static async Task<InstallationOptions> FromPackageAsync(IPackage package,
         }
 
         /// <summary>
-        /// Returns a new InstallationOptions object from a given SerializableInstallationOptions_v1 and a package.
+        /// Returns a new InstallationOptions object from a given SerializableInstallationOptions and a package.
         /// </summary>
-        public static InstallationOptions FromSerialized(SerializableInstallationOptions_v1 options, IPackage package)
+        public static InstallationOptions FromSerialized(SerializableInstallationOptions options, IPackage package)
         {
             InstallationOptions instance = new(package);
             instance.FromSerializable(options);
@@ -111,9 +111,9 @@ public static InstallationOptions CreateEmpty(IPackage package)
         }
 
         /// <summary>
-        /// Loads and applies the options from the given SerializableInstallationOptions_v1 object to the current object.
+        /// Loads and applies the options from the given SerializableInstallationOptions object to the current object.
         /// </summary>
-        public void FromSerializable(SerializableInstallationOptions_v1 options)
+        public void FromSerializable(SerializableInstallationOptions options)
         {
             SkipHashCheck = options.SkipHashCheck;
             InteractiveInstallation = options.InteractiveInstallation;
@@ -145,11 +145,11 @@ public void FromSerializable(SerializableInstallationOptions_v1 options)
         }
 
         /// <summary>
-        /// Returns a SerializableInstallationOptions_v1 object containing the options of the current instance.
+        /// Returns a SerializableInstallationOptions object containing the options of the current instance.
         /// </summary>
-        public SerializableInstallationOptions_v1 AsSerializable()
+        public SerializableInstallationOptions AsSerializable()
         {
-            SerializableInstallationOptions_v1 options = new()
+            SerializableInstallationOptions options = new()
             {
                 SkipHashCheck = SkipHashCheck,
                 InteractiveInstallation = InteractiveInstallation,
@@ -229,7 +229,7 @@ public void LoadFromDisk()
                 if (jsonData is null)
                     return;
 
-                var serializedOptions = SerializableInstallationOptions_v1.FromJsonString(jsonData);
+                var serializedOptions = SerializableInstallationOptions.FromJsonString(jsonData);
                 FromSerializable(serializedOptions);
             }
             catch (JsonException)

src/UniGetUI.PackageEngine.PackageManagerClasses/Packages/ImportedPackage.cs

@@ -11,7 +11,7 @@ public partial class ImportedPackage : Package
         /// Construct an invalid package with a given name, id, version, source and manager, and an optional scope.
         /// </summary>
         public SerializableUpdatesOptions_v1 updates_options;
-        public SerializableInstallationOptions_v1 installation_options;
+        public SerializableInstallationOptions installation_options;
 
         private readonly string _version;
 

src/UniGetUI.PackageEngine.Serializable/SerializableComponent.cs

@@ -0,0 +1,52 @@
+using System.Text.Json;
+using System.Text.Json.Nodes;
+using UniGetUI.Core.Data;
+
+namespace UniGetUI.PackageEngine.Serializable;
+
+public abstract class SerializableComponent
+{
+    /// <summary>
+    /// Creates a deep copy of the object
+    /// </summary>
+    /// <returns>A memory-independend copy of this</returns>
+    public abstract SerializableComponent Copy();
+
+    /// <summary>
+    /// Loads data for this object from a JsonNode object
+    /// </summary>
+    /// <param name="data">The JSON from which to load the data</param>
+    public abstract void LoadFromJson(JsonNode data);
+
+    /// <summary>
+    /// Serializes this object into a JsonNode object
+    /// </summary>
+    /// <returns>A pretty-formatted JSON string representing the current data</returns>
+    public string AsJsonString()
+    {
+        return JsonSerializer.Serialize(this, SerializationHelpers.DefaultOptions);
+    }
+
+    /// <summary>
+    /// Serializes this object into a JsonNode object
+    /// </summary>
+    /// <returns>A pretty-formatted JSON string representing the current data</returns>
+    public JsonNode AsJsonNode()
+    {
+        return JsonNode.Parse(AsJsonString()) ?? throw new InvalidDataException("The JSON object could not be parsed to a JsonNode");
+    }
+
+    /// <summary>
+    /// Creates an instance of this object with the default data
+    /// </summary>
+    public SerializableComponent() {}
+
+    /// <summary>
+    /// Creates an instance of this object, and loads the data from the given JsonNode object
+    /// </summary>
+    /// <param name="data">The JSON from which to load the data</param>
+    public SerializableComponent(JsonNode data)
+    {
+        LoadFromJson(data);
+    }
+}

src/UniGetUI.PackageEngine.Serializable/SerializableInstallationOptions.cs

@@ -2,7 +2,7 @@
 
 namespace UniGetUI.PackageEngine.Serializable
 {
-    public class SerializableInstallationOptions_v1
+    public class SerializableInstallationOptions: SerializableComponent
     {
         public bool SkipHashCheck { get; set; }
         public bool InteractiveInstallation { get; set; }
@@ -15,7 +15,7 @@ public class SerializableInstallationOptions_v1
         public string Version { get; set; } = "";
         public bool SkipMinorUpdates { get; set; }
 
-        public SerializableInstallationOptions_v1 Copy()
+        public override SerializableInstallationOptions Copy()
         {
             return new()
             {
@@ -32,24 +32,22 @@ public SerializableInstallationOptions_v1 Copy()
             };
         }
 
-        public static SerializableInstallationOptions_v1 FromJsonString(JsonNode data)
+        public override void LoadFromJson(JsonNode data)
         {
-            var options = new SerializableInstallationOptions_v1();
-            options.SkipHashCheck = data[nameof(SkipHashCheck)]?.GetValue<bool>() ?? false;
-            options.InteractiveInstallation = data[nameof(InteractiveInstallation)]?.GetValue<bool>() ?? false;
-            options.RunAsAdministrator = data[nameof(RunAsAdministrator)]?.GetValue<bool>() ?? false;
-            options.Architecture = data[nameof(Architecture)]?.GetValue<string>() ?? "";
-            options.InstallationScope = data[nameof(InstallationScope)]?.GetValue<string>() ?? "";
+            this.SkipHashCheck = data[nameof(SkipHashCheck)]?.GetValue<bool>() ?? false;
+            this.InteractiveInstallation = data[nameof(InteractiveInstallation)]?.GetValue<bool>() ?? false;
+            this.RunAsAdministrator = data[nameof(RunAsAdministrator)]?.GetValue<bool>() ?? false;
+            this.Architecture = data[nameof(Architecture)]?.GetValue<string>() ?? "";
+            this.InstallationScope = data[nameof(InstallationScope)]?.GetValue<string>() ?? "";
 
-            options.CustomParameters = new List<string>();
+            this.CustomParameters = new List<string>();
             foreach(var element in data[nameof(CustomParameters)]?.AsArray() ?? [])
-                if (element is not null) options.CustomParameters.Add(element.GetValue<string>());
+                if (element is not null) this.CustomParameters.Add(element.GetValue<string>());
 
-            options.PreRelease = data[nameof(PreRelease)]?.GetValue<bool>() ?? false;
-            options.CustomInstallLocation = data[nameof(CustomInstallLocation)]?.GetValue<string>() ?? "";
-            options.Version = data[nameof(Version)]?.GetValue<string>() ?? "";
-            options.SkipMinorUpdates = data[nameof(SkipMinorUpdates)]?.GetValue<bool>() ?? false;
-            return options;
+            this.PreRelease = data[nameof(PreRelease)]?.GetValue<bool>() ?? false;
+            this.CustomInstallLocation = data[nameof(CustomInstallLocation)]?.GetValue<string>() ?? "";
+            this.Version = data[nameof(Version)]?.GetValue<string>() ?? "";
+            this.SkipMinorUpdates = data[nameof(SkipMinorUpdates)]?.GetValue<bool>() ?? false;
         }
     }
 }

src/UniGetUI.PackageEngine.Serializable/SerializablePackage_v1.cs

@@ -32,7 +32,7 @@ public class SerializablePackage_v1
         /// <summary>
         /// The InstallationOptions associated to this package
         /// </summary>
-        public SerializableInstallationOptions_v1 InstallationOptions { get; set; } = new();
+        public SerializableInstallationOptions InstallationOptions { get; set; } = new();
 
         /// <summary>
         /// The Updates preferences associated to this package

src/UniGetUI.PackageEngine.Serializable/UniGetUI.PackageEngine.Serializable.csproj

@@ -5,4 +5,10 @@
   <ItemGroup>
     <Compile Include="..\SharedAssemblyInfo.cs" Link="SharedAssemblyInfo.cs" />
   </ItemGroup>
+
+
+
+  <ItemGroup>
+    <ProjectReference Include="..\UniGetUI.Core.Tools\UniGetUI.Core.Tools.csproj" />
+  </ItemGroup>
 </Project>

src/UniGetUI/Pages/DialogPages/DialogHelper_Packages.cs

@@ -50,10 +50,10 @@ public static async Task<ContentDialogResult> ShowInstallOptions_ImportedPackage
         return dialogResult;
     }
 
-    private static async Task<(SerializableInstallationOptions_v1, ContentDialogResult)> ShowInstallOptions(
+    private static async Task<(SerializableInstallationOptions, ContentDialogResult)> ShowInstallOptions(
         IPackage package,
         OperationType operation,
-        SerializableInstallationOptions_v1 options)
+        SerializableInstallationOptions options)
     {
         InstallOptionsPage OptionsPage = new(package, operation, options);
 

src/UniGetUI/Pages/DialogPages/InstallOptions.xaml.cs

@@ -18,15 +18,15 @@ namespace UniGetUI.Interface.Dialogs
     /// </summary>
     public sealed partial class InstallOptionsPage : Page
     {
-        public SerializableInstallationOptions_v1 Options;
+        public SerializableInstallationOptions Options;
         public IPackage Package;
         public event EventHandler? Close;
         private readonly OperationType Operation;
         private readonly string packageInstallLocation;
         private bool _uiLoaded;
 
-        public InstallOptionsPage(IPackage package, SerializableInstallationOptions_v1 options) : this(package, OperationType.None, options) { }
-        public InstallOptionsPage(IPackage package, OperationType operation, SerializableInstallationOptions_v1 options)
+        public InstallOptionsPage(IPackage package, SerializableInstallationOptions options) : this(package, OperationType.None, options) { }
+        public InstallOptionsPage(IPackage package, OperationType operation, SerializableInstallationOptions options)
         {
             Package = package;
             InitializeComponent();
@@ -161,7 +161,7 @@ private async Task LoadVersions()
             VersionProgress.Visibility = Visibility.Collapsed;
         }
 
-        public async Task<SerializableInstallationOptions_v1> GetUpdatedOptions(bool updateIgnoredUpdates = true)
+        public async Task<SerializableInstallationOptions> GetUpdatedOptions(bool updateIgnoredUpdates = true)
         {
             Options.RunAsAdministrator = AdminCheckBox?.IsChecked ?? false;
             Options.InteractiveInstallation = InteractiveCheckBox?.IsChecked ?? false;