feature/api update (#29)

Updated collection creation and return types changed to IReadOnlyList

Author: MrMatthewLayton

.editorconfig

@@ -2,4 +2,4 @@ root = true
 
 [*]
 max_line_length = 140
-insert_final_newline = true
+insert_final_newline = true

OnixLabs.Core.UnitTests/PreconditionTests.cs

@@ -23,24 +23,40 @@ public sealed class PreconditionTests
     [Fact(DisplayName = "Check should throw an ArgumentException when the condition is false")]
     public void CheckShouldProduceExpectedResult()
     {
-        Assert.Throws<InvalidOperationException>(() => Check(false));
+        // When
+        InvalidOperationException exception = Assert.Throws<InvalidOperationException>(() => Check(false));
+
+        // Then
+        Assert.Equal("Check requirement failed.", exception.Message);
     }
 
     [Fact(DisplayName = "CheckNotNull should throw an ArgumentNullException when the condition is null")]
     public void CheckNotNullShouldProduceExpectedResult()
     {
-        Assert.Throws<InvalidOperationException>(() => CheckNotNull<object>(null));
+        // When
+        InvalidOperationException exception = Assert.Throws<InvalidOperationException>(() => CheckNotNull<object>(null));
+
+        // Then
+        Assert.Equal("Argument must not be null.", exception.Message);
     }
 
     [Fact(DisplayName = "Require should throw an ArgumentException when the condition is false")]
     public void RequireShouldProduceExpectedResult()
     {
-        Assert.Throws<ArgumentException>(() => Require(false));
+        // When
+        ArgumentException exception = Assert.Throws<ArgumentException>(() => Require(false));
+
+        // Then
+        Assert.Equal("Argument requirement failed.", exception.Message);
     }
 
     [Fact(DisplayName = "RequireNotNull should throw an ArgumentNullException when the condition is null")]
     public void RequireNotNullShouldProduceExpectedResult()
     {
-        Assert.Throws<ArgumentNullException>(() => RequireNotNull<object>(null));
+        // When
+        ArgumentNullException exception = Assert.Throws<ArgumentNullException>(() => RequireNotNull<object>(null));
+
+        // Then
+        Assert.Equal("Argument must not be null.", exception.Message);
     }
 }

OnixLabs.Core/Collections/Collection.Empty.cs

@@ -51,7 +51,7 @@ public static T[] EmptyArray<T>()
     /// <returns>Returns an empty immutable array.</returns>
     public static ImmutableArray<T> EmptyImmutableArray<T>()
     {
-        return EmptyArray<T>().ToImmutableArray();
+        return ImmutableArray<T>.Empty;
     }
 
     /// <summary>
@@ -71,7 +71,7 @@ public static List<T> EmptyList<T>()
     /// <returns>Returns an empty immutable list.</returns>
     public static ImmutableList<T> EmptyImmutableList<T>()
     {
-        return EmptyList<T>().ToImmutableList();
+        return ImmutableList<T>.Empty;
     }
 
     /// <summary>
@@ -93,7 +93,7 @@ public static Dictionary<TKey, TValue> EmptyDictionary<TKey, TValue>() where TKe
     /// <returns>Returns an empty immutable dictionary.</returns>
     public static ImmutableDictionary<TKey, TValue> EmptyImmutableDictionary<TKey, TValue>() where TKey : notnull
     {
-        return EmptyDictionary<TKey, TValue>().ToImmutableDictionary();
+        return ImmutableDictionary<TKey, TValue>.Empty;
     }
 
     /// <summary>
@@ -115,7 +115,7 @@ public static SortedDictionary<TKey, TValue> EmptySortedDictionary<TKey, TValue>
     /// <returns>Returns an empty immutable sorted dictionary.</returns>
     public static ImmutableSortedDictionary<TKey, TValue> EmptyImmutableSortedDictionary<TKey, TValue>() where TKey : notnull
     {
-        return EmptySortedDictionary<TKey, TValue>().ToImmutableSortedDictionary();
+        return ImmutableSortedDictionary<TKey, TValue>.Empty;
     }
 
     /// <summary>
@@ -135,7 +135,7 @@ public static HashSet<T> EmptyHashSet<T>()
     /// <returns>Returns an empty immutable hash set.</returns>
     public static ImmutableHashSet<T> EmptyImmutableHashSet<T>()
     {
-        return EmptyHashSet<T>().ToImmutableHashSet();
+        return ImmutableHashSet<T>.Empty;
     }
 
     /// <summary>
