feat: change return type of `ReturnsAsync` to `IReturnMethodSetupReturnBuilder` #366

vbreuss · 2026-01-15T16:23:06Z

This PR changes the return type of the ReturnsAsync extension methods from IReturnMethodSetup to IReturnMethodSetupReturnBuilder to support fluent chaining with builder methods like When and Only.

Key Changes:

Updated all ReturnsAsync method signatures to return IReturnMethodSetupReturnBuilder instead of IReturnMethodSetup
Added comprehensive tests demonstrating the new fluent API capabilities with When and Only chaining
Updated API baseline files to reflect the new method signatures

Fixes Inconsistent return type of ReturnsAsync #365

Copilot

Pull request overview

This PR changes the return type of the ReturnsAsync extension methods from IReturnMethodSetup to IReturnMethodSetupReturnBuilder to support fluent chaining with builder methods like When and Only.

Changes:

Updated all ReturnsAsync method signatures to return IReturnMethodSetupReturnBuilder instead of IReturnMethodSetup
Added comprehensive tests demonstrating the new fluent API capabilities with When and Only chaining
Updated API baseline files to reflect the new method signatures

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
Source/Mockolate/ReturnsAsyncExtensions.cs	Changed return type from `IReturnMethodSetup` to `IReturnMethodSetupReturnBuilder` for all `ReturnsAsync` methods
Source/Mockolate.SourceGenerators/Sources/Sources.ReturnsAsyncExtensions.cs	Updated source generator to emit `IReturnMethodSetupReturnBuilder` return type
Tests/Mockolate.Tests/ReturnsAsyncExtensionsTests.cs	Added tests verifying `When` and `Only` can be chained after `ReturnsAsync`
Tests/Mockolate.SourceGenerators.Tests/Sources/ReturnsAsyncExtensionsTests.cs	Updated test expectations to validate new return type in generated code
Tests/Mockolate.Api.Tests/Expected/Mockolate_netstandard2.0.txt	Updated API baseline for .NET Standard 2.0
Tests/Mockolate.Api.Tests/Expected/Mockolate_net8.0.txt	Updated API baseline for .NET 8.0
Tests/Mockolate.Api.Tests/Expected/Mockolate_net10.0.txt	Updated API baseline for .NET 10.0

Tests/Mockolate.Tests/ReturnsAsyncExtensionsTests.cs

github-actions · 2026-01-15T16:26:07Z

Test Results

14 files ± 0 14 suites ±0 5m 53s ⏱️ +38s
2 175 tests +10 2 174 ✅ +10 1 💤 ±0 0 ❌ ±0
14 555 runs +65 14 554 ✅ +65 1 💤 ±0 0 ❌ ±0

Results for commit 30d938d. ± Comparison against base commit ecb3045.

♻️ This comment has been updated with latest results.

github-actions · 2026-01-15T16:27:32Z

🚀 Benchmark Results

Details

BenchmarkDotNet v0.15.8, Linux Ubuntu 24.04.3 LTS (Noble Numbat)

Intel Xeon Platinum 8370C CPU 2.80GHz (Max: 2.79GHz), 1 CPU, 4 logical and 2 physical cores

.NET SDK 10.0.102

[Host] : .NET 10.0.2 (10.0.2, 10.0.225.61305), X64 RyuJIT x86-64-v4
Job=InProcess  Toolchain=InProcessEmitToolchain  IterationCount=15

LaunchCount=1  WarmupCount=10

Method	Mean	Error	StdDev	Gen0	Gen1	Allocated
Simple_Mockolate	1.635 μs	0.0355 μs	0.0332 μs	0.1507	-	3.72 KB
Simple_Moq	136.056 μs	1.0852 μs	1.0151 μs	0.4883	0.2441	14.56 KB
Simple_NSubstitute	6.076 μs	0.0427 μs	0.0399 μs	0.3662	-	9.14 KB
Simple_FakeItEasy	5.816 μs	0.0362 μs	0.0302 μs	0.3281	-	8.12 KB

