Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add async Select and Consume #39

Merged
merged 4 commits into from
Feb 23, 2023
Merged

Add async Select and Consume #39

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
83345d2
Add async Select and Consume
d-nery Feb 3, 2023
3ea7836
Merge branch 'release/1.0' into feature/async
d-nery Feb 3, 2023
419a22c
Add Or/OrMaybe Async variants and tests
d-nery Feb 7, 2023
e4ec414
Add Or/OrMaybe Async tests with null arg
d-nery Feb 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
153 changes: 152 additions & 1 deletion Maybe.Test/MaybeExtensionsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
using FluentAssertions;
using System;
using System.Threading.Tasks;
using FluentAssertions;
using Xunit;

namespace ZBRA.Maybe.Test
Expand Down Expand Up @@ -106,6 +107,15 @@ public void Select_WithNullableProperty_ReturnsSelectedProperty(Maybe<NullableIn
result.Should().Be(expected);
}

[Theory]
[MemberData(nameof(Select_WithNullablePropertyTestCases))]
public async Task SelectAsync_WithNullableProperty_ReturnsSelectedProperty(Maybe<NullableIntObj> subject, Maybe<int> expected)
{
var result = await subject.SelectAsync(async o => await Task.FromResult(o.Count));

result.Should().Be(expected);
}

public static TheoryData<Maybe<NullableIntObj>, Maybe<int>> Select_WithNullablePropertyTestCases()
{
return new TheoryData<Maybe<NullableIntObj>, Maybe<int>>
Expand Down Expand Up @@ -141,6 +151,15 @@ public void SelectMany_WithMaybeProperty_ReturnsSelectedProperty(Maybe<MaybeIntO
result.Should().Be(expected);
}

[Theory]
[MemberData(nameof(SelectMany_WithMaybePropertyTestCases))]
public async Task SelectManyAsync_WithMaybeProperty_ReturnsSelectedProperty(Maybe<MaybeIntObj> subject, Maybe<int> expected)
{
var result = await subject.SelectManyAsync(async o => await Task.FromResult(o.Count));

result.Should().Be(expected);
}

public static TheoryData<Maybe<MaybeIntObj>, Maybe<int>> SelectMany_WithMaybePropertyTestCases()
{
return new TheoryData<Maybe<MaybeIntObj>, Maybe<int>>
Expand All @@ -158,5 +177,137 @@ public void SelectMany_NullArgument_ShouldThrow()

subject.Should().ThrowExactly<ArgumentNullException>();
}

[Fact]
public void Consume_WithValue_ShouldExecuteAction()
{
string result = null;
var expected = 1;

expected.ToMaybe()
.Consume(i => result = i.ToString());

result.Should().Be(expected.ToString());
}

[Fact]
public async Task ConsumeAsync_WithValue_ShouldExecuteAction()
{
string result = null;
const int expected = 1;

await expected.ToMaybe()
.ConsumeAsync(async i =>
{
result = i.ToString();
await Task.CompletedTask;
});

result.Should().Be(expected.ToString());
}

[Fact]
public void Consume_WithNoValue_ShouldNotExecuteAction()
{
var result = "a";

Maybe<string>.Nothing
.Consume(i => result = "b");

result.Should().Be("a");
}

[Fact]
public async Task ConsumeAsync_WithNoValue_ShouldNotExecuteAction()
{
var result = "a";

await Maybe<string>.Nothing
.ConsumeAsync(async _ =>
{
result = "b";
await Task.CompletedTask;
});

result.Should().Be("a");
}

[Fact]
public void Consume_NullArgument_ShouldThrow()
{
Action subject = () => 1.ToMaybe().Consume((Action<int>)null);

subject.Should().ThrowExactly<ArgumentNullException>();
}

[Theory]
[InlineData(null, null, null)]
[InlineData(null, 2, null)]
[InlineData(2, null, null)]
[InlineData(1, 2, "3")]
public void Zip_WithTransformer_ShouldZipValues(int? value, double? otherValue, string expected)
{
static string transformer(int v, double o) => (v + o).ToString();

var result = value.ToMaybe()
.Zip(otherValue.ToMaybe(), transformer);

result.Should().Be(expected.ToMaybe());
}

[Theory]
[InlineData(null, null, null)]
[InlineData(null, 2, null)]
[InlineData(2, null, null)]
[InlineData(1, 2, "3")]
public void Zip_WithMaybeTransformer_ShouldZipValues(int? value, double? otherValue, string expected)
{
static Maybe<string> transformer(int v, double o) => (v + o).ToString().ToMaybe();

var result = value.ToMaybe()
.Zip(otherValue.ToMaybe(), transformer);

result.Should().Be(expected.ToMaybe());
}

[Fact]
public void Zip_NullArgument_ShouldThrow()
{
Action subject = () => 1.ToMaybe().Zip(Maybe<int>.Nothing, (Func<int, int, int>)null);

subject.Should().ThrowExactly<ArgumentNullException>();
}

[Fact]
public void Zip_MaybeNullArgument_ShouldThrow()
{
Action subject = () => 1.ToMaybe().Zip(Maybe<int>.Nothing, (Func<int, int, Maybe<int>>)null);

subject.Should().ThrowExactly<ArgumentNullException>();
}

[Theory]
[InlineData(null, null, null)]
[InlineData(null, 2, null)]
[InlineData(2, null, null)]
[InlineData(1, 2, "3")]
public void ZipConsume_WhenBothValuesExist_ShouldExecuteAction(int? value, double? otherValue, string expected)
{
string result = null;
void action(int v, double o) => result = (v + o).ToString();

value.ToMaybe()
.ZipAndConsume(otherValue.ToMaybe(), action);

result.Should().Be(expected);
}

[Fact]
public void ZipAndConsume_NullArgument_ShouldThrow()
{
Action subject = () => 1.ToMaybe().ZipAndConsume(Maybe<int>.Nothing, null);

subject.Should().ThrowExactly<ArgumentNullException>();
}
}
}
103 changes: 1 addition & 102 deletions Maybe.Test/MaybeTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
using FluentAssertions;
using System;
using System.Collections.Generic;
using FluentAssertions;
using Xunit;