@@ -155,7 +155,7 @@ public static SortedSet<T> EmptySortedSet<T>()
     /// <returns>Returns an empty immutable sorted set.</returns>
     public static ImmutableSortedSet<T> EmptyImmutableSortedSet<T>()
     {
-        return EmptySortedSet<T>().ToImmutableSortedSet();
+        return ImmutableSortedSet<T>.Empty;
     }
 
     /// <summary>
@@ -175,7 +175,7 @@ public static Stack<T> EmptyStack<T>()
     /// <returns>Returns an empty immutable stack.</returns>
     public static ImmutableStack<T> EmptyImmutableStack<T>()
     {
-        return ImmutableStack.Create<T>();
+        return ImmutableStack<T>.Empty;
     }
 
     /// <summary>
@@ -195,6 +195,6 @@ public static Queue<T> EmptyQueue<T>()
     /// <returns>Returns an empty immutable queue.</returns>
     public static ImmutableQueue<T> EmptyImmutableQueue<T>()
     {
-        return ImmutableQueue.Create<T>();
+        return ImmutableQueue<T>.Empty;
     }
 }

OnixLabs.Core/Collections/Collection.Of.cs

@@ -28,7 +28,7 @@ public static partial class Collection
     /// <returns>Returns an enumerable populated with the specified items.</returns>
     public static IEnumerable<T> EnumerableOf<T>(params T[] items)
     {
-        return items.Copy();
+        return items;
     }
 
     /// <summary>
@@ -39,7 +39,7 @@ public static IEnumerable<T> EnumerableOf<T>(params T[] items)
     /// <returns>Returns an array populated with the specified items.</returns>
     public static T[] ArrayOf<T>(params T[] items)
     {
-        return items.Copy();
+        return items;
     }
 
     /// <summary>
@@ -50,7 +50,7 @@ public static T[] ArrayOf<T>(params T[] items)
     /// <returns>Returns an immutable array populated with the specified items.</returns>
     public static ImmutableArray<T> ImmutableArrayOf<T>(params T[] items)
     {
-        return ArrayOf(items).ToImmutableArray();
+        return ImmutableArray.Create(items);
     }
 
     /// <summary>
@@ -61,7 +61,7 @@ public static ImmutableArray<T> ImmutableArrayOf<T>(params T[] items)
     /// <returns>Returns a list populated with the specified items.</returns>
     public static List<T> ListOf<T>(params T[] items)
     {
-        return new List<T>(items.Copy());
+        return new List<T>(items);
     }
 
     /// <summary>
@@ -72,7 +72,7 @@ public static List<T> ListOf<T>(params T[] items)
     /// <returns>Returns an immutable list populated with the specified items.</returns>
     public static ImmutableList<T> ImmutableListOf<T>(params T[] items)
     {
-        return ListOf(items).ToImmutableList();
+        return ImmutableList.Create(items);
     }
 
     /// <summary>
@@ -84,7 +84,7 @@ public static ImmutableList<T> ImmutableListOf<T>(params T[] items)
     /// <returns>Returns a dictionary populated with the specified items.</returns>
     public static Dictionary<TKey, TValue> DictionaryOf<TKey, TValue>(params KeyValuePair<TKey, TValue>[] items) where TKey : notnull
     {
-        return new Dictionary<TKey, TValue>(items.Copy());
+        return new Dictionary<TKey, TValue>(items);
     }
 
     /// <summary>
