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 6756573228

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

Totals
Change from base Build 6755976903:	0.005%
Covered Lines:	11758
Relevant Lines:	11949

💛 - 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?

of ICollection

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?

jnyrup · 2023-11-04T12:04:16Z

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

+                "Expected superset to be a proper superset of {4, 3, 2, 1} because we want to test the failure message, " +
+                "but items {1, 1, 1, 2, 2, 3, 3, 4} are equivalent to the superset");


Should we print the non-set version of expected?
This might be useful when object.Equals(object) and object.ToString() are not aligned as they are for int, i.e. where ToString() includes more/different information than what Equals use to compare instances.

hmm, maybe we should create an ISet and an ICollection for the Subject and expected values?
then we could print both versions of the values, both the unique values and the raw values,
does this make sense?

…-and-superset

Src/FluentAssertions/Collections/GenericCollectionAssertions.cs

dennisdoomen · 2023-11-08T18:49:53Z

docs/_pages/collections.md

@@ -41,6 +41,9 @@ collection.Should().EndWith(8);
 collection.Should().EndWith(new[] { 5, 8 });

 collection.Should().BeSubsetOf(new[] { 1, 2, 3, 4, 5, 6, 7, 8, 9, });
+collection.Should().BeProperSubsetOf(new[] { 1, 2, 5, 6, 7, 8 });


🤔 I would add some comments here to explain the difference (again) between a normal subset/superset and a proper one.

dennisdoomen · 2023-11-08T18:51:20Z

docs/_pages/releases.md

+* Introduced new collection assertions methods - [#2432](https://github.com/fluentassertions/fluentassertions/pull/2432)
+  * `BeProperSubsetOf`
+  * `BeProperSupersetOf`
+  * `BeSupersetOf`


Suggested change

* Introduced new collection assertions methods - [#2432](https://github.com/fluentassertions/fluentassertions/pull/2432)

* `BeProperSubsetOf`

* `BeProperSupersetOf`

* `BeSupersetOf`

* Introduced new collection assertions methods `BeProperSubsetOf`, `BeProperSupersetOf` and `BeSupersetOf - [#2432](https://github.com/fluentassertions/fluentassertions/pull/2432)

* `BeSupersetOf`

dennisdoomen · 2023-11-08T18:53:55Z

Src/FluentAssertions/Collections/GenericCollectionAssertions.cs

+        {
+            Execute.Assertion
+                .BecauseOf(because, becauseArgs)
+                .FailWith("Expected {context:collection} to be a proper subset of {0}{reason}, but items {1} are equivalent to the subset",


🤔 Can we make the last part of the failure clearer?

dennisdoomen · 2023-11-08T18:55:15Z

Src/FluentAssertions/Collections/GenericCollectionAssertions.cs

@@ -3262,6 +3298,62 @@ public AndConstraint<TAssertions> StartWith(T element, string because = "", para
        return StartWith(new[] { element }, ObjectExtensions.GetComparer<T>(), because, becauseArgs);
    }

+    internal void AssertContainment(IEnumerable<T> expected, string containmentType, string because = "", params object[] becauseArgs)


🙃 We prefer to keep private methods just below the last usage.
🔧 Make it private

dennisdoomen · 2023-11-08T18:58:32Z

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

+    public class BeProperSubsetOf
+    {
+        [Fact]
+        public void When_collection_is_proper_subset_of_a_specified_collection_it_should_not_throw()


🔧 We prefer to avoid using terms like when and should.

feat: add BeProperSupersetOf and BeProperSubsetOf and BeSupersetOf

398bb8f

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

update release notes

37be391

fix docs

086fbb5

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

Refactor collection assertions to use ISet instead

b425131

of ICollection

jnyrup reviewed Nov 4, 2023

View reviewed changes

Meir017 added 2 commits November 4, 2023 20:38

Merge remote-tracking branch 'origin/develop' into feature/api-subset…

aa2a2bb

…-and-superset

fix docs

2754427

dennisdoomen requested changes Nov 8, 2023

View reviewed changes

Meir017 added 2 commits November 9, 2023 08:08

make AssertBeSubsetOf private

2e112a4

better docs for the proper subset/superset

5ecd020

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

jnyrup Nov 4, 2023

Meir017 Nov 4, 2023 •

edited

dennisdoomen Nov 8, 2023 •

edited

dennisdoomen Nov 8, 2023

dennisdoomen Nov 8, 2023

dennisdoomen Nov 8, 2023

dennisdoomen Nov 8, 2023

		"Expected superset to be a proper superset of {4, 3, 2, 1} because we want to test the failure message, " +
		"but items {1, 1, 1, 2, 2, 3, 3, 4} are equivalent to the superset");

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 6756573228

💛 - 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

jnyrup Nov 4, 2023

Choose a reason for hiding this comment

Meir017 Nov 4, 2023 • edited

Choose a reason for hiding this comment

dennisdoomen Nov 8, 2023 • edited

Choose a reason for hiding this comment

dennisdoomen Nov 8, 2023

Choose a reason for hiding this comment

dennisdoomen Nov 8, 2023

Choose a reason for hiding this comment

dennisdoomen Nov 8, 2023

Choose a reason for hiding this comment

dennisdoomen Nov 8, 2023

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

Meir017 Nov 4, 2023 •

edited

dennisdoomen Nov 8, 2023 •

edited