beberlei/assert

What's Changed

• Update GitHub Action versions by @TimWolla in #347
• Add PHP 8.5 to CI by @TimWolla in #346
• Fix copy-pasted docblock on base64 assertion by @edorian in #351
• Reject trailing newline in alnum, url and e164 by @edorian in #352
• Fix uuid() accepting {, }, and prefixes inside the string by @edorian in #353

Full Changelog: v3.3.3...v3.3.4

What's Changed

• Allow any value to be passed to Assertion::isCountable() by @Wirone in #303
• PHP 8.2 CI Support by @rogervila in #332
• Fix typo in CONTRIBUTING.md by @TimWolla in #327
• Add .github/ export-ignore to .gitattributes by @TimWolla in #326
• Bump minimum PHP requirement to PHP 7.1 by @Ayesh in #338
• [PHP 8.4] Fixes for implicit nullability deprecation by @Ayesh in #337
• Add PHP 8.4 to CI by @TimWolla in #341

New Contributors

• @Wirone made their first contribution in #303
• @rogervila made their first contribution in #332
• @TimWolla made their first contribution in #327
• @Ayesh made their first contribution in #338

Full Changelog: v3.3.2...v3.3.3

What's Changed

• PHP 8.1 compatible by @frankvanhest in #320
• Improve performance of Assertion Chain class by @scyzoryck in #318

New Contributors

• @frankvanhest made their first contribution in #320
• @scyzoryck made their first contribution in #318

Full Changelog: v3.3.1...v3.3.2

• Merge changes from 3.2.7 missing in 3.3.0 thanks to @wilsonge

• #302 PHP 8 support thanks to @ptondereau
• #304 Migrate from TravisCI to Github Actions
• #296 Add Assert::uniqueValues thanks to @gronostajo

3.2.7 - 2019-12-19

Fixes

• Reinstated the @method return type for Assert\LazyAssertion methods to show that the return type is LazyAssertion.

Fixes

• Reinstated the @method return type for Assert\LazyAssertion methods to show that the return type is LazyAssertion.

3.2.6 - 2019-10-10

Fixes

• Make Assert\Assertion::stringify() UTF-8 safe (Thanks to Pedram Azimaei)

Fixes

• Make Assert\Assertion::stringify() UTF-8 safe (Thanks to Pedram Azimaei)

3.2.5 - 2019-10-10 - Fix the broken things release.

Notice

• Sigh!
  • Richard Quadling

Fixes

• REALLY Removed dependency of the intl extension.
• Updated the Docblocks for Assert\Assertion::all() helper to show that the value is expected to be an array.

Notice

• Sigh!
  • Richard Quadling

Fixes

• REALLY Removed dependency of the intl extension.
• Updated the Docblocks for Assert\Assertion::all() helper to show that the value is expected to be an array.

3.2.4 - 2019-10-09 - Fix the broken things release.

Notice

• It seems I've been slightly lax in verifying the signature changes and expected extensions.
  Hopefully, both of these have been fixed in this version.
  Truly sorry for breaking the internet!
  • Richard Quadling

Fixes