@@ -109,7 +109,7 @@ public static Dictionary<TKey, TValue> DictionaryOf<TKey, TValue>(params (TKey k
     public static ImmutableDictionary<TKey, TValue> ImmutableDictionaryOf<TKey, TValue>(
         params KeyValuePair<TKey, TValue>[] items) where TKey : notnull
     {
-        return DictionaryOf(items).ToImmutableDictionary();
+        return ImmutableDictionary.CreateRange(items);
     }
 
     /// <summary>
@@ -122,7 +122,7 @@ public static ImmutableDictionary<TKey, TValue> ImmutableDictionaryOf<TKey, TVal
     public static ImmutableDictionary<TKey, TValue> ImmutableDictionaryOf<TKey, TValue>(
         params (TKey key, TValue value)[] items) where TKey : notnull
     {
-        return DictionaryOf(items).ToImmutableDictionary();
+        return ImmutableDictionary.CreateRange(items.Select(item => new KeyValuePair<TKey, TValue>(item.key, item.value)));
     }
 
     /// <summary>
@@ -161,7 +161,7 @@ public static SortedDictionary<TKey, TValue> SortedDictionaryOf<TKey, TValue>(
     public static ImmutableSortedDictionary<TKey, TValue> ImmutableSortedDictionaryOf<TKey, TValue>(
         params KeyValuePair<TKey, TValue>[] items) where TKey : notnull
     {
-        return SortedDictionaryOf(items).ToImmutableSortedDictionary();
+        return ImmutableSortedDictionary.CreateRange(items);
     }
 
     /// <summary>
@@ -174,7 +174,7 @@ public static ImmutableSortedDictionary<TKey, TValue> ImmutableSortedDictionaryO
     public static ImmutableSortedDictionary<TKey, TValue> ImmutableSortedDictionaryOf<TKey, TValue>(
         params (TKey key, TValue value)[] items) where TKey : notnull
     {
-        return SortedDictionaryOf(items).ToImmutableSortedDictionary();
+        return ImmutableSortedDictionary.CreateRange(items.Select(item => new KeyValuePair<TKey, TValue>(item.key, item.value)));
     }
 
     /// <summary>
@@ -185,7 +185,7 @@ public static ImmutableSortedDictionary<TKey, TValue> ImmutableSortedDictionaryO
     /// <returns>Returns a hash set populated with the specified items.</returns>
     public static HashSet<T> HashSetOf<T>(params T[] items)
     {
-        return new HashSet<T>(items.Copy());
+        return new HashSet<T>(items);
     }
 
     /// <summary>
@@ -196,7 +196,7 @@ public static HashSet<T> HashSetOf<T>(params T[] items)
     /// <returns>Returns an immutable hash set populated with the specified items.</returns>
     public static ImmutableHashSet<T> ImmutableHashSetOf<T>(params T[] items)
     {
-        return HashSetOf(items).ToImmutableHashSet();
+        return ImmutableHashSet.Create(items);
     }
 
     /// <summary>
@@ -207,7 +207,7 @@ public static ImmutableHashSet<T> ImmutableHashSetOf<T>(params T[] items)
     /// <returns>Returns a sorted set populated with the specified items.</returns>
     public static SortedSet<T> SortedSetOf<T>(params T[] items)
     {
-        return new SortedSet<T>(items.Copy());
+        return new SortedSet<T>(items);
     }
 
     /// <summary>
@@ -218,7 +218,7 @@ public static SortedSet<T> SortedSetOf<T>(params T[] items)
     /// <returns>Returns an immutable sorted set populated with the specified items.</returns>
     public static ImmutableSortedSet<T> ImmutableSortedSetOf<T>(params T[] items)
     {
-        return SortedSetOf(items).ToImmutableSortedSet();
+        return ImmutableSortedSet.Create(items);
     }
 
     /// <summary>
@@ -229,7 +229,7 @@ public static ImmutableSortedSet<T> ImmutableSortedSetOf<T>(params T[] items)
     /// <returns>Returns a stack populated with the specified items.</returns>
     public static Stack<T> StackOf<T>(params T[] items)
     {
-        return new Stack<T>(items.Copy());
+        return new Stack<T>(items);
     }
 
     /// <summary>
@@ -240,7 +240,7 @@ public static Stack<T> StackOf<T>(params T[] items)
     /// <returns>Returns an immutable stack populated with the specified items.</returns>
     public static ImmutableStack<T> ImmutableStackOf<T>(params T[] items)
     {
-        return ImmutableStack.Create(items.Copy());
+        return ImmutableStack.Create(items);
     }
 
     /// <summary>
@@ -251,7 +251,7 @@ public static ImmutableStack<T> ImmutableStackOf<T>(params T[] items)
     /// <returns>Returns a queue populated with the specified items.</returns>
     public static Queue<T> QueueOf<T>(params T[] items)
     {
-        return new Queue<T>(items.Copy());
+        return new Queue<T>(items);
     }
 
     /// <summary>
@@ -262,6 +262,6 @@ public static Queue<T> QueueOf<T>(params T[] items)
     /// <returns>Returns an immutable queue populated with the specified items.</returns>
     public static ImmutableQueue<T> ImmutableQueueOf<T>(params T[] items)
     {
-        return ImmutableQueue.Create(items.Copy());
+        return ImmutableQueue.Create(items);
     }
 }

OnixLabs.Core/Enumeration.Get.cs

@@ -12,20 +12,22 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+using System.Collections.Generic;
 using System.Collections.Immutable;
 using System.Linq;
 using System.Reflection;
 using OnixLabs.Core.Linq;
 
 namespace OnixLabs.Core;
 
+// ReSharper disable ReturnTypeCanBeEnumerable.Global
 public abstract partial class Enumeration<T>
 {
     /// <summary>
     /// Gets all of the enumeration entries for the current type.
     /// </summary>
     /// <returns>Returns all of the enumeration entries for the current type.</returns>
-    public static ImmutableHashSet<T> GetAll()
+    public static IReadOnlySet<T> GetAll()
     {
         return typeof(T)
             .GetFields(BindingFlags.Public | BindingFlags.Static | BindingFlags.DeclaredOnly)
@@ -38,7 +40,7 @@ public static ImmutableHashSet<T> GetAll()
     /// Gets all of the enumeration entries for the current type.
     /// </summary>
     /// <returns>Returns all of the enumeration entries for the current type.</returns>
-    public static ImmutableHashSet<(int Value, string Name)> GetEntries()
+    public static IReadOnlySet<(int Value, string Name)> GetEntries()
     {
         return GetAll().Select(entry => entry.ToEntry()).ToImmutableHashSet();
     }
@@ -47,7 +49,7 @@ public static ImmutableHashSet<T> GetAll()
     /// Gets all of the enumeration names for the current type.
     /// </summary>
     /// <returns>Returns all of the enumeration names for the current type.</returns>
-    public static ImmutableHashSet<string> GetNames()
+    public static IReadOnlySet<string> GetNames()
     {
         return GetAll().Select(entry => entry.Name).ToImmutableHashSet();
     }
@@ -56,7 +58,7 @@ public static ImmutableHashSet<string> GetNames()
     /// Gets all of the enumeration values for the current type.
     /// </summary>
     /// <returns>Returns all of the enumeration values for the current type.</returns>
-    public static ImmutableHashSet<int> GetValues()
+    public static IReadOnlySet<int> GetValues()
     {
         return GetAll().Select(entry => entry.Value).ToImmutableHashSet();
     }

OnixLabs.Core/Preconditions.cs

@@ -29,7 +29,7 @@ public static class Preconditions
     /// <param name="message">The exception message to throw in the event that the condition fails.</param>
     /// <exception cref="InvalidOperationException">If the condition fails.</exception>
     [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)]
-    public static void Check(bool condition, string message = "Check failed.")
+    public static void Check(bool condition, string message = "Check requirement failed.")
     {
         if (!condition) throw new InvalidOperationException(message);
     }
@@ -43,7 +43,7 @@ public static void Check(bool condition, string message = "Check failed.")
     /// <returns>Returns the specified value as non-nullable in the event that the value is not null.</returns>
     /// <exception cref="InvalidOperationException">If the condition fails because the value is null.</exception>
     [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)]
-    public static T CheckNotNull<T>(T? value, string message = "Null check failed.") where T : notnull
+    public static T CheckNotNull<T>(T? value, string message = "Argument must not be null.") where T : notnull
     {
         return value ?? throw new InvalidOperationException(message);
     }
@@ -71,8 +71,9 @@ public static void Require(bool condition, string message = "Argument requiremen
     /// <returns>Returns the specified value as non-nullable in the event that the value is not null.</returns>
     /// <exception cref="ArgumentNullException">If the condition fails because the value is null.</exception>
     [MethodImpl(MethodImplOptions.AggressiveInlining | MethodImplOptions.AggressiveOptimization)]
-    public static T RequireNotNull<T>(T? value, string message = "Argument must be null.", string? parameterName = null) where T : notnull
+    public static T RequireNotNull<T>(T? value, string message = "Argument must not be null.", string? parameterName = null)
+        where T : notnull
     {
-        return value ?? throw new ArgumentNullException(message, parameterName);
+        return value ?? throw new ArgumentNullException(parameterName, message);
     }
 }

OnixLabs.Playground/Program.cs

@@ -16,7 +16,7 @@ namespace OnixLabs.Playground;
 
 internal static class Program
 {
-    private static void Main(string[] args)
+    public static void Main()
     {
     }
 }

OnixLabs.Security.Cryptography/MerkleTree.Generic.Get.cs

@@ -33,7 +33,7 @@ public MerkleTree ToMerkleTree()
     /// Obtains the leaf values from the current <see cref="MerkleTree{T}"/>.
     /// </summary>
     /// <returns>Returns an <see cref="IEnumerable{T}"/> containing the leaf values from the current <see cref="MerkleTree{T}"/>.</returns>
-    public ImmutableList<T> GetLeafValues()
+    public IReadOnlyList<T> GetLeafValues()
     {
         ICollection<T> result = EmptyList<T>();
         CollectLeafValues(this, result);

OnixLabs.Security.Cryptography/MerkleTree.Get.cs

@@ -23,7 +23,7 @@ public abstract partial class MerkleTree
     /// Obtains the leaf hashes from the current <see cref="MerkleTree"/>.
     /// </summary>
     /// <returns>Returns an <see cref="IEnumerable{T}"/> containing the leaf hashes from the current <see cref="MerkleTree"/>.</returns>
-    public ImmutableList<Hash> GetLeafHashes()
+    public IReadOnlyList<Hash> GetLeafHashes()
     {
         ICollection<Hash> result = EmptyList<Hash>();
         CollectLeafHashes(this, result);