refactor: Rewrite pyRevit configurations

dev/Directory.Build.targets

@@ -2,7 +2,7 @@
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
     <PropertyGroup>
         <NetFolder Condition="'$(TargetFramework)' == 'net48'">netfx</NetFolder>
-        <NetFolder Condition="'$(TargetFramework)' == 'net8.0-windows'">netcore</NetFolder>
+        <NetFolder Condition="'$(TargetFramework.StartsWith(net8.0))'">netcore</NetFolder>
     </PropertyGroup>
 
     <PropertyGroup>

dev/pyRevitLabs/pyRevitLabs.Common/pyRevitLabs.Common.csproj

@@ -17,9 +17,6 @@
         <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.10.0"/>
         <PackageReference Include="Microsoft.CodeAnalysis.VisualBasic" Version="4.10.0"/>
 
-        <PackageReference Condition="'$(TargetFrameworkIdentifier)' == '.NETFramework'" Include="MadMilkman.Ini" Version="1.0.6"/>
-        <PackageReference Condition="'$(TargetFrameworkIdentifier)' == '.NetCoreApp'" Include="MadMilkman.Ini.Unofficial" Version="1.0.1"/>
-
         <Reference Condition="'$(TargetFrameworkIdentifier)' == '.NETFramework'" Include="System.Management"/>
         <PackageReference Condition="'$(TargetFrameworkIdentifier)' == '.NetCoreApp'" Include="System.Management" Version="8.0.0"/>
     </ItemGroup>
@@ -36,7 +33,6 @@
         <Copy SourceFiles="$(OutDir)\DotNetVersionFinder.dll" DestinationFolder="$(PyRevitBinDir)"/>
         <Copy SourceFiles="$(OutDir)\LibGit2Sharp.dll" DestinationFolder="$(PyRevitBinDir)"/>
         <Copy SourceFiles="@(LibGit2SharpNative)" DestinationFolder="$(PyRevitBinDir)"/>
-        <Copy SourceFiles="$(OutDir)\MadMilkman.Ini.dll" DestinationFolder="$(PyRevitBinDir)"/>
         <Copy SourceFiles="$(OutDir)\OpenMcdf.dll" DestinationFolder="$(PyRevitBinDir)"/>
         <Copy SourceFiles="$(OutDir)\YamlDotNet.dll" DestinationFolder="$(PyRevitBinDir)"/>
         <Copy SourceFiles="$(OutDir)\Microsoft.CodeAnalysis.dll" DestinationFolder="$(PyRevitBinDir)"/>

dev/pyRevitLabs/pyRevitLabs.Configurations.Ini/Extensions/IniConfigurationExtensions.cs

@@ -0,0 +1,15 @@
+namespace pyRevitLabs.Configurations.Ini.Extensions;
+
+public static class IniConfigurationExtensions
+{
+    public static ConfigurationBuilder AddIniConfiguration(this ConfigurationBuilder builder, string configurationPath, bool readOnly = default)
+    {
+        if (builder == null)
+            throw new ArgumentNullException(nameof(builder));
+
+        if (string.IsNullOrWhiteSpace(configurationPath))
+            throw new ArgumentException("Value cannot be null or whitespace.", nameof(configurationPath));
+
+        return builder.AddConfigurationSource(IniConfiguration.Create(configurationPath, readOnly));
+    }
+}

dev/pyRevitLabs/pyRevitLabs.Configurations.Ini/IniConfiguration.cs

