Skip to content

Allow fluently calling WithoutMatchingRules and WithoutSelectionRules while using BeEquivalentTo #2457

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

Merged
dennisdoomen merged 3 commits into from
Nov 14, 2023
Merged

Allow fluently calling WithoutMatchingRules and WithoutSelectionRules while using BeEquivalentTo #2457

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b08356f
Change return type to `TSelf` for `WithoutMatchingRules` and `Without…
vbreuss Nov 12, 2023
06dbc3f
Update releases.md
vbreuss Nov 13, 2023
ef6c5b6
Update docs/_pages/releases.md
vbreuss Nov 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions Src/FluentAssertions/Equivalency/SelfReferenceEquivalencyOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,17 +427,19 @@ public TSelf AllowingInfiniteRecursion()
/// <summary>
/// Clears all selection rules, including those that were added by default.
/// </summary>
public void WithoutSelectionRules()
public TSelf WithoutSelectionRules()
{
selectionRules.Clear();
return (TSelf)this;
}

/// <summary>
/// Clears all matching rules, including those that were added by default.
/// </summary>
public void WithoutMatchingRules()
public TSelf WithoutMatchingRules()
{
matchingRules.Clear();
return (TSelf)this;
}

/// <summary>
Expand Down
4 changes: 2 additions & 2 deletions Tests/Approval.Tests/ApprovedApi/FluentAssertions/net47.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -957,8 +957,8 @@ namespace FluentAssertions.Equivalency
public TSelf WithStrictOrderingFor(System.Linq.Expressions.Expression<System.Func<FluentAssertions.Equivalency.IObjectInfo, bool>> predicate) { }
public TSelf WithTracing(FluentAssertions.Equivalency.Tracing.ITraceWriter writer = null) { }
public TSelf WithoutAutoConversionFor(System.Linq.Expressions.Expression<System.Func<FluentAssertions.Equivalency.IObjectInfo, bool>> predicate) { }
public void WithoutMatchingRules() { }
public void WithoutSelectionRules() { }
public TSelf WithoutMatchingRules() { }
public TSelf WithoutSelectionRules() { }
public TSelf WithoutStrictOrdering() { }
public TSelf WithoutStrictOrderingFor(System.Linq.Expressions.Expression<System.Func<FluentAssertions.Equivalency.IObjectInfo, bool>> predicate) { }
public class Restriction<TMember>
Expand Down
4 changes: 2 additions & 2 deletions Tests/Approval.Tests/ApprovedApi/FluentAssertions/net6.0.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -970,8 +970,8 @@ namespace FluentAssertions.Equivalency
public TSelf WithStrictOrderingFor(System.Linq.Expressions.Expression<System.Func<FluentAssertions.Equivalency.IObjectInfo, bool>> predicate) { }
public TSelf WithTracing(FluentAssertions.Equivalency.Tracing.ITraceWriter writer = null) { }
public TSelf WithoutAutoConversionFor(System.Linq.Expressions.Expression<System.Func<FluentAssertions.Equivalency.IObjectInfo, bool>> predicate) { }
public void WithoutMatchingRules() { }
public void WithoutSelectionRules() { }
public TSelf WithoutMatchingRules() { }
public TSelf WithoutSelectionRules() { }
public TSelf WithoutStrictOrdering() { }
public TSelf WithoutStrictOrderingFor(System.Linq.Expressions.Expression<System.Func<FluentAssertions.Equivalency.IObjectInfo, bool>> predicate) { }
public class Restriction<TMember>
Expand Down
4 changes: 2 additions & 2 deletions Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.0.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -950,8 +950,8 @@ namespace FluentAssertions.Equivalency
public TSelf WithStrictOrderingFor(System.Linq.Expressions.Expression<System.Func<FluentAssertions.Equivalency.IObjectInfo, bool>> predicate) { }
public TSelf WithTracing(FluentAssertions.Equivalency.Tracing.ITraceWriter writer = null) { }
public TSelf WithoutAutoConversionFor(System.Linq.Expressions.Expression<System.Func<FluentAssertions.Equivalency.IObjectInfo, bool>> predicate) { }
public void WithoutMatchingRules() { }
public void WithoutSelectionRules() { }
public TSelf WithoutMatchingRules() { }
public TSelf WithoutSelectionRules() { }
public TSelf WithoutStrictOrdering() { }
public TSelf WithoutStrictOrderingFor(System.Linq.Expressions.Expression<System.Func<FluentAssertions.Equivalency.IObjectInfo, bool>> predicate) { }
public class Restriction<TMember>
Expand Down
4 changes: 2 additions & 2 deletions Tests/Approval.Tests/ApprovedApi/FluentAssertions/netstandard2.1.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -957,8 +957,8 @@ namespace FluentAssertions.Equivalency
public TSelf WithStrictOrderingFor(System.Linq.Expressions.Expression<System.Func<FluentAssertions.Equivalency.IObjectInfo, bool>> predicate) { }
public TSelf WithTracing(FluentAssertions.Equivalency.Tracing.ITraceWriter writer = null) { }
public TSelf WithoutAutoConversionFor(System.Linq.Expressions.Expression<System.Func<FluentAssertions.Equivalency.IObjectInfo, bool>> predicate) { }
public void WithoutMatchingRules() { }
public void WithoutSelectionRules() { }
public TSelf WithoutMatchingRules() { }
public TSelf WithoutSelectionRules() { }
public TSelf WithoutStrictOrdering() { }
public TSelf WithoutStrictOrderingFor(System.Linq.Expressions.Expression<System.Func<FluentAssertions.Equivalency.IObjectInfo, bool>> predicate) { }
public class Restriction<TMember>
Expand Down
66 changes: 66 additions & 0 deletions Tests/FluentAssertions.Equivalency.Specs/SelectionRulesSpecs.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
using System;
using FluentAssertions.Equivalency.Matching;
using FluentAssertions.Equivalency.Ordering;
using FluentAssertions.Equivalency.Selection;
using Xunit;

namespace FluentAssertions.Equivalency.Specs;

public partial class SelectionRulesSpecs
{
[Fact]
public void Public_methods_follow_fluent_syntax()
{
// Arrange
var subject = new Root();
var expected = new RootDto();

// Act / Assert
subject.Should().BeEquivalentTo(expected,
options => options
.AllowingInfiniteRecursion()
.ComparingByMembers(typeof(Root))
.ComparingByMembers<RootDto>()
.ComparingByValue(typeof(Customer))
.ComparingByValue<CustomerDto>()
.ComparingEnumsByName()
.ComparingEnumsByValue()
.ComparingRecordsByMembers()
.ComparingRecordsByValue()
.Excluding(r => r.Level)
.ExcludingFields()
.ExcludingMissingMembers()
.ExcludingNestedObjects()
.ExcludingNonBrowsableMembers()
.ExcludingProperties()
.IgnoringCyclicReferences()
.IgnoringNonBrowsableMembersOnSubject()
.Including(r => r.Level)
.IncludingAllDeclaredProperties()
.IncludingAllRuntimeProperties()
.IncludingFields()
.IncludingInternalFields()
.IncludingInternalProperties()
.IncludingNestedObjects()
.IncludingProperties()
.RespectingDeclaredTypes()
.RespectingRuntimeTypes()
.ThrowingOnMissingMembers()
.Using(new ExtensibilitySpecs.DoEquivalencyStep(() => { }))
.Using(new MustMatchByNameRule())
.Using(new AllFieldsSelectionRule())
.Using(new ByteArrayOrderingRule())
.Using(StringComparer.OrdinalIgnoreCase)
.WithAutoConversion()
.WithAutoConversionFor(_ => false)
.WithoutAutoConversionFor(_ => true)
.WithoutMatchingRules()
.WithoutSelectionRules()
.WithoutStrictOrdering()
.WithoutStrictOrderingFor(r => r.Level)
.WithStrictOrdering()
.WithStrictOrderingFor(r => r.Level)
.WithTracing()
);
}
}
1 change: 1 addition & 0 deletions docs/_pages/releases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ sidebar:
* `EquivalencyAssertionOptions<TExpectation>` to `EquivalencyOptions<TExpectation>`
* `IEquivalencyAssertionOptions` to `IEquivalencyOptions`
* `SelfReferenceEquivalencyAssertionOptions<TSelf>` to `SelfReferenceEquivalencyOptions<TSelf>`
* Allow fluently calling `WithoutMatchingRules` and `WithoutSelectionRules` while using `BeEquivalentTo` - [#2457](https://github.com/fluentassertions/fluentassertions/pull/2457)

### Breaking Changes (for extensions)
* Add `ForConstraint` to `IAssertionsScope` to support chaining `.ForConstraint()` after `.Then` - [#2324](https://github.com/fluentassertions/fluentassertions/pull/2324)
Expand Down