Add BeNaN and NotBeNaN assertions by arocheleau · Pull Request #2606 · fluentassertions/fluentassertions

arocheleau · 2024-03-12T19:17:47Z

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 · 2024-03-12T19:24:52Z

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

Or via our issue tracker: https://jb.gg/qodana-issue
Or share your feedback: https://jb.gg/qodana-discussions

coveralls · 2024-03-12T19:27:14Z

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
Change from base Build 8329963322:	0.02%
Covered Lines:	11994
Relevant Lines:	12178

💛 - Coveralls

IT-VBFK · 2024-03-12T21:32:15Z

Tests/FluentAssertions.Specs/Numeric/NumericAssertionSpecs.BeNaN.cs

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


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

Looks good 👍
I only have a few minor comments

docs/_pages/releases.md

Src/FluentAssertions/NumericAssertionsExtensions.cs

Tests/FluentAssertions.Specs/Numeric/NumericAssertionSpecs.BeNaN.cs

dennisdoomen · 2024-03-15T06:57:35Z

Src/FluentAssertions/NumericAssertionsExtensions.cs

+    /// <summary>
+    /// Asserts that the float value is NaN.
+    /// </summary>
+    /// <param name="parent">The <see cref="NumericAssertions{T}"/> object that is being extended.</param>


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

dennisdoomen · 2024-03-15T07:25:26Z

Src/FluentAssertions/NumericAssertionsExtensions.cs

+    #region BeNaN
+
+    /// <summary>
+    /// Asserts that the float value is NaN.


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

dennisdoomen · 2024-03-15T07:28:39Z

Src/FluentAssertions/NumericAssertionsExtensions.cs

+        return new AndConstraint<NullableNumericAssertions<double>>(parent);
+    }
+
+    private static void FailIfValueIsNaN(bool valueIsNaN,


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

dennisdoomen

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

arocheleau · 2024-03-18T19:05:16Z

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 · 2024-03-19T06:42:16Z

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 · 2024-03-19T13:45:08Z

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 ;-)

IT-VBFK reviewed Mar 12, 2024

View reviewed changes

jnyrup reviewed Mar 13, 2024

View reviewed changes

arocheleau marked this pull request as ready for review March 14, 2024 12:57

dennisdoomen reviewed Mar 15, 2024

View reviewed changes

arocheleau added 3 commits March 18, 2024 14:37

Add BeNaN and NotBeNaN assertions

bbf71c3

Update release notes

818cbe1

Apply code review recommendations

8da273a

arocheleau force-pushed the feature/2579/add-be-nan branch from 4bfd607 to 8da273a Compare March 18, 2024 18:45

dennisdoomen approved these changes Mar 18, 2024

View reviewed changes

jnyrup approved these changes Mar 18, 2024

View reviewed changes

Update documentation

b2531ef

dennisdoomen merged commit 1dc38ae into fluentassertions:develop Mar 19, 2024

arocheleau deleted the feature/2579/add-be-nan branch May 27, 2024 19:30

jnyrup added the feature label May 30, 2024

dependabot bot mentioned this pull request Feb 6, 2026

deps: Bump the test-dependencies group with 3 updates RicherTunes/Brainarr#401

Open

Conversation

arocheleau commented Mar 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

IMPORTANT

Uh oh!

github-actions bot commented Mar 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Qodana for .NET

Uh oh!

coveralls commented Mar 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 8344341172

Details

💛 - Coveralls

Uh oh!

IT-VBFK Mar 12, 2024

Choose a reason for hiding this comment

Uh oh!

jnyrup left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dennisdoomen Mar 15, 2024

Choose a reason for hiding this comment

Uh oh!

dennisdoomen Mar 15, 2024

Choose a reason for hiding this comment

Uh oh!

dennisdoomen Mar 15, 2024

Choose a reason for hiding this comment

Uh oh!

dennisdoomen left a comment

Choose a reason for hiding this comment

Uh oh!

arocheleau commented Mar 18, 2024

Uh oh!

ITaluone commented Mar 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dennisdoomen commented Mar 19, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

arocheleau commented Mar 12, 2024 •

edited

Loading

github-actions bot commented Mar 12, 2024 •

edited

Loading

coveralls commented Mar 12, 2024 •

edited

Loading

ITaluone commented Mar 19, 2024 •

edited

Loading