Merge pull request #578 from marcinjahn/allocation-free-maybe-map

vkhorikov · web-flow · commit 1b13ecce293a · 2024-12-23T11:18:30.000-05:00
feat: add allocation-free overloads of Maybe.Map
diff --git a/CSharpFunctionalExtensions.Tests/MaybeTests/Extensions/MapTests.Task.Left.cs b/CSharpFunctionalExtensions.Tests/MaybeTests/Extensions/MapTests.Task.Left.cs
@@ -26,5 +26,25 @@ public async Task Map_Task_Left_returns_no_value_if_initial_maybe_is_null()
 
             maybe2.HasValue.Should().BeFalse();
         }
+
+        [Fact]
+        public async Task Map_Task_Left_provides_context_to_selector()
+        {
+            Maybe<T> maybe = T.Value;
+            var context = 5;
+
+            var maybe2 = await maybe
+                .AsTask()
+                .Map(
+                    (value, ctx) =>
+                    {
+                        ctx.Should().Be(context);
+                        return value;
+                    },
+                    context
+                );
+
+            maybe2.HasValue.Should().BeTrue();
+        }
     }
-}
+}
diff --git a/CSharpFunctionalExtensions.Tests/MaybeTests/Extensions/MapTests.Task.Right.cs b/CSharpFunctionalExtensions.Tests/MaybeTests/Extensions/MapTests.Task.Right.cs
@@ -26,5 +26,23 @@ public async Task Map_Task_Right_returns_no_value_if_initial_maybe_is_null()
 
             maybe2.HasValue.Should().BeFalse();
         }
+
+        [Fact]
+        public async Task Map_Task_Right_provides_context_to_selector()
+        {
+            Maybe<T> maybe = T.Value;
+            var context = 5;
+
+            var maybe2 = await maybe.Map(
+                (value, ctx) =>
+                {
+                    ctx.Should().Be(context);
+                    return value.AsTask();
+                },
+                context
+            );
+
+            maybe2.HasValue.Should().BeTrue();
+        }
     }
-}
+}
diff --git a/CSharpFunctionalExtensions.Tests/MaybeTests/Extensions/MapTests.Task.cs b/CSharpFunctionalExtensions.Tests/MaybeTests/Extensions/MapTests.Task.cs
@@ -26,5 +26,25 @@ public async Task Map_Task_returns_no_value_if_initial_maybe_is_null()
 
             maybe2.HasValue.Should().BeFalse();
         }
+
+        [Fact]
+        public async Task Map_Task_provides_context_to_selector()
+        {
+            Maybe<T> maybe = T.Value;
+            var context = 5;
+
+            var maybe2 = await maybe
+                .AsTask()
+                .Map(
+                    (value, ctx) =>
+                    {
+                        ctx.Should().Be(context);
+                        return value.AsTask();
+                    },
+                    context
+                );
+
+            maybe2.HasValue.Should().BeTrue();
+        }
     }
-}
+}
diff --git a/CSharpFunctionalExtensions.Tests/MaybeTests/Extensions/MapTests.ValueTask.Left.cs b/CSharpFunctionalExtensions.Tests/MaybeTests/Extensions/MapTests.ValueTask.Left.cs
@@ -27,5 +27,25 @@ public async Task Map_ValueTask_Left_returns_no_value_if_initial_maybe_is_null()
 
             maybe2.HasValue.Should().BeFalse();
         }
+
+        [Fact]
+        public async Task Map_ValueTask_Left_provides_context_to_selector()
+        {
+            Maybe<T> maybe = T.Value;
+            var context = 5;
+
+            var maybe2 = await maybe
+                .AsValueTask()
+                .Map(
+                    (value, ctx) =>
+                    {
+                        ctx.Should().Be(context);
+                        return value;
+                    },
+                    context
+                );
+
+            maybe2.HasValue.Should().BeTrue();
+        }
     }
