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.
- For this particular updater, a list of exceptions to the rules
downloaded by geonames is included in POSTAL_CODES_EXTRA, for
cases in which we seem to do better than geonames itself based
on previous user reports.
- Added an option to also validate formatting of the postal codes.
- Combined multiple PR bots into a single one.
This commit will also remove the second argument from the constructor of
the rule because there is no much use for that, instead if will simply
perform the CountryCode validation.
Signed-off-by: Henrique Moody <henriquemoody@gmail.com>
The current documentation is hosted via GitHub pages rendered by
"Couscous". Every time we need a new version of the documentation
published we need to manually execute the "couscous".
This commit reorganize the documentation to be published to
"Read the Docs" because it will also allow us to have documentations per
version of the library most importantly provider a search field for the
documentation.
The documentation will be then published on:
https://respect-validation.readthedocs.io/
Signed-off-by: Henrique Moody <henriquemoody@gmail.com>
