Rename EquivalencyAssertionOptions to EquivalencyOptions

[vbreuss]

While working on #2413 I stumbled over this code comment to rename EquivalencyAssertionOptions to EquivalencyOptions. As we are currently working on the next major version, I thought it a good time to implement it.

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]

Qodana for .NET

5 new problems were found

Inspection name	Severity	Problems
Use preferred body style (convert into property, indexer, or event with preferred body style)	◽️ Notice	5

💡 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:

1. Register at Qodana Cloud and configure the action
2. Use GitHub Code Scanning with Qodana
3. Host Qodana report at GitHub Pages
4. 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

[dennisdoomen]

While working on #2413 I stumbled over this code comment to rename EquivalencyAssertionOptions to EquivalencyOptions. As we are currently working on the next major version, I thought it a good time to implement it.

I'm all for this change, but I suspect @jnyrup may have a different perspective on breaking changes like these.

[jnyrup]

I'm all for this change, but I suspect @jnyrup may have a different perspective on breaking changes like these.

You read me like an open book.

As we are currently working on the next major version, I thought it a good time to implement it.

To extend on this, I'm quite conservative when it comes to breaking changes, even between major versions.

I do agree that the new name is better, but I don't think the change pull it's own weight.
grep.app
dotnet tests
datadog tracer tests
FluentAssertions.Json/JsonAssertionOptions.cs
Stack Overflow

If I should try being a tiny bit pragmatic for once:
#2253 might also re-arrange (read break) a lot of things.
If that happens, I guess we have broken extensibility enough that we might as well break this one.

[vbreuss]

I'm quite conservative when it comes to breaking changes, even between major versions.

As a user of this library, I am often glad about this approach, as it simplifies updates.

Should I leave the pull request open for now and wait for #2253?

As an alternative, if you prefer to not rename the classes at all, I could also just remove the code comment.

[dennisdoomen]

#2253 might also re-arrange (read break) a lot of things.

It will. As I have it envisioned in my brain, it will be big time breaking change ;-)

[jnyrup]

#2413 will also cause a related breaking change by adding members to the public interface IEquivalencyAssertionOptions.

Let's do this 🚀

[coveralls]

Pull Request Test Coverage Report for Build 6755429589

• 38 of 39 (97.44%) changed or added relevant lines in 14 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage remained the same at 97.393%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
Src/FluentAssertions/Equivalency/EquivalencyOptions.cs	3	4	75.0%

Totals
Change from base Build 6754534983:	0.0%
Covered Lines:	11735
Relevant Lines:	11926

---

💛 - Coveralls

[IT-VBFK]

What is wrong with the qodana scan? 🤔

[vbreuss]

What is wrong with the qodana scan? 🤔

I am not sure. I had similar problems with in #2431...

[IT-VBFK]

IMHO it has nothing to do with the code itself?

[dennisdoomen]

I think we need to look at that Qodana rule