Feature: Add collections methods BeProperSubsetOf / BeProperSupersetOf / BeSupersetOf #2432

Meir017 · 2023-11-01T17:15:27Z

resolves #2363

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 · 2023-11-01T17:19:47Z

Qodana for .NET

4 new problems were found

Inspection name	Severity	Problems
`Possible multiple enumeration`	🔶 Warning	4

💡 Qodana analysis was run in the pull request mode: only the changed files were checked

View the detailed Qodana report

To be able to view the detailed Qodana report, you can either:

Register at Qodana Cloud and configure the action
Use GitHub Code Scanning with Qodana
Host Qodana report at GitHub Pages
Inspect and use qodana.sarif.json (see the Qodana SARIF format for details)

To get *.log files or any other Qodana artifacts, run the action with upload-result option set to true,
so that the action will upload the files as the job artifacts:

      - name: 'Qodana Scan'
        uses: JetBrains/qodana-action@v2023.2.8
        with:
          upload-result: true

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 · 2023-11-01T17:29:31Z

Pull Request Test Coverage Report for Build 9185874020

Details

41 of 41 (100.0%) changed or added relevant lines in 2 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.004%) to 97.57%

Totals
Change from base Build 9161168279:	0.004%
Covered Lines:	12078
Relevant Lines:	12262

💛 - Coveralls

vbreuss · 2023-11-03T06:17:33Z

These methods come from set theory, but work on IEnumerable<T>. What happens when duplicate entries are provided in the subject or the expected value?
I would expect duplicate entries to be ignored, right?
What happens, e.g.

var subject = new []{1, 1, 1, 2, 2, 3, 3};
subject.Should().BeProperSubsetOf(new []{1, 2, 3, 3, 3, 4});

Should we add test cases for it?

Meir017 · 2023-11-03T11:39:41Z

@vbreuss done! thanks for the suggestion

Src/FluentAssertions/Collections/GenericCollectionAssertions.cs

jnyrup · 2023-11-04T11:37:59Z

Src/FluentAssertions/Collections/GenericCollectionAssertions.cs

+        AssertBeSubsetOf(expectedProperSuperset, "proper subset", because, becauseArgs);
+
+        ISet<T> expectedItems = expectedProperSuperset.ConvertOrCastToSet();
+
+        if (expectedItems.Intersect(Subject).Count() == expectedItems.Count)


Could this cause multiple enumeration of either Subject or expectedProperSuperset?

hmm, maybe we should create an ISet and an ICollection for the Subject and expected values?

Tests/FluentAssertions.Specs/Collections/CollectionAssertionSpecs.BeProperSupersetOf.cs

Src/FluentAssertions/Collections/GenericCollectionAssertions.cs

docs/_pages/collections.md

docs/_pages/releases.md

Src/FluentAssertions/Collections/GenericCollectionAssertions.cs

Tests/FluentAssertions.Specs/Collections/CollectionAssertionSpecs.BeProperSubsetOf.cs

dennisdoomen

Not all previous comments have been addressed either.

Src/FluentAssertions/Collections/GenericCollectionAssertions.cs

github-actions · 2024-05-15T09:11:43Z

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

docs/_pages/collections.md

dennisdoomen

Nice work

ITaluone · 2024-05-21T05:12:00Z

@Meir017 FYI we usually use rebasing instead of merging in changes from develop ;)

dennisdoomen · 2024-05-21T10:09:29Z

And there are some Qodana issues to address.

Meir017 · 2024-05-22T06:02:52Z

@dennisdoomen done

jnyrup · 2024-05-27T16:54:26Z

Tests/FluentAssertions.Specs/Collections/CollectionAssertionSpecs.BeProperSubsetOf.cs

+        public void A_collection_with_all_items_of_a_superset_but_has_extra_items_is_not_a_proper_subset()
+        {
+            // Arrange
+            var subset = new[] { 1, 2, 3, 4 };
+            var superset = new[] { 4, 3, 2, 1 };


I don't know that the "extra items" the method name mentions are?

jnyrup · 2024-05-27T16:59:19Z

Src/FluentAssertions/Collections/GenericCollectionAssertions.cs

+    }
+
+    /// <summary>
+    /// Asserts that the collection is a proper subset of the <paramref name="expectedProperSubset" />.


Suggested change

/// Asserts that the collection is a proper subset of the <paramref name="expectedProperSubset" />.

/// Asserts that the collection is a proper superset of the <paramref name="expectedProperSubset" />.

jnyrup · 2024-05-27T17:12:33Z

Tests/FluentAssertions.Specs/Collections/CollectionAssertionSpecs.BeSupersetOf.cs