@@ -0,0 +1,93 @@
+using System.Text;
+using IniParser;
+using IniParser.Model;
+using pyRevitLabs.Configurations.Abstractions;
+using pyRevitLabs.Configurations.Exceptions;
+using pyRevitLabs.Json;
+
+namespace pyRevitLabs.Configurations.Ini;
+
+public sealed class IniConfiguration : ConfigurationBase
+{
+    public static readonly Encoding DefaultIniFileEncoding = new UTF8Encoding(false);
+
+    private readonly IniData _iniFile;
+    private readonly FileIniDataParser _parser;
+
+    /// <summary>
+    /// Create ini configuration instance.
+    /// </summary>
+    /// <param name="configurationPath">Configuration path.</param>
+    /// <param name="readOnly">Admin configurations </param>
+    private IniConfiguration(string configurationPath, bool readOnly)
+        : base(configurationPath, readOnly)
+    {
+        _parser = new FileIniDataParser();
+        _iniFile = !File.Exists(configurationPath)
+            ? new IniData()
+            : _parser.ReadFile(_configurationPath, DefaultIniFileEncoding);
+    }
+
+    /// <summary>
+    /// Creates IniConfiguration.
+    /// </summary>
+    /// <param name="configurationPath">Configuration file path.</param>
+    /// <param name="readOnly">Mark file is readonly.</param>
+    /// <returns>Return new IniConfiguration.</returns>
+    /// <exception cref="ArgumentNullException">When configurationPath is null.</exception>
+    public static IConfiguration Create(string configurationPath, bool readOnly = default)
+    {
+        if (configurationPath is null)
+            throw new ArgumentNullException(nameof(configurationPath));
+
+        return new IniConfiguration(configurationPath, readOnly);
+    }
+
+    /// <inheritdoc />
+    protected override void SaveConfigurationImpl()
+    {
+        _parser.WriteFile(_configurationPath, _iniFile, DefaultIniFileEncoding);
+    }
+
+    /// <inheritdoc />
+    protected override bool HasSectionImpl(string sectionName)
+    {
+        return _iniFile.Sections.ContainsSection(sectionName);
+    }
+
+    /// <inheritdoc />
+    protected override bool HasSectionKeyImpl(string sectionName, string keyName)
+    {
+        return HasSection(sectionName)
+               && _iniFile.Sections[sectionName].ContainsKey(keyName);
+    }
+
+    /// <inheritdoc />
+    protected override bool RemoveValueImpl(string sectionName, string keyName)
+    {
+        return _iniFile[sectionName].RemoveKey(keyName);
+    }
+
+    /// <inheritdoc />
+    protected override T GetValueImpl<T>(string sectionName, string keyName)
+    {
+        return JsonConvert.DeserializeObject<T>(_iniFile[sectionName][keyName])
+               ?? throw new ConfigurationException("Cannot deserialize value using the specified key.");
+    }
+
+    /// <inheritdoc />
+    protected override void SetValueImpl<T>(string sectionName, string keyName, T value)
+    {
+        if (!HasSection(sectionName))
+        {
+            _iniFile.Sections.AddSection(sectionName);
+        }
+
+        if (!HasSectionKey(sectionName, keyName))
+        {
+            _iniFile[sectionName].AddKey(keyName);
+        }
+
+        _iniFile[sectionName][keyName] = JsonConvert.SerializeObject(value);
+    }
+}

dev/pyRevitLabs/pyRevitLabs.Configurations.Ini/pyRevitLabs.Configurations.Ini.csproj

@@ -0,0 +1,19 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <TargetFrameworks>net48;net8.0</TargetFrameworks>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+        <LangVersion>12</LangVersion>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <PackageReference Include="ini-parser-netstandard" Version="2.5.2" />
+        <Reference Include="pyRevitLabs.Json" HintPath="$(PyRevitDevLibsDir)\pyRevitLabs.Json.dll" Private="false"/>
+    </ItemGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\pyRevitLabs.Configurations\pyRevitLabs.Configurations.csproj" />
+    </ItemGroup>
+
+</Project>

dev/pyRevitLabs/pyRevitLabs.Configurations.Json/Extensions/JsonConfigurationExtensions.cs

@@ -0,0 +1,15 @@
+namespace pyRevitLabs.Configurations.Json.Extensions;
+
+public static class JsonConfigurationExtensions
+{
+    public static ConfigurationBuilder AddJsonConfiguration(this ConfigurationBuilder builder, string configurationPath, bool readOnly = default)
+    {
+        if (builder == null)
+            throw new ArgumentNullException(nameof(builder));
+
+        if (string.IsNullOrWhiteSpace(configurationPath))
+            throw new ArgumentException("Value cannot be null or whitespace.", nameof(configurationPath));
+
+        return builder.AddConfigurationSource(JsonConfiguration.Create(configurationPath, readOnly));
+    }
+}

dev/pyRevitLabs/pyRevitLabs.Configurations.Json/JsonConfiguration.cs

