Merge pull request #30 from Open-NET-Libraries/v6

V6

Author: electricessence

.editorconfig

@@ -80,7 +80,7 @@ csharp_style_var_when_type_is_apparent = true:suggestion
 
 # Expression-bodied members
 csharp_style_expression_bodied_accessors = true:suggestion
-csharp_style_expression_bodied_constructors = when_on_single_line
+csharp_style_expression_bodied_constructors = when_on_single_line:silent
 csharp_style_expression_bodied_indexers = true:suggestion
 csharp_style_expression_bodied_lambdas = true:suggestion
 csharp_style_expression_bodied_local_functions = true:suggestion
@@ -103,8 +103,8 @@ csharp_prefer_static_local_function = true
 csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async
 
 # Code-block preferences
-csharp_prefer_braces = when_multiline
-csharp_prefer_simple_using_statement = true
+csharp_prefer_braces = when_multiline:silent
+csharp_prefer_simple_using_statement = true:suggestion
 csharp_style_namespace_declarations = file_scoped:suggestion
 
 # Expression-level preferences
@@ -222,3 +222,24 @@ dotnet_diagnostic.RCS1123.severity = silent
 
 # IDE0290: Don't suggest primary constructor.
 dotnet_diagnostic.IDE0290.severity = silent
+csharp_style_prefer_method_group_conversion = true:silent
+csharp_style_prefer_top_level_statements = true:silent
+csharp_style_prefer_primary_constructors = true:suggestion
+
+[*.{cs,vb}]
+dotnet_style_operator_placement_when_wrapping = beginning_of_line
+tab_width = 4
+indent_size = 4
+end_of_line = crlf
+dotnet_style_coalesce_expression = true:warning
+dotnet_style_null_propagation = true:warning
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true:warning
+dotnet_style_prefer_auto_properties = true:suggestion
+dotnet_style_object_initializer = true:suggestion
+dotnet_style_prefer_collection_expression = true:suggestion
+dotnet_style_collection_initializer = true:suggestion
+dotnet_style_prefer_simplified_boolean_expressions = true:warning
+dotnet_style_prefer_conditional_expression_over_assignment = true:warning
+dotnet_style_prefer_conditional_expression_over_return = true:warning
+dotnet_style_explicit_tuple_names = true:suggestion
+dotnet_diagnostic.CA1510.severity = none

Open.ChannelExtensions.ComparisonTests/Open.ChannelExtensions.ComparisonTests.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>

Open.ChannelExtensions.Tests/BasicTests.cs

@@ -405,7 +405,6 @@ public static async Task BatchJoin(int testSize, int batchSize)
 		Assert.True(result.SequenceEqual(range));
 	}
 
-#if NET5_0_OR_GREATER
 	[Theory]
 	[InlineData(11)]
 	[InlineData(51)]
@@ -439,7 +438,6 @@ async IAsyncEnumerable<int> Samples()
 			}
 		}
 	}
-#endif
 
 	[Theory]
 	[InlineData(testSize1)]

Open.ChannelExtensions.Tests/Open.ChannelExtensions.Tests.csproj

@@ -2,7 +2,7 @@
 
 	<PropertyGroup>
 		<OutputType>Exe</OutputType>
-		<TargetFramework>net6.0</TargetFramework>
+		<TargetFramework>net8.0</TargetFramework>
 		<LangVersion>latest</LangVersion>
 		<IsPackable>false</IsPackable>
 	</PropertyGroup>
@@ -12,13 +12,13 @@
 	</ItemGroup>
 
 	<ItemGroup>
-		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.10.0" />
-		<PackageReference Include="xunit" Version="2.4.1" />
-		<PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
+		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
+		<PackageReference Include="xunit" Version="2.6.6" />
+		<PackageReference Include="xunit.runner.visualstudio" Version="2.5.6">
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 		</PackageReference>
-		<PackageReference Include="coverlet.collector" Version="3.0.3">
+		<PackageReference Include="coverlet.collector" Version="6.0.0">
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 		</PackageReference>

Open.ChannelExtensions/BatchingChannelReader.cs

