Skip to content

Improve output for expected argument matchers#806

Merged
dtchepak merged 2 commits into
nsubstitute:mainfrom
dtchepak:improve-output-for-expected-arg-match
Nov 30, 2024
Merged

Improve output for expected argument matchers#806
dtchepak merged 2 commits into
nsubstitute:mainfrom
dtchepak:improve-output-for-expected-arg-match

Conversation

@dtchepak

@dtchepak dtchepak commented May 5, 2024

Copy link
Copy Markdown
Member
  • Add IDescribeSpecification to allow custom arg matchers to provide custom output for "expected to receive" entries.
  • Fallback to ToString when IDescribeSpecification not implemented.
  • Update code comment docs accordingly.

Closes #796.

@dtchepak dtchepak mentioned this pull request May 5, 2024
Closed
@dtchepak
dtchepak force-pushed the improve-output-for-expected-arg-match branch 2 times, most recently from 957259f to e4bdaed Compare May 5, 2024 06:07
@dtchepak
dtchepak requested review from alexandrnikitin and zvirja May 5, 2024 06:08
rbeurskens
rbeurskens suggested changes May 5, 2024
View reviewed changes
Comment thread src/NSubstitute/Core/CallSpecification.cs Outdated
Comment thread src/NSubstitute/Core/CallSpecification.cs Outdated
Comment thread src/NSubstitute/Core/Arguments/ArgumentMatcher.cs Outdated
Comment thread src/NSubstitute/Core/Arguments/ArgumentMatcher.cs Outdated
@dtchepak
dtchepak requested a review from rbeurskens May 5, 2024 12:37
@dtchepak
dtchepak force-pushed the improve-output-for-expected-arg-match branch from aa3cd12 to 50401f7 Compare November 10, 2024 03:55
rbeurskens
rbeurskens reviewed Nov 10, 2024
View reviewed changes
Comment thread src/NSubstitute/Core/Arguments/ArgumentSpecification.cs.orig Outdated
@dtchepak
Improve output for expected argument matchers
90d93ec 
- Add IDescribeSpecification to allow custom arg matchers to provide
  custom output for "expected to receive" entries.
- Fallback to ToString when IDescribeSpecification not implemented.
- Update code comment docs accordingly.

Relates to nsubstitute#796.
@dtchepak
Apply review comments
72005d0 
- use string.Empty for null value from IDescribeSpecification, rather than
  falling back to ToString(). This supports the contract that
  IDescribeSpecification will be used if implemented. Replacing
  null string.Empty with matches the documented
  behaviour of IDescribeNonMatches.
- updated IDescribeSpecification code docs.
- removed GenericToNonGenericMatcherProxyWithDescribe `ToString` as it
  can use the GenericToNonGenericMatcherProxy superclass implementation.
- update ArgumentSpecification to also support IDescribeSpecification
  for its matcher.
- Replace linq with Array.ConvertAll rather than requiring an extra
  ToArray conversion.
@dtchepak
dtchepak force-pushed the improve-output-for-expected-arg-match branch from 50401f7 to 72005d0 Compare November 17, 2024 03:59
@dtchepak
dtchepak requested a review from Romfos November 17, 2024 04:00
zvirja
zvirja approved these changes Nov 18, 2024
View reviewed changes

@zvirja zvirja left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! Small feature, but could be a good quality of life enhancement

@Romfos

Romfos commented Nov 18, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

One question why do we need ?? string.Empty? for me it looks like anti-pattern

@rbeurskens

rbeurskens commented Nov 20, 2024

Copy link
Copy Markdown
Contributor

One question why do we need ?? string.Empty? for me it looks like anti-pattern

Yes, I agree it feels like smell. IDK if it is needed, but especially since nullable reference types is enabled in the code and the specified methods are declared to return string (not string?) we could trust the implementation does not return null, or replace ?? string.Empty with ?? throw new NullReferenceException()