…rnBuilder`

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 10 comments.

Copilot · 2026-01-17T16:00:32Z

Tests/Mockolate.Tests/ReturnsAsyncExtensionsTests.cs

 		}

+		[Fact]
+		public async Task ReturnsAsync_1Parameter_ShouldSupportWhenAndFor()


Test method name uses 'For' but the test uses Only(1). The method should be named 'ReturnsAsync_1Parameter_ShouldSupportWhenAndOnly' to accurately reflect what is being tested.

Suggested change

public async Task ReturnsAsync_1Parameter_ShouldSupportWhenAndFor()

public async Task ReturnsAsync_1Parameter_ShouldSupportWhenAndOnly()

Copilot · 2026-01-17T16:00:33Z

Tests/Mockolate.Tests/ReturnsAsyncExtensionsTests.cs

 		}

+		[Fact]
+		public async Task ReturnsAsync_2Parameters_ShouldSupportWhenAndFor()


Test method name uses 'For' but the test uses Only(1). The method should be named 'ReturnsAsync_2Parameters_ShouldSupportWhenAndOnly' to accurately reflect what is being tested.

Suggested change

public async Task ReturnsAsync_2Parameters_ShouldSupportWhenAndFor()

public async Task ReturnsAsync_2Parameters_ShouldSupportWhenAndOnly()

Copilot · 2026-01-17T16:00:33Z

Tests/Mockolate.Tests/ReturnsAsyncExtensionsTests.cs

 		}

+		[Fact]
+		public async Task ReturnsAsync_3Parameters_ShouldSupportWhenAndFor()


Test method name uses 'For' but the test uses Only(1). The method should be named 'ReturnsAsync_3Parameters_ShouldSupportWhenAndOnly' to accurately reflect what is being tested.

Suggested change

public async Task ReturnsAsync_3Parameters_ShouldSupportWhenAndFor()

public async Task ReturnsAsync_3Parameters_ShouldSupportWhenAndOnly()

Copilot · 2026-01-17T16:00:33Z

Tests/Mockolate.Tests/ReturnsAsyncExtensionsTests.cs

 		}

+		[Fact]
+		public async Task ReturnsAsync_4Parameters_ShouldSupportWhenAndFor()


Test method name uses 'For' but the test uses Only(1). The method should be named 'ReturnsAsync_4Parameters_ShouldSupportWhenAndOnly' to accurately reflect what is being tested.

Suggested change

public async Task ReturnsAsync_4Parameters_ShouldSupportWhenAndFor()

public async Task ReturnsAsync_4Parameters_ShouldSupportWhenAndOnly()

Copilot · 2026-01-17T16:00:34Z

Tests/Mockolate.Tests/ReturnsAsyncExtensionsTests.cs

 		}

+		[Fact]
+		public async Task ReturnsAsync_NoParameters_ShouldSupportWhenAndFor()


Test method name uses 'For' but the test uses Only(1). The method should be named 'ReturnsAsync_NoParameters_ShouldSupportWhenAndOnly' to accurately reflect what is being tested.

Suggested change

public async Task ReturnsAsync_NoParameters_ShouldSupportWhenAndFor()

public async Task ReturnsAsync_NoParameters_ShouldSupportWhenAndOnly()

Copilot · 2026-01-17T16:00:34Z

Tests/Mockolate.Tests/ReturnsAsyncExtensionsTests.cs

 		}

+		[Fact]
+		public async Task ReturnsAsync_1Parameter_ShouldSupportWhenAndFor()


Test method name uses 'For' but the test uses Only(1). The method should be named 'ReturnsAsync_1Parameter_ShouldSupportWhenAndOnly' to accurately reflect what is being tested.

Suggested change

public async Task ReturnsAsync_1Parameter_ShouldSupportWhenAndFor()

public async Task ReturnsAsync_1Parameter_ShouldSupportWhenAndOnly()

Copilot · 2026-01-17T16:00:34Z

Tests/Mockolate.Tests/ReturnsAsyncExtensionsTests.cs

 		}

+		[Fact]
+		public async Task ReturnsAsync_2Parameters_ShouldSupportWhenAndFor()


Test method name uses 'For' but the test uses Only(1). The method should be named 'ReturnsAsync_2Parameters_ShouldSupportWhenAndOnly' to accurately reflect what is being tested.

Suggested change

public async Task ReturnsAsync_2Parameters_ShouldSupportWhenAndFor()

public async Task ReturnsAsync_2Parameters_ShouldSupportWhenAndOnly()

Copilot · 2026-01-17T16:00:34Z

Tests/Mockolate.Tests/ReturnsAsyncExtensionsTests.cs

 		}

+		[Fact]
+		public async Task ReturnsAsync_3Parameters_ShouldSupportWhenAndFor()


Test method name uses 'For' but the test uses Only(1). The method should be named 'ReturnsAsync_3Parameters_ShouldSupportWhenAndOnly' to accurately reflect what is being tested.

Suggested change

public async Task ReturnsAsync_3Parameters_ShouldSupportWhenAndFor()

public async Task ReturnsAsync_3Parameters_ShouldSupportWhenAndOnly()

Copilot · 2026-01-17T16:00:35Z

Tests/Mockolate.Tests/ReturnsAsyncExtensionsTests.cs

 		}

+		[Fact]
+		public async Task ReturnsAsync_4Parameters_ShouldSupportWhenAndFor()


Test method name uses 'For' but the test uses Only(1). The method should be named 'ReturnsAsync_4Parameters_ShouldSupportWhenAndOnly' to accurately reflect what is being tested.

Suggested change

public async Task ReturnsAsync_4Parameters_ShouldSupportWhenAndFor()

public async Task ReturnsAsync_4Parameters_ShouldSupportWhenAndOnly()

Copilot · 2026-01-17T16:00:35Z

Tests/Mockolate.Tests/ReturnsAsyncExtensionsTests.cs

 		}

+		[Fact]
+		public async Task ReturnsAsync_NoParameters_ShouldSupportWhenAndFor()


Test method name uses 'For' but the test uses Only(1). The method should be named 'ReturnsAsync_NoParameters_ShouldSupportWhenAndOnly' to accurately reflect what is being tested.

Suggested change

public async Task ReturnsAsync_NoParameters_ShouldSupportWhenAndFor()

public async Task ReturnsAsync_NoParameters_ShouldSupportWhenAndOnly()

sonarqubecloud · 2026-01-17T16:02:28Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

github-actions · 2026-01-17T16:43:59Z

This is addressed in release v0.52.0.

vbreuss self-assigned this Jan 15, 2026

Copilot AI review requested due to automatic review settings January 15, 2026 16:23

vbreuss added the enhancement New feature or request label Jan 15, 2026

Copilot AI reviewed Jan 15, 2026

View reviewed changes

vbreuss added 2 commits January 17, 2026 16:59

feat: change return type of ReturnsAsync to `IReturnMethodSetupRetu…