-}
+}
diff --git a/CSharpFunctionalExtensions.Tests/MaybeTests/Extensions/MapTests.ValueTask.Right.cs b/CSharpFunctionalExtensions.Tests/MaybeTests/Extensions/MapTests.ValueTask.Right.cs
@@ -1,6 +1,6 @@
 ﻿using System.Threading.Tasks;
-using FluentAssertions;
 using CSharpFunctionalExtensions.ValueTasks;
+using FluentAssertions;
 using Xunit;
 
 namespace CSharpFunctionalExtensions.Tests.MaybeTests.Extensions
@@ -27,5 +27,23 @@ public async Task Map_ValueTask_Right_returns_no_value_if_initial_maybe_is_null(
 
             maybe2.HasValue.Should().BeFalse();
         }
+
+        [Fact]
+        public async Task Map_ValueTask_Right_provides_context_to_selector()
+        {
+            Maybe<T> maybe = T.Value;
+            var context = 5;
+
+            var maybe2 = await maybe.Map(
+                valueTask: (value, ctx) =>
+                {
+                    ctx.Should().Be(context);
+                    return value.AsValueTask();
+                },
+                context
+            );
+
+            maybe2.HasValue.Should().BeTrue();
+        }
     }
-}
+}
diff --git a/CSharpFunctionalExtensions.Tests/MaybeTests/Extensions/MapTests.ValueTask.cs b/CSharpFunctionalExtensions.Tests/MaybeTests/Extensions/MapTests.ValueTask.cs
@@ -12,7 +12,9 @@ public async Task Map_ValueTask_returns_mapped_value()
         {
             Maybe<T> maybe = T.Value;
 
-            var maybe2 = await maybe.AsValueTask().Map(ExpectAndReturn_ValueTask(T.Value, T.Value2));
+            var maybe2 = await maybe
+                .AsValueTask()
+                .Map(ExpectAndReturn_ValueTask(T.Value, T.Value2));
 
             maybe2.HasValue.Should().BeTrue();
             maybe2.Value.Should().Be(T.Value2);
@@ -27,5 +29,25 @@ public async Task Map_ValueTask_returns_no_value_if_initial_maybe_is_null()
 
             maybe2.HasValue.Should().BeFalse();
         }
+
+        [Fact]
+        public async Task Map_ValueTask_provides_context_to_selector()
+        {
+            Maybe<T> maybe = T.Value;
+            var context = 5;
+
+            var maybe2 = await maybe
+                .AsValueTask()
+                .Map(
+                    (value, ctx) =>
+                    {
+                        ctx.Should().Be(context);
+                        return value.AsValueTask();
+                    },
+                    context
+                );
+
+            maybe2.HasValue.Should().BeTrue();
+        }
     }
-}
+}
diff --git a/CSharpFunctionalExtensions.Tests/MaybeTests/Extensions/MapTests.cs b/CSharpFunctionalExtensions.Tests/MaybeTests/Extensions/MapTests.cs
@@ -25,5 +25,23 @@ public void Map_returns_no_value_if_initial_maybe_is_null()
 
             maybe2.HasValue.Should().BeFalse();
         }
+
+        [Fact]
+        public void Map_provides_context_to_selector()
+        {
+            Maybe<T> maybe = T.Value;
+            var context = 5;
+
+            var maybe2 = maybe.Map(
+                (value, ctx) =>
+                {
+                    ctx.Should().Be(context);
+                    return value;
+                },
+                context
+            );
+
+            maybe2.HasValue.Should().BeTrue();
+        }
     }
 }