@@ -33,7 +33,7 @@ protected BatchingChannelReader(
 	/// </summary>
 	public bool ForceBatch() => TryPipeItems(true);
 
-	void ForceBatch(object obj) => ForceBatch();
+	void ForceBatch(object? obj) => ForceBatch();
 
 	long _timeout = -1;
 	Timer? _timer;
@@ -224,15 +224,15 @@ protected override async ValueTask<bool> WaitToReadAsyncCore(
 
 		if (b.IsCompleted)
 		{
-			tokenSource.Cancel();
+			await tokenSource.CancelAsync().ConfigureAwait(false);
 			return await b.ConfigureAwait(false);
 		}
 
 		// WhenAny will not throw when a task is cancelled.
 		await Task.WhenAny(s.AsTask(), b).ConfigureAwait(false);
 		if (b.IsCompleted) // Assuming it was bufferWait that completed.
 		{
-			tokenSource.Cancel();
+			await tokenSource.CancelAsync().ConfigureAwait(false);
 			return await b.ConfigureAwait(false);
 		}
 
@@ -254,19 +254,31 @@ public QueueBatchingChannelReader(ChannelReader<T> source, int batchSize, bool s
 
 	/// <inheritdoc />
 	[MethodImpl(MethodImplOptions.AggressiveInlining)]
-	protected override void AddBatchItem(Queue<T> batch, T item) => batch.Enqueue(item);
+	protected override void AddBatchItem(Queue<T> batch, T item)
+	{
+		Debug.Assert(batch is not null);
+		batch!.Enqueue(item);
+	}
 
 	/// <inheritdoc />
 	[MethodImpl(MethodImplOptions.AggressiveInlining)]
 	protected override Queue<T> CreateBatch(int capacity) => new(capacity);
 
 	/// <inheritdoc />
 	[MethodImpl(MethodImplOptions.AggressiveInlining)]
-	protected override int GetBatchSize(Queue<T> batch) => batch.Count;
+	protected override int GetBatchSize(Queue<T> batch)
+	{
+		Debug.Assert(batch is not null);
+		return batch!.Count;
+	}
 
 	/// <inheritdoc />
 	[MethodImpl(MethodImplOptions.AggressiveInlining)]
-	protected override void TrimBatch(Queue<T> batch) => batch!.TrimExcess();
+	protected override void TrimBatch(Queue<T> batch)
+	{
+		Debug.Assert(batch is not null);
+		batch!.TrimExcess();
+	}
 }
 
 /// <inheritdoc />
@@ -278,17 +290,29 @@ public BatchingChannelReader(ChannelReader<T> source, int batchSize, bool single
 
 	/// <inheritdoc />
 	[MethodImpl(MethodImplOptions.AggressiveInlining)]
-	protected override void AddBatchItem(List<T> batch, T item) => batch.Add(item);
+	protected override void AddBatchItem(List<T> batch, T item)
+	{
+		Debug.Assert(batch is not null);
+		batch!.Add(item);
+	}
 
 	/// <inheritdoc />
 	[MethodImpl(MethodImplOptions.AggressiveInlining)]
 	protected override List<T> CreateBatch(int capacity) => new(capacity);
 
 	/// <inheritdoc />
 	[MethodImpl(MethodImplOptions.AggressiveInlining)]
-	protected override int GetBatchSize(List<T> batch) => batch.Count;
+	protected override int GetBatchSize(List<T> batch)
+	{
+		Debug.Assert(batch is not null);
+		return batch!.Count;
+	}
 
 	/// <inheritdoc />
 	[MethodImpl(MethodImplOptions.AggressiveInlining)]
-	protected override void TrimBatch(List<T> batch) => batch!.TrimExcess();
+	protected override void TrimBatch(List<T> batch)
+	{
+		Debug.Assert(batch is not null);
+		batch!.TrimExcess();
+	}
 }

Open.ChannelExtensions/BufferingChannelReader.cs

@@ -100,7 +100,7 @@ public override ValueTask<bool> WaitToReadAsync(CancellationToken cancellationTo
 		if (completion.IsCompleted)
 		{
 			return completion.IsFaulted
-				? new ValueTask<bool>(Task.FromException<bool>(completion.Exception))
+				? new ValueTask<bool>(Task.FromException<bool>(completion.Exception!))
 				: new ValueTask<bool>(false);
 		}
 
@@ -131,7 +131,7 @@ protected virtual async ValueTask<bool> WaitToReadAsyncCore(ValueTask<bool> buff
 
 		if (bufferWait.IsCompleted)
 		{
-			tokenSource.Cancel();
+			await tokenSource.CancelAsync().ConfigureAwait(false);
 			return await bufferWait.ConfigureAwait(false);
 		}
 

Open.ChannelExtensions/Extensions.Filter.cs

@@ -2,7 +2,7 @@
 
 public static partial class Extensions
 {
-	class FilteringChannelReader<T> : ChannelReader<T>
+	sealed class FilteringChannelReader<T> : ChannelReader<T>
 	{
 		public FilteringChannelReader(ChannelReader<T> source, Func<T, bool> predicate)
 		{

Open.ChannelExtensions/Extensions.Join.cs

@@ -2,7 +2,7 @@
 
 public static partial class Extensions
 {
-	class JoiningChannelReader<TList, T> : BufferingChannelReader<TList, T>
+	sealed class JoiningChannelReader<TList, T> : BufferingChannelReader<TList, T>
 		where TList : IEnumerable<T>
 	{
 		public JoiningChannelReader(ChannelReader<TList> source, bool singleReader) : base(source, singleReader)
@@ -81,7 +81,8 @@ public static ChannelReader<T> Join<T>(this ChannelReader<List<T>> source, bool
 	public static ChannelReader<T> Join<T>(this ChannelReader<T[]> source, bool singleReader = false)
 		=> new JoiningChannelReader<T[], T>(source, singleReader);
 
-#if NETSTANDARD2_1
+#if NETSTANDARD2_0
+#else
 	/// <summary>
 	/// Joins collections of the same type into a single channel reader in the order provided.
 	/// </summary>
@@ -90,6 +91,8 @@ public static ChannelReader<T> Join<T>(this ChannelReader<T[]> source, bool sing
 	/// <param name="singleReader">True will cause the resultant reader to optimize for the assumption that no concurrent read operations will occur.</param>
 	/// <param name="allowSynchronousContinuations">True can reduce the amount of scheduling and markedly improve performance, but may produce unexpected or even undesirable behavior.</param>
 	/// <returns>A channel reader containing the joined results.</returns>
+	[SuppressMessage("CodeQuality", "IDE0079:Remove unnecessary suppression", Justification = "For NET STandard 2.1")]
+	[SuppressMessage("Design", "CA1031:Do not catch general exception types", Justification = "Potential exception type is too far removed.")]
 	public static ChannelReader<T> Join<T>(
 		this ChannelReader<IAsyncEnumerable<T>> source,
 		bool singleReader = false,

Open.ChannelExtensions/Extensions.ReadConcurrently.cs

@@ -26,7 +26,11 @@ public static Task<long> ReadAllConcurrentlyAsync<T>(this ChannelReader<T> reade
 		if (maxConcurrency == 1)
 			return reader.ReadAllAsync(receiver, cancellationToken, true).AsTask();
 
+#pragma warning disable IDE0079 // Remove unnecessary suppression
+#pragma warning disable CA2000 // Dispose objects before losing scope
 		var tokenSource = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
+#pragma warning restore CA2000 // Dispose objects before losing scope
+#pragma warning restore IDE0079 // Remove unnecessary suppression
 		CancellationToken token = tokenSource.Token;
 		var readers = new Task<long>[maxConcurrency];
 		for (int r = 0; r < maxConcurrency; ++r)
@@ -37,11 +41,15 @@ public static Task<long> ReadAllConcurrentlyAsync<T>(this ChannelReader<T> reade
 			.ContinueWith(t =>
 				{
 					tokenSource.Dispose();
+#pragma warning disable IDE0079 // Remove unnecessary suppression
+#pragma warning disable CA1849 // Call async methods when in an async method
 					return t.IsFaulted
-						? Task.FromException<long>(t.Exception)
+						? Task.FromException<long>(t.Exception!)
 						: t.IsCanceled
 						? Task.FromCanceled<long>(token)
 						: Task.FromResult(t.Result.Sum());
+#pragma warning restore CA1849 // Call async methods when in an async method
+#pragma warning restore IDE0079 // Remove unnecessary suppression
 				},
 				CancellationToken.None,
 				TaskContinuationOptions.ExecuteSynchronously,
@@ -56,7 +64,7 @@ async Task<long> Read()
 			}
 			catch
 			{
-				tokenSource.Cancel();
+				await tokenSource.CancelAsync().ConfigureAwait(false);
 				throw;
 			}
 		}
@@ -251,7 +259,11 @@ public static Task ReadAllConcurrentlyAsEnumerablesAsync<T>(this ChannelReader<T
 		if (maxConcurrency == 1)
 			return reader.ReadAllAsEnumerablesAsync(receiver, true, cancellationToken).AsTask();
 
+#pragma warning disable IDE0079 // Remove unnecessary suppression
+#pragma warning disable CA2000 // Dispose objects before losing scope
 		var tokenSource = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
+#pragma warning restore CA2000 // Dispose objects before losing scope
+#pragma warning restore IDE0079 // Remove unnecessary suppression
 		CancellationToken token = tokenSource.Token;
 		var readers = new Task[maxConcurrency];
 		for (int r = 0; r < maxConcurrency; ++r)
@@ -260,14 +272,14 @@ public static Task ReadAllConcurrentlyAsEnumerablesAsync<T>(this ChannelReader<T
 		return Task
 			.WhenAll(readers)
 			.ContinueWith(t =>
-			{
-				tokenSource.Dispose();
-				return t.IsFaulted
-					? Task.FromException(t.Exception)
-					: t.IsCanceled
-					? Task.FromCanceled(token)
-					: Task.CompletedTask;
-			},
+				{
+					tokenSource.Dispose();
+					return t.IsFaulted
+						? Task.FromException(t.Exception!)
+						: t.IsCanceled
+						? Task.FromCanceled(token)
+						: Task.CompletedTask;
+				},
 				CancellationToken.None,
 				TaskContinuationOptions.ExecuteSynchronously,
 				TaskScheduler.Current)
@@ -281,7 +293,7 @@ async Task Read()
 			}
 			catch
 			{
-				tokenSource.Cancel();
+				await tokenSource.CancelAsync().ConfigureAwait(false);
 				throw;
 			}
 		}

Open.ChannelExtensions/Extensions.Transform.cs

@@ -2,7 +2,7 @@
 
 public static partial class Extensions
 {
-	class TransformingChannelReader<T, TResult> : ChannelReader<TResult>
+	sealed class TransformingChannelReader<T, TResult> : ChannelReader<TResult>
 	{
 		public TransformingChannelReader(ChannelReader<T> source, Func<T, TResult> transform)
 		{