Merge pull request #38 from MagmaWorks/task/common-serialization

Single common serialization
MagmaWorks · Nov 5, 2024 · b321dbd · b321dbd
2 parents f8d4d01 + 1ded648
commit b321dbd
Show file tree

Hide file tree

Showing 34 changed files with 181 additions and 71 deletions.
diff --git a/Countries/Countries/ICountry.cs b/Countries/Countries/ICountry.cs
@@ -1,6 +1,8 @@
-namespace MagmaWorks.Taxonomy.Countries
+using MagmaWorks.Taxonomy.Serialization;
+
+namespace MagmaWorks.Taxonomy.Countries
 {
-    public interface ICountry
+    public interface ICountry : ITaxonomySerializable
     {
         /// <summary>
         /// Country name

diff --git a/Countries/Countries/MagmaWorks.Taxonomy.Countries.csproj b/Countries/Countries/MagmaWorks.Taxonomy.Countries.csproj
@@ -43,4 +43,8 @@
     </None>
   </ItemGroup>
 
+  <ItemGroup>
+    <ProjectReference Include="..\..\Serialization\ISerialization\MagmaWorks.Taxonomy.ISerialization.csproj" />
+  </ItemGroup>
+
 </Project>
diff --git a/Countries/CountryTests/CountryTests.csproj b/Countries/CountryTests/CountryTests.csproj
@@ -21,6 +21,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\..\Serialization\Serialization\MagmaWorks.Taxonomy.Serialization.csproj" />
     <ProjectReference Include="..\Countries\MagmaWorks.Taxonomy.Countries.csproj" />
     <ProjectReference Include="..\Serialization\MagmaWorks.Taxonomy.Serialization.Countries.csproj" />
   </ItemGroup>

diff --git a/Loads/Cases/MagmaWorks.Taxonomy.Cases.csproj b/Loads/Cases/MagmaWorks.Taxonomy.Cases.csproj
@@ -26,7 +26,6 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="OasysUnits" Version="1.1.1" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/Loads/ICases/ICase.cs b/Loads/ICases/ICase.cs
@@ -1,6 +1,8 @@
-namespace MagmaWorks.Taxonomy.Loads
+using MagmaWorks.Taxonomy.Serialization;
+
+namespace MagmaWorks.Taxonomy.Loads
 {
-    public interface ICase
+    public interface ICase : ITaxonomySerializable
     {
         string Name { get; }
     }

diff --git a/Loads/ICases/MagmaWorks.Taxonomy.ICases.csproj b/Loads/ICases/MagmaWorks.Taxonomy.ICases.csproj
@@ -26,7 +26,6 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="OasysUnits" Version="1.1.1" />
   </ItemGroup>
 
   <ItemGroup>
@@ -49,6 +48,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\..\Serialization\ISerialization\MagmaWorks.Taxonomy.ISerialization.csproj" />
     <ProjectReference Include="..\..\Standards\IStandards\MagmaWorks.Taxonomy.IStandards.csproj" />
     <ProjectReference Include="..\ILoads\MagmaWorks.Taxonomy.ILoads.csproj" />
   </ItemGroup>

diff --git a/Loads/ILoads/ILoad.cs b/Loads/ILoads/ILoad.cs
@@ -1,8 +1,9 @@
-using OasysUnits;
+using MagmaWorks.Taxonomy.Serialization;
+using OasysUnits;
 
 namespace MagmaWorks.Taxonomy.Loads
 {
-    public interface ILoad
+    public interface ILoad : ITaxonomySerializable
     {
         string Label { get; }
         ILoad Factor(Ratio factor);

diff --git a/Loads/ILoads/MagmaWorks.Taxonomy.ILoads.csproj b/Loads/ILoads/MagmaWorks.Taxonomy.ILoads.csproj
@@ -48,4 +48,8 @@
     </None>
   </ItemGroup>
 
+  <ItemGroup>
+    <ProjectReference Include="..\..\Serialization\ISerialization\MagmaWorks.Taxonomy.ISerialization.csproj" />
+  </ItemGroup>
+
 </Project>
diff --git a/Loads/LoadTests/LoadTests.csproj b/Loads/LoadTests/LoadTests.csproj
@@ -23,6 +23,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\..\Serialization\Serialization\MagmaWorks.Taxonomy.Serialization.csproj" />
     <ProjectReference Include="..\Cases\MagmaWorks.Taxonomy.Cases.csproj" />
     <ProjectReference Include="..\ICases\MagmaWorks.Taxonomy.ICases.csproj" />
     <ProjectReference Include="..\Loads\MagmaWorks.Taxonomy.Loads.csproj" />

diff --git a/Loads/Loads/MagmaWorks.Taxonomy.Loads.csproj b/Loads/Loads/MagmaWorks.Taxonomy.Loads.csproj
@@ -26,7 +26,6 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="OasysUnits" Version="1.1.1" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/Materials/IMaterials/IMaterial.cs b/Materials/IMaterials/IMaterial.cs
@@ -1,6 +1,8 @@
-namespace MagmaWorks.Taxonomy.Materials
+using MagmaWorks.Taxonomy.Serialization;
+
+namespace MagmaWorks.Taxonomy.Materials
 {
-    public interface IMaterial
+    public interface IMaterial : ITaxonomySerializable
     {
         MaterialType Type { get; }
     }

diff --git a/Materials/IMaterials/MagmaWorks.Taxonomy.IMaterials.csproj b/Materials/IMaterials/MagmaWorks.Taxonomy.IMaterials.csproj
@@ -30,6 +30,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\..\Serialization\ISerialization\MagmaWorks.Taxonomy.ISerialization.csproj" />
     <ProjectReference Include="..\..\Standards\IStandards\MagmaWorks.Taxonomy.IStandards.csproj" />
   </ItemGroup>
 

diff --git a/Materials/MaterialTests/MaterialTests.csproj b/Materials/MaterialTests/MaterialTests.csproj
@@ -9,7 +9,6 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
-    <PackageReference Include="OasysUnits.Serialization.JsonNet" Version="1.1.1" />
     <PackageReference Include="xunit" Version="2.9.2" />
     <PackageReference Include="xunit.runner.visualstudio" Version="3.0.0-pre.42">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
@@ -22,6 +21,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\..\Serialization\Serialization\MagmaWorks.Taxonomy.Serialization.csproj" />
     <ProjectReference Include="..\..\Standards\IStandards\MagmaWorks.Taxonomy.IStandards.csproj" />
     <ProjectReference Include="..\..\Standards\Serialization\MagmaWorks.Taxonomy.Serialization.Standards.csproj" />
     <ProjectReference Include="..\..\Standards\Standards\MagmaWorks.Taxonomy.Standards.csproj" />

diff --git a/Materials/Materials/MagmaWorks.Taxonomy.Materials.csproj b/Materials/Materials/MagmaWorks.Taxonomy.Materials.csproj
@@ -26,7 +26,6 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="OasysUnits" Version="1.1.1" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/Profiles/CatalogueProfiles/MagmaWorks.Taxonomy.Profiles.Catalogue.csproj b/Profiles/CatalogueProfiles/MagmaWorks.Taxonomy.Profiles.Catalogue.csproj
@@ -26,7 +26,6 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="OasysUnits" Version="1.1.1" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/Profiles/IProfiles/IProfile.cs b/Profiles/IProfiles/IProfile.cs
@@ -1,4 +1,6 @@
-namespace MagmaWorks.Taxonomy.Profiles
+using MagmaWorks.Taxonomy.Serialization;
+
+namespace MagmaWorks.Taxonomy.Profiles
 {
-    public interface IProfile { }
+    public interface IProfile : ITaxonomySerializable { }
 }
diff --git a/Profiles/IProfiles/MagmaWorks.Taxonomy.IProfiles.csproj b/Profiles/IProfiles/MagmaWorks.Taxonomy.IProfiles.csproj
@@ -48,4 +48,8 @@
     </None>
   </ItemGroup>
 
+  <ItemGroup>
+    <ProjectReference Include="..\..\Serialization\ISerialization\MagmaWorks.Taxonomy.ISerialization.csproj" />
+  </ItemGroup>
+
 </Project>
diff --git a/Profiles/Perimeter/MagmaWorks.Taxonomy.Profiles.Perimeter.csproj b/Profiles/Perimeter/MagmaWorks.Taxonomy.Profiles.Perimeter.csproj
@@ -27,7 +27,6 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="OasysUnits" Version="1.1.1" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/Profiles/ProfileTests/ProfileTests.csproj b/Profiles/ProfileTests/ProfileTests.csproj
@@ -9,7 +9,6 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
-    <PackageReference Include="OasysUnits.Serialization.JsonNet" Version="1.1.1" />
     <PackageReference Include="xunit" Version="2.9.2" />
     <PackageReference Include="xunit.runner.visualstudio" Version="3.0.0-pre.42">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
@@ -22,6 +21,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\..\Serialization\Serialization\MagmaWorks.Taxonomy.Serialization.csproj" />
     <ProjectReference Include="..\CatalogueProfiles\MagmaWorks.Taxonomy.Profiles.Catalogue.csproj" />
     <ProjectReference Include="..\IProfiles\MagmaWorks.Taxonomy.IProfiles.csproj" />
     <ProjectReference Include="..\Profiles\MagmaWorks.Taxonomy.Profiles.csproj" />

diff --git a/Sections/ISections/ISection.cs b/Sections/ISections/ISection.cs
@@ -1,9 +1,10 @@
 using MagmaWorks.Taxonomy.Materials;
 using MagmaWorks.Taxonomy.Profiles;
+using MagmaWorks.Taxonomy.Serialization;
 
 namespace MagmaWorks.Taxonomy.Sections
 {
-    public interface ISection
+    public interface ISection : ITaxonomySerializable
     {
         IMaterial Material { get; }
         IProfile Profile { get; }

diff --git a/Sections/SectionTests/SectionTests.csproj b/Sections/SectionTests/SectionTests.csproj
@@ -29,6 +29,7 @@
     <ProjectReference Include="..\..\Profiles\CatalogueProfiles\MagmaWorks.Taxonomy.Profiles.Catalogue.csproj" />
     <ProjectReference Include="..\..\Profiles\IProfiles\MagmaWorks.Taxonomy.IProfiles.csproj" />
     <ProjectReference Include="..\..\Profiles\Profiles\MagmaWorks.Taxonomy.Profiles.csproj" />
+    <ProjectReference Include="..\..\Serialization\Serialization\MagmaWorks.Taxonomy.Serialization.csproj" />
     <ProjectReference Include="..\..\Standards\Standards\MagmaWorks.Taxonomy.Standards.csproj" />
     <ProjectReference Include="..\ISections\MagmaWorks.Taxonomy.ISections.csproj" />
     <ProjectReference Include="..\Sections\MagmaWorks.Taxonomy.Sections.csproj" />

diff --git a/Serialization/ISerialization/ITaxonomySerializable.cs b/Serialization/ISerialization/ITaxonomySerializable.cs
@@ -0,0 +1,4 @@
+namespace MagmaWorks.Taxonomy.Serialization
+{
+    public interface ITaxonomySerializable { }
+}
diff --git a/Serialization/ISerialization/MagmaWorks.Taxonomy.ISerialization.csproj b/Serialization/ISerialization/MagmaWorks.Taxonomy.ISerialization.csproj
@@ -0,0 +1,50 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <MinVerMinimumMajorMinor>0.0</MinVerMinimumMajorMinor>
+    <MinVerDefaultPreReleaseIdentifiers>preview</MinVerDefaultPreReleaseIdentifiers>
+  </PropertyGroup>
+
+  <PropertyGroup>
+    <TargetFrameworks>net48;netstandard2.0;net6.0;net7.0;net8.0</TargetFrameworks>
+    <LangVersion>9.0</LangVersion>
+    <Platforms>AnyCPU</Platforms>
+    <RootNamespace>MagmaWorks.Taxonomy.Serialization</RootNamespace>
+  </PropertyGroup>
+
+  <PropertyGroup>
+    <Title>MagmaWorks Taxonomy Serialization Interfaces</Title>
+    <Company>Whitby Wood</Company>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+    <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    <RepositoryUrl>https://github.com/MagmaWorks/Taxonomy/</RepositoryUrl>
+    <PackageIcon>MagmaWorks.png</PackageIcon>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="MinVer" Version="6.0.0">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Include="..\..\README.md">
+      <Pack>True</Pack>
+      <PackagePath>\</PackagePath>
+    </None>
+    <None Include="..\..\LICENSE">
+      <Pack>True</Pack>
+      <PackagePath>\</PackagePath>
+    </None>
+    <None Include="..\..\Licenses\UnitsNet">
+      <Pack>True</Pack>
+      <PackagePath>\Licenses\</PackagePath>
+    </None>
+    <None Include="..\..\MagmaWorks.png">
+      <Pack>True</Pack>
+      <PackagePath>\</PackagePath>
+    </None>
+  </ItemGroup>
+
+</Project>
diff --git a/Serialization/Serialization/JsonSerializationExtensions.cs b/Serialization/Serialization/JsonSerializationExtensions.cs
@@ -0,0 +1,19 @@
+using Newtonsoft.Json;
+
+namespace MagmaWorks.Taxonomy.Serialization
+{
+    public static class JsonSerializationExtensions
+    {
+        public static string ToJson<T>(this T taxonomyObject, JsonSerializerSettings? settings = null) where T : ITaxonomySerializable
+        {
+            settings ??= TaxonomyJsonSerializer.Settings;
+            return JsonConvert.SerializeObject(taxonomyObject, Formatting.Indented, settings);
+        }
+
+        public static T? FromJson<T>(this string json, JsonSerializerSettings? settings = null) where T : ITaxonomySerializable
+        {
+            settings ??= TaxonomyJsonSerializer.Settings;
+            return JsonConvert.DeserializeObject<T>(json, settings);
+        }
+    }
+}
diff --git a/Serialization/Serialization/MagmaWorks.Taxonomy.Serialization.csproj b/Serialization/Serialization/MagmaWorks.Taxonomy.Serialization.csproj
@@ -0,0 +1,18 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+    <PackageReference Include="OasysUnits.Serialization.JsonNet" Version="1.1.1" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\ISerialization\MagmaWorks.Taxonomy.ISerialization.csproj" />
+  </ItemGroup>
+
+</Project>
diff --git a/Serialization/Serialization/TaxonomyJsonSerializer.cs b/Serialization/Serialization/TaxonomyJsonSerializer.cs
@@ -0,0 +1,24 @@
+using Newtonsoft.Json;
+
+namespace MagmaWorks.Taxonomy.Serialization
+{
+    internal static class TaxonomyJsonSerializer
+    {
+        internal static JsonSerializerSettings Settings
+        {
+            get
+            {
+                var settings = new JsonSerializerSettings
+                {
+                    Converters = {
+                        new Newtonsoft.Json.Converters.StringEnumConverter(),
+                        new OasysUnits.Serialization.JsonNet.OasysUnitsIQuantityJsonConverter(),
+                    },
+                    TypeNameHandling = TypeNameHandling.Objects,
+                    TypeNameAssemblyFormatHandling = TypeNameAssemblyFormatHandling.Simple
+                };
+                return settings;
+            }
+        }
+    }
+}
diff --git a/Stages/IStages/IStage.cs b/Stages/IStages/IStage.cs
@@ -1,6 +1,8 @@
-namespace MagmaWorks.Taxonomy.Stages
+using MagmaWorks.Taxonomy.Serialization;
+
+namespace MagmaWorks.Taxonomy.Stages
 {
-    public interface IStage
+    public interface IStage : ITaxonomySerializable
     {
         string Name { get; }
         string Description { get; }

diff --git a/Stages/IStages/MagmaWorks.Taxonomy.IStages.csproj b/Stages/IStages/MagmaWorks.Taxonomy.IStages.csproj
@@ -45,6 +45,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\..\Countries\Countries\MagmaWorks.Taxonomy.Countries.csproj" />
+    <ProjectReference Include="..\..\Serialization\ISerialization\MagmaWorks.Taxonomy.ISerialization.csproj" />
   </ItemGroup>
 
 </Project>
diff --git a/Stages/StageTests/StageTests.csproj b/Stages/StageTests/StageTests.csproj
@@ -21,6 +21,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\..\Serialization\Serialization\MagmaWorks.Taxonomy.Serialization.csproj" />
     <ProjectReference Include="..\IStages\MagmaWorks.Taxonomy.IStages.csproj" />
     <ProjectReference Include="..\Serialization\MagmaWorks.Taxonomy.Serialization.Stages.csproj" />
   </ItemGroup>

diff --git a/Standards/IStandards/IStandard.cs b/Standards/IStandards/IStandard.cs
@@ -1,8 +1,9 @@
 using System;
+using MagmaWorks.Taxonomy.Serialization;
 
 namespace MagmaWorks.Taxonomy.Standards
 {
-    public interface IStandard
+    public interface IStandard : ITaxonomySerializable
     {
         StandardBody Body { get; }
         Enum Code { get; }

diff --git a/Standards/IStandards/MagmaWorks.Taxonomy.IStandards.csproj b/Standards/IStandards/MagmaWorks.Taxonomy.IStandards.csproj
@@ -26,7 +26,6 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="OasysUnits" Version="1.1.1" />
   </ItemGroup>
 
   <ItemGroup>
@@ -48,4 +47,8 @@
     </None>
   </ItemGroup>
 
+  <ItemGroup>
+    <ProjectReference Include="..\..\Serialization\ISerialization\MagmaWorks.Taxonomy.ISerialization.csproj" />
+  </ItemGroup>
+
 </Project>