Skip to content

Commit 1a1b02e

Browse files
MrMatthewLaytonMrMatthewLayton
authored
feature/crypto-named-hash (#54) (#55)
* Added `NamedHash`, new pre-condition checks, and extension methods. * Updated version to 8.2.0
1 parent fdb839c commit 1a1b02e

File tree

13 files changed

+495
-30
lines changed

13 files changed

+495
-30
lines changed

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

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
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+
namespace OnixLabs.Core.UnitTests.Data;
16+
17+
public enum Shape
18+
{
19+
Square,
20+
Circle
21+
}

‎OnixLabs.Core.UnitTests/ObjectExtensionTests.cs

+31-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,37 @@ namespace OnixLabs.Core.UnitTests;
2020

2121
public sealed class ObjectExtensionTests
2222
{
23-
[Fact(DisplayName = "Object.ToRecordString should produce a record formatted string")]
23+
[Theory(DisplayName = "IsWithinRangeInclusive should produce the expected result")]
24+
[InlineData(2, 1, 3, true)]
25+
[InlineData(1, 1, 3, true)]
26+
[InlineData(3, 1, 3, true)]
27+
[InlineData(0, 1, 3, false)]
28+
[InlineData(4, 1, 3, false)]
29+
public void IsWithinRangeInclusiveShouldProduceExpectedResult(int value, int min, int max, bool expected)
30+
{
31+
// When
32+
bool actual = value.IsWithinRangeInclusive(min, max);
33+
34+
// Then
35+
Assert.Equal(expected, actual);
36+
}
37+
38+
[Theory(DisplayName = "IsWithinRangeExclusive should produce the expected result")]
39+
[InlineData(2, 1, 3, true)]
40+
[InlineData(1, 1, 3, false)]
41+
[InlineData(3, 1, 3, false)]
42+
[InlineData(0, 1, 3, false)]
43+
[InlineData(4, 1, 3, false)]
44+
public void IsWithinRangeExclusiveShouldProduceExpectedResult(int value, int min, int max, bool expected)
45+
{
46+
// When
47+
bool actual = value.IsWithinRangeExclusive(min, max);
48+
49+
// Then
50+
Assert.Equal(expected, actual);
51+
}
52+
53+
[Fact(DisplayName = "ToRecordString should produce a record formatted string")]
2454
public void ToRecordStringShouldProduceExpectedResult()
2555
{
2656
// Given

‎OnixLabs.Core.UnitTests/PreconditionTests.cs

+146-15
Original file line numberDiff line numberDiff line change
@@ -13,59 +13,190 @@
1313
// limitations under the License.
1414

1515
using System;
16+
using OnixLabs.Core.UnitTests.Data;
1617
using Xunit;
1718

1819
namespace OnixLabs.Core.UnitTests;
1920

2021
public sealed class PreconditionTests
2122
{
22-
[Fact(DisplayName = "Check should throw an ArgumentException when the condition is false")]
23-
public void CheckShouldProduceExpectedResult()
23+
[Fact(DisplayName = "Check should throw an InvalidOperationException when the condition is false")]
24+
public void CheckShouldThrowInvalidOperationExceptionWhenConditionIsFalse()
2425
{
2526
// When
26-
InvalidOperationException exception = Assert.Throws<InvalidOperationException>(() => Check(false));
27+
Exception exception = Assert.Throws<InvalidOperationException>(() => Check(false));
2728

2829
// Then
29-
Assert.Equal("Check failed.", exception.Message);
30+
Assert.Equal("Argument must satisfy the specified condition.", exception.Message);
3031
}
3132

32-
[Fact(DisplayName = "CheckNotNull should throw an ArgumentNullException when the condition is null")]
33-
public void CheckNotNullShouldProduceExpectedResult()
33+
[Fact(DisplayName = "CheckNotNull should throw an InvalidOperationException when the condition is null")]
34+
public void CheckNotNullShouldThrowInvalidOperationExceptionWhenConditionIsNull()
3435
{
3536
// When
36-
InvalidOperationException exception = Assert.Throws<InvalidOperationException>(() => CheckNotNull<object>(null));
37+
Exception exception = Assert.Throws<InvalidOperationException>(() => CheckNotNull<object>(null));
3738

3839
// Then
3940
Assert.Equal("Argument must not be null.", exception.Message);
4041
}
4142

43+
[Fact(DisplayName = "CheckNotNullOrEmpty should throw an InvalidOperationException when the value is null")]
44+
public void CheckNotNullOrEmptyShouldThrowInvalidOperationExceptionWhenValueIsNull()
45+
{
46+
// When
47+
Exception exception = Assert.Throws<InvalidOperationException>(() => CheckNotNullOrEmpty(null));
48+
49+
// Then
50+
Assert.Equal("Argument must not be null or empty.", exception.Message);
51+
}
52+
53+
[Fact(DisplayName = "CheckNotNullOrEmpty should throw an InvalidOperationException when the value is empty")]
54+
public void CheckNotNullOrEmptyShouldThrowInvalidOperationExceptionWhenValueIsEmpty()
55+
{
56+
// When
57+
Exception exception = Assert.Throws<InvalidOperationException>(() => CheckNotNullOrEmpty(string.Empty));
58+
59+
// Then
60+
Assert.Equal("Argument must not be null or empty.", exception.Message);
61+
}
62+
63+
[Fact(DisplayName = "CheckNotNullOrWhiteSpace should throw an InvalidOperationException when the value is null")]
64+
public void CheckNotNullOrWhiteSpaceShouldThrowInvalidOperationExceptionWhenValueIsNull()
65+
{
66+
// When
67+
Exception exception = Assert.Throws<InvalidOperationException>(() => CheckNotNullOrWhiteSpace(null));
68+
69+
// Then
70+
Assert.Equal("Argument must not be null or whitespace.", exception.Message);
71+
}
72+
73+
[Fact(DisplayName = "CheckNotNullOrWhiteSpace should throw an InvalidOperationException when the value is whitespace")]
74+
public void CheckNotNullOrWhiteSpaceShouldThrowInvalidOperationExceptionWhenValueIsWhiteSpace()
75+
{
76+
// When
77+
Exception exception = Assert.Throws<InvalidOperationException>(() => CheckNotNullOrWhiteSpace(" "));
78+
79+
// Then
80+
Assert.Equal("Argument must not be null or whitespace.", exception.Message);
81+
}
82+
4283
[Fact(DisplayName = "Require should throw an ArgumentException when the condition is false")]
43-
public void RequireShouldProduceExpectedResult()
84+
public void RequireShouldThrowArgumentExceptionWhenConditionIsFalse()
4485
{
4586
// When
46-
ArgumentException exception = Assert.Throws<ArgumentException>(() => Require(false));
87+
Exception exception = Assert.Throws<ArgumentException>(() => Require(false));
4788

4889
// Then
49-
Assert.Equal("Argument requirement failed.", exception.Message);
90+
Assert.Equal("Argument must satisfy the specified condition.", exception.Message);
5091
}
5192

5293
[Fact(DisplayName = "RequireWithinRange should throw an ArgumentOutOfRangeException when the condition is false")]
53-
public void RequireWithinRangeShouldProduceExpectedResult()
94+
public void RequireWithinRangeShouldThrowArgumentOutOfRangeExceptionWhenConditionIsFalse()
5495
{
5596
// When
56-
ArgumentOutOfRangeException exception = Assert.Throws<ArgumentOutOfRangeException>(() => RequireWithinRange(false));
97+
Exception exception = Assert.Throws<ArgumentOutOfRangeException>(() => RequireWithinRange(false));
98+
99+
// Then
100+
Assert.Equal("Argument must be within range.", exception.Message);
101+
}
102+
103+
[Fact(DisplayName = "RequireWithinRangeInclusive should throw an ArgumentOutOfRangeException when the value falls below the specified range")]
104+
public void RequireWithinRangeInclusiveShouldThrowArgumentOutOfRangeExceptionWhenValueFallsBelowSpecifiedRange()
105+
{
106+
// Given
107+
Exception exception = Assert.Throws<ArgumentOutOfRangeException>(() => RequireWithinRangeInclusive(1, 2, 3));
108+
109+
// Then
110+
Assert.Equal("Argument must be within range.", exception.Message);
111+
}
112+
113+
[Fact(DisplayName = "RequireWithinRangeInclusive should throw an ArgumentOutOfRangeException when the value falls above the specified range")]
114+
public void RequireWithinRangeInclusiveShouldThrowArgumentOutOfRangeExceptionWhenValueFallsAboveSpecifiedRange()
115+
{
116+
// Given
117+
Exception exception = Assert.Throws<ArgumentOutOfRangeException>(() => RequireWithinRangeInclusive(4, 2, 3));
118+
119+
// Then
120+
Assert.Equal("Argument must be within range.", exception.Message);
121+
}
122+
123+
[Fact(DisplayName = "RequireWithinRangeExclusive should throw an ArgumentOutOfRangeException when the value falls below the specified range")]
124+
public void RequireWithinRangeExclusiveShouldThrowArgumentOutOfRangeExceptionWhenValueFallsBelowSpecifiedRange()
125+
{
126+
// Given
127+
Exception exception = Assert.Throws<ArgumentOutOfRangeException>(() => RequireWithinRangeExclusive(2, 2, 4));
128+
129+
// Then
130+
Assert.Equal("Argument must be within range.", exception.Message);
131+
}
132+
133+
[Fact(DisplayName = "RequireWithinRangeExclusive should throw an ArgumentOutOfRangeException when the value falls above the specified range")]
134+
public void RequireWithinRangeExclusiveShouldThrowArgumentOutOfRangeExceptionWhenValueFallsAboveSpecifiedRange()
135+
{
136+
// Given
137+
Exception exception = Assert.Throws<ArgumentOutOfRangeException>(() => RequireWithinRangeExclusive(4, 2, 4));
57138

58139
// Then
59-
Assert.Equal("Argument is out of range.", exception.Message);
140+
Assert.Equal("Argument must be within range.", exception.Message);
60141
}
61142

62143
[Fact(DisplayName = "RequireNotNull should throw an ArgumentNullException when the condition is null")]
63-
public void RequireNotNullShouldProduceExpectedResult()
144+
public void RequireNotNullShouldThrowArgumentNullExceptionWhenConditionIsNull()
64145
{
65146
// When
66-
ArgumentNullException exception = Assert.Throws<ArgumentNullException>(() => RequireNotNull<object>(null));
147+
Exception exception = Assert.Throws<ArgumentNullException>(() => RequireNotNull<object>(null));
67148

68149
// Then
69150
Assert.Equal("Argument must not be null.", exception.Message);
70151
}
152+
153+
[Fact(DisplayName = "RequireNotNullOrEmpty should throw an ArgumentException when the value is null")]
154+
public void RequireNotNullOrEmptyShouldThrowArgumentExceptionWhenValueIsNull()
155+
{
156+
// When
157+
Exception exception = Assert.Throws<ArgumentException>(() => RequireNotNullOrEmpty(null));
158+
159+
// Then
160+
Assert.Equal("Argument must not be null or empty.", exception.Message);
161+
}
162+
163+
[Fact(DisplayName = "RequireNotNullOrEmpty should throw an ArgumentException when the value is empty")]
164+
public void RequireNotNullOrEmptyShouldThrowArgumentExceptionWhenValueIsEmpty()
165+
{
166+
// When
167+
Exception exception = Assert.Throws<ArgumentException>(() => RequireNotNullOrEmpty(string.Empty));
168+
169+
// Then
170+
Assert.Equal("Argument must not be null or empty.", exception.Message);
171+
}
172+
173+
[Fact(DisplayName = "RequireNotNullOrWhiteSpace should throw an ArgumentException when the value is null")]
174+
public void RequireNotNullOrWhiteSpaceShouldThrowArgumentExceptionWhenValueIsNull()
175+
{
176+
// When
177+
Exception exception = Assert.Throws<ArgumentException>(() => RequireNotNullOrWhiteSpace(null));
178+
179+
// Then
180+
Assert.Equal("Argument must not be null or whitespace.", exception.Message);
181+
}
182+
183+
[Fact(DisplayName = "RequireNotNullOrWhiteSpace should throw an ArgumentException when the value is whitespace")]
184+
public void RequireNotNullOrWhiteSpaceShouldThrowArgumentExceptionWhenValueIsWhiteSpace()
185+
{
186+
// When
187+
Exception exception = Assert.Throws<ArgumentException>(() => RequireNotNullOrWhiteSpace(" "));
188+
189+
// Then
190+
Assert.Equal("Argument must not be null or whitespace.", exception.Message);
191+
}
192+
193+
[Fact(DisplayName = "RequireIsDefined should throw an ArgumentOutOfRangeException when the specified enum value is not defined")]
194+
public void RequireIsDefinedShouldThrowArgumentOutOfRangeExceptionWhenSpecifiedEnumValueIsNotDefined()
195+
{
196+
// When
197+
Exception exception = Assert.Throws<ArgumentOutOfRangeException>(() => RequireIsDefined((Shape)2));
198+
199+
// Then
200+
Assert.Equal("Invalid Shape enum value: 2. Valid values include: Square, Circle.", exception.Message);
201+
}
71202
}

‎OnixLabs.Core/Extensions.Object.cs

+32
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,38 @@ namespace OnixLabs.Core;
2727
[EditorBrowsable(EditorBrowsableState.Never)]
2828
public static class ObjectExtensions
2929
{
30+
/// <summary>
31+
/// Determines whether the current <see cref="IComparable{T}"/> value falls within range, inclusive of the specified minimum and maximum values.
32+
/// </summary>
33+
/// <param name="value">The value to test.</param>
34+
/// <param name="min">The inclusive minimum value.</param>
35+
/// <param name="max">The inclusive maximum value.</param>
36+
/// <typeparam name="T">The underlying <see cref="IComparable{T}"/> type.</typeparam>
37+
/// <returns>
38+
/// Returns <see langword="true"/> if the current <see cref="IComparable{T}"/> value falls within range,
39+
/// inclusive of the specified minimum and maximum values; otherwise, <see langword="false"/>.
40+
/// </returns>
41+
public static bool IsWithinRangeInclusive<T>(this T value, T min, T max) where T : IComparable<T>
42+
{
43+
return value.CompareTo(min) is 0 or 1 && value.CompareTo(max) is 0 or -1;
44+
}
45+
46+
/// <summary>
47+
/// Determines whether the current <see cref="IComparable{T}"/> value falls within range, exclusive of the specified minimum and maximum values.
48+
/// </summary>
49+
/// <param name="value">The value to test.</param>
50+
/// <param name="min">The exclusive minimum value.</param>
51+
/// <param name="max">The exclusive maximum value.</param>
52+
/// <typeparam name="T">The underlying <see cref="IComparable{T}"/> type.</typeparam>
53+
/// <returns>
54+
/// Returns <see langword="true"/> if the current <see cref="IComparable{T}"/> value falls within range,
55+
/// exclusive of the specified minimum and maximum values; otherwise, <see langword="false"/>.
56+
/// </returns>
57+
public static bool IsWithinRangeExclusive<T>(this T value, T min, T max) where T : IComparable<T>
58+
{
59+
return value.CompareTo(min) is 1 && value.CompareTo(max) is -1;
60+
}
61+
3062
/// <summary>
3163
/// Compares the current <see cref="IComparable{T}"/> instance with the specified <see cref="Object"/> instance.
3264
/// </summary>

‎OnixLabs.Core/OnixLabs.Core.csproj

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<NeutralLanguage>en</NeutralLanguage>
1212
<Copyright>Copyright © ONIXLabs 2020</Copyright>
1313
<RepositoryUrl>https://github.com/onix-labs/onixlabs-dotnet</RepositoryUrl>
14-
<PackageVersion>8.1.0</PackageVersion>
14+
<PackageVersion>8.2.0</PackageVersion>
1515
<PackageLicenseUrl></PackageLicenseUrl>
1616
</PropertyGroup>
1717
<PropertyGroup>

0 commit comments

Comments
 (0)