+/// </content>
+public partial class CollectionAssertionSpecs
+{
+    public class BeSupersetOf


We're missing test on how BeSupersetOf should behave when Subject is either null or empty.

jnyrup · 2024-05-27T17:26:40Z

Tests/FluentAssertions.Specs/Collections/CollectionAssertionSpecs.BeSupersetOf.cs

+        [Fact]
+        public void A_collection_is_not_a_superset_of_an_empty_collection()
+        {
+            // Arrange
+            var collection = new[] { 1, 2, 3 };
+
+            // Act
+            Action act = () => collection.Should().BeSupersetOf(new int[0]);
+
+            // Assert
+            act.Should().Throw<ArgumentException>().WithMessage(
+                "Cannot verify containment against an empty collection*");
+        }


I'm sorry, I didn't think about this case when I suggested forwarding BeProperSupersetOf to Contain.

The empty set is a valid set and { 1, 2, 3 } is a super set of {}.

I think all the set theoretic methods should handle empty sets.

Meir017 force-pushed the feature/api-subset-and-superset branch from 5f23897 to 398bb8f Compare November 1, 2023 17:20

Meir017 changed the title ~~Feature/api subset and superset~~ Feature: Add collections methods BeProperSubsetOf / BeProperSupersetOf / BeSupersetOf Nov 1, 2023

dennisdoomen added the enhancement label Nov 2, 2023

jnyrup reviewed Nov 4, 2023

View reviewed changes

dennisdoomen requested changes Nov 8, 2023

View reviewed changes

dennisdoomen requested changes May 10, 2024

View reviewed changes

Src/FluentAssertions/Collections/GenericCollectionAssertions.cs Outdated Show resolved Hide resolved

dennisdoomen reviewed May 19, 2024

View reviewed changes

docs/_pages/collections.md Outdated Show resolved Hide resolved

dennisdoomen requested a review from jnyrup May 19, 2024 08:34

dennisdoomen approved these changes May 20, 2024

View reviewed changes

feat: add BeProperSupersetOf and BeProperSubsetOf and BeSupersetOf

817afca

Meir017 force-pushed the feature/api-subset-and-superset branch from d2ee717 to 817afca Compare May 22, 2024 05:03

Meir017 added 2 commits May 22, 2024 08:14

qodana fixes

12c26a9

fix null checks

043bef9

jnyrup requested changes May 27, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Add collections methods BeProperSubsetOf / BeProperSupersetOf / BeSupersetOf #2432

Feature: Add collections methods BeProperSubsetOf / BeProperSupersetOf / BeSupersetOf #2432

Meir017 commented Nov 1, 2023 •

edited

github-actions bot commented Nov 1, 2023 •

edited

coveralls commented Nov 1, 2023 •

edited

vbreuss commented Nov 3, 2023

Meir017 commented Nov 3, 2023

jnyrup Nov 4, 2023

Meir017 Nov 4, 2023

dennisdoomen left a comment

github-actions bot commented May 15, 2024 •

edited

dennisdoomen left a comment

ITaluone commented May 21, 2024

dennisdoomen commented May 21, 2024

Meir017 commented May 22, 2024

jnyrup May 27, 2024

jnyrup May 27, 2024

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

jnyrup May 27, 2024

jnyrup May 27, 2024

	/// Asserts that the collection is a proper subset of the <paramref name="expectedProperSubset" />.
	/// Asserts that the collection is a proper superset of the <paramref name="expectedProperSubset" />.

Feature: Add collections methods BeProperSubsetOf / BeProperSupersetOf / BeSupersetOf #2432

Are you sure you want to change the base?

Feature: Add collections methods BeProperSubsetOf / BeProperSupersetOf / BeSupersetOf #2432

Conversation

Meir017 commented Nov 1, 2023 • edited

IMPORTANT

github-actions bot commented Nov 1, 2023 • edited

Qodana for .NET

coveralls commented Nov 1, 2023 • edited

Pull Request Test Coverage Report for Build 9185874020

Details

💛 - Coveralls

vbreuss commented Nov 3, 2023

Meir017 commented Nov 3, 2023

jnyrup Nov 4, 2023

Choose a reason for hiding this comment

Meir017 Nov 4, 2023

Choose a reason for hiding this comment

dennisdoomen left a comment

Choose a reason for hiding this comment

github-actions bot commented May 15, 2024 • edited

Qodana for .NET

dennisdoomen left a comment

Choose a reason for hiding this comment

ITaluone commented May 21, 2024

dennisdoomen commented May 21, 2024

Meir017 commented May 22, 2024

jnyrup May 27, 2024

Choose a reason for hiding this comment

jnyrup May 27, 2024

Choose a reason for hiding this comment

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

jnyrup May 27, 2024

Choose a reason for hiding this comment

jnyrup May 27, 2024

Choose a reason for hiding this comment

Meir017 commented Nov 1, 2023 •

edited

github-actions bot commented Nov 1, 2023 •

edited

coveralls commented Nov 1, 2023 •

edited

github-actions bot commented May 15, 2024 •

edited