Skip to content

Commit 07cb34b

Browse files
MrMatthewLaytonMrMatthewLayton
committed
Merge branch 'refs/heads/main' into release
2 parents e450a17 + 658325f commit 07cb34b

File tree

69 files changed

+956
-158
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+956
-158
lines changed

‎OnixLabs.Core.UnitTests.Data/BufferSegment.cs

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
// Copyright 2020 ONIXLabs
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
using System.Buffers;
16+
17+
namespace OnixLabs.Core.UnitTests.Data;
18+
19+
public sealed class BufferSegment<T> : ReadOnlySequenceSegment<T>
20+
{
21+
private BufferSegment(ReadOnlyMemory<T> memory) => Memory = memory;
22+
23+
private void SetNext(BufferSegment<T> next)
24+
{
25+
Next = next;
26+
next.RunningIndex = RunningIndex + Memory.Length;
27+
}
28+
29+
public static ReadOnlySequence<T> FromMemory(ReadOnlyMemory<T>[] segments)
30+
{
31+
if (segments.Length == 1)
32+
return new ReadOnlySequence<T>(segments[0]);
33+
34+
BufferSegment<T>[] bufferSegments = segments
35+
.Select(segment => new BufferSegment<T>(segment)).ToArray();
36+
37+
for (int index = 0; index < bufferSegments.Length - 1; index++)
38+
bufferSegments[index].SetNext(bufferSegments[index + 1]);
39+
40+
return new ReadOnlySequence<T>(bufferSegments[0], 0, bufferSegments[^1], bufferSegments[^1].Memory.Length);
41+
}
42+
}

‎OnixLabs.Core.UnitTests/PreconditionTests.cs

+56
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,34 @@ public void CheckNotNullShouldNotThrowInvalidOperationExceptionWhenConditionIsNo
5454
CheckNotNull(new object());
5555
}
5656

57+
[Fact(DisplayName = "CheckNotNull of ValueType should throw an InvalidOperationException when the condition is null")]
58+
public void CheckNotNullOfValueTypeShouldThrowInvalidOperationExceptionWhenConditionIsNull()
59+
{
60+
// Given
61+
int? expected = null;
62+
int actual = default;
63+
64+
// When
65+
Exception exception = Assert.Throws<InvalidOperationException>(() => actual = CheckNotNull(expected));
66+
67+
// Then
68+
Assert.Equal(default, actual);
69+
Assert.Equal("Argument must not be null.", exception.Message);
70+
}
71+
72+
[Fact(DisplayName = "CheckNotNull of ValueType should not throw an InvalidOperationException when the condition is not null")]
73+
public void CheckNotNullOfValueTypeShouldNotThrowInvalidOperationExceptionWhenConditionIsNotNull()
74+
{
75+
// Given
76+
int? expected = 123;
77+
78+
// When
79+
int actual = CheckNotNull(expected);
80+
81+
// Then
82+
Assert.Equal(expected, actual);
83+
}
84+
5785
[Fact(DisplayName = "CheckNotNullOrEmpty should throw an InvalidOperationException when the value is null")]
5886
public void CheckNotNullOrEmptyShouldThrowInvalidOperationExceptionWhenValueIsNull()
5987
{
@@ -240,6 +268,34 @@ public void RequireNotNullShouldNotThrowInvalidOperationExceptionWhenConditionIs
240268
RequireNotNull(new object());
241269
}
242270