namespace ZBRA.Maybe.Test
Expand Down Expand Up @@ -74,107 +74,6 @@ public void OrThrow_NullArgument_ShouldThrow()
subject.Should().ThrowExactly<ArgumentNullException>();
}

[Fact]
public void Consume_WithValue_ShouldExecuteAction()
{
string result = null;
var expected = 1;

expected.ToMaybe()
.Consume(i => result = i.ToString());

result.Should().Be(expected.ToString());
}

[Fact]
public void Consume_WithNoValue_ShouldNotExecuteAction()
{
var result = "a";

Maybe<string>.Nothing
.Consume(i => result = "b");

result.Should().Be("a");
}

[Fact]
public void Consume_NullArgument_ShouldThrow()
{
Action subject = () => 1.ToMaybe().Consume(null);

subject.Should().ThrowExactly<ArgumentNullException>();
}

[Theory]
[InlineData(null, null, null)]
[InlineData(null, 2, null)]
[InlineData(2, null, null)]
[InlineData(1, 2, "3")]
public void Zip_WithTransformer_ShouldZipValues(int? value, double? otherValue, string expected)
{
static string transformer(int v, double o) => (v + o).ToString();

var result = value.ToMaybe()
.Zip(otherValue.ToMaybe(), transformer);

result.Should().Be(expected.ToMaybe());
}

[Theory]
[InlineData(null, null, null)]
[InlineData(null, 2, null)]
[InlineData(2, null, null)]
[InlineData(1, 2, "3")]
public void Zip_WithMaybeTransformer_ShouldZipValues(int? value, double? otherValue, string expected)
{
static Maybe<string> transformer(int v, double o) => (v + o).ToString().ToMaybe();

var result = value.ToMaybe()
.Zip(otherValue.ToMaybe(), transformer);

result.Should().Be(expected.ToMaybe());
}

[Fact]
public void Zip_NullArgument_ShouldThrow()
{
Action subject = () => 1.ToMaybe().Zip(Maybe<int>.Nothing, (Func<int, int, int>)null);

subject.Should().ThrowExactly<ArgumentNullException>();
}

[Fact]
public void Zip_MaybeNullArgument_ShouldThrow()
{
Action subject = () => 1.ToMaybe().Zip(Maybe<int>.Nothing, (Func<int, int, Maybe<int>>)null);

subject.Should().ThrowExactly<ArgumentNullException>();
}

[Theory]
[InlineData(null, null, null)]
[InlineData(null, 2, null)]
[InlineData(2, null, null)]
[InlineData(1, 2, "3")]
public void ZipConsume_WhenBothValuesExist_ShouldExecuteAction(int? value, double? otherValue, string expected)
{
string result = null;
void action(int v, double o) => result = (v + o).ToString();

value.ToMaybe()
.ZipAndConsume(otherValue.ToMaybe(), action);

result.Should().Be(expected);
}

[Fact]
public void ZipAndConsume_NullArgument_ShouldThrow()
{
Action subject = () => 1.ToMaybe().ZipAndConsume(Maybe<int>.Nothing, null);

subject.Should().ThrowExactly<ArgumentNullException>();
}

[Fact]
public void Equals_WhenObjectReferencesAreEqual()
{
Expand Down
20 changes: 3 additions & 17 deletions Maybe/Maybe.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ namespace ZBRA.Maybe
/// </summary>
public readonly struct Maybe<T> : IEquatable<Maybe<T>>, IComparable<Maybe<T>>
{
/// <value>A Maybe without a value.</value>
/// <summary>A Maybe without a value.</summary>
public static readonly Maybe<T> Nothing = new Maybe<T>(default, false);

private readonly T obj;
Expand All @@ -25,10 +25,10 @@ internal Maybe(T obj)
HasValue = true;
}

/// <value>True if there is a value present, otherwise false.</value>
/// <summary>True if there is a value present, otherwise false.</summary>
public bool HasValue { get; }

/// <value>The encapsulated value.</value>
/// <summary>The encapsulated value.</summary>
/// <exception cref="Exception">Thrown if HasValue is false.</exception>
public T Value
{
Expand Down Expand Up @@ -137,20 +137,6 @@ public T OrThrow(Func<Exception> errorSupplier)
throw errorSupplier();
}

/// <summary>
/// Applies an action to the value if it's present.
/// </summary>
/// <param name="consumer"> The action to be applied to the value.</param>
public void Consume(Action<T> consumer)
{
consumer = consumer ?? throw new ArgumentNullException(nameof(consumer));

if (HasValue)
{
consumer(obj);
}
}

/// <summary>
/// Determines if the encapsulated value matches another value using Equals.
/// </summary>
Expand Down
Loading