a19ae93

…rnBuilder`

Simplify tests

30d938d

Copilot AI review requested due to automatic review settings January 17, 2026 15:59

vbreuss force-pushed the topic/change-returntype-of-returnsasync branch from c6ec3fb to 30d938d Compare January 17, 2026 15:59

vbreuss enabled auto-merge (squash) January 17, 2026 15:59

Copilot AI reviewed Jan 17, 2026

View reviewed changes

vbreuss merged commit 6711f57 into main Jan 17, 2026
12 checks passed

vbreuss deleted the topic/change-returntype-of-returnsasync branch January 17, 2026 16:07

github-actions bot added the state: released The issue is released label Jan 17, 2026

	public async Task ReturnsAsync_1Parameter_ShouldSupportWhenAndFor()
	public async Task ReturnsAsync_1Parameter_ShouldSupportWhenAndOnly()

	public async Task ReturnsAsync_2Parameters_ShouldSupportWhenAndFor()
	public async Task ReturnsAsync_2Parameters_ShouldSupportWhenAndOnly()

	public async Task ReturnsAsync_3Parameters_ShouldSupportWhenAndFor()
	public async Task ReturnsAsync_3Parameters_ShouldSupportWhenAndOnly()

	public async Task ReturnsAsync_4Parameters_ShouldSupportWhenAndFor()
	public async Task ReturnsAsync_4Parameters_ShouldSupportWhenAndOnly()

	public async Task ReturnsAsync_NoParameters_ShouldSupportWhenAndFor()
	public async Task ReturnsAsync_NoParameters_ShouldSupportWhenAndOnly()

Uh oh!

feat: change return type of ReturnsAsync to IReturnMethodSetupReturnBuilder #366

feat: change return type of ReturnsAsync to IReturnMethodSetupReturnBuilder #366

Uh oh!

Conversation

vbreuss commented Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Key Changes:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

github-actions bot commented Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Benchmark Results

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 17, 2026

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Jan 17, 2026

Quality Gate passed

Uh oh!

Uh oh!

github-actions bot commented Jan 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

feat: change return type of `ReturnsAsync` to `IReturnMethodSetupReturnBuilder` #366

feat: change return type of `ReturnsAsync` to `IReturnMethodSetupReturnBuilder` #366

vbreuss commented Jan 15, 2026 •

edited

Loading

github-actions bot commented Jan 15, 2026 •

edited

Loading

github-actions bot commented Jan 15, 2026 •

edited

Loading