diff --git a/CSharpFunctionalExtensions/Maybe/Extensions/Map.Task.Left.cs b/CSharpFunctionalExtensions/Maybe/Extensions/Map.Task.Left.cs
@@ -5,10 +5,23 @@ namespace CSharpFunctionalExtensions
 {
     public static partial class MaybeExtensions
     {
-        public static async Task<Maybe<K>> Map<T, K>(this Task<Maybe<T>> maybeTask, Func<T, K> selector)
+        public static async Task<Maybe<K>> Map<T, K>(
+            this Task<Maybe<T>> maybeTask,
+            Func<T, K> selector
+        )
         {
             var maybe = await maybeTask.DefaultAwait();
             return maybe.Map(selector);
         }
+
+        public static async Task<Maybe<K>> Map<T, K, TContext>(
+            this Task<Maybe<T>> maybeTask,
+            Func<T, TContext, K> selector,
+            TContext context
+        )
+        {
+            var maybe = await maybeTask.DefaultAwait();
+            return maybe.Map(selector, context);
+        }
     }
-}
+}
diff --git a/CSharpFunctionalExtensions/Maybe/Extensions/Map.Task.Right.cs b/CSharpFunctionalExtensions/Maybe/Extensions/Map.Task.Right.cs
@@ -12,5 +12,17 @@ public static async Task<Maybe<K>> Map<T, K>(this Maybe<T> maybe, Func<T, Task<K
 
             return await selector(maybe.GetValueOrThrow()).DefaultAwait();
         }
+
+        public static async Task<Maybe<K>> Map<T, K, TContext>(
+            this Maybe<T> maybe,
+            Func<T, TContext, Task<K>> selector,
+            TContext context
+        )
+        {
+            if (maybe.HasNoValue)
+                return Maybe<K>.None;
+
+            return await selector(maybe.GetValueOrThrow(), context).DefaultAwait();
+        }
     }
-}
+}
diff --git a/CSharpFunctionalExtensions/Maybe/Extensions/Map.Task.cs b/CSharpFunctionalExtensions/Maybe/Extensions/Map.Task.cs
@@ -5,10 +5,23 @@ namespace CSharpFunctionalExtensions
 {
     public static partial class MaybeExtensions
     {
-        public static async Task<Maybe<K>> Map<T, K>(this Task<Maybe<T>> maybeTask, Func<T, Task<K>> selector)
+        public static async Task<Maybe<K>> Map<T, K>(
+            this Task<Maybe<T>> maybeTask,
+            Func<T, Task<K>> selector
+        )
         {
             var maybe = await maybeTask.DefaultAwait();
             return await maybe.Map(selector).DefaultAwait();
         }
+
+        public static async Task<Maybe<K>> Map<T, K, TContext>(
+            this Task<Maybe<T>> maybeTask,
+            Func<T, TContext, Task<K>> selector,
+            TContext context
+        )
+        {
+            var maybe = await maybeTask.DefaultAwait();
+            return await maybe.Map(selector, context).DefaultAwait();
+        }
     }
-}
+}
diff --git a/CSharpFunctionalExtensions/Maybe/Extensions/Map.ValueTask.Left.cs b/CSharpFunctionalExtensions/Maybe/Extensions/Map.ValueTask.Left.cs
@@ -6,11 +6,24 @@ namespace CSharpFunctionalExtensions.ValueTasks
 {
     public static partial class MaybeExtensions
     {
-        public static async ValueTask<Maybe<K>> Map<T, K>(this ValueTask<Maybe<T>> valueTask, Func<T, K> selector)
+        public static async ValueTask<Maybe<K>> Map<T, K>(
+            this ValueTask<Maybe<T>> valueTask,
+            Func<T, K> selector
+        )
         {
             Maybe<T> maybe = await valueTask;
             return maybe.Map(selector);
         }
+
+        public static async ValueTask<Maybe<K>> Map<T, K, TContext>(
+            this ValueTask<Maybe<T>> valueTask,
+            Func<T, TContext, K> selector,
+            TContext context
+        )
+        {
+            Maybe<T> maybe = await valueTask;
+            return maybe.Map(selector, context);
+        }
     }
 }
