Skip to content

Commit 19bb8ed

Browse files
MrMatthewLaytonMrMatthewLayton
authored
feature/type-conversions (#71)
* Adding several features including async extensions for working with the `Result` and `Result<T>` types. This also includes several bug fixes and improves test coverage. * Added more unit tests, xmldoc and general code cleanup. Version bumped to 8.14.0 * Removed playground code.
1 parent 71d3e0f commit 19bb8ed

File tree

96 files changed

+5954
-1786
lines changed

Some content is hidden

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

96 files changed

+5954
-1786
lines changed

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

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
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 sealed class Disposable : IDisposable, IAsyncDisposable
18+
{
19+
public bool IsDisposed { get; private set; }
20+
21+
public void Dispose()
22+
{
23+
IsDisposed = true;
24+
}
25+
26+
public async ValueTask DisposeAsync()
27+
{
28+
IsDisposed = true;
29+
await ValueTask.CompletedTask;
30+
}
31+
}

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

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
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 sealed class InvalidFormatProvider : IFormatProvider
18+
{
19+
public static readonly InvalidFormatProvider Instance = new();
20+
21+
private InvalidFormatProvider()
22+
{
23+
}
24+
25+
public object? GetFormat(Type? formatType) => null;
26+
}

‎OnixLabs.Core.UnitTests.Data/OnixLabs.Core.UnitTests.Data.csproj

+4-4
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@
88
<IsTestProject>false</IsTestProject>
99
</PropertyGroup>
1010
<ItemGroup>
11-
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0"/>
12-
<PackageReference Include="xunit" Version="2.6.4"/>
13-
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.6">
11+
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
12+
<PackageReference Include="xunit" Version="2.8.1" />
13+
<PackageReference Include="xunit.runner.visualstudio" Version="2.8.1">
1414
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
1515
<PrivateAssets>all</PrivateAssets>
1616
</PackageReference>
17-
<PackageReference Include="coverlet.collector" Version="6.0.0">
17+
<PackageReference Include="coverlet.collector" Version="6.0.2">
1818
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
1919
<PrivateAssets>all</PrivateAssets>
2020
</PackageReference>

‎OnixLabs.Core.UnitTests/EnumerationTests.cs

+18
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ public void EnumerationsShouldBeEqual()
2929

3030
// Then
3131
Assert.Equal(a, b);
32+
Assert.True(a == b);
33+
Assert.False(a != b);
3234
}
3335

3436
[Fact(DisplayName = "Enumerations should not be equal")]
@@ -40,6 +42,8 @@ public void EnumerationsShouldNotBeEqual()
4042

4143
// Then
4244
Assert.NotEqual(a, b);
45+
Assert.True(a != b);
46+
Assert.False(a == b);
4347
}
4448

4549
[Fact(DisplayName = "Enumeration should return all enumeration instances")]
@@ -149,4 +153,18 @@ public void EnumerationCompareToAsObjectShouldReturnTheCorrectValue()
149153
// Then
150154
Assert.Equal(-1, actual);
151155
}
156+
157+
[Fact(DisplayName = "Enumeration.ToString should produce the expected result")]
158+
public void EnumerationToStringShouldProduceExpectedResult()
159+
{
160+
// Given
161+
const string expected = "Red";
162+
Color red = Color.Red;
163+
164+
// When
165+
string actual = red.ToString();
166+
167+
// Then
168+
Assert.Equal(expected, actual);
169+
}
152170
}

‎OnixLabs.Core.UnitTests/Linq/IEnumerableExtensionTests.cs

+70
Original file line numberDiff line numberDiff line change
@@ -480,6 +480,76 @@ public void NoneShouldProduceExpectedResultFalseAll()
480480
Assert.False(result);
481481
}
482482