271+
[Fact(DisplayName = "RequireNotNull of ValueType should throw an InvalidOperationException when the condition is null")]
272+
public void RequireNotNullOfValueTypeShouldThrowInvalidOperationExceptionWhenConditionIsNull()
273+
{
274+
// Given
275+
int? expected = null;
276+
int actual = default;
277+
278+
// When
279+
Exception exception = Assert.Throws<ArgumentNullException>(() => actual = RequireNotNull(expected));
280+
281+
// Then
282+
Assert.Equal(default, actual);
283+
Assert.Equal("Argument must not be null.", exception.Message);
284+
}
285+
286+
[Fact(DisplayName = "RequireNotNull of ValueType should not throw an InvalidOperationException when the condition is not null")]
287+
public void RequireNotNullOfValueTypeShouldNotThrowInvalidOperationExceptionWhenConditionIsNotNull()
288+
{
289+
// Given
290+
int? expected = 123;
291+
292+
// When
293+
int actual = RequireNotNull(expected);
294+
295+
// Then
296+
Assert.Equal(expected, actual);
297+
}
298+
243299
[Fact(DisplayName = "RequireNotNullOrEmpty should throw an ArgumentException when the value is null")]
244300
public void RequireNotNullOrEmptyShouldThrowArgumentExceptionWhenValueIsNull()
245301
{

‎OnixLabs.Core.UnitTests/ReadOnlySequenceExtensionTests.cs

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
// Copyright 2020 ONIXLabs
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
using System;
16+
using System.Buffers;
17+
using OnixLabs.Core.UnitTests.Data;
18+
using Xunit;
19+
20+
namespace OnixLabs.Core.UnitTests;
21+
22+
public sealed class ReadOnlySequenceExtensionTests
23+
{
24+
[Fact(DisplayName = "ReadOnlySequence.CopyTo should copy into a new array with a single element")]
25+
public void ReadOnlySequenceCopyToShouldCopyIntoNewArrayWithSingleElement()
26+
{
27+
// Given
28+
string[] expected = ["ABC", "XYZ", "123", "789"];
29+
ReadOnlySequence<string> value = new(expected);
30+
31+
// When
32+
value.CopyTo(out string[] actual);
33+
34+
// Then
35+
Assert.Equal(expected, actual);
36+
}
37+
38+
[Fact(DisplayName = "ReadOnlySequence.CopyTo should copy into a new array with multiple elements")]
39+
public void ReadOnlySequenceCopyToShouldCopyIntoNewArrayWithMultipleElements()
40+
{
41+
// Given
42+
string[] expected = ["ABC", "XYZ", "123", "789"];
43+
ReadOnlySequence<string> value = BufferSegment<string>.FromMemory([
44+
new ReadOnlyMemory<string>(["ABC", "XYZ"]),
45+
new ReadOnlyMemory<string>(["123", "789"])
46+
]);
47+
48+
// When
49+
value.CopyTo(out string[] actual);
50+
51+
// Then
52+
Assert.Equal(expected, actual);
53+
}
54+
}

‎OnixLabs.Core.UnitTests/Text/Base16Tests.cs

+15
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,21 @@ public void Base16ShouldBeImplicitlyConstructableFromReadOnlySequenceOfChar()
9797
Assert.Equal(expected, actual);
9898
}
9999

100+
[Fact(DisplayName = "Base16 should be implicitly constructable from ReadOnlySequence<byte>")]
101+
public void Base16ShouldBeImplicitlyConstructableFromReadOnlySequenceOfByte()
102+
{
103+
// Given
104+
byte[] expected = [1, 2, 3, 4];
105+
ReadOnlySequence<byte> value = new(expected);
106+
107+
// When
108+
Base16 candidate = value;
109+
byte[] actual = candidate.ToByteArray();
110+
111+
// Then
112+
Assert.Equal(expected, actual);
113+
}
114+
100115
[Fact(DisplayName = "Base16 should not change when modifying the original byte array")]
101116
public void Base16ShouldNotChangeWhenModifyingOriginalByteArray()
102117
{

‎OnixLabs.Core.UnitTests/Text/Base32Tests.cs

+15
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,21 @@ public void Base32ShouldBeImplicitlyConstructableFromReadOnlySequenceOfChar()
9797
Assert.Equal(expected, actual);
9898
}
9999

100+
[Fact(DisplayName = "Base32 should be implicitly constructable from ReadOnlySequence<byte>")]
101+
public void Base32ShouldBeImplicitlyConstructableFromReadOnlySequenceOfByte()
102+
{
103+
// Given
104+
byte[] expected = [1, 2, 3, 4];
105+
ReadOnlySequence<byte> value = new(expected);
106+
107+
// When
108+
Base32 candidate = value;
109+
byte[] actual = candidate.ToByteArray();
110+
111+
// Then
112+
Assert.Equal(expected, actual);
113+
}
114+
100115
[Fact(DisplayName = "Base32 should not change when modifying the original byte array")]
101116
public void Base32ShouldNotChangeWhenModifyingOriginalByteArray()
102117
{

‎OnixLabs.Core.UnitTests/Text/Base58Tests.cs

+15
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,21 @@ public void Base58ShouldBeImplicitlyConstructableFromReadOnlySpanOfByte()
5252
Assert.Equal(expected, actual);
5353
}
5454

