Skip to content

Add BeNaN and NotBeNaN assertions #2606

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

Jump to bottom
Merged
dennisdoomen merged 4 commits into from
Mar 19, 2024
Merged

Add BeNaN and NotBeNaN assertions #2606

dennisdoomen merged 4 commits into from
Mar 19, 2024

Conversation

@arocheleau
Copy link
Contributor

@arocheleau arocheleau commented Mar 12, 2024 •
edited
Loading

Add the BeNaN and NotBeNaN extension methods to NumericAssertionsExtensions.

float value = float.NaN;

value.Should().BeNaN();
value.Should().NotBeNaN();

This fixes #2579.

IMPORTANT

  • If the PR touches the public API, the changes have been approved in a separate issue with the "api-approved" label.
  • The code complies with the Coding Guidelines for C#.
  • The changes are covered by unit tests which follow the Arrange-Act-Assert syntax and the naming conventions such as is used in these tests.
  • If the PR adds a feature or fixes a bug, please update the release notes with a functional description that explains what the change means to consumers of this library, which are published on the website.
  • If the PR changes the public API the changes needs to be included by running AcceptApiChanges.ps1 or AcceptApiChanges.sh.
  • If the PR affects the documentation, please include your changes in this pull request so the documentation will appear on the website.
    • Please also run ./build.sh --target spellcheck or .\build.ps1 --target spellcheck before pushing and check the good outcome

@github-actions
Copy link

github-actions bot commented Mar 12, 2024 •
edited
Loading

Qodana for .NET

It seems all right 👌

No new problems were found according to the checks applied

💡 Qodana analysis was run in the pull request mode: only the changed files were checked
☁️ View the detailed Qodana report

Contact Qodana team

Contact us at qodana-support@jetbrains.com

@coveralls
Copy link

coveralls commented Mar 12, 2024 •
edited
Loading

Pull Request Test Coverage Report for Build 8344341172

Details

  • 50 of 50 (100.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.02%) to 97.555%
Totals Coverage Status
Change from base Build 8329963322: 0.02%
Covered Lines: 11994
Relevant Lines: 12178
💛 - Coveralls

IT-VBFK
IT-VBFK reviewed Mar 12, 2024
View reviewed changes
Tests/FluentAssertions.Specs/Numeric/NumericAssertionSpecs.BeNaN.cs Outdated
Comment on lines 17 to 21
// Act
Action act = () => actual.Should().BeNaN();

// Assert
act.Should().NotThrow();
Copy link
Contributor

@IT-VBFK IT-VBFK Mar 12, 2024

Choose a reason for hiding this comment

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

Suggested change
// Act
Action act = () => actual.Should().BeNaN();
// Assert
act.Should().NotThrow();
// Act / Assert
actual.Should().BeNaN();

We now combine assertions that are not supposed to throw into one.

(And following)

jnyrup
jnyrup reviewed Mar 13, 2024
View reviewed changes
Copy link
Member

@jnyrup jnyrup left a comment

Choose a reason for hiding this comment

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

Looks good 👍
I only have a few minor comments

@arocheleau arocheleau marked this pull request as ready for review March 14, 2024 12:57
dennisdoomen
dennisdoomen reviewed Mar 15, 2024
View reviewed changes
Src/FluentAssertions/NumericAssertionsExtensions.cs Outdated
/// <summary>
/// Asserts that the float value is NaN.
/// </summary>
/// <param name="parent">The <see cref="NumericAssertions{T}"/> object that is being extended.</param>
Copy link
Member

@dennisdoomen dennisdoomen Mar 15, 2024

Choose a reason for hiding this comment

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

🌱 I generally don't document these since they are not relevant for users.

Src/FluentAssertions/NumericAssertionsExtensions.cs Outdated
#region BeNaN

/// <summary>
/// Asserts that the float value is NaN.
Copy link
Member

@dennisdoomen dennisdoomen Mar 15, 2024

Choose a reason for hiding this comment

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

🤔 I prefer to keep this more functional, e.g. like Asserts that a number is seen as not-a-number.

Src/FluentAssertions/NumericAssertionsExtensions.cs Outdated
return new AndConstraint<NullableNumericAssertions<double>>(parent);
}

private static void FailIfValueIsNaN(bool valueIsNaN,
Copy link
Member

@dennisdoomen dennisdoomen Mar 15, 2024

Choose a reason for hiding this comment

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

🤔 I'm not a big fan of applying DRY like that. In most cases, duplicating the code makes the implementation much more readable.

@arocheleau arocheleau force-pushed the feature/2579/add-be-nan branch from 4bfd607 to 8da273a Compare March 18, 2024 18:45
dennisdoomen
dennisdoomen approved these changes Mar 18, 2024
View reviewed changes
Copy link
Member

@dennisdoomen dennisdoomen left a comment

Choose a reason for hiding this comment

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

It would be nice to update the numerictypes.md with the two new methods.

@arocheleau
Copy link
Contributor Author

arocheleau commented Mar 18, 2024

I did add them to the numerictypes.md earlier, but I guess I missunderstood your comment saying "🌱 I generally don't document these since they are not relevant for users.".

@ITaluone
Copy link
Contributor

ITaluone commented Mar 19, 2024 •
edited
Loading

I did add them to the numerictypes.md earlier, but I guess I missunderstood your comment saying "🌱 I generally don't document these since they are not relevant for users.".

The XML summary on the XxxxAssertions extension methods :)

@dennisdoomen
Copy link
Member

dennisdoomen commented Mar 19, 2024

I did add them to the numerictypes.md earlier, but I guess I missunderstood your comment saying "🌱 I generally don't document these since they are not relevant for users.".

I meant the this parent parameter ;-)

@dennisdoomen dennisdoomen merged commit 1dc38ae into fluentassertions:develop Mar 19, 2024
@arocheleau arocheleau deleted the feature/2579/add-be-nan branch May 27, 2024 19:30
@jnyrup jnyrup added the feature label May 30, 2024
This was referenced Jul 21, 2025
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
This was referenced Dec 30, 2025
Merged
Closed
Closed
Open
Merged
Open
Open
Open
Open
Closed
Closed
This was referenced Jan 7, 2026
Closed
Closed
Open
Merged
Merged
Closed
Closed
Open
Open
Open
Closed
Open
Open
Open
Open
This was referenced Jan 14, 2026
Open
Merged
Closed
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dennisdoomen dennisdoomen dennisdoomen approved these changes

@jnyrup jnyrup jnyrup approved these changes

+1 more reviewer

@IT-VBFK IT-VBFK IT-VBFK left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

feature

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add support for asserting NaN values

6 participants

@arocheleau @coveralls @ITaluone @dennisdoomen @jnyrup @IT-VBFK