483+
[Fact(DisplayName = "IEnumerable.SequenceEqualOrNull should return true when the current and other enumerables are null.")]
484+
public void SequenceEqualOrNullShouldReturnTrueWhenCurrentAndOtherEnumerablesAreNull()
485+
{
486+
// Given
487+
IEnumerable<int>? enumerable = null;
488+
IEnumerable<int>? other = null;
489+
490+
// When
491+
bool result = enumerable.SequenceEqualOrNull(other);
492+
493+
// Then
494+
Assert.True(result);
495+
}
496+
497+
[Fact(DisplayName = "IEnumerable.SequenceEqualOrNull should return false when the current enumerable is not null and other enumerable is null.")]
498+
public void SequenceEqualOrNullShouldReturnTrueWhenCurrentEnumerableIsNotNullAndOtherEnumerableIsNull()
499+
{
500+
// Given
501+
IEnumerable<int> enumerable = [1, 2, 3];
502+
IEnumerable<int>? other = null;
503+
504+
// When
505+
bool result = enumerable.SequenceEqualOrNull(other);
506+
507+
// Then
508+
Assert.False(result);
509+
}
510+
511+
[Fact(DisplayName = "IEnumerable.SequenceEqualOrNull should return false when the current enumerable is null and other enumerable is not null.")]
512+
public void SequenceEqualOrNullShouldReturnTrueWhenCurrentEnumerableIsNullAndOtherEnumerableIsNotNull()
513+
{
514+
// Given
515+
IEnumerable<int>? enumerable = null;
516+
IEnumerable<int> other = [1, 2, 3];
517+
518+
// When
519+
bool result = enumerable.SequenceEqualOrNull(other);
520+
521+
// Then
522+
Assert.False(result);
523+
}
524+
525+
[Fact(DisplayName = "IEnumerable.SequenceEqualOrNull should return true when the current enumerable is equal to the other enumerable.")]
526+
public void SequenceEqualOrNullShouldReturnTrueWhenCurrentEnumerableIsEqualToTheOtherEnumerable()
527+
{
528+
// Given
529+
IEnumerable<int>? enumerable = [1, 2, 3];
530+
IEnumerable<int> other = [1, 2, 3];
531+
532+
// When
533+
bool result = enumerable.SequenceEqualOrNull(other);
534+
535+
// Then
536+
Assert.True(result);
537+
}
538+
539+
[Fact(DisplayName = "IEnumerable.SequenceEqualOrNull should return false when the current enumerable is not equal to the other enumerable.")]
540+
public void SequenceEqualOrNullShouldReturnTrueWhenCurrentEnumerableIsNotEqualToTheOtherEnumerable()
541+
{
542+
// Given
543+
IEnumerable<int>? enumerable = [1, 2, 3];
544+
IEnumerable<int> other = [3, 2, 1];
545+
546+
// When
547+
bool result = enumerable.SequenceEqualOrNull(other);
548+
549+
// Then
550+
Assert.False(result);
551+
}
552+
483553
[Fact(DisplayName = "IEnumerable.SingleOrNone should return success none when the enumerable contains no elements.")]
484554
public void SingleOrNoneShouldReturnSuccessNoneWhenEnumerableContainsNoElements()
485555
{

‎OnixLabs.Core.UnitTests/ObjectExtensionTests.cs

+62
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,68 @@ public void IsWithinRangeExclusiveShouldProduceExpectedResult(int value, int min
5050
Assert.Equal(expected, actual);
5151
}
5252

53+
[Fact(DisplayName = "CompareToObject should produce zero if the current IComparable<T> is equal to the specified object.")]
54+
public void CompareToObjectShouldProduceZeroIfTheCurrentIComparableIsEqualToTheSpecifiedObject()
55+
{
56+
// Given
57+
const int expected = 0;
58+
59+
// When
60+
int actual = 123.CompareToObject(123);
61+
62+
// Then
63+
Assert.Equal(expected, actual);
64+
}
65+
66+
[Fact(DisplayName = "CompareToObject should produce positive one if the specified object is null.")]
67+
public void CompareToObjectShouldProducePositiveOneIfTheSpecifiedObjectIsNull()
68+
{
69+
// Given
70+
const int expected = 1;
71+
72+
// When
73+
int actual = 124.CompareToObject(null);
74+
75+
// Then
76+
Assert.Equal(expected, actual);
77+
}
78+
79+
[Fact(DisplayName = "CompareToObject should produce positive one if the current IComparable<T> greater than the specified object.")]
80+
public void CompareToObjectShouldProducePositiveOneIfTheCurrentIComparableIsGreaterThanTheSpecifiedObject()
81+
{
82+
// Given
83+
const int expected = 1;
84+
85+
// When
86+
int actual = 124.CompareToObject(123);
87+
88+
// Then
89+
Assert.Equal(expected, actual);
90+
}
91+
92+
[Fact(DisplayName = "CompareToObject should produce negative one if the current IComparable<T> greater than the specified object.")]
93+
public void CompareToObjectShouldProduceNegativeOneIfTheCurrentIComparableIsGreaterThanTheSpecifiedObject()
94+
{
95+
// Given
96+
const int expected = -1;
97+
98+
// When
99+
int actual = 122.CompareToObject(123);
100+
101+
// Then
102+
Assert.Equal(expected, actual);
103+
}
104+
105+
[Fact(DisplayName = "CompareToObject should throw ArgumentException if the specified object is of the incorrect type.")]
106+
public void CompareToObjectShouldThrowArgumentExceptionIfSpecifiedObjectIsOfIncorrectType()
107+
{
108+
// When
109+
Exception exception = Assert.Throws<ArgumentException>(() => 122.CompareToObject(123.456));
110+
111+
// Then
112+
Assert.Equal("Object must be of type System.Int32 (Parameter 'obj')", exception.Message);
113+
}
114+
53115
[Fact(DisplayName = "ToRecordString should produce a record formatted string")]
54116
public void ToRecordStringShouldProduceExpectedResult()
55117
{

‎OnixLabs.Core.UnitTests/OnixLabs.Core.UnitTests.csproj

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66
<Nullable>enable</Nullable>
77
</PropertyGroup>
88
<ItemGroup>
9-
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0"/>
10-
<PackageReference Include="xunit" Version="2.6.4"/>
11-
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.6">
9+
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
10+
<PackageReference Include="xunit" Version="2.8.1" />
11+
<PackageReference Include="xunit.runner.visualstudio" Version="2.8.1">
1212
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
1313
<PrivateAssets>all</PrivateAssets>
1414
</PackageReference>
15-
<PackageReference Include="coverlet.collector" Version="6.0.0">
15+
<PackageReference Include="coverlet.collector" Version="6.0.2">
1616
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
1717
<PrivateAssets>all</PrivateAssets>
1818
</PackageReference>

‎OnixLabs.Core.UnitTests/OptionalTests.cs

+28-11
Original file line numberDiff line numberDiff line change
@@ -201,39 +201,51 @@ public void OptionalNoneExplicitOperatorShouldProduceExpectedResult()
201201
public void OptionalSomeValuesShouldBeConsideredEqual()
202202
{
203203
// Given
204-
Optional<int> a = Optional<int>.Some(123);
205-
Optional<int> b = Optional<int>.Some(123);
204+
Some<int> a = Optional<int>.Some(123);
205+
Some<int> b = Optional<int>.Some(123);
206+
object bObject = b;
206207

207208
// When / Then
208209
Assert.Equal(a, b);
209-
Assert.True(a == b);
210+
Assert.Equal(a, bObject);
210211
Assert.True(a.Equals(b));
212+
Assert.True(a.Equals(bObject));
213+
Assert.True(a == b);
214+
Assert.False(a != b);
211215
}
212216

213217
[Fact(DisplayName = "Optional Some values should not be considered equal.")]
214218
public void OptionalSomeValuesShouldNotBeConsideredEqual()
215219
{
216220
// Given
217-
Optional<int> a = Optional<int>.Some(123);
218-
Optional<int> b = Optional<int>.Some(456);
221+
Some<int> a = Optional<int>.Some(123);
222+
Some<int> b = Optional<int>.Some(456);
223+
object bObject = b;
219224

220225
// When / Then
221226
Assert.NotEqual(a, b);
222-
Assert.True(a != b);
227+
Assert.NotEqual(a, bObject);
223228
Assert.False(a.Equals(b));
229+
Assert.False(a.Equals(bObject));
230+
Assert.False(a == b);
231+
Assert.True(a != b);
224232
}
225233

226234
[Fact(DisplayName = "Optional None values should be considered equal.")]
227235
public void OptionalNoneValuesShouldBeConsideredEqual()
228236
{
229237
// Given
230-
Optional<int> a = Optional<int>.None;
231-
Optional<int> b = Optional<int>.None;
238+
None<int> a = Optional<int>.None;
239+
None<int> b = Optional<int>.None;
240+
object bObject = b;
232241

233242
// When / Then
234243
Assert.Equal(a, b);
235-
Assert.True(a == b);
244+
Assert.Equal(a, bObject);
236245
Assert.True(a.Equals(b));
246+
Assert.True(a.Equals(bObject));
247+
Assert.True(a == b);
248+
Assert.False(a != b);
237249
}
238250

239251
[Fact(DisplayName = "Optional Some and None values should not be considered equal.")]
@@ -242,11 +254,15 @@ public void OptionalSomeAndNoneValuesShouldNotBeConsideredEqual()
242254
// Given
243255
Optional<int> a = Optional<int>.Some(123);
244256
Optional<int> b = Optional<int>.None;
257+
object bObject = b;
245258

246259
// When / Then
247260
Assert.NotEqual(a, b);
248-
Assert.True(a != b);
261+
Assert.NotEqual(a, bObject);
249262
Assert.False(a.Equals(b));
263+
Assert.False(a.Equals(bObject));
264+
Assert.False(a == b);
265+
Assert.True(a != b);
250266
}
251267

252268
[Fact(DisplayName = "Optional Some.GetHashCode should produce the expected result.")]
@@ -317,7 +333,8 @@ public void OptionalSomeGetValueOrDefaultWithDefaultValueShouldProduceExpectedRe
317333
Optional<string> text = "abc";
318334

319335
// When
320-
int actualNumber = number.GetValueOrDefault(456);
336+
int? actualNumber = number.GetValueOrDefault(456);
337+
// ReSharper disable once VariableCanBeNotNullable
321338
string? actualText = text.GetValueOrDefault("xyz");
322339

323340
// Then

0 commit comments

Comments
 (0)