-#endif
+#endif
diff --git a/CSharpFunctionalExtensions/Maybe/Extensions/Map.ValueTask.Right.cs b/CSharpFunctionalExtensions/Maybe/Extensions/Map.ValueTask.Right.cs
@@ -6,13 +6,28 @@ namespace CSharpFunctionalExtensions.ValueTasks
 {
     public static partial class MaybeExtensions
     {
-        public static async ValueTask<Maybe<K>> Map<T, K>(this Maybe<T> maybe, Func<T, ValueTask<K>> valueTask)
+        public static async ValueTask<Maybe<K>> Map<T, K>(
+            this Maybe<T> maybe,
+            Func<T, ValueTask<K>> valueTask
+        )
         {
             if (maybe.HasNoValue)
                 return Maybe<K>.None;
 
             return await valueTask(maybe.GetValueOrThrow());
         }
+
+        public static async ValueTask<Maybe<K>> Map<T, K, TContext>(
+            this Maybe<T> maybe,
+            Func<T, TContext, ValueTask<K>> valueTask,
+            TContext context
+        )
+        {
+            if (maybe.HasNoValue)
+                return Maybe<K>.None;
+
+            return await valueTask(maybe.GetValueOrThrow(), context);
+        }
     }
 }
-#endif
+#endif
diff --git a/CSharpFunctionalExtensions/Maybe/Extensions/Map.ValueTask.cs b/CSharpFunctionalExtensions/Maybe/Extensions/Map.ValueTask.cs
@@ -6,11 +6,24 @@ namespace CSharpFunctionalExtensions.ValueTasks
 {
     public static partial class MaybeExtensions
     {
-        public static async ValueTask<Maybe<K>> Map<T, K>(this ValueTask<Maybe<T>> maybeTask, Func<T, ValueTask<K>> valueTask)
+        public static async ValueTask<Maybe<K>> Map<T, K>(
+            this ValueTask<Maybe<T>> maybeTask,
+            Func<T, ValueTask<K>> valueTask
+        )
         {
             Maybe<T> maybe = await maybeTask;
             return await maybe.Map(valueTask);
         }
+
+        public static async ValueTask<Maybe<K>> Map<T, K, TContext>(
+            this ValueTask<Maybe<T>> maybeTask,
+            Func<T, TContext, ValueTask<K>> valueTask,
+            TContext context
+        )
+        {
+            Maybe<T> maybe = await maybeTask;
+            return await maybe.Map(valueTask, context);
+        }
     }
 }
-#endif
+#endif
diff --git a/CSharpFunctionalExtensions/Maybe/Extensions/Map.cs b/CSharpFunctionalExtensions/Maybe/Extensions/Map.cs
@@ -11,5 +11,17 @@ public static Maybe<K> Map<T, K>(in this Maybe<T> maybe, Func<T, K> selector)
 
             return selector(maybe.GetValueOrThrow());
         }
+
+        public static Maybe<K> Map<T, K, TContext>(
+            in this Maybe<T> maybe,
+            Func<T, TContext, K> selector,
+            TContext context
+        )
+        {
+            if (maybe.HasNoValue)
+                return Maybe<K>.None;
+
+            return selector(maybe.GetValueOrThrow(), context);
+        }
     }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -5,10 +5,23 @@ namespace CSharpFunctionalExtensions`
`5`	`5`	`{`
`6`	`6`	`public static partial class MaybeExtensions`
`7`	`7`	`{`
`8`		`- public static async Task<Maybe<K>> Map<T, K>(this Task<Maybe<T>> maybeTask, Func<T, K> selector)`
	`8`	`+ public static async Task<Maybe<K>> Map<T, K>(`
	`9`	`+ this Task<Maybe<T>> maybeTask,`
	`10`	`+ Func<T, K> selector`
	`11`	`+ )`
`9`	`12`	`{`
`10`	`13`	`var maybe = await maybeTask.DefaultAwait();`
`11`	`14`	`return maybe.Map(selector);`
`12`	`15`	`}`
	`16`	`+`
	`17`	`+ public static async Task<Maybe<K>> Map<T, K, TContext>(`
	`18`	`+ this Task<Maybe<T>> maybeTask,`
	`19`	`+ Func<T, TContext, K> selector,`
	`20`	`+ TContext context`
	`21`	`+ )`
	`22`	`+ {`
	`23`	`+ var maybe = await maybeTask.DefaultAwait();`
	`24`	`+ return maybe.Map(selector, context);`
	`25`	`+ }`
`13`	`26`	`}`
`14`		`-}`
	`27`	`+}`