• Restored \Assert\Assertion::createException() signature to 3.2.2.
• Removed dependency of the intl extension. If the extension is available, then Assert\Assertion::count(), Assert\Assertion::isCountable(), Assert\Assertion::minCount(), and Assert\Assertion::maxCount() will operate on ResourceBundles.
• Fixed the @method return type for Assert\LazyAssertion methods to show that the return type is static for extensions of Assert\LazyAssertion.
  NOTE : Docblock does not have the ability to differentiate between a non static @method whose returns type is of the subclass and a @method that is called statically (PSR-5#899). So the use of static static is a fudge that sort of works for IDEs that need to know about the method that MAY be overridden in a subclass.

Notice

• It seems I've been slightly lax in verifying the signature changes and expected extensions. Hopefully, both of these have been fixed in this version. Truly sorry for breaking the internet!
  • Richard Quadling

Fixes

• Restored \Assert\Assertion::createException() signature to 3.2.2.
• Removed dependency of the intl extension. If the extension is available, then Assert\Assertion::count(), Assert\Assertion::isCountable(), Assert\Assertion::minCount(), and Assert\Assertion::maxCount() will operate on ResourceBundles.
• Fixed the @method return type for Assert\LazyAssertion methods to show that the return type is static for extensions of Assert\LazyAssertion.
  NOTE : Docblock does not have the ability to differentiate between a non static @method whose returns type is of the subclass and a @method that is called statically (PSR-5#899). So the use of static static is a fudge that sort of works for IDEs that need to know about the method that MAY be overridden in a subclass.

Other changes

• Added type hints and documentation consistency (Thanks to Andru Cherny)

Added assertions

• Assertion::eqArraySubset() (Thanks to Anna Filina)

Fixes

• Updated regex for Assert\Assertion::url() (Thanks to Christophe Histaesse)
• Fixed broken regex for Assert\Assertion::url() (Thanks to Menno Holtkamp)

Other changes

• Added PHP 7.3.0, PHP 7.3.1, and PHP 7.3.2 to Travis pipeline as there are differences in PCRE
• Updated docblocks for Assert\Assertion::NullOrXxxx() to show that the first parameter can be null.
• Updated docblocks for Assert\LazyAssertion to show that the return type is $this to aid IDE's static analysis.

Added assertions

• Assertion::isCountable() (Thanks to Baptiste Clavié)
• Assertion::maxCount() (Thanks to Baptiste Clavié)
• Assertion::minCount() (Thanks to Baptiste Clavié)
• Assertion::nonContains() (Thanks to Baptiste Clavié)

Other changes

• Added PHP 7.3 to Travis pipeline
• Added support for \ResourceBundle and \SimpleXMLElement to Assertion::count().

Other changes

• Refactor assertion messages for Assert\Assertion::notEq(), Assert\Assertion::notSame(), and Assert\Assertion::notInArray() (Thanks to Rick Kuipers)

Added assertions

• Assertion::notRegex() (Thanks to Thomas Müller)

Other changes

• Upgraded regex and unit tests for Assert\Assertion::url() to latest from Symfony/Validator

Changes

• Deprecate support for PHP < 7.0

Fixes

• An AssertionFailedException must be a Throwable (Thanks to Marco Pivetta)

Fixes

• Made constraints in exceptions consistent for all assertions (Thanks to Peter Kruithof)

Fixes

• Remove DocBlock entry causing exception in third party DocBlock parser (Thanks to Koutsoumpos Valantis)

Fixes

• Prevent date overflow in Assertion::date() by reset preset date value (Thanks to Nobuhiro Nakamura)

Changes

• Expand error for \Assert\Assertion::count() to include the supplied count (Thanks to Yoann Blot)

Fixes

• Usage of custom extended Assertion class in LazyAssertion (Thanks to Marek Štípek)

Deprecation notice

• Support for PHP 5 will be dropped at the end of 2018, in line with PHP's supported versions.

Fixes

• \Assert\Assertion::generateMessage() will now receive the default message for an assertion if one is not supplied (Thanks to Romans Malinovskis)

Fixes

• Assertion::integerish() has had several issues in the last couple of versions.
  Hopefully these are now fixed. Thanks to Erik Roelofs and Michał Mleczko

Deprecation notice

• The functions \Assert\that(), \Assert\thatAll(), \Assert\thatNullOr(), and \Assert\lazy() are no longer marked as deprecated.
  Both the functional and static constructors work together. Whichever you wish to use is a personal preference.

Fixes

• Assertion::integerish(0) and Assertion::integerish('0') now assert correctly.

Added assertions

• Assertion::base64() (Thanks to Pablo Kowalczyk)

Fixes

• Assertion::integerish() now correctly asserts integers with leading zeros in strings (Thanks to Albert Casademont)

Fixes

• Assertion::integerish() now throws exception as expected (Thanks to Thomas Flack)

Fixes

• Basic Auth usernames and passwords can contain '.' (Thanks to Fede Isas)

Fixes

• Fixed stringification of booleans (Thanks to Philipp Rieber)

Added assertions

• Assert\Assertion:isResource() (Thanks to Timothy Younger)

Other changes

• Corrected doc-block for Assert\Assertion::propertiesExist().

Added assertions

• Assert\Assertion::objectOrClass() (Thanks to Timothy Younger)
• Assert\Assertion::propertyExists() (Thanks to Timothy Younger)
• Assert\Assertion::propertiesExist() (Thanks to Timothy Younger)

Other changes

• Unit tests no longer using deprecated exception methods (Thanks to Richard Quadling)
• All global namespaced functions have been optimised (Thanks to Andreas Möller)

Fixes

• Fix Assert\Assertion::integerish() when used with a resource (Thanks to manuxi)

Fixes

• Backward compatibility fixes for PHP 5.3

Added assertions

• Assert\Assertion::extensionVersion() (Thanks to Timothy Younger)
• Assert\Assertion::phpVersion() (Thanks to Timothy Younger)
• Assert\Assertion::version() (Thanks to Timothy Younger)

Other changes

• Exception messages can now be constructed via a callback.
• Documentation now includes types.

Added assertions

• Assert\Assertion::defined() (Thanks to Timothy Younger)
• Assert\Assertion::extensionLoaded() (Thanks to Timothy Younger)

Other changes

• Added types to generated documentation.
• Added PHPStan analysis for PHP 7+

Fixes

• All exceptions thrown by this library extend \Assert\InvalidArgumentException (Thanks to Richard Quadling)

Other changes

• Update to php-cs-fixer ^2.0 release (Thanks to Raphael Stolt)
• Simplify XDebug disabling for Travis (Thanks to Raphael Stolt)
• Use PSR-4 autoloading (Thanks to Andreas Möller)
• Enable Composer package sorting (Thanks to Raphael Stolt)
• Fix grammar in documentation (Thanks to Adrian Föder)

Fixes

• Fix the interfaceExists assertion
• Fixed issue in document generator (Thanks to Taco van den Broek)

Other changes

• Added ability to capture multiple errors on a single value in a chain (Thanks to Alec Carpenter)
• Use static factory methods instead of functions in the Assert namespace (Thanks to Taco van den Broek)

Deprecation notice

• The functions in the Assert namespace (\Assert\that(), \Assert\thatAll(), \Assert\thatNullOr() and \Assert\lazy()) are now marked as deprecated. They will be removed in the next major release. They have been replaced with the static methods \Assert\Assert::that(), \Assert\Assert::thatAll(), \Assert\Assert::thatNullOr() and \Assert\Assert::lazy()

Other changes

• Make all assertions return true on success, so that it can be used inside PHP 7 assert()

Added assertions

• Assert\Assertion::between()
• Assert\Assertion::betweenExclusive()

Fixes

• Allow http://localhost as a valid URL - fixes Assertion::url('http://localhost') not a valid url?

Other changes

• Upgraded regex and unit tests for Assert\Assertion::url() to latest from Symfony/Validator
• Added PHP-CS
• Speed up of builds for Travis

Added assertions

• Assert\Assertion::e164() - The international public telecommunication numbering plan
• Assert\Assertion::interfaceExists()
• Assert\Assertion::ip() / Assert\Assertion::ipv4() / Assert\Assertion::ipv6()
• Assert\Assertion::keyNotExists()
• Assert\Assertion::null()
• Assert\Assertion::satisfy() - Allows for a bespoke assertion, rather than a predefined one

Fixes

• Improved the reporting of the value for min and max assertions

Other changes

• Removed composer.lock file from library
• Improved travis build to detect incorrect documentation changes

Added assertions

• Assert\Assertion::notInArray()

Fixes

• Made Assert\Assertion::INVALID_GREATER_OR_EQUAL unique

Other changes

• Introduced CONTRIBUTING.md to get contributors to generate the docblocks when a new assertion is added
• Introduced .editorconfig to allow IDEs that support EditorConfig to provide a consistent code style. See EditorConfig for further details
• Additional tests and updated documentation.
• Travis updates.

Fixes

• Fixed unit test to work with PHP 5.3

Fixes

• Fixed Assertion::isCallable() to with with PHP 5.3

Other changes

• Updated tests
• Updated generate_method_docs.php and regenerated all documentation
• Added Richard Quadling as collaborator

Other changes

• Updated missing assertions from documentation

Other changes

• Pass constraints and values to Assert\AssertionFailedException