@dtchepak
dtchepak merged commit 116db20 into nsubstitute:main Nov 30, 2024
@dtchepak

dtchepak commented Nov 30, 2024

Copy link
Copy Markdown
Member Author

One question why do we need ?? string.Empty? for me it looks like anti-pattern

Yes, I agree it feels like smell. IDK if it is needed, but especially since nullable reference types is enabled in the code and the specified methods are declared to return string (not string?) we could trust the implementation does not return null, or replace ?? string.Empty with ?? throw new NullReferenceException()

I've merged as-is as the PR is pretty old already, but would be very happy to accept a PR to improve this code. 🙇

@dtchepak
dtchepak deleted the improve-output-for-expected-arg-match branch November 30, 2024 08:21
@rbeurskens rbeurskens mentioned this pull request Jan 18, 2025
Closed
This was referenced Jul 12, 2026
Merged
Open
Merged
Merged
Merged
Closed
Closed
Merged
Open
This was referenced Jul 17, 2026
Merged
Merged
Merged
Open
Merged
Open
Closed
Open
Merged
Merged
tetsuo13 pushed a commit to tetsuo13/TeamsStatusPub that referenced this pull request Jul 18, 2026
@dependabot
Bump NSubstitute from 5.3.0 to 6.0.0 (#319)
7176712 
Updated [NSubstitute](https://github.com/nsubstitute/NSubstitute) from
5.3.0 to 6.0.0.

<details>
<summary>Release notes</summary>

_Sourced from [NSubstitute's
releases](https://github.com/nsubstitute/NSubstitute/releases)._

## 6.0.0

:information_source: No changes from [Release Candidate
1](https://github.com/nsubstitute/NSubstitute/releases/tag/v6.0.0-rc.1).

# NSubstitute v6.0.0 

From
[RC1](https://github.com/nsubstitute/NSubstitute/releases/tag/v6.0.0-rc.1)
notes:

* [NEW] `ArgMatchers.Matching` predicate matcher as an alternative to
`Is(Expression<Predicate<T>>`. (.NET6 and above.)
* [UPDATE] Improved support for custom argument matchers. `Arg.Is` now
accepts arg matchers.
* [UPDATE][BREAKING] Update target frameworks: .NET8, .NET Standard 2.0
* [UPDATE][BREAKING] Remove legacy obsolete API
* [UPDATE][BREAKING] Mark as obsolete api CompatArg with pre c# 7.0
support
* [UPDATE][BREAKING] Nullability is enabled for public api for .NET 8+
TFMs
* [UPDATE] Migrate documentation to [docfx
platform](https://github.com/dotnet/docfx) and update samples to NUnit 4
* [NEW] Added NuGet Package README file.


## Full change list

* Update target frameworks and other infrastructure changes by @​Romfos
in nsubstitute/NSubstitute#831
* Remove Google Groups hyperlinks by @​304NotModified in
nsubstitute/NSubstitute#804
* Improve output for expected argument matchers in
nsubstitute/NSubstitute#806
* Mark Substitute.For<T> method as Pure by @​Dzliera in
nsubstitute/NSubstitute#844
* Move package creating from build.fsproj to github actions by @​Romfos
in nsubstitute/NSubstitute#838
* Added .NET 9 to test matrix by @​Romfos in
nsubstitute/NSubstitute#848
* Update dependencies by @​Saibamen in
nsubstitute/NSubstitute#843
* Migrate documentation to docfx by @​Romfos in
nsubstitute/NSubstitute#850
* Added test for issue #​716 by @​rbeurskens in
nsubstitute/NSubstitute#846
* feat: add dependabot for this project for minor and patch updates for
nuget packages and github actions by @​wmundev in
nsubstitute/NSubstitute#792
* #​853 Fix matching with multiple generic arguments of the same type by
@​rholek in nsubstitute/NSubstitute#858
* Ability to mock protected methods with and without return value by
@​Jason31569 in nsubstitute/NSubstitute#845
* Enable nullability for public api by @​Romfos in
nsubstitute/NSubstitute#856
* Bugfix/async event handlers return instantly by @​jmartschinke in
nsubstitute/NSubstitute#808
* Fix matching generic calls with AnyType when the generic argument is
also a generic argument in return type, out or ref parameter by
@​JMolenkamp in nsubstitute/NSubstitute#862
* Feature: allow interception of any generic method call when using
Arg.AnyType by @​JMolenkamp in
nsubstitute/NSubstitute#855
* Params arg unit test by @​Jason31569 in
nsubstitute/NSubstitute#874
* Added exception extensions for ValueTask without return type (rebase)
in nsubstitute/NSubstitute#873
* Migrate to slnx by @​Romfos in
nsubstitute/NSubstitute#882
* Migrate documentation validation from build.fsproj to Roslyn code
generator by @​Romfos in
nsubstitute/NSubstitute#883
* Fix doc links (#​884) in
nsubstitute/NSubstitute#886
* Add PackageReadmeFile. by @​peymanr34 in
nsubstitute/NSubstitute#888
* Make public api and tests the same for all TFMs by @​Romfos in
nsubstitute/NSubstitute#885
* Migrate documentation samples to NUnit4 by @​Romfos in
nsubstitute/NSubstitute#889
* Run unit tests in Microsoft.Testing.Platform mode by @​Romfos in
nsubstitute/NSubstitute#896
* Bump actions/checkout from 4 to 5 by @​dependabot[bot] in
nsubstitute/NSubstitute#902
* Fix typo in return value documentation by @​ericmutta in
nsubstitute/NSubstitute#903
* Bump actions/setup-dotnet from 4 to 5 by @​dependabot[bot] in
nsubstitute/NSubstitute#907
* Fix typo in received calls documentation by @​ericmutta in
nsubstitute/NSubstitute#904
* Simplify github actions to use less jobs by @​Romfos in
nsubstitute/NSubstitute#911
* Bump actions/upload-artifact from 4 to 5 by @​dependabot[bot] in
nsubstitute/NSubstitute#916
* Bump NUnit3TestAdapter from 5.0.0 to 5.2.0 by @​dependabot[bot] in
nsubstitute/NSubstitute#922
 ... (truncated)

## 6.0.0-rc.1

# NSubstitute v6.0.0 Release Candidate 1

Due to the large number of changes in this release, we wanted to start
with a release candidate to ensure we've correctly captured breaking
changes.

* [NEW] `ArgMatchers.Matching` predicate matcher as an alternative to
`Is(Expression<Predicate<T>>`. (.NET6 and above.)
* [UPDATE] Improved support for custom argument matchers. `Arg.Is` now
accepts arg matchers.
* [UPDATE][BREAKING] Update target frameworks: .NET8, .NET Standard 2.0
* [UPDATE][BREAKING] Remove legacy obsolete API
* [UPDATE][BREAKING] Mark as obsolete api CompatArg with pre c# 7.0
support
* [UPDATE][BREAKING] Nullability is enabled for public api for .NET 8+
TFMs
* [UPDATE] Migrate documentation to [docfx
platform](https://github.com/dotnet/docfx) and update samples to NUnit 4
* [NEW] Added NuGet Package README file.


## Full change list

* Update target frameworks and other infrastructure changes by @​Romfos
in nsubstitute/NSubstitute#831
* Remove Google Groups hyperlinks by @​304NotModified in
nsubstitute/NSubstitute#804
* Improve output for expected argument matchers in
nsubstitute/NSubstitute#806
* Mark Substitute.For<T> method as Pure by @​Dzliera in
nsubstitute/NSubstitute#844
* Move package creating from build.fsproj to github actions by @​Romfos
in nsubstitute/NSubstitute#838
* Added .NET 9 to test matrix by @​Romfos in
nsubstitute/NSubstitute#848
* Update dependencies by @​Saibamen in
nsubstitute/NSubstitute#843
* Migrate documentation to docfx by @​Romfos in
nsubstitute/NSubstitute#850
* Added test for issue #​716 by @​rbeurskens in
nsubstitute/NSubstitute#846
* feat: add dependabot for this project for minor and patch updates for
nuget packages and github actions by @​wmundev in
nsubstitute/NSubstitute#792
* #​853 Fix matching with multiple generic arguments of the same type by
@​rholek in nsubstitute/NSubstitute#858
* Ability to mock protected methods with and without return value by
@​Jason31569 in nsubstitute/NSubstitute#845
* Enable nullability for public api by @​Romfos in
nsubstitute/NSubstitute#856
* Bugfix/async event handlers return instantly by @​jmartschinke in
nsubstitute/NSubstitute#808
* Fix matching generic calls with AnyType when the generic argument is
also a generic argument in return type, out or ref parameter by
@​JMolenkamp in nsubstitute/NSubstitute#862
* Feature: allow interception of any generic method call when using
Arg.AnyType by @​JMolenkamp in
nsubstitute/NSubstitute#855
* Params arg unit test by @​Jason31569 in
nsubstitute/NSubstitute#874
* Added exception extensions for ValueTask without return type (rebase)
in nsubstitute/NSubstitute#873
* Migrate to slnx by @​Romfos in
nsubstitute/NSubstitute#882
* Migrate documentation validation from build.fsproj to Roslyn code
generator by @​Romfos in
nsubstitute/NSubstitute#883
* Fix doc links (#​884) in
nsubstitute/NSubstitute#886
* Add PackageReadmeFile. by @​peymanr34 in
nsubstitute/NSubstitute#888
* Make public api and tests the same for all TFMs by @​Romfos in
nsubstitute/NSubstitute#885
* Migrate documentation samples to NUnit4 by @​Romfos in
nsubstitute/NSubstitute#889
* Run unit tests in Microsoft.Testing.Platform mode by @​Romfos in
nsubstitute/NSubstitute#896
* Bump actions/checkout from 4 to 5 by @​dependabot[bot] in
nsubstitute/NSubstitute#902
* Fix typo in return value documentation by @​ericmutta in
nsubstitute/NSubstitute#903
* Bump actions/setup-dotnet from 4 to 5 by @​dependabot[bot] in
nsubstitute/NSubstitute#907
* Fix typo in received calls documentation by @​ericmutta in
nsubstitute/NSubstitute#904
* Simplify github actions to use less jobs by @​Romfos in
nsubstitute/NSubstitute#911
* Bump actions/upload-artifact from 4 to 5 by @​dependabot[bot] in
nsubstitute/NSubstitute#916
* Bump NUnit3TestAdapter from 5.0.0 to 5.2.0 by @​dependabot[bot] in
nsubstitute/NSubstitute#922
* Bump BenchmarkDotNet from 0.15.2 to 0.15.5 by @​dependabot[bot] in
nsubstitute/NSubstitute#921
* Add .NET 10 to test matrix by @​Romfos in
nsubstitute/NSubstitute#913
 ... (truncated)

Commits viewable in [compare
view](nsubstitute/NSubstitute@v5.3.0...v6.0.0).
</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
This was referenced Jul 18, 2026
Merged
Open
Merged
Open
Closed
Merged
Merged
Open
Closed
Open
Merged
Open
Open
Merged
Merged
Open
Open
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@zvirja zvirja zvirja approved these changes
@alexandrnikitin alexandrnikitin Awaiting requested review from alexandrnikitin
@Romfos Romfos Awaiting requested review from Romfos
+1 more reviewer
@rbeurskens rbeurskens rbeurskens approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Improve output for expected argument for custom argument matchers on non-match or make it customizable

4 participants

@dtchepak @Romfos @rbeurskens @zvirja