@@ -0,0 +1,103 @@
+using System.Text;
+using System.Xml;
+using pyRevitLabs.Configurations.Abstractions;
+using pyRevitLabs.Configurations.Exceptions;
+using pyRevitLabs.Json;
+using pyRevitLabs.Json.Linq;
+using Formatting = pyRevitLabs.Json.Formatting;
+
+namespace pyRevitLabs.Configurations.Json;
+
+public sealed class JsonConfiguration : ConfigurationBase
+{
+    public static readonly Encoding DefaultJsonFileEncoding = Encoding.UTF8;
+
+    private readonly JObject _jsonObject;
+
+    /// <summary>
+    /// Create json configuration instance.
+    /// </summary>
+    /// <param name="configurationPath">Configuration path.</param>
+    /// <param name="readOnly">Readonly configurations </param>
+    private JsonConfiguration(string configurationPath, bool readOnly)
+        : base(configurationPath, readOnly)
+    {
+        _jsonObject = !File.Exists(configurationPath)
+            ? new JObject()
+            : JObject.Parse(File.ReadAllText(_configurationPath, DefaultJsonFileEncoding));
+    }
+
+    /// <summary>
+    /// Creates JsonConfiguration.
+    /// </summary>
+    /// <param name="configurationPath">Configuration file path.</param>
+    /// <param name="readOnly">Mark file is readonly.</param>
+    /// <returns>Return new JsonConfiguration.</returns>
+    /// <exception cref="ArgumentNullException">When configurationPath is null.</exception>
+    public static IConfiguration Create(string configurationPath, bool readOnly = default)
+    {
+        if (configurationPath is null)
+            throw new ArgumentNullException(nameof(configurationPath));
+
+        return new JsonConfiguration(configurationPath, readOnly);
+    }
+
+    protected override void SaveConfigurationImpl()
+    {
+        string jsonString = JsonConvert.SerializeObject(_jsonObject,
+            new JsonSerializerSettings() {Formatting = Formatting.Indented});
+        File.WriteAllText(_configurationPath, jsonString, DefaultJsonFileEncoding);
+    }
+
+    protected override bool HasSectionImpl(string sectionName)
+    {
+        return _jsonObject.ContainsKey(sectionName);
+    }
+
+    protected override bool HasSectionKeyImpl(string sectionName, string keyName)
+    {
+        JObject? sectionObject = _jsonObject[sectionName] as JObject;
+        return sectionObject?.ContainsKey(keyName) == true;
+    }
+
+    protected override bool RemoveValueImpl(string sectionName, string keyName)
+    {
+        _jsonObject[sectionName]![keyName] = null;
+        return true;
+    }
+
+    protected override T GetValueImpl<T>(string sectionName, string keyName)
+    {
+        JToken? token = _jsonObject[sectionName]?[keyName];
+        return token is null
+            ? throw new ConfigurationException($"Section {sectionName} or keyName {keyName} not found.")
+            : token.ToObject<T>()
+              ?? throw new ConfigurationException($"Cannot deserialize value with {sectionName} and {keyName}.");
+    }
+
+    protected override void SetValueImpl<T>(string sectionName, string keyName, T value)
+    {
+        if (!HasSection(sectionName))
+        {
+            JObject fromObject = new();
+            fromObject.Add(keyName, JToken.FromObject(value!));
+
+            _jsonObject.Add(sectionName, fromObject);
+
+            return;
+        }
+
+        if (!HasSectionKey(sectionName, keyName))
+        {
+            JObject fromObject = new();
+            fromObject.Add(keyName, JToken.FromObject(value!));
+
+            JObject? sectionObject = (JObject?)_jsonObject[sectionName];
+            sectionObject?.Add(keyName, fromObject);
+
+            return;
+        }
+
+        _jsonObject[sectionName]![keyName] = JToken.FromObject(value!);
+    }
+}

dev/pyRevitLabs/pyRevitLabs.Configurations.Json/pyRevitLabs.Configurations.Json.csproj

@@ -0,0 +1,18 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <TargetFrameworks>net48;net8.0</TargetFrameworks>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+        <LangVersion>12</LangVersion>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <Reference Include="pyRevitLabs.Json" HintPath="$(PyRevitDevLibsDir)\pyRevitLabs.Json.dll" Private="false"/>
+    </ItemGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\pyRevitLabs.Configurations\pyRevitLabs.Configurations.csproj" />
+    </ItemGroup>
+
+</Project>

dev/pyRevitLabs/pyRevitLabs.Configurations.Yaml/Extensions/YamlConfigurationExtensions.cs

@@ -0,0 +1,15 @@
+namespace pyRevitLabs.Configurations.Yaml.Extensions;
+
+public static class YamlConfigurationExtensions
+{
+    public static ConfigurationBuilder AddYamlConfiguration(this ConfigurationBuilder builder, string configurationPath, bool readOnly = default)
+    {
+        if (builder == null)
+            throw new ArgumentNullException(nameof(builder));
+
+        if (string.IsNullOrWhiteSpace(configurationPath))
+            throw new ArgumentException("Value cannot be null or whitespace.", nameof(configurationPath));
+
+        return builder.AddConfigurationSource(YamlConfiguration.Create(configurationPath, readOnly));
+    }
+}