55+
[Fact(DisplayName = "Base58 should be implicitly constructable from ReadOnlySequence<byte>")]
56+
public void Base58ShouldBeImplicitlyConstructableFromReadOnlySequenceOfByte()
57+
{
58+
// Given
59+
byte[] expected = [1, 2, 3, 4];
60+
ReadOnlySequence<byte> value = new(expected);
61+
62+
// When
63+
Base58 candidate = value;
64+
byte[] actual = candidate.ToByteArray();
65+
66+
// Then
67+
Assert.Equal(expected, actual);
68+
}
69+
5570
[Fact(DisplayName = "Base58 should be implicitly constructable from string")]
5671
public void Base58ShouldBeImplicitlyConstructableFromString()
5772
{

‎OnixLabs.Core.UnitTests/Text/Base64Tests.cs

+15
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,21 @@ public void Base64ShouldBeImplicitlyConstructableFromReadOnlySequenceOfChar()
9797
Assert.Equal(expected, actual);
9898
}
9999

100+
[Fact(DisplayName = "Base64 should be implicitly constructable from ReadOnlySequence<byte>")]
101+
public void Base64ShouldBeImplicitlyConstructableFromReadOnlySequenceOfByte()
102+
{
103+
// Given
104+
byte[] expected = [1, 2, 3, 4];
105+
ReadOnlySequence<byte> value = new(expected);
106+
107+
// When
108+
Base64 candidate = value;
109+
byte[] actual = candidate.ToByteArray();
110+
111+
// Then
112+
Assert.Equal(expected, actual);
113+
}
114+
100115
[Fact(DisplayName = "Base64 should not change when modifying the original byte array")]
101116
public void Base64ShouldNotChangeWhenModifyingOriginalByteArray()
102117
{

‎OnixLabs.Core/Extensions.ReadOnlySequence.cs

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
// Copyright 2020 ONIXLabs
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
using System.Buffers;
16+
using System.ComponentModel;
17+
18+
namespace OnixLabs.Core;
19+
20+
/// <summary>
21+
/// Provides extension methods for read-only sequences.
22+
/// </summary>
23+
[EditorBrowsable(EditorBrowsableState.Never)]
24+
public static class ReadOnlySequenceExtensions
25+
{
26+
/// <summary>
27+
/// Copies the current <see cref="ReadOnlySequence{T}"/> to the specified <see cref="T:[]"/> by reference.
28+
/// </summary>
29+
/// <param name="sequence">The current <see cref="ReadOnlySequence{T}"/> to copy.</param>
30+
/// <param name="array">The <see cref="T:[]"/> to copy to.</param>
31+
/// <typeparam name="T">The underlying type of the specified <see cref="ReadOnlySequence{T}"/> and <see cref="T:[]"/>.</typeparam>
32+
public static void CopyTo<T>(this ReadOnlySequence<T> sequence, out T[] array)
33+
{
34+
if (sequence.IsSingleSegment)
35+
{
36+
array = sequence.First.Span.ToArray();
37+
}
38+
else
39+
{
40+
array = new T[sequence.Length];
41+
sequence.CopyTo(array);
42+
}
43+
}
44+
}

‎OnixLabs.Core/Extensions.String.cs

+1-6
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,6 @@ public static class StringExtensions
4242
/// </summary>
4343
private const DateTimeStyles DefaultStyles = DateTimeStyles.None;
4444

45-
/// <summary>
46-
/// The default encoding.
47-
/// </summary>
48-
private static readonly Encoding DefaultEncoding = Encoding.UTF8;
49-
5045
/// <summary>
5146
/// Repeats the current <see cref="String"/> by the specified number of repetitions.
5247
/// </summary>
@@ -246,7 +241,7 @@ public static string SubstringAfterLast(this string value, string delimiter, str
246241
/// <param name="value">The current <see cref="String"/> from which to obtain a <see cref="T:Byte[]"/>.</param>
247242
/// <param name="encoding">The encoding that will be used to convert the current <see cref="String"/> into a <see cref="T:Byte[]"/>.</param>
248243
/// <returns>Returns a new <see cref="T:Byte[]"/> representation of the current <see cref="String"/> instance.</returns>
249-
public static byte[] ToByteArray(this string value, Encoding? encoding = null) => (encoding ?? DefaultEncoding).GetBytes(value);
244+
public static byte[] ToByteArray(this string value, Encoding? encoding = null) => encoding.GetOrDefault().GetBytes(value);
250245

251246
/// <summary>
252247
/// Converts the current <see cref="String"/> instance into a new <see cref="DateTime"/> instance.

‎OnixLabs.Core/OnixLabs.Core.csproj

+7-2
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
<Title>OnixLabs.Core</Title>
88
<Authors>ONIXLabs</Authors>
99
<Description>ONIXLabs Core API for .NET</Description>
10-
<AssemblyVersion>8.15.0</AssemblyVersion>
10+
<AssemblyVersion>8.16.0</AssemblyVersion>
1111
<NeutralLanguage>en</NeutralLanguage>
1212
<Copyright>Copyright © ONIXLabs 2020</Copyright>
1313
<RepositoryUrl>https://github.com/onix-labs/onixlabs-dotnet</RepositoryUrl>
14-
<PackageVersion>8.15.0</PackageVersion>
14+
<PackageVersion>8.16.0</PackageVersion>
1515
</PropertyGroup>
1616
<PropertyGroup>
1717
<AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
@@ -45,4 +45,9 @@
4545
<ItemGroup>
4646
<Using Include="OnixLabs.Core.Preconditions" Static="True"/>
4747
</ItemGroup>
48+
<ItemGroup>
49+
<InternalsVisibleTo Include="OnixLabs.Numerics"/>
50+
<InternalsVisibleTo Include="OnixLabs.Security"/>
51+
<InternalsVisibleTo Include="OnixLabs.Security.Cryptography"/>
52+
</ItemGroup>
4853
</Project>

‎OnixLabs.Core/Preconditions.cs

+28
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,19 @@ public static T CheckNotNull<T>(T? value, string message = ArgumentNull)
5353
return value ?? throw new InvalidOperationException(message);
5454
}
5555

56+
/// <summary>
57+
/// Performs a general pre-condition check that fails if the specified value is <see langword="null"/>.
58+
/// </summary>
59+
/// <param name="value">The nullable value to check.</param>
60+
/// <param name="message">The exception message to throw in the event that the specified value is <see langword="null"/>.</param>
61+
/// <typeparam name="T">The underlying type of the value.</typeparam>
62+
/// <returns>Returns a non-null value of the specified type.</returns>
63+
/// <exception cref="InvalidOperationException">If the specified value is <see langword="null"/>.</exception>
64+
public static T CheckNotNull<T>(T? value, string message = ArgumentNull) where T : struct
65+
{
66+
return value ?? throw new InvalidOperationException(message);
67+
}
68+
5669
/// <summary>
5770
/// Performs a general pre-condition check that fails if the specified value is <see langword="null"/> or an empty string.
5871
/// </summary>
@@ -99,6 +112,7 @@ public static void Require(bool condition, string message = ArgumentFailed, stri
99112
/// <param name="parameterName">The name of the invalid parameter.</param>
100113
/// <exception cref="ArgumentOutOfRangeException">If the specified condition is <see langword="false"/>.</exception>
101114
[EditorBrowsable(EditorBrowsableState.Never)]
115+
[Obsolete("This method is obsolete and will be removed in a future version. Use RequireWithinRangeInclusive or RequireWithinRangeExclusive methods instead.")]
102116
public static void RequireWithinRange(bool condition, string message = ArgumentOutOfRange, string? parameterName = null)
103117
{
104118
if (!condition) throw new ArgumentOutOfRangeException(parameterName, message);
@@ -148,6 +162,20 @@ public static T RequireNotNull<T>(T? value, string message = ArgumentNull, strin
148162
return value ?? throw new ArgumentNullException(parameterName, message);
149163
}
150164

165+
/// <summary>
166+
/// Performs a general pre-condition requirement that fails if the specified value is <see langword="null"/>.
167+
/// </summary>
168+
/// <param name="value">The nullable value to check.</param>
169+
/// <param name="message">The exception message to throw in the event that the specified value is <see langword="null"/>.</param>
170+
/// <param name="parameterName">The name of the invalid parameter.</param>
171+
/// <typeparam name="T">The underlying type of the value.</typeparam>
172+
/// <returns>Returns a non-null value of the specified type.</returns>
173+
/// <exception cref="ArgumentNullException">If the specified value is <see langword="null"/>.</exception>
174+
public static T RequireNotNull<T>(T? value, string message = ArgumentNull, string? parameterName = null) where T : struct
175+
{
176+
return value ?? throw new ArgumentNullException(parameterName, message);
177+
}
178+
151179
/// <summary>
152180
/// Performs a general pre-condition requirement that fails if the specified value is <see langword="null"/> or an empty string.
153181
/// </summary>

0 commit comments

Comments
 (0)