Releases: approvals/ApprovalTests.cpp
Single Hpp File - v.10.1.0
- Breaking changes
- None
- New features
- ApprovalTests::verifyExistingFile() now supports scrubbers (#141)
- Bug fixes
- None
- Other changes
- None
Single Hpp File - v.10.0.1
- Breaking changes
- None
- New features
- None
- Bug fixes
- Fixed compilation error with Approvals::verify(writer, Options) (#139)
- Other changes
- None
Single Hpp File - v.10.0.0
DON'T PANIC!
We expect most of our users to have no problem with this upgrade. Changes are only needed when:
- you are passing in a specific reporter, which is usually an infrequent and temporary coding state,
- you call
verifyWithExtension(object, ".json")
is now
Approvals::verify(object, Options().fileOptions().withFileExtension(".json"))
Removing verify(..., Reporter)
This is the fourth and final of a series of rapid releases, to make small steps in deprecating passing in a Reporter object, in favor of an Options object, to the verify*()
methods. See Why We Are Converting To Options for easy ways to update your code.
- deprecation warnings are off: users can opt-in (v.8.7.0)
- deprecation warnings are on: users can opt-out (v.8.9.1)
- deprecation warnings are forced, code still exists (v.8.9.2)
- the deprecated methods are hidden: users can opt-in (v.9.0.0)
- the deprecated methods are removed (v.10.0.0) <== you are here
-
Breaking changes
- Removed methods:
Approvals::verify(..., Reporter)
Approvals::verifyAll(..., Reporter)
Approvals::verifyExistingFile(..., Reporter)
Approvals::verifyExceptionMessage(..., Reporter)
Approvals::verifyWithExtension(...)
CombinationApprovals::verifyAllCombinations(Reporter, ...)
- Removed macros:
APPROVAL_TESTS_HIDE_DEPRECATED_CODE
APPROVALTESTS_VERSION
APPROVALTESTS_VERSION_MAJOR
APPROVALTESTS_VERSION_MINOR
APPROVALTESTS_VERSION_PATCH
APPROVALTESTS_VERSION_STR
APPROVALS_CATCH_DISABLE_FILE_MACRO_CHECK
- The following macros have been changed.
- Removed methods:
Old (removed) | New |
---|---|
APPROVALTESTS_VERSION |
APPROVAL_TESTS_VERSION |
APPROVALTESTS_VERSION_MAJOR |
APPROVAL_TESTS_VERSION_MAJOR |
APPROVALTESTS_VERSION_MINOR |
APPROVAL_TESTS_VERSION_MINOR |
APPROVALTESTS_VERSION_PATCH |
APPROVAL_TESTS_VERSION_PATCH |
APPROVALTESTS_VERSION_STR |
APPROVAL_TESTS_VERSION_STR |
APPROVALS_CATCH_DISABLE_FILE_MACRO_CHECK |
APPROVAL_TESTS_DISABLE_FILE_MACRO_CHECK |
- New features
- None
- Bug fixes
- None
- Other changes
- None
Single Hpp File - v.9.0.0
DON'T PANIC!
We expect most of our users to have no problem with this upgrade. Changes are only needed when:
- you are passing in a specific reporter, which is usually an infrequent and temporary coding state,
- you call
verifyWithExtension(object, ".json")
is now
Approvals::verify(object, Options().fileOptions().withFileExtension(".json"))
Deprecating verify(..., Reporter)
This is the third of a series of rapid releases, to make small steps in deprecating passing in a Reporter object, in favor of an Options object, to the verify*()
methods. See Why We Are Converting To Options for easy ways to update your code.
- deprecation warnings are off: users can opt-in (v.8.7.0)
- deprecation warnings are on: users can opt-out (v.8.9.1)
- deprecation warnings are forced, code still exists (v.8.9.2)
- the deprecated methods are hidden: users can opt-in (v.9.0.0) <== you are here
- the deprecated methods are removed
- Breaking changes
- Hidden methods:
Approvals::verify(..., Reporter)
Approvals::verifyAll(..., Reporter)
Approvals::verifyExistingFile(..., Reporter)
Approvals::verifyExceptionMessage(..., Reporter)
Approvals::verifyWithExtension(...)
CombinationApprovals::verifyAllCombinations(Reporter, ...)
- Hidden macros:
APPROVAL_TESTS_HIDE_DEPRECATED_CODE
APPROVALTESTS_VERSION
APPROVALTESTS_VERSION_MAJOR
APPROVALTESTS_VERSION_MINOR
APPROVALTESTS_VERSION_PATCH
APPROVALTESTS_VERSION_STR
APPROVALS_CATCH_DISABLE_FILE_MACRO_CHECK
- The following macros have been changed.
- Hidden methods:
Old (hidden) | New |
---|---|
APPROVALTESTS_VERSION |
APPROVAL_TESTS_VERSION |
APPROVALTESTS_VERSION_MAJOR |
APPROVAL_TESTS_VERSION_MAJOR |
APPROVALTESTS_VERSION_MINOR |
APPROVAL_TESTS_VERSION_MINOR |
APPROVALTESTS_VERSION_PATCH |
APPROVAL_TESTS_VERSION_PATCH |
APPROVALTESTS_VERSION_STR |
APPROVAL_TESTS_VERSION_STR |
APPROVALS_CATCH_DISABLE_FILE_MACRO_CHECK |
APPROVAL_TESTS_DISABLE_FILE_MACRO_CHECK |
- New features
- None
- Bug fixes
- None
- Other changes
APPROVAL_TESTS_HIDE_DEPRECATED_CODE
is now enabled by default.
Single Hpp File - v.8.9.2
DON'T PANIC!
We expect most of our users to have no problem with this upgrade. Source code is totally backwards-compatible, as long as you don't treat compiler warnings as errors. Even if you do, it only applies when:
- you are passing in a specific reporter, which is usually an infrequent and temporary coding state,
- you call
verifyWithExtension()
.
Deprecating verify(..., Reporter)
This is the second of a series of rapid releases, to make small steps in deprecating passing in a Reporter object, in favor of an Options object, to the verify*()
methods. See Why We Are Converting To Options for easy ways to update your code.
- deprecation warnings are off: users can opt-in (v.8.7.0)
- deprecation warnings are on: users can opt-out (v.8.9.1)
- deprecation warnings are forced, code still exists (v.8.9.2) <== you are here
- the deprecated methods are hidden: users can opt-in
- the deprecated methods are removed
- Breaking changes
- None
- New features
- None
- Bug fixes
- None
- Other changes
APPROVAL_TESTS_SHOW_DEPRECATION_WARNINGS
is now ignored. Warnings are always shown when using theverify*()
methods that took a Reporter.
Single Hpp File - v.8.9.1
DON'T PANIC!
We expect most of our users to have no problem with this upgrade. Source code is totally backwards-compatible, as long as you don't treat compiler warnings as errors. Even if you do, it only applies when:
- you are passing in a specific reporter, which is usually an infrequent and temporary coding state,
- you call
verifyWithExtension()
.
Deprecating verify(..., Reporter)
This is the first of a series of rapid releases, to make small steps in deprecating passing in a Reporter object, in favor of an Options object, to the verify*()
methods. See Why We Are Converting To Options for easy ways to update your code.
- deprecation warnings are off: users can opt-in (v.8.7.0)
- deprecation warnings are on: users can opt-out (v.8.9.1) <== you are here
- deprecation warnings are forced, code still exists
- the deprecated methods are hidden: users can opt-in
- the deprecated methods are removed
- Breaking changes
- None
- New features
- None
- Bug fixes
- None
- Other changes
APPROVAL_TESTS_SHOW_DEPRECATION_WARNINGS
is now enabled by default.
Single Hpp File - v.8.9.0
- Breaking changes
- None
- New features
- Added Scrubbing using Regular Expressions (regex).
- Add support for CLion diff tool on Mac and Linux. See #138 for limitations.
- Bug fixes
- None
- Other changes
- None
Single Hpp File - v.8.8.1
Single Hpp File - v.8.8.0
- Breaking changes
- None
- New features
- FmtApprovals (#124)
Added integration with the {fmt} library.
See How to Use the Fmt Library To Print Objects.
Thanks @alepez
- FmtApprovals (#124)
- Bug fixes
- None
- Other changes
- None
Single Hpp File - v.8.7.1
- Breaking changes
- None
- New features
- None
- Bug fixes
- Fix compilation of
TCombinationApprovals
on C++14 and above, when deprecation warnings are enabled (#132)
- Fix compilation of
- Other changes
- None