Prepare library for the next major version #1518
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
henriquemoody
force-pushed
the
2.4
branch
8 times, most recently
from
5c422b3 to
b851bf3
Compare
Version 3.0 will include a few crucial deprecations. This commit adds some soft deprecations to warn users about these changes. Some of the biggest changes are: * The method `validate()` will be renamed to `isValid()`. * The method `validate()` will be repurposed to return an object with failures. * It won't be possible to handle rules directly; users will need to use the `Validator` class to validate with any rule. There will some more changes, but those are some of the most important ones, and are the ones that are easy to deprecate right now.
It won't be possible to catch specific exceptions; users will need to catch `ValidationException`. The `NestedValidationException` will be removed in the next major version, but there's no alternative to it right now, so I didn't deprecate it.
This commit will deprecate some classes in favor of a couple of news ones. If there are no customisations to `assert()`, `check()`, and other methods, the migration should be pretty easy on users.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## 2.3 #1518 +/- ##
============================================
- Coverage 95.04% 94.03% -1.01%
+ Complexity 981 448 -533
============================================
Files 195 97 -98
Lines 2299 1240 -1059
============================================
- Hits 2185 1166 -1019
+ Misses 114 74 -40 ☔ View full report in Codecov by Sentry. |
|
This merge request got merged as branch 2.4 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Version 3.0 will include a few crucial deprecations. This commit adds some soft deprecations to warn users about these changes.
Some of the biggest changes are:
The method
validate()will be renamed toisValid().The method
validate()will be repurposed to return an object with failures.It won't be possible to handle rules directly; users will need to use the
Validatorclass to validate with any rule.It won't be possible to catch specific exceptions; users will need to catch
ValidationException.There will some more changes, but those are some of the most important ones, and are the ones that are easy to deprecate right now.