Cleanup and refactor for new analyzers.

electricessence · electricessence · commit 5ceedb5ff357 · 2021-07-03T12:27:20.000-07:00
diff --git a/benchmarking/Benchmarks/CollectionParallelBenchmark.cs b/benchmarking/Benchmarks/CollectionParallelBenchmark.cs
@@ -1,13 +1,11 @@
 ﻿using Open.Diagnostics;
 using System;
 using System.Collections.Generic;
-using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using System.Threading.Tasks;
 
 namespace Open.Collections
 {
-	[SuppressMessage("ReSharper", "ReturnValueOfPureMethodIsNotUsed")]
 	public class CollectionParallelBenchmark<T> : CollectionBenchmark<T>
 	{
 		public CollectionParallelBenchmark(uint size, uint repeat, Func<ICollection<T>> factory, Func<int, T> itemFactory) : base(size, repeat, factory, itemFactory)
diff --git a/benchmarking/Benchmarks/LinkedListBenchmark.cs b/benchmarking/Benchmarks/LinkedListBenchmark.cs
@@ -10,7 +10,7 @@ public LinkedListBenchmark(uint size, uint repeat, Func<ILinkedList<object>> fac
 		{
 		}
 
-		protected readonly object _item = new object();
+		protected readonly object _item = new();
 
 		protected override IEnumerable<TimedResult> TestOnceInternal()
 		{
diff --git a/benchmarking/Benchmarks/QueueBenchmark.cs b/benchmarking/Benchmarks/QueueBenchmark.cs
@@ -10,7 +10,7 @@ public QueueBenchmark(uint size, uint repeat, Func<IQueue<object>> queueFactory)
 		{
 		}
 
-		protected readonly object _item = new object();
+		protected readonly object _item = new();
 
 		protected override IEnumerable<TimedResult> TestOnceInternal()
 		{
diff --git a/benchmarking/GlobalSuppressions.cs b/benchmarking/GlobalSuppressions.cs
@@ -0,0 +1,11 @@
+﻿// This file is used by Code Analysis to maintain SuppressMessage
+// attributes that are applied to this project.
+// Project-level suppressions either have no target or are given
+// a specific target and scoped to a namespace, type, member, etc.
+
+using System.Diagnostics.CodeAnalysis;
+
+[assembly: SuppressMessage("CodeQuality", "IDE0051:Remove unused private members", Justification = "<Pending>", Scope = "member", Target = "~M:Program.OutputList(System.Int32[][])")]
+[assembly: SuppressMessage("CodeQuality", "IDE0051:Remove unused private members", Justification = "<Pending>", Scope = "member", Target = "~M:Program.QueueTests")]
+[assembly: SuppressMessage("CodeQuality", "IDE0051:Remove unused private members", Justification = "<Pending>", Scope = "member", Target = "~M:Program.CollectionTests")]
+[assembly: SuppressMessage("CodeQuality", "IDE0051:Remove unused private members", Justification = "<Pending>", Scope = "member", Target = "~M:Program.LinkedListTests")]
diff --git a/benchmarking/Program.cs b/benchmarking/Program.cs
@@ -1,5 +1,4 @@
-﻿using BenchmarkDotNet.Running;
-using Open.Collections;
+﻿using Open.Collections;
 using Open.Collections.Synchronized;
 using Open.Diagnostics;
 using System;
@@ -13,7 +12,7 @@ static void Main()
 	{
 		Console.Clear();
 		var perms = new char[] { 'A', 'B', 'C' }.Permutations(new char[3]);
-		foreach(var p in perms)
+		foreach (var p in perms)
 		{
 			Console.WriteLine(new string(p));
 		}
diff --git a/source/Extensions.Combinations.cs b/source/Extensions.Combinations.cs
@@ -158,7 +158,7 @@ public static IEnumerable<T[]> CombinationsBuffered<T>(this IEnumerable<T> eleme
 			var buffer = pool.Rent(length);
 			try
 			{
-				foreach(var c in  Combinations(elements, length, buffer))
+				foreach (var c in Combinations(elements, length, buffer))
 					yield return c;
 			}
 			finally
diff --git a/source/Extensions.Generic.Synchronized.cs b/source/Extensions.Generic.Synchronized.cs
@@ -142,7 +142,7 @@ public static T AddOrUpdateSynchronized<TKey, T>(this IDictionary<TKey, T> targe
 					() =>
 						valueUsed = target.AddOrUpdate(key,
 							newValueFactory,
-							(k, o) => k!.Equals(key) && (o?.Equals(old) ?? old==null) ? updateValue : updateValueFactory(k, o)
+							(k, o) => k!.Equals(key) && (o?.Equals(old) ?? old == null) ? updateValue : updateValueFactory(k, o)
 				));
 				}
 				else
diff --git a/source/Extensions.cs b/source/Extensions.cs
@@ -2,7 +2,6 @@
 using System.Buffers;
 using System.Collections;
 using System.Collections.Generic;
-using System.Diagnostics.CodeAnalysis;
 using System.Diagnostics.Contracts;
 using System.Dynamic;
 using System.Linq;
@@ -217,7 +216,7 @@ public static IEnumerable<T> Shuffle<T>(this IEnumerable<T> target)
 				throw new ArgumentNullException(nameof(target));
 
 			var r = new Random();
-			return target.OrderBy(x => (r.Next()));
+			return target.OrderBy(x => r.Next());
 		}
 
 		// Ensures an optimized means of acquiring Any();
@@ -342,7 +341,7 @@ public static IEnumerable<T> PreCache<T>(this IEnumerable<T> source, int count =
 				while (queue.Reader.TryRead(out var item))
 					yield return item;
 			}
-			while (queue.Reader.WaitToReadAsync().Result);
+			while (queue.Reader.WaitToReadAsync().AsTask().Result);
 
 			var complete = queue.Reader.Completion;
 			if (complete.IsFaulted)
diff --git a/source/GlobalSuppressions.cs b/source/GlobalSuppressions.cs
@@ -0,0 +1,8 @@
+﻿// This file is used by Code Analysis to maintain SuppressMessage
+// attributes that are applied to this project.
+// Project-level suppressions either have no target or are given
+// a specific target and scoped to a namespace, type, member, etc.
+
+using System.Diagnostics.CodeAnalysis;
+
+[assembly: SuppressMessage("Design", "CA1068:CancellationToken parameters must come last", Justification = "<Pending>", Scope = "member", Target = "~M:Open.Collections.Extensions.ForEach``1(System.Collections.Generic.IEnumerable{``0},System.Threading.CancellationToken,System.Action{``0})")]
diff --git a/source/Open.Collections.csproj b/source/Open.Collections.csproj
@@ -4,6 +4,7 @@
 		<TargetFrameworks>netstandard2.0;netstandard2.1</TargetFrameworks>
 		<LangVersion>latest</LangVersion>
 		<Nullable>enable</Nullable>
+		<EnableNETAnalyzers>true</EnableNETAnalyzers>
 		<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
 		<Authors>electricessence</Authors>
 		<Description>
diff --git a/source/OrderedDictionary.cs b/source/OrderedDictionary.cs
@@ -2,7 +2,6 @@
 using System;
 using System.Collections;
 using System.Collections.Generic;
-using System.Diagnostics.CodeAnalysis;
 using System.Threading;
 // ReSharper disable UnusedMethodReturnValue.Global
 
@@ -242,15 +241,14 @@ public void Insert(int index, TKey key, TValue value)
 		/// index is equal to or greater than <see cref="Count"/>.</exception>
 		public void RemoveAt(int index)
 		{
-			if (index < 0) throw new ArgumentOutOfRangeException();
+			if (index < 0) throw new ArgumentOutOfRangeException(nameof(index), index, "Must be at least zero.");
 
 			TKey key;
 			TValue value;
 
 			lock (SyncRoot)
 			{
-				if (index > Count)
-					throw new ArgumentOutOfRangeException(nameof(index), index, "Cannot be greater than the count.");
+				if (index >= Count) throw new ArgumentOutOfRangeException(nameof(index), index, "Must be less than the count.");
 
 				key = List[index];
 				value = Dictionary[key];
@@ -274,27 +272,28 @@ public TValue this[int index]
 		{
 			get
 			{
-				if (index < 0 || index >= Count) throw new ArgumentOutOfRangeException();
+				if (index < 0) throw new ArgumentOutOfRangeException(nameof(index), index, "Must be at least zero.");
+				if (index >= Count) throw new ArgumentOutOfRangeException(nameof(index), index, "Must be less than the count.");
 
 				// Could still explode here when not synchronized, but just allow for it.
 				return Dictionary[List[index]];
 			}
 
 			set
 			{
-				if (index < 0 || index >= Count) throw new ArgumentOutOfRangeException();
+				if (index < 0) throw new ArgumentOutOfRangeException(nameof(index), index, "Must be at least zero.");
+				if (index >= Count) throw new ArgumentOutOfRangeException(nameof(index), index, "Must be less than the count.");
 
 				TKey key;
 				bool changed;
 				TValue previous;
 				lock (SyncRoot)
 				{
-					if (index > Count)
-						throw new ArgumentOutOfRangeException(nameof(index), index, "Cannot be greater than the count.");
+					if (index >= Count) throw new ArgumentOutOfRangeException(nameof(index), index, "Must be less than the count.");
 
 					key = List[index];
 
-					changed = !Dictionary.TryGetValue(key, out previous) || !(previous?.Equals(value) ?? value==null);
+					changed = !Dictionary.TryGetValue(key, out previous) || !(previous?.Equals(value) ?? value == null);
 					if (changed)
 						Dictionary[key] = value;
 				}
@@ -452,7 +451,7 @@ public TValue this[TKey key]
 				{
 					if (Dictionary.TryGetValue(key, out previous))
 					{
-						if (!(previous?.Equals(value) ?? value==null))
+						if (!(previous?.Equals(value) ?? value == null))
 						{
 							Dictionary[key] = value;
 							change = ItemChange.Modified;
diff --git a/source/Synchronized/ISynchronizedCollectionWrapper.cs b/source/Synchronized/ISynchronizedCollectionWrapper.cs
@@ -1,6 +1,5 @@
 ﻿using System;
 using System.Collections.Generic;
-using System.Diagnostics.CodeAnalysis;
 
 namespace Open.Collections.Synchronized
 {
diff --git a/source/Synchronized/LockSynchronizedLinkedList.cs b/source/Synchronized/LockSynchronizedLinkedList.cs
@@ -1,6 +1,5 @@
 ﻿using Open.Threading;
 using System.Collections.Generic;
-using System.Diagnostics.CodeAnalysis;
 
 namespace Open.Collections.Synchronized
 {
diff --git a/source/Synchronized/TrackedList.cs b/source/Synchronized/TrackedList.cs
@@ -171,7 +171,7 @@ public bool Replace(T target, T replacement, bool throwIfNotFound = false)
 					if (index != -1) return true;
 
 					if (throwIfNotFound)
-						throw new ArgumentException("Not found.", "target");
+						throw new ArgumentException("Not found.", nameof(target));
 					return false;
 				},
 				() =>
diff --git a/testing/Open.Collections.Tests/CombinationTests.cs b/testing/Open.Collections.Tests/CombinationTests.cs
@@ -1,5 +1,4 @@
-﻿using System;
-using System.Collections.Immutable;
+﻿using System.Collections.Immutable;
 using System.Linq;
 using Xunit;
 
diff --git a/testing/Open.Collections.Tests/PermutationTests.cs b/testing/Open.Collections.Tests/PermutationTests.cs
@@ -1,5 +1,4 @@
-﻿using System;
-using System.Collections.Immutable;
+﻿using System.Collections.Immutable;
 using System.Linq;
 using Xunit;
 
diff --git a/testing/Open.Collections.Tests/SubsetTests.cs b/testing/Open.Collections.Tests/SubsetTests.cs
@@ -1,4 +1,3 @@
-using System;
 using System.Collections.Immutable;
 using System.Linq;
 using Xunit;
diff --git a/testing/Open.Collections.Tests/SumCombinationTests.cs b/testing/Open.Collections.Tests/SumCombinationTests.cs
@@ -10,7 +10,7 @@ public class SumCombinationTests
 		[Fact]
 		public void NoAddendsLessThan2()
 		{
-			for(int i = 0;i<2;i++)
+			for (int i = 0; i < 2; i++)
 				Assert.Equal(0, SC.UniqueAddendsFor(7, i).Count);
 		}
 
@@ -60,7 +60,7 @@ public void AddendsFor2()
 		public void AddendsFor3()
 		{
 			{
-				for(int i = 0;i<6;i++)
+				for (int i = 0; i < 6; i++)
 				{
 					var result = SC.UniqueAddendsFor(i, 3);
 					Assert.Equal(0, result.Count);

Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,11 @@`
`1`	`1`	`using Open.Diagnostics;`
`2`	`2`	`using System;`
`3`	`3`	`using System.Collections.Generic;`
`4`		`-using System.Diagnostics.CodeAnalysis;`
`5`	`4`	`using System.Linq;`
`6`	`5`	`using System.Threading.Tasks;`
`7`	`6`
`8`	`7`	`namespace Open.Collections`
`9`	`8`	`{`
`10`		`- [SuppressMessage("ReSharper", "ReturnValueOfPureMethodIsNotUsed")]`
`11`	`9`	`public class CollectionParallelBenchmark<T> : CollectionBenchmark<T>`
`12`	`10`	`{`
`13`	`11`	`public CollectionParallelBenchmark(uint size, uint repeat, Func<ICollection<T>> factory, Func<int, T> itemFactory) : base(size, repeat, factory, itemFactory)`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ public LinkedListBenchmark(uint size, uint repeat, Func<ILinkedList<object>> fac`
`10`	`10`	`{`
`11`	`11`	`}`
`12`	`12`
`13`		`- protected readonly object _item = new object();`
	`13`	`+ protected readonly object _item = new();`
`14`	`14`
`15`	`15`	`protected override IEnumerable<TimedResult> TestOnceInternal()`
`16`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ public QueueBenchmark(uint size, uint repeat, Func<IQueue<object>> queueFactory)`
`10`	`10`	`{`
`11`	`11`	`}`
`12`	`12`
`13`		`- protected readonly object _item = new object();`
	`13`	`+ protected readonly object _item = new();`
`14`	`14`
`15`	`15`	`protected override IEnumerable<TimedResult> TestOnceInternal()`
`16`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`		`-using BenchmarkDotNet.Running;`
`2`		`-using Open.Collections;`
	`1`	`+using Open.Collections;`
`3`	`2`	`using Open.Collections.Synchronized;`
`4`	`3`	`using Open.Diagnostics;`
`5`	`4`	`using System;`
`@@ -13,7 +12,7 @@ static void Main()`
`13`	`12`	`{`
`14`	`13`	`Console.Clear();`
`15`	`14`	`var perms = new char[] { 'A', 'B', 'C' }.Permutations(new char[3]);`
`16`		`- foreach(var p in perms)`
	`15`	`+ foreach (var p in perms)`
`17`	`16`	`{`
`18`	`17`	`Console.WriteLine(new string(p));`
`19`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -158,7 +158,7 @@ public static IEnumerable<T[]> CombinationsBuffered<T>(this IEnumerable<T> eleme`
`158`	`158`	`var buffer = pool.Rent(length);`
`159`	`159`	`try`
`160`	`160`	`{`
`161`		`- foreach(var c in Combinations(elements, length, buffer))`
	`161`	`+ foreach (var c in Combinations(elements, length, buffer))`
`162`	`162`	`yield return c;`
`163`	`163`	`}`
`164`	`164`	`finally`
Original file line number	Diff line number	Diff line change
`@@ -142,7 +142,7 @@ public static T AddOrUpdateSynchronized<TKey, T>(this IDictionary<TKey, T> targe`
`142`	`142`	`() =>`
`143`	`143`	`valueUsed = target.AddOrUpdate(key,`
`144`	`144`	`newValueFactory,`
`145`		`- (k, o) => k!.Equals(key) && (o?.Equals(old) ?? old==null) ? updateValue : updateValueFactory(k, o)`
	`145`	`+ (k, o) => k!.Equals(key) && (o?.Equals(old) ?? old == null) ? updateValue : updateValueFactory(k, o)`
`146`	`146`	`));`
`147`	`147`	`}`
`148`	`148`	`else`