Updated packages. (#5)

fluxera · Jun 7, 2022 · 78ee8fb · 78ee8fb
1 parent 72db100
commit 78ee8fb
Show file tree

Hide file tree

Showing 13 changed files with 60 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -2,3 +2,20 @@
 
 # Fluxera.Temporal
 A libary that provides temporal types.
+
+
+## Serialization Support
+
+At the moment serialization support is available for:
+
+- [MongoDB](https://github.com/mongodb/mongo-csharp-driver)
+
+### MongoDB
+
+To support the temporal serializers in MongoDB use the ```UseTemporal``` extension method on a ```ConventionPack```.
+
+```C#
+ConventionPack pack = new ConventionPack();
+pack.UseTemporal();
+ConventionRegistry.Register("ConventionPack", pack, t => true);
+```
diff --git a/src/Fluxera.Temporal.MongoDB/ConventionPackExtensions.cs b/src/Fluxera.Temporal.MongoDB/ConventionPackExtensions.cs
@@ -3,9 +3,17 @@
 	using global::MongoDB.Bson.Serialization.Conventions;
 	using JetBrains.Annotations;
 
+	/// <summary>
+	///     Extension methods for the <see cref="ConventionPack" /> type.
+	/// </summary>
 	[PublicAPI]
 	public static class ConventionPackExtensions
 	{
+		/// <summary>
+		///     Configures the database to use the temporal serializers.
+		/// </summary>
+		/// <param name="pack"></param>
+		/// <returns></returns>
 		public static ConventionPack UseTemporal(this ConventionPack pack)
 		{
 			pack.Add(new DateTimeConvention());

diff --git a/src/Fluxera.Temporal.MongoDB/DateOnlyDateTimeOffsetSerializer.cs b/src/Fluxera.Temporal.MongoDB/DateOnlyDateTimeOffsetSerializer.cs
@@ -5,11 +5,18 @@
 	using global::MongoDB.Bson.Serialization.Serializers;
 	using JetBrains.Annotations;
 
+	/// <summary>
+	///     A <see cref="DateTimeOffsetSerializer" /> that only serializes the date part.
+	/// </summary>
 	[PublicAPI]
 	public class DateOnlyDateTimeOffsetSerializer : DateTimeOffsetSerializer
 	{
 		private readonly DateTimeSerializer dateTimeSerializer;
 
+		/// <summary>
+		///     Initializes a new instance of the <see cref="DateOnlyDateTimeOffsetSerializer" />.
+		/// </summary>
+		/// <param name="dateTimeSerializer"></param>
 		public DateOnlyDateTimeOffsetSerializer(DateTimeSerializer dateTimeSerializer)
 		{
 			this.dateTimeSerializer = dateTimeSerializer;

diff --git a/src/Fluxera.Temporal.MongoDB/DateOnlyDateTimeSerializer.cs b/src/Fluxera.Temporal.MongoDB/DateOnlyDateTimeSerializer.cs
@@ -5,11 +5,18 @@
 	using global::MongoDB.Bson.Serialization.Serializers;
 	using JetBrains.Annotations;
 
+	/// <summary>
+	///     A <see cref="DateTimeSerializer" /> that only serializes the date part.
+	/// </summary>
 	[PublicAPI]
 	public class DateOnlyDateTimeSerializer : DateTimeSerializer
 	{
 		private readonly DateTimeSerializer dateTimeSerializer;
 
+		/// <summary>
+		///     Initializes a new instance of the <see cref="DateOnlyDateTimeSerializer" /> type.
+		/// </summary>
+		/// <param name="dateTimeSerializer"></param>
 		public DateOnlyDateTimeSerializer(DateTimeSerializer dateTimeSerializer)
 		{
 			this.dateTimeSerializer = dateTimeSerializer;

diff --git a/src/Fluxera.Temporal.MongoDB/DateOnlySerializer.cs b/src/Fluxera.Temporal.MongoDB/DateOnlySerializer.cs
@@ -5,14 +5,19 @@
 	using global::MongoDB.Bson.Serialization.Serializers;
 	using JetBrains.Annotations;
 
+	/// <summary>
+	///     A serializer for the <see cref="DateOnly" /> type.
+	/// </summary>
 	[PublicAPI]
 	public class DateOnlySerializer : StructSerializerBase<DateOnly>
 	{
+		/// <inheritdoc />
 		public override void Serialize(BsonSerializationContext context, BsonSerializationArgs args, DateOnly value)
 		{
 			context.Writer.WriteString(value.ToString("yyyy-MM-dd"));
 		}
 
+		/// <inheritdoc />
 		public override DateOnly Deserialize(BsonDeserializationContext context, BsonDeserializationArgs args)
 		{
 			return DateOnly.ParseExact(context.Reader.ReadString(), "yyyy-MM-dd", null);

diff --git a/src/Fluxera.Temporal.MongoDB/Fluxera.Temporal.MongoDB.csproj b/src/Fluxera.Temporal.MongoDB/Fluxera.Temporal.MongoDB.csproj
@@ -22,13 +22,13 @@
 	</ItemGroup>
 
 	<ItemGroup>
-		<PackageReference Include="Fluxera.Utilities" Version="6.0.16" />
-		<PackageReference Include="GitVersion.MsBuild" Version="5.10.1">
+		<PackageReference Include="Fluxera.Utilities" Version="6.1.0" />
+		<PackageReference Include="GitVersion.MsBuild" Version="5.10.3">
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 		</PackageReference>
 		<PackageReference Include="JetBrains.Annotations" Version="2022.1.0" />
-		<PackageReference Include="MongoDB.Driver" Version="2.15.1" />
+		<PackageReference Include="MongoDB.Driver" Version="2.16.0" />
 	</ItemGroup>
 
 	<ItemGroup>

diff --git a/src/Fluxera.Temporal.MongoDB/TimeOnlySerializer.cs b/src/Fluxera.Temporal.MongoDB/TimeOnlySerializer.cs
@@ -5,16 +5,21 @@
 	using global::MongoDB.Bson.Serialization.Serializers;
 	using JetBrains.Annotations;
 
+	/// <summary>
+	///     A serializer for the <see cref="TimeOnly" /> type.
+	/// </summary>
 	[PublicAPI]
 	public class TimeOnlySerializer : StructSerializerBase<TimeOnly>
 	{
 		private readonly TimeSpanSerializer timeSpanSerializer = new TimeSpanSerializer();
 
+		/// <inheritdoc />
 		public override void Serialize(BsonSerializationContext context, BsonSerializationArgs args, TimeOnly value)
 		{
 			this.timeSpanSerializer.Serialize(context, args, value.ToTimeSpan());
 		}
 
+		/// <inheritdoc />
 		public override TimeOnly Deserialize(BsonDeserializationContext context, BsonDeserializationArgs args)
 		{
 			TimeSpan timeSpan = this.timeSpanSerializer.Deserialize(context, args);

diff --git a/src/Fluxera.Temporal/Fluxera.Temporal.csproj b/src/Fluxera.Temporal/Fluxera.Temporal.csproj
@@ -22,9 +22,9 @@
 	</ItemGroup>
 
 	<ItemGroup>
-		<PackageReference Include="Fluxera.ComponentModel.Annotations" Version="6.0.9" />
-		<PackageReference Include="Fluxera.Guards" Version="6.0.22" />
-		<PackageReference Include="GitVersion.MsBuild" Version="5.10.1">
+		<PackageReference Include="Fluxera.ComponentModel.Annotations" Version="6.1.1" />
+		<PackageReference Include="Fluxera.Guards" Version="6.1.0" />
+		<PackageReference Include="GitVersion.MsBuild" Version="5.10.3">
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 		</PackageReference>

diff --git a/tests/Fluxera.Temporal.MongoDB.UnitTests/DateOnlyDateTimeOffsetTests.cs b/tests/Fluxera.Temporal.MongoDB.UnitTests/DateOnlyDateTimeOffsetTests.cs
@@ -17,7 +17,7 @@ public void SetUp()
 		{
 			ConventionPack pack = new ConventionPack();
 			pack.UseTemporal();
-			ConventionRegistry.Register("ConventionPack", pack, t => true);
+			ConventionRegistry.Register("ConventionPack", pack, _ => true);
 		}
 
 		private class TestClass

diff --git a/tests/Fluxera.Temporal.MongoDB.UnitTests/DateOnlyDateTimeTests.cs b/tests/Fluxera.Temporal.MongoDB.UnitTests/DateOnlyDateTimeTests.cs
@@ -17,7 +17,7 @@ public void SetUp()
 		{
 			ConventionPack pack = new ConventionPack();
 			pack.UseTemporal();
-			ConventionRegistry.Register("ConventionPack", pack, t => true);
+			ConventionRegistry.Register("ConventionPack", pack, _ => true);
 		}
 
 		private class TestClass

diff --git a/tests/Fluxera.Temporal.MongoDB.UnitTests/DateOnlyTests.cs b/tests/Fluxera.Temporal.MongoDB.UnitTests/DateOnlyTests.cs
@@ -16,7 +16,7 @@ public void SetUp()
 		{
 			ConventionPack pack = new ConventionPack();
 			pack.UseTemporal();
-			ConventionRegistry.Register("ConventionPack", pack, t => true);
+			ConventionRegistry.Register("ConventionPack", pack, _ => true);
 		}
 
 		private class TestClass

diff --git a/tests/Fluxera.Temporal.MongoDB.UnitTests/Fluxera.Temporal.MongoDB.UnitTests.csproj b/tests/Fluxera.Temporal.MongoDB.UnitTests/Fluxera.Temporal.MongoDB.UnitTests.csproj
@@ -2,9 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>net6.0</TargetFramework>
-    <Nullable>enable</Nullable>
-
-    <IsPackable>false</IsPackable>
+	  <IsPackable>false</IsPackable>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/tests/Fluxera.Temporal.MongoDB.UnitTests/TimeOnlyTests.cs b/tests/Fluxera.Temporal.MongoDB.UnitTests/TimeOnlyTests.cs
@@ -16,7 +16,7 @@ public void SetUp()
 		{
 			ConventionPack pack = new ConventionPack();
 			pack.UseTemporal();
-			ConventionRegistry.Register("ConventionPack", pack, t => true);
+			ConventionRegistry.Register("ConventionPack", pack, _ => true);
 		}
 